github.com/optim-corp/cios-golang-sdk@v0.5.1/cios/README.md (about)

     1  # Go API client for cios
     2  
     3  No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
     4  
     5  ## Overview
     6  This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project.  By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
     7  
     8  - API version: 1.0.1
     9  - Package version: 1.0.0
    10  - Build package: org.openapitools.codegen.languages.GoClientCodegen
    11  
    12  ## Installation
    13  
    14  Install the following dependencies:
    15  
    16  ```shell
    17  go get github.com/stretchr/testify/assert
    18  go get golang.org/x/oauth2
    19  go get golang.org/x/net/context
    20  ```
    21  
    22  Put the package under your project folder and add the following in import:
    23  
    24  ```golang
    25  import sw "./cios"
    26  ```
    27  
    28  To use a proxy, set the environment variable `HTTP_PROXY`:
    29  
    30  ```golang
    31  os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
    32  ```
    33  
    34  ## Configuration of Server URL
    35  
    36  Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.
    37  
    38  ### Select Server Configuration
    39  
    40  For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.
    41  
    42  ```golang
    43  ctx := context.WithValue(context.Background(), sw.ContextServerIndex, 1)
    44  ```
    45  
    46  ### Templated Server URL
    47  
    48  Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.
    49  
    50  ```golang
    51  ctx := context.WithValue(context.Background(), sw.ContextServerVariables, map[string]string{
    52  	"basePath": "v2",
    53  })
    54  ```
    55  
    56  Note, enum values are always validated and all unused variables are silently ignored.
    57  
    58  ### URLs Configuration per Operation
    59  
    60  Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
    61  An operation is uniquely identifield by `"{classname}Service.{nickname}"` string.
    62  Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.
    63  
    64  ```
    65  ctx := context.WithValue(context.Background(), sw.ContextOperationServerIndices, map[string]int{
    66  	"{classname}Service.{nickname}": 2,
    67  })
    68  ctx = context.WithValue(context.Background(), sw.ContextOperationServerVariables, map[string]map[string]string{
    69  	"{classname}Service.{nickname}": {
    70  		"port": "8443",
    71  	},
    72  })
    73  ```
    74  
    75  ## Documentation for API Endpoints
    76  
    77  All URIs are relative to *http://localhost*
    78  
    79  Class | Method | HTTP request | Description
    80  ------------ | ------------- | ------------- | -------------
    81  *AccountApi* | [**GetMe**](docs/AccountApi.md#getme) | **Get** /v2/me | ログイン中のユーザープロフィールおよび所属する企業、参加するグループの一覧を取得する
    82  *AuthApi* | [**RefreshToken**](docs/AuthApi.md#refreshtoken) | **Post** /connect/token | 
    83  *CollectionApi* | [**CreateSeriesDataBulk**](docs/CollectionApi.md#createseriesdatabulk) | **Put** /v2/collections/{collection_id}/series/{series_id}/data-bulk | 
    84  *CollectionApi* | [**CreateSeriesImage**](docs/CollectionApi.md#createseriesimage) | **Put** /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/image | 
    85  *CollectionApi* | [**DeleteSeriesLatest**](docs/CollectionApi.md#deleteserieslatest) | **Delete** /v2/collections/{collection_id}/series/{series_id}/latest | 
    86  *CollectionApi* | [**GetCollectionStatus**](docs/CollectionApi.md#getcollectionstatus) | **Get** /v2/collections/{collection_id}/status | 
    87  *CollectionApi* | [**GetRecordedDates**](docs/CollectionApi.md#getrecordeddates) | **Get** /v2/collections/{collection_id}/recorded-dates | 
    88  *CollectionApi* | [**GetSeries**](docs/CollectionApi.md#getseries) | **Get** /v2/collections/{collection_id}/series/{series_id} | 
    89  *CollectionApi* | [**GetSeriesAggregation**](docs/CollectionApi.md#getseriesaggregation) | **Post** /v2/collections/{collection_id}/series/{series_id}/aggregation | 
    90  *CollectionApi* | [**GetSeriesImage**](docs/CollectionApi.md#getseriesimage) | **Get** /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/image | 
    91  *CollectionApi* | [**GetSeriesImages**](docs/CollectionApi.md#getseriesimages) | **Get** /v2/collections/{collection_id}/series/{series_id}/images | 
    92  *CollectionApi* | [**GetSeriesThumbnails**](docs/CollectionApi.md#getseriesthumbnails) | **Get** /v2/collections/{collection_id}/series/{series_id}/thumbnails | 
    93  *CollectionApi* | [**GetSeriesThumnbnail**](docs/CollectionApi.md#getseriesthumnbnail) | **Get** /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/thumbnail | 
    94  *CollectionApi* | [**GetTimeSeriesData**](docs/CollectionApi.md#gettimeseriesdata) | **Get** /v2/collections/{collection_id}/series/{series_id}/data | 
    95  *CollectionApi* | [**PostCollectionArchive**](docs/CollectionApi.md#postcollectionarchive) | **Post** /v2/collections/{collection_id}/archive | 
    96  *CollectionApi* | [**PostCollectionRestore**](docs/CollectionApi.md#postcollectionrestore) | **Post** /v2/collections/{collection_id}/restore | 
    97  *CollectionApi* | [**PostSearchLatest**](docs/CollectionApi.md#postsearchlatest) | **Post** /v2/collections/{collection_id}/search-latest | 
    98  *CollectionApi* | [**PostSeries**](docs/CollectionApi.md#postseries) | **Post** /v2/collections/{collection_id}/series | 時系列データ保存
    99  *CollectionApi* | [**PostSeriesBulk**](docs/CollectionApi.md#postseriesbulk) | **Post** /v2/collections/{collection_id}/series-bulk | 
   100  *CollectionApi* | [**PutSeries**](docs/CollectionApi.md#putseries) | **Put** /v2/collections/{collection_id}/series/{series_id}/timestamp/{timestamp}/data | 
   101  *ContractApi* | [**GetContract**](docs/ContractApi.md#getcontract) | **Get** /v2/contracts/{contract_id} | 契約IDの契約情報を取得する
   102  *ContractApi* | [**GetContractUser**](docs/ContractApi.md#getcontractuser) | **Get** /v2/contracts/{contract_id}/users/{user_id} | 契約IDの契約情報を取得する
   103  *ContractApi* | [**GetContractUsers**](docs/ContractApi.md#getcontractusers) | **Get** /v2/contracts/{contract_id}/users | 契約IDの契約情報を取得する
   104  *ContractApi* | [**GetContracts**](docs/ContractApi.md#getcontracts) | **Get** /v2/contracts | 契約一覧情報を取得する
   105  *DeviceApi* | [**CreateDevice**](docs/DeviceApi.md#createdevice) | **Post** /v2/devices | デバイスの登録
   106  *DeviceApi* | [**CreateDeviceClient**](docs/DeviceApi.md#createdeviceclient) | **Post** /v2/devices/{device_id}/device_clients | 
   107  *DeviceApi* | [**CreateDevicePolicy**](docs/DeviceApi.md#createdevicepolicy) | **Post** /v2/devices/group_policies | 
   108  *DeviceApi* | [**DeleteDevice**](docs/DeviceApi.md#deletedevice) | **Delete** /v2/devices/{device_id} | 
   109  *DeviceApi* | [**DeleteDeviceClient**](docs/DeviceApi.md#deletedeviceclient) | **Delete** /v2/devices/{device_id}/device_clients/{client_id} | device.write
   110  *DeviceApi* | [**DeletePolicy**](docs/DeviceApi.md#deletepolicy) | **Delete** /v2/devices/group_policies/{policy_id} | 
   111  *DeviceApi* | [**GetDevice**](docs/DeviceApi.md#getdevice) | **Get** /v2/devices/{device_id} | 指定したidのデバイスの情報を取得する
   112  *DeviceApi* | [**GetDeviceInventoryLatest**](docs/DeviceApi.md#getdeviceinventorylatest) | **Get** /v2/devices/{device_id}/inventory/latest | 
   113  *DeviceApi* | [**GetDeviceMonitoringLatest**](docs/DeviceApi.md#getdevicemonitoringlatest) | **Get** /v2/devices/{device_id}/monitoring/latest | 
   114  *DeviceApi* | [**GetDeviceMonitoringsLatest**](docs/DeviceApi.md#getdevicemonitoringslatest) | **Post** /v2/devices/monitoring/latest | 
   115  *DeviceApi* | [**GetDevicePolicies**](docs/DeviceApi.md#getdevicepolicies) | **Get** /v2/devices/group_policies | 
   116  *DeviceApi* | [**GetDeviceProfile**](docs/DeviceApi.md#getdeviceprofile) | **Get** /v2/devices/profile | device.profile
   117  *DeviceApi* | [**GetDevices**](docs/DeviceApi.md#getdevices) | **Get** /v2/devices | デバイスの一覧を取得する
   118  *DeviceApi* | [**UpdateDevice**](docs/DeviceApi.md#updatedevice) | **Patch** /v2/devices/{device_id} | 指定したidのデバイス情報を更新する
   119  *DeviceApi* | [**UpdateDeviceClient**](docs/DeviceApi.md#updatedeviceclient) | **Patch** /v2/devices/{device_id}/device_clients/{client_id} | device.write
   120  *DeviceAssetApi* | [**CreateDeviceEntitiesComponent**](docs/DeviceAssetApi.md#createdeviceentitiescomponent) | **Post** /v2/device_entities/{key}/components | 
   121  *DeviceAssetApi* | [**CreateDeviceEntitiesLifecycle**](docs/DeviceAssetApi.md#createdeviceentitieslifecycle) | **Post** /v2/device_entities/{key}/lifecycles | 
   122  *DeviceAssetApi* | [**CreateDeviceModel**](docs/DeviceAssetApi.md#createdevicemodel) | **Post** /v2/device_models | 
   123  *DeviceAssetApi* | [**CreateInventory**](docs/DeviceAssetApi.md#createinventory) | **Post** /v2/device_models/{name}/entities | 
   124  *DeviceAssetApi* | [**DeleteDeviceEntitiesComponent**](docs/DeviceAssetApi.md#deletedeviceentitiescomponent) | **Delete** /v2/device_entities/{key}/components/{component_id} | 
   125  *DeviceAssetApi* | [**DeleteDeviceEntitiesLifecycle**](docs/DeviceAssetApi.md#deletedeviceentitieslifecycle) | **Delete** /v2/device_entities/{key}/lifecycles/{lifecycle_id} | 
   126  *DeviceAssetApi* | [**DeleteDeviceEntity**](docs/DeviceAssetApi.md#deletedeviceentity) | **Delete** /v2/device_entities/{key} | 
   127  *DeviceAssetApi* | [**DeleteDeviceModel**](docs/DeviceAssetApi.md#deletedevicemodel) | **Delete** /v2/device_models/{name} | 
   128  *DeviceAssetApi* | [**GetDeviceEntities**](docs/DeviceAssetApi.md#getdeviceentities) | **Get** /v2/device_entities | 
   129  *DeviceAssetApi* | [**GetDeviceEntitiesComponent**](docs/DeviceAssetApi.md#getdeviceentitiescomponent) | **Get** /v2/device_entities/{key}/components/{component_id} | 
   130  *DeviceAssetApi* | [**GetDeviceEntitiesComponents**](docs/DeviceAssetApi.md#getdeviceentitiescomponents) | **Get** /v2/device_entities/{key}/components | 
   131  *DeviceAssetApi* | [**GetDeviceEntitiesLifecycle**](docs/DeviceAssetApi.md#getdeviceentitieslifecycle) | **Get** /v2/device_entities/{key}/lifecycles/{lifecycle_id} | 
   132  *DeviceAssetApi* | [**GetDeviceEntitiesLifecycles**](docs/DeviceAssetApi.md#getdeviceentitieslifecycles) | **Get** /v2/device_entities/{key}/lifecycles | 
   133  *DeviceAssetApi* | [**GetDeviceEntity**](docs/DeviceAssetApi.md#getdeviceentity) | **Get** /v2/device_entities/{key} | 
   134  *DeviceAssetApi* | [**GetDeviceModel**](docs/DeviceAssetApi.md#getdevicemodel) | **Get** /v2/device_models/{name} | 
   135  *DeviceAssetApi* | [**GetDeviceModels**](docs/DeviceAssetApi.md#getdevicemodels) | **Get** /v2/device_models | 
   136  *DeviceAssetApi* | [**GetDeviceModelsComponents**](docs/DeviceAssetApi.md#getdevicemodelscomponents) | **Get** /v2/device_models/{name}/components | 
   137  *DeviceAssetApi* | [**UpdateDeviceEntitiesComponent**](docs/DeviceAssetApi.md#updatedeviceentitiescomponent) | **Patch** /v2/device_entities/{key}/components/{component_id} | 
   138  *DeviceAssetApi* | [**UpdateDeviceEntitiesComponents**](docs/DeviceAssetApi.md#updatedeviceentitiescomponents) | **Patch** /v2/device_entities/{key}/components | 
   139  *DeviceAssetApi* | [**UpdateDeviceEntity**](docs/DeviceAssetApi.md#updatedeviceentity) | **Patch** /v2/device_entities/{key} | 
   140  *DeviceAssetApi* | [**UpdateDeviceModel**](docs/DeviceAssetApi.md#updatedevicemodel) | **Patch** /v2/device_models/{name} | 
   141  *FileStorageApi* | [**CopyNode**](docs/FileStorageApi.md#copynode) | **Post** /v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/copy | 
   142  *FileStorageApi* | [**CreateBucket**](docs/FileStorageApi.md#createbucket) | **Post** /v2/file_storage/buckets | 
   143  *FileStorageApi* | [**CreateDirectory**](docs/FileStorageApi.md#createdirectory) | **Post** /v2/file_storage/buckets/{bucket_id}/create_directory | 
   144  *FileStorageApi* | [**DeleteBucket**](docs/FileStorageApi.md#deletebucket) | **Delete** /v2/file_storage/buckets/{bucket_id} | 
   145  *FileStorageApi* | [**DeleteNode**](docs/FileStorageApi.md#deletenode) | **Delete** /v2/file_storage/buckets/{bucket_id}/nodes/{node_id} | 
   146  *FileStorageApi* | [**DownloadFile**](docs/FileStorageApi.md#downloadfile) | **Get** /v2/file_storage/buckets/{bucket_id}/download | 
   147  *FileStorageApi* | [**GetBucket**](docs/FileStorageApi.md#getbucket) | **Get** /v2/file_storage/buckets/{bucket_id} | 
   148  *FileStorageApi* | [**GetBuckets**](docs/FileStorageApi.md#getbuckets) | **Get** /v2/file_storage/buckets | 
   149  *FileStorageApi* | [**GetNode**](docs/FileStorageApi.md#getnode) | **Get** /v2/file_storage/buckets/{bucket_id}/nodes/{node_id} | 
   150  *FileStorageApi* | [**GetNodes**](docs/FileStorageApi.md#getnodes) | **Get** /v2/file_storage/buckets/{bucket_id}/nodes | 
   151  *FileStorageApi* | [**MoveNode**](docs/FileStorageApi.md#movenode) | **Post** /v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/move | 
   152  *FileStorageApi* | [**RenameNode**](docs/FileStorageApi.md#renamenode) | **Post** /v2/file_storage/buckets/{bucket_id}/nodes/{node_id}/rename | 
   153  *FileStorageApi* | [**UpdateBucket**](docs/FileStorageApi.md#updatebucket) | **Patch** /v2/file_storage/buckets/{bucket_id} | 
   154  *FileStorageApi* | [**UploadFile**](docs/FileStorageApi.md#uploadfile) | **Put** /v2/file_storage/buckets/{bucket_id}/upload | 
   155  *GeographyApi* | [**CreateCircle**](docs/GeographyApi.md#createcircle) | **Post** /v2/geo/circles | 
   156  *GeographyApi* | [**CreatePoint**](docs/GeographyApi.md#createpoint) | **Post** /v2/geo/points | 
   157  *GeographyApi* | [**CreateRoute**](docs/GeographyApi.md#createroute) | **Post** /v2/geo/routes | 
   158  *GeographyApi* | [**DeleteCircle**](docs/GeographyApi.md#deletecircle) | **Delete** /v2/geo/circles/{circles_id} | 
   159  *GeographyApi* | [**DeletePoint**](docs/GeographyApi.md#deletepoint) | **Delete** /v2/geo/points/{point_id} | 
   160  *GeographyApi* | [**DeleteRoute**](docs/GeographyApi.md#deleteroute) | **Delete** /v2/geo/routes/{routes_id} | 
   161  *GeographyApi* | [**GetCircle**](docs/GeographyApi.md#getcircle) | **Get** /v2/geo/circles/{circles_id} | 
   162  *GeographyApi* | [**GetCircles**](docs/GeographyApi.md#getcircles) | **Get** /v2/geo/circles | 
   163  *GeographyApi* | [**GetPoint**](docs/GeographyApi.md#getpoint) | **Get** /v2/geo/points/{point_id} | 
   164  *GeographyApi* | [**GetPoints**](docs/GeographyApi.md#getpoints) | **Get** /v2/geo/points | 
   165  *GeographyApi* | [**GetRoute**](docs/GeographyApi.md#getroute) | **Get** /v2/geo/routes/{routes_id} | 
   166  *GeographyApi* | [**GetRoutes**](docs/GeographyApi.md#getroutes) | **Get** /v2/geo/routes | 
   167  *GeographyApi* | [**UpdateCircle**](docs/GeographyApi.md#updatecircle) | **Patch** /v2/geo/circles/{circles_id} | 
   168  *GeographyApi* | [**UpdatePoint**](docs/GeographyApi.md#updatepoint) | **Patch** /v2/geo/points/{point_id} | 
   169  *GeographyApi* | [**UpdateRoute**](docs/GeographyApi.md#updateroute) | **Patch** /v2/geo/routes/{routes_id} | 
   170  *GroupApi* | [**CreateGroup**](docs/GroupApi.md#creategroup) | **Post** /v2/groups | 
   171  *GroupApi* | [**DeleteGroup**](docs/GroupApi.md#deletegroup) | **Delete** /v2/groups/{group_id} | 
   172  *GroupApi* | [**DeleteMember**](docs/GroupApi.md#deletemember) | **Delete** /v2/groups/{group_id}/members | 
   173  *GroupApi* | [**GetGroup**](docs/GroupApi.md#getgroup) | **Get** /v2/groups/{group_id} | 
   174  *GroupApi* | [**GetGroups**](docs/GroupApi.md#getgroups) | **Get** /v2/groups | 
   175  *GroupApi* | [**GetMembers**](docs/GroupApi.md#getmembers) | **Get** /v2/groups/{group_id}/members | 
   176  *GroupApi* | [**InviteGroup**](docs/GroupApi.md#invitegroup) | **Post** /v2/groups/{group_id}/invites | 
   177  *GroupApi* | [**ReplaceGroup**](docs/GroupApi.md#replacegroup) | **Put** /v2/groups/{group_id} | 
   178  *GroupApi* | [**SetMember**](docs/GroupApi.md#setmember) | **Patch** /v2/groups/{group_id}/members | 
   179  *GroupApi* | [**UpdateGroup**](docs/GroupApi.md#updategroup) | **Patch** /v2/groups/{group_id} | 
   180  *GroupApi* | [**UpdateMember**](docs/GroupApi.md#updatemember) | **Put** /v2/groups/{group_id}/members | 
   181  *LicenseApi* | [**GetMyLicenses**](docs/LicenseApi.md#getmylicenses) | **Get** /v2/licenses/me | 
   182  *PublishSubscribeApi* | [**CreateChannel**](docs/PublishSubscribeApi.md#createchannel) | **Post** /v2/channels | 
   183  *PublishSubscribeApi* | [**CreateDataStoreObject**](docs/PublishSubscribeApi.md#createdatastoreobject) | **Post** /v2/datastore/channels/{channel_id}/objects | 
   184  *PublishSubscribeApi* | [**DeleteChannel**](docs/PublishSubscribeApi.md#deletechannel) | **Delete** /v2/channels/{channel_id} | 
   185  *PublishSubscribeApi* | [**DeleteDataStoreChannel**](docs/PublishSubscribeApi.md#deletedatastorechannel) | **Delete** /v2/datastore/channels/{channel_id} | 
   186  *PublishSubscribeApi* | [**DeleteDataStoreObjectData**](docs/PublishSubscribeApi.md#deletedatastoreobjectdata) | **Delete** /v2/datastore/channels/{channel_id}/objects/{object_id} | 
   187  *PublishSubscribeApi* | [**DeleteDataStoreSession**](docs/PublishSubscribeApi.md#deletedatastoresession) | **Delete** /v2/datastore/channels/{channel_id}/sessions/{session_id} | 
   188  *PublishSubscribeApi* | [**GetChannel**](docs/PublishSubscribeApi.md#getchannel) | **Get** /v2/channels/{channel_id} | 
   189  *PublishSubscribeApi* | [**GetChannels**](docs/PublishSubscribeApi.md#getchannels) | **Get** /v2/channels | 
   190  *PublishSubscribeApi* | [**GetDataStoreChannel**](docs/PublishSubscribeApi.md#getdatastorechannel) | **Get** /v2/datastore/channels/{channel_id} | 
   191  *PublishSubscribeApi* | [**GetDataStoreChannels**](docs/PublishSubscribeApi.md#getdatastorechannels) | **Get** /v2/datastore/channels | 
   192  *PublishSubscribeApi* | [**GetDataStoreMultiObjectDataLatest**](docs/PublishSubscribeApi.md#getdatastoremultiobjectdatalatest) | **Post** /v2/datastore/objects_latest | 
   193  *PublishSubscribeApi* | [**GetDataStoreObjectData**](docs/PublishSubscribeApi.md#getdatastoreobjectdata) | **Get** /v2/datastore/channels/{channel_id}/objects/{object_id} | 
   194  *PublishSubscribeApi* | [**GetDataStoreObjectDataLatest**](docs/PublishSubscribeApi.md#getdatastoreobjectdatalatest) | **Get** /v2/datastore/channels/{channel_id}/object_latest | 
   195  *PublishSubscribeApi* | [**GetDataStoreObjects**](docs/PublishSubscribeApi.md#getdatastoreobjects) | **Get** /v2/datastore/channels/{channel_id}/objects | 
   196  *PublishSubscribeApi* | [**GetDataStoreSession**](docs/PublishSubscribeApi.md#getdatastoresession) | **Get** /v2/datastore/channels/{channel_id}/sessions/{session_id} | 
   197  *PublishSubscribeApi* | [**GetDataStoreSessions**](docs/PublishSubscribeApi.md#getdatastoresessions) | **Get** /v2/datastore/channels/{channel_id}/sessions | 
   198  *PublishSubscribeApi* | [**PublishMessage**](docs/PublishSubscribeApi.md#publishmessage) | **Post** /v2/messaging | 
   199  *PublishSubscribeApi* | [**SubscribeMessage**](docs/PublishSubscribeApi.md#subscribemessage) | **Get** /v2/messaging | 
   200  *PublishSubscribeApi* | [**UpdateChannel**](docs/PublishSubscribeApi.md#updatechannel) | **Patch** /v2/channels/{channel_id} | 
   201  *ResourceOwnerApi* | [**GetResourceOwner**](docs/ResourceOwnerApi.md#getresourceowner) | **Get** /v2/resource_owners/{resource_owner_id} | 
   202  *ResourceOwnerApi* | [**GetResourceOwners**](docs/ResourceOwnerApi.md#getresourceowners) | **Get** /v2/resource_owners | 
   203  *VideostreamingOperationsApi* | [**CreateVideoStreamsPlay**](docs/VideostreamingOperationsApi.md#createvideostreamsplay) | **Post** /v2/video_streams/{video_id}/play | 
   204  *VideostreamingOperationsApi* | [**CreateVideoStreamsStop**](docs/VideostreamingOperationsApi.md#createvideostreamsstop) | **Post** /v2/video_streams/{video_id}/stop | 
   205  *VideostreamingOperationsApi* | [**GetVideoStreams**](docs/VideostreamingOperationsApi.md#getvideostreams) | **Get** /v2/video_streams/{video_id} | 
   206  *VideostreamingOperationsApi* | [**GetVideoStreamsList**](docs/VideostreamingOperationsApi.md#getvideostreamslist) | **Get** /v2/video_streams | 
   207  *VideostreamingOperationsApi* | [**GetVideoStreamsThumbnail**](docs/VideostreamingOperationsApi.md#getvideostreamsthumbnail) | **Get** /v2/video_streams/{video_id}/thumbnail | 
   208  *VideostreamingOperationsApi* | [**UpdateStreams**](docs/VideostreamingOperationsApi.md#updatestreams) | **Patch** /v2/video_streams/{video_id} | 
   209  
   210  
   211  ## Documentation For Models
   212  
   213   - [ApplicationClient](docs/ApplicationClient.md)
   214   - [Bucket](docs/Bucket.md)
   215   - [BucketEditBody](docs/BucketEditBody.md)
   216   - [BucketFiles](docs/BucketFiles.md)
   217   - [BucketName](docs/BucketName.md)
   218   - [BucketRequest](docs/BucketRequest.md)
   219   - [Channel](docs/Channel.md)
   220   - [ChannelProposal](docs/ChannelProposal.md)
   221   - [ChannelProtocol](docs/ChannelProtocol.md)
   222   - [ChannelUpdateProposal](docs/ChannelUpdateProposal.md)
   223   - [Circle](docs/Circle.md)
   224   - [Client](docs/Client.md)
   225   - [CollectionLatest](docs/CollectionLatest.md)
   226   - [CollectionLatestRequest](docs/CollectionLatestRequest.md)
   227   - [CollectionLocation](docs/CollectionLocation.md)
   228   - [ComponentTypeEnum](docs/ComponentTypeEnum.md)
   229   - [ConnectTokenResponse](docs/ConnectTokenResponse.md)
   230   - [ConnectedDeviceResult](docs/ConnectedDeviceResult.md)
   231   - [ConstitutionComponent](docs/ConstitutionComponent.md)
   232   - [Contract](docs/Contract.md)
   233   - [ContractItem](docs/ContractItem.md)
   234   - [ContractOwner](docs/ContractOwner.md)
   235   - [ContractOwnerAddress](docs/ContractOwnerAddress.md)
   236   - [ContractUser](docs/ContractUser.md)
   237   - [ContractUserLicense](docs/ContractUserLicense.md)
   238   - [CreatedBy](docs/CreatedBy.md)
   239   - [CreatedByClient](docs/CreatedByClient.md)
   240   - [CreatedByUser](docs/CreatedByUser.md)
   241   - [DataError](docs/DataError.md)
   242   - [DataStoreChannel](docs/DataStoreChannel.md)
   243   - [DataStoreChannelStats](docs/DataStoreChannelStats.md)
   244   - [DataStoreConfig](docs/DataStoreConfig.md)
   245   - [DataStoreObject](docs/DataStoreObject.md)
   246   - [DataStoreObjectLocation](docs/DataStoreObjectLocation.md)
   247   - [Device](docs/Device.md)
   248   - [DeviceClient](docs/DeviceClient.md)
   249   - [DeviceClientList](docs/DeviceClientList.md)
   250   - [DeviceClientRequest](docs/DeviceClientRequest.md)
   251   - [DeviceClientRsaKey](docs/DeviceClientRsaKey.md)
   252   - [DeviceEntitiesComponent](docs/DeviceEntitiesComponent.md)
   253   - [DeviceEntitiesComponentUpdateRequest](docs/DeviceEntitiesComponentUpdateRequest.md)
   254   - [DeviceInfo](docs/DeviceInfo.md)
   255   - [DeviceModel](docs/DeviceModel.md)
   256   - [DeviceModelRequest](docs/DeviceModelRequest.md)
   257   - [DeviceModelUpdateRequest](docs/DeviceModelUpdateRequest.md)
   258   - [DeviceModelUpdateRequestWatch](docs/DeviceModelUpdateRequestWatch.md)
   259   - [DeviceModelUpdateRequestWatchTypes](docs/DeviceModelUpdateRequestWatchTypes.md)
   260   - [DeviceModelsEntity](docs/DeviceModelsEntity.md)
   261   - [DeviceModelsEntityModel](docs/DeviceModelsEntityModel.md)
   262   - [DeviceMonitoring](docs/DeviceMonitoring.md)
   263   - [DeviceMonitoringIDsRequest](docs/DeviceMonitoringIDsRequest.md)
   264   - [DevicePerformance](docs/DevicePerformance.md)
   265   - [DevicePolicy](docs/DevicePolicy.md)
   266   - [DevicePolicyRequest](docs/DevicePolicyRequest.md)
   267   - [DeviceUpdateRequest](docs/DeviceUpdateRequest.md)
   268   - [DisplayInfo](docs/DisplayInfo.md)
   269   - [Group](docs/Group.md)
   270   - [GroupAddress](docs/GroupAddress.md)
   271   - [GroupChildren](docs/GroupChildren.md)
   272   - [GroupCreateRequest](docs/GroupCreateRequest.md)
   273   - [GroupInviteRequest](docs/GroupInviteRequest.md)
   274   - [GroupReplaceRequest](docs/GroupReplaceRequest.md)
   275   - [GroupUpdateRequest](docs/GroupUpdateRequest.md)
   276   - [Ids](docs/Ids.md)
   277   - [Inventory](docs/Inventory.md)
   278   - [Label](docs/Label.md)
   279   - [License](docs/License.md)
   280   - [LifeCycle](docs/LifeCycle.md)
   281   - [LifeCycleRequest](docs/LifeCycleRequest.md)
   282   - [Location](docs/Location.md)
   283   - [Me](docs/Me.md)
   284   - [MeGroups](docs/MeGroups.md)
   285   - [Member](docs/Member.md)
   286   - [MemberInfo](docs/MemberInfo.md)
   287   - [MemberInfoProfile](docs/MemberInfoProfile.md)
   288   - [MessagingConfig](docs/MessagingConfig.md)
   289   - [MultipleBucket](docs/MultipleBucket.md)
   290   - [MultipleChannel](docs/MultipleChannel.md)
   291   - [MultipleCircle](docs/MultipleCircle.md)
   292   - [MultipleCollectionLatest](docs/MultipleCollectionLatest.md)
   293   - [MultipleConstitutionComponent](docs/MultipleConstitutionComponent.md)
   294   - [MultipleContract](docs/MultipleContract.md)
   295   - [MultipleContractUser](docs/MultipleContractUser.md)
   296   - [MultipleDataStoreChannel](docs/MultipleDataStoreChannel.md)
   297   - [MultipleDataStoreDataLatest](docs/MultipleDataStoreDataLatest.md)
   298   - [MultipleDataStoreObject](docs/MultipleDataStoreObject.md)
   299   - [MultipleDevice](docs/MultipleDevice.md)
   300   - [MultipleDeviceEntitiesComponent](docs/MultipleDeviceEntitiesComponent.md)
   301   - [MultipleDeviceModel](docs/MultipleDeviceModel.md)
   302   - [MultipleDeviceModelEntity](docs/MultipleDeviceModelEntity.md)
   303   - [MultipleDeviceMonitoring](docs/MultipleDeviceMonitoring.md)
   304   - [MultipleDevicePolicy](docs/MultipleDevicePolicy.md)
   305   - [MultipleGroup](docs/MultipleGroup.md)
   306   - [MultipleLicense](docs/MultipleLicense.md)
   307   - [MultipleLifeCycle](docs/MultipleLifeCycle.md)
   308   - [MultipleMember](docs/MultipleMember.md)
   309   - [MultipleMemberInfo](docs/MultipleMemberInfo.md)
   310   - [MultipleNode](docs/MultipleNode.md)
   311   - [MultiplePoint](docs/MultiplePoint.md)
   312   - [MultipleResourceOwner](docs/MultipleResourceOwner.md)
   313   - [MultipleRoute](docs/MultipleRoute.md)
   314   - [MultipleSeriesDataLocationUnix](docs/MultipleSeriesDataLocationUnix.md)
   315   - [MultipleSeriesImage](docs/MultipleSeriesImage.md)
   316   - [MultipleSession](docs/MultipleSession.md)
   317   - [MultipleVideo](docs/MultipleVideo.md)
   318   - [Node](docs/Node.md)
   319   - [NodeFile](docs/NodeFile.md)
   320   - [NodeName](docs/NodeName.md)
   321   - [NodeRequest](docs/NodeRequest.md)
   322   - [PackerFormatJson](docs/PackerFormatJson.md)
   323   - [PackerFormatJsonHeader](docs/PackerFormatJsonHeader.md)
   324   - [Participant](docs/Participant.md)
   325   - [Point](docs/Point.md)
   326   - [PointRequest](docs/PointRequest.md)
   327   - [RecordedDates](docs/RecordedDates.md)
   328   - [ResourceOwner](docs/ResourceOwner.md)
   329   - [ResourceOwnerProfile](docs/ResourceOwnerProfile.md)
   330   - [Room](docs/Room.md)
   331   - [Route](docs/Route.md)
   332   - [RouteContents](docs/RouteContents.md)
   333   - [RsaPublicKey](docs/RsaPublicKey.md)
   334   - [SeriesAggregations](docs/SeriesAggregations.md)
   335   - [SeriesBulkRequest](docs/SeriesBulkRequest.md)
   336   - [SeriesDataBulkRequest](docs/SeriesDataBulkRequest.md)
   337   - [SeriesDataLocation](docs/SeriesDataLocation.md)
   338   - [SeriesDataLocationUnix](docs/SeriesDataLocationUnix.md)
   339   - [SeriesDataRequest](docs/SeriesDataRequest.md)
   340   - [SeriesImage](docs/SeriesImage.md)
   341   - [SeriesRequest](docs/SeriesRequest.md)
   342   - [Session](docs/Session.md)
   343   - [SingleBucket](docs/SingleBucket.md)
   344   - [SingleChannel](docs/SingleChannel.md)
   345   - [SingleCircle](docs/SingleCircle.md)
   346   - [SingleDataStoreChannel](docs/SingleDataStoreChannel.md)
   347   - [SingleDataStoreObject](docs/SingleDataStoreObject.md)
   348   - [SingleDevice](docs/SingleDevice.md)
   349   - [SingleDeviceClientList](docs/SingleDeviceClientList.md)
   350   - [SingleDeviceEntitiesComponent](docs/SingleDeviceEntitiesComponent.md)
   351   - [SingleDeviceModel](docs/SingleDeviceModel.md)
   352   - [SingleDeviceModelsEntity](docs/SingleDeviceModelsEntity.md)
   353   - [SingleDeviceMonitoring](docs/SingleDeviceMonitoring.md)
   354   - [SingleLifeCycle](docs/SingleLifeCycle.md)
   355   - [SingleNode](docs/SingleNode.md)
   356   - [SinglePoint](docs/SinglePoint.md)
   357   - [SingleRoom](docs/SingleRoom.md)
   358   - [SingleRoute](docs/SingleRoute.md)
   359   - [SingleSession](docs/SingleSession.md)
   360   - [SingleVideo](docs/SingleVideo.md)
   361   - [Subscription](docs/Subscription.md)
   362   - [SubscriptionItem](docs/SubscriptionItem.md)
   363   - [SubscriptionOwner](docs/SubscriptionOwner.md)
   364   - [UpdatedBy](docs/UpdatedBy.md)
   365   - [Video](docs/Video.md)
   366   - [VideoUpdateRequest](docs/VideoUpdateRequest.md)
   367   - [Watch](docs/Watch.md)
   368  
   369  
   370  ## Documentation For Authorization
   371  
   372  
   373  
   374  ### bearerAuth
   375  
   376  - **Type**: HTTP Bearer token authentication
   377  
   378  Example
   379  
   380  ```golang
   381  auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARERTOKENSTRING")
   382  r, err := client.Service.Operation(auth, args)
   383  ```
   384  
   385  
   386  ## Documentation for Utility Methods
   387  
   388  Due to the fact that model structure members are all pointers, this package contains
   389  a number of utility functions to easily obtain pointers to values of basic types.
   390  Each of these functions takes a value of the given basic type and returns a pointer to it:
   391  
   392  * `PtrBool`
   393  * `PtrInt`
   394  * `PtrInt32`
   395  * `PtrInt64`
   396  * `PtrFloat`
   397  * `PtrFloat32`
   398  * `PtrFloat64`
   399  * `PtrString`
   400  * `PtrTime`
   401  
   402  ## Author
   403  
   404  
   405