diff --git a/docs/CreateParticipantRequest.md b/docs/CreateParticipantRequest.md deleted file mode 100644 index d610301..0000000 --- a/docs/CreateParticipantRequest.md +++ /dev/null @@ -1,14 +0,0 @@ -# Bandwidth.Standard.Model.CreateParticipantRequest -Create a participant request. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CallbackUrl** | **string** | Full callback url to use for notifications about this participant. | [optional] -**PublishPermissions** | [**List<PublishPermissionsEnum>**](PublishPermissionsEnum.md) | Defines if this participant can publish audio or video. | [optional] -**Tag** | **string** | User defined tag to associate with the participant. | [optional] -**DeviceApiVersion** | **DeviceApiVersionEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/CreateParticipantResponse.md b/docs/CreateParticipantResponse.md deleted file mode 100644 index cc5b1c8..0000000 --- a/docs/CreateParticipantResponse.md +++ /dev/null @@ -1,12 +0,0 @@ -# Bandwidth.Standard.Model.CreateParticipantResponse -Response generated when a Participant is created. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Participant** | [**Participant**](Participant.md) | | [optional] -**Token** | **string** | Auth token for the returned participant. This should be passed to the participant so that they can connect to the platform. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DeviceApiVersionEnum.md b/docs/DeviceApiVersionEnum.md deleted file mode 100644 index 2527c80..0000000 --- a/docs/DeviceApiVersionEnum.md +++ /dev/null @@ -1,10 +0,0 @@ -# Bandwidth.Standard.Model.DeviceApiVersionEnum -Optional field to define the device api version of this participant. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/DisconenctCallback.md b/docs/DisconenctCallback.md deleted file mode 100644 index 0fa0dfe..0000000 --- a/docs/DisconenctCallback.md +++ /dev/null @@ -1,27 +0,0 @@ -# Bandwidth.Standard.Model.DisconenctCallback -The Disconnect event is fired when a call ends, for any reason. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**EventType** | **string** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] -**EventTime** | **string** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] -**AccountId** | **string** | The user account associated with the call. | [optional] -**ApplicationId** | **string** | The id of the application associated with the call. | [optional] -**From** | **string** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] -**To** | **string** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] -**CallId** | **string** | The call id associated with the event. | [optional] -**Direction** | **CallDirectionEnum** | | [optional] -**CallUrl** | **string** | The URL of the call associated with the event. | [optional] -**EnqueuedTime** | **DateTime?** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] -**StartTime** | **DateTime** | Time the call was started, in ISO 8601 format. | [optional] -**AnswerTime** | **DateTime?** | Time the call was answered, in ISO 8601 format. | [optional] -**EndTime** | **DateTime** | The time that the recording ended in ISO-8601 format | [optional] -**Cause** | **string** | Reason the call failed - hangup, busy, timeout, cancel, rejected, callback-error, invalid-bxml, application-error, account-limit, node-capacity-exceeded, error, or unknown. | [optional] -**ErrorMessage** | **string** | Text explaining the reason that caused the call to fail in case of errors. | [optional] -**ErrorId** | **string** | Bandwidth's internal id that references the error event. | [optional] -**Tag** | **string** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ForbiddenRequest.md b/docs/ForbiddenRequest.md deleted file mode 100644 index 11905ad..0000000 --- a/docs/ForbiddenRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# Bandwidth.Standard.Model.ForbiddenRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | **string** | The message containing the reason behind the request being forbidden. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InboundMessageCallback.md b/docs/InboundMessageCallback.md deleted file mode 100644 index 8e6859a..0000000 --- a/docs/InboundMessageCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bandwidth.Standard.Model.InboundMessageCallback -Inbound Message Callback - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | **DateTime** | | -**Type** | **string** | | -**To** | **string** | | -**Description** | **string** | | -**Message** | [**InboundMessageCallbackMessage**](InboundMessageCallbackMessage.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/InboundMessageCallbackMessage.md b/docs/InboundMessageCallbackMessage.md deleted file mode 100644 index 74a0b16..0000000 --- a/docs/InboundMessageCallbackMessage.md +++ /dev/null @@ -1,22 +0,0 @@ -# Bandwidth.Standard.Model.InboundMessageCallbackMessage -Inbound Message Callback Message Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Owner** | **string** | | -**ApplicationId** | **string** | | -**Time** | **DateTime** | | -**SegmentCount** | **int** | | -**Direction** | **MessageDirectionEnum** | | -**To** | **List<string>** | | -**From** | **string** | | -**Text** | **string** | | -**Tag** | **string** | | [optional] -**Media** | **List<string>** | | [optional] -**Priority** | **PriorityEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageDeliveredCallback.md b/docs/MessageDeliveredCallback.md deleted file mode 100644 index 4d6d26c..0000000 --- a/docs/MessageDeliveredCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bandwidth.Standard.Model.MessageDeliveredCallback -Message Delivered Callback - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | **DateTime** | | -**Type** | **string** | | -**To** | **string** | | -**Description** | **string** | | -**Message** | [**MessageDeliveredCallbackMessage**](MessageDeliveredCallbackMessage.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageDeliveredCallbackMessage.md b/docs/MessageDeliveredCallbackMessage.md deleted file mode 100644 index 4a3ec0f..0000000 --- a/docs/MessageDeliveredCallbackMessage.md +++ /dev/null @@ -1,22 +0,0 @@ -# Bandwidth.Standard.Model.MessageDeliveredCallbackMessage -Message Delivered Callback Message Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Owner** | **string** | | -**ApplicationId** | **string** | | -**Time** | **DateTime** | | -**SegmentCount** | **int** | | -**Direction** | **MessageDirectionEnum** | | -**To** | **List<string>** | | -**From** | **string** | | -**Text** | **string** | | -**Tag** | **string** | | -**Media** | **List<string>** | | [optional] -**Priority** | **PriorityEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageFailedCallback.md b/docs/MessageFailedCallback.md deleted file mode 100644 index 3ab2f11..0000000 --- a/docs/MessageFailedCallback.md +++ /dev/null @@ -1,16 +0,0 @@ -# Bandwidth.Standard.Model.MessageFailedCallback -Message Failed Callback - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | **DateTime** | | -**Type** | **string** | | -**To** | **string** | | -**Description** | **string** | | -**Message** | [**MessageFailedCallbackMessage**](MessageFailedCallbackMessage.md) | | -**ErrorCode** | **int** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageFailedCallbackMessage.md b/docs/MessageFailedCallbackMessage.md deleted file mode 100644 index 91ab761..0000000 --- a/docs/MessageFailedCallbackMessage.md +++ /dev/null @@ -1,22 +0,0 @@ -# Bandwidth.Standard.Model.MessageFailedCallbackMessage -Message Failed Callback Message Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Owner** | **string** | | -**ApplicationId** | **string** | | -**Time** | **DateTime** | | -**SegmentCount** | **int** | | -**Direction** | **MessageDirectionEnum** | | -**To** | **List<string>** | | -**From** | **string** | | -**Text** | **string** | | -**Tag** | **string** | | -**Media** | **List<string>** | | [optional] -**Priority** | **PriorityEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageSendingCallback.md b/docs/MessageSendingCallback.md deleted file mode 100644 index 12a5c37..0000000 --- a/docs/MessageSendingCallback.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bandwidth.Standard.Model.MessageSendingCallback -Message Sending Callback - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Time** | **DateTime** | | -**Type** | **string** | | -**To** | **string** | | -**Description** | **string** | | -**Message** | [**MessageSendingCallbackMessage**](MessageSendingCallbackMessage.md) | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/MessageSendingCallbackMessage.md b/docs/MessageSendingCallbackMessage.md deleted file mode 100644 index 3724834..0000000 --- a/docs/MessageSendingCallbackMessage.md +++ /dev/null @@ -1,22 +0,0 @@ -# Bandwidth.Standard.Model.MessageSendingCallbackMessage -Message Sending Callback Message Schema - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | -**Owner** | **string** | | -**ApplicationId** | **string** | | -**Time** | **DateTime** | | -**SegmentCount** | **int** | | -**Direction** | **MessageDirectionEnum** | | -**To** | **List<string>** | | -**From** | **string** | | -**Text** | **string** | | -**Tag** | **string** | | [optional] -**Media** | **List<string>** | | -**Priority** | **PriorityEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Participant.md b/docs/Participant.md deleted file mode 100644 index 1c59b39..0000000 --- a/docs/Participant.md +++ /dev/null @@ -1,17 +0,0 @@ -# Bandwidth.Standard.Model.Participant -Participant object. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id of the participant. | [optional] [readonly] -**CallbackUrl** | **string** | Full callback url to use for notifications about this participant. | [optional] -**PublishPermissions** | [**List<PublishPermissionsEnum>**](PublishPermissionsEnum.md) | Defines if this participant can publish audio or video. | [optional] -**Sessions** | **List<string>** | List of session ids this participant is associated with Capped to one Upon creation of a Participant, returns as an empty array. | [optional] [readonly] -**Subscriptions** | [**Subscriptions**](Subscriptions.md) | | [optional] -**Tag** | **string** | User defined tag to associate with the participant. | [optional] -**DeviceApiVersion** | **DeviceApiVersionEnum** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ParticipantSubscription.md b/docs/ParticipantSubscription.md deleted file mode 100644 index b2aaa11..0000000 --- a/docs/ParticipantSubscription.md +++ /dev/null @@ -1,11 +0,0 @@ -# Bandwidth.Standard.Model.ParticipantSubscription - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ParticipantId** | **string** | The Participant the subscriber will be subscribed to | -**StreamAliases** | **List<string>** | (optional) An array of specific streamAliases owned by the Participant that the subscriber will be subscribed to. Background: A streamAlias is created by a WebRTC client when it connects and declares a name for the related stream. The client is responsible for informing the application of any created streamAliases to enable the application to subscribe to specific streamAliases. Subscribing to a `streamAlias` that does not exist is undefined. If the array is empty all aliases are assumed. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/ParticipantsApi.md b/docs/ParticipantsApi.md deleted file mode 100644 index 91cf555..0000000 --- a/docs/ParticipantsApi.md +++ /dev/null @@ -1,311 +0,0 @@ -# Bandwidth.Standard.Api.ParticipantsApi - -All URIs are relative to *http://localhost* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**CreateParticipant**](ParticipantsApi.md#createparticipant) | **POST** /accounts/{accountId}/participants | Create Participant | -| [**DeleteParticipant**](ParticipantsApi.md#deleteparticipant) | **DELETE** /accounts/{accountId}/participants/{participantId} | Delete Participant | -| [**GetParticipant**](ParticipantsApi.md#getparticipant) | **GET** /accounts/{accountId}/participants/{participantId} | Get Participant | - - -# **CreateParticipant** -> CreateParticipantResponse CreateParticipant (string accountId, CreateParticipantRequest createParticipantRequest = null) - -Create Participant - -Create a new participant under this account. Participants are idempotent, so relevant parameters must be set in this function if desired. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class CreateParticipantExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new ParticipantsApi(config); - var accountId = 9900000; // string | Account ID - var createParticipantRequest = new CreateParticipantRequest(); // CreateParticipantRequest | Create participant request body. (optional) - - try - { - // Create Participant - CreateParticipantResponse result = apiInstance.CreateParticipant(accountId, createParticipantRequest); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling ParticipantsApi.CreateParticipant: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the CreateParticipantWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Create Participant - ApiResponse response = apiInstance.CreateParticipantWithHttpInfo(accountId, createParticipantRequest); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling ParticipantsApi.CreateParticipantWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **createParticipantRequest** | [**CreateParticipantRequest**](CreateParticipantRequest.md) | Create participant request body. | [optional] | - -### Return type - -[**CreateParticipantResponse**](CreateParticipantResponse.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteParticipant** -> void DeleteParticipant (string accountId, string participantId) - -Delete Participant - -Delete participant by ID. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class DeleteParticipantExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new ParticipantsApi(config); - var accountId = 9900000; // string | Account ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - - try - { - // Delete Participant - apiInstance.DeleteParticipant(accountId, participantId); - } - catch (ApiException e) - { - Debug.Print("Exception when calling ParticipantsApi.DeleteParticipant: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the DeleteParticipantWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Delete Participant - apiInstance.DeleteParticipantWithHttpInfo(accountId, participantId); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling ParticipantsApi.DeleteParticipantWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **participantId** | **string** | Participant ID | | - -### Return type - -void (empty response body) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetParticipant** -> Participant GetParticipant (string accountId, string participantId) - -Get Participant - -Get participant by ID. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class GetParticipantExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new ParticipantsApi(config); - var accountId = 9900000; // string | Account ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - - try - { - // Get Participant - Participant result = apiInstance.GetParticipant(accountId, participantId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling ParticipantsApi.GetParticipant: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the GetParticipantWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Get Participant - ApiResponse response = apiInstance.GetParticipantWithHttpInfo(accountId, participantId); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling ParticipantsApi.GetParticipantWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **participantId** | **string** | Participant ID | | - -### Return type - -[**Participant**](Participant.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/PublishPermissionsEnum.md b/docs/PublishPermissionsEnum.md deleted file mode 100644 index 2c78b34..0000000 --- a/docs/PublishPermissionsEnum.md +++ /dev/null @@ -1,9 +0,0 @@ -# Bandwidth.Standard.Model.PublishPermissionsEnum - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/RequestError.md b/docs/RequestError.md deleted file mode 100644 index 5a0124a..0000000 --- a/docs/RequestError.md +++ /dev/null @@ -1,11 +0,0 @@ -# Bandwidth.Standard.Model.RequestError - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Error** | **string** | A message describing the error with your request. | [optional] -**RequestId** | **string** | The associated requestId from AWS. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/Session.md b/docs/Session.md deleted file mode 100644 index bafa46e..0000000 --- a/docs/Session.md +++ /dev/null @@ -1,12 +0,0 @@ -# Bandwidth.Standard.Model.Session -Session object. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | Unique id of the session. | [optional] -**Tag** | **string** | User defined tag to associate with the session. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/SessionsApi.md b/docs/SessionsApi.md deleted file mode 100644 index 5fda904..0000000 --- a/docs/SessionsApi.md +++ /dev/null @@ -1,829 +0,0 @@ -# Bandwidth.Standard.Api.SessionsApi - -All URIs are relative to *http://localhost* - -| Method | HTTP request | Description | -|--------|--------------|-------------| -| [**AddParticipantToSession**](SessionsApi.md#addparticipanttosession) | **PUT** /accounts/{accountId}/sessions/{sessionId}/participants/{participantId} | Add Participant to Session | -| [**CreateSession**](SessionsApi.md#createsession) | **POST** /accounts/{accountId}/sessions | Create Session | -| [**DeleteSession**](SessionsApi.md#deletesession) | **DELETE** /accounts/{accountId}/sessions/{sessionId} | Delete Session | -| [**GetParticipantSubscriptions**](SessionsApi.md#getparticipantsubscriptions) | **GET** /accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions | Get Participant Subscriptions | -| [**GetSession**](SessionsApi.md#getsession) | **GET** /accounts/{accountId}/sessions/{sessionId} | Get Session | -| [**ListSessionParticipants**](SessionsApi.md#listsessionparticipants) | **GET** /accounts/{accountId}/sessions/{sessionId}/participants | List Participants in Session | -| [**RemoveParticipantFromSession**](SessionsApi.md#removeparticipantfromsession) | **DELETE** /accounts/{accountId}/sessions/{sessionId}/participants/{participantId} | Remove Participant from Session | -| [**UpdateParticipantSubscriptions**](SessionsApi.md#updateparticipantsubscriptions) | **PUT** /accounts/{accountId}/sessions/{sessionId}/participants/{participantId}/subscriptions | Update Participant Subscriptions | - - -# **AddParticipantToSession** -> void AddParticipantToSession (string accountId, string sessionId, string participantId, Subscriptions subscriptions = null) - -Add Participant to Session - -Add a participant to a session. Subscriptions can optionally be provided as part of this call. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class AddParticipantToSessionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - var subscriptions = new Subscriptions(); // Subscriptions | The Body describes an optional set of subscriptions to apply to the participant. Calling this endpoint with no/empty body will only add the participant to the session, and will not subscribe the Participant to any media. The request body for this endpoint is OPTIONAL and provided as a convenience to avoid additional calls to the Update Participant Subscriptions endpoint. - -- If a body is provided it will result in direct control over what Participants are subscribed to. - if the participants Array is provided and not empty, that list of Participants will be subscribed To - if the participants Array is missing or empty, and the sessionId is provided, the participant will be subscribed to the session, including all subsequent changes to the membership of the session - if the sessionId and the participant Array are both missing or empty, no subscriptions will be created (optional) - - try - { - // Add Participant to Session - apiInstance.AddParticipantToSession(accountId, sessionId, participantId, subscriptions); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.AddParticipantToSession: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the AddParticipantToSessionWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Add Participant to Session - apiInstance.AddParticipantToSessionWithHttpInfo(accountId, sessionId, participantId, subscriptions); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.AddParticipantToSessionWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | -| **participantId** | **string** | Participant ID | | -| **subscriptions** | [**Subscriptions**](Subscriptions.md) | The Body describes an optional set of subscriptions to apply to the participant. Calling this endpoint with no/empty body will only add the participant to the session, and will not subscribe the Participant to any media. The request body for this endpoint is OPTIONAL and provided as a convenience to avoid additional calls to the Update Participant Subscriptions endpoint. - -- If a body is provided it will result in direct control over what Participants are subscribed to. - if the participants Array is provided and not empty, that list of Participants will be subscribed To - if the participants Array is missing or empty, and the sessionId is provided, the participant will be subscribed to the session, including all subsequent changes to the membership of the session - if the sessionId and the participant Array are both missing or empty, no subscriptions will be created | [optional] | - -### Return type - -void (empty response body) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **409** | Conflict | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **CreateSession** -> Session CreateSession (string accountId, Session session = null) - -Create Session - -Create a new session. Sessions are idempotent, so relevant parameters must be set in this function if desired. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class CreateSessionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var session = new Session(); // Session | Create session request body. (optional) - - try - { - // Create Session - Session result = apiInstance.CreateSession(accountId, session); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.CreateSession: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the CreateSessionWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Create Session - ApiResponse response = apiInstance.CreateSessionWithHttpInfo(accountId, session); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.CreateSessionWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **session** | [**Session**](Session.md) | Create session request body. | [optional] | - -### Return type - -[**Session**](Session.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **DeleteSession** -> void DeleteSession (string accountId, string sessionId) - -Delete Session - -Delete session by ID. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class DeleteSessionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - - try - { - // Delete Session - apiInstance.DeleteSession(accountId, sessionId); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.DeleteSession: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the DeleteSessionWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Delete Session - apiInstance.DeleteSessionWithHttpInfo(accountId, sessionId); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.DeleteSessionWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | - -### Return type - -void (empty response body) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetParticipantSubscriptions** -> Subscriptions GetParticipantSubscriptions (string accountId, string sessionId, string participantId) - -Get Participant Subscriptions - -Get a participant's subscriptions. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class GetParticipantSubscriptionsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - - try - { - // Get Participant Subscriptions - Subscriptions result = apiInstance.GetParticipantSubscriptions(accountId, sessionId, participantId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.GetParticipantSubscriptions: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the GetParticipantSubscriptionsWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Get Participant Subscriptions - ApiResponse response = apiInstance.GetParticipantSubscriptionsWithHttpInfo(accountId, sessionId, participantId); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.GetParticipantSubscriptionsWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | -| **participantId** | **string** | Participant ID | | - -### Return type - -[**Subscriptions**](Subscriptions.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **GetSession** -> Session GetSession (string accountId, string sessionId) - -Get Session - -Get session by ID. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class GetSessionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - - try - { - // Get Session - Session result = apiInstance.GetSession(accountId, sessionId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.GetSession: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the GetSessionWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Get Session - ApiResponse response = apiInstance.GetSessionWithHttpInfo(accountId, sessionId); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.GetSessionWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | - -### Return type - -[**Session**](Session.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **ListSessionParticipants** -> List<Participant> ListSessionParticipants (string accountId, string sessionId) - -List Participants in Session - -List participants in a session. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class ListSessionParticipantsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - - try - { - // List Participants in Session - List result = apiInstance.ListSessionParticipants(accountId, sessionId); - Debug.WriteLine(result); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.ListSessionParticipants: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the ListSessionParticipantsWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // List Participants in Session - ApiResponse> response = apiInstance.ListSessionParticipantsWithHttpInfo(accountId, sessionId); - Debug.Write("Status Code: " + response.StatusCode); - Debug.Write("Response Headers: " + response.Headers); - Debug.Write("Response Body: " + response.Data); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.ListSessionParticipantsWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | - -### Return type - -[**List<Participant>**](Participant.md) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **200** | OK | - | -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **RemoveParticipantFromSession** -> void RemoveParticipantFromSession (string accountId, string sessionId, string participantId) - -Remove Participant from Session - -Remove a participant from a session. This will automatically remove any subscriptions the participant has associated with this session. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class RemoveParticipantFromSessionExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - - try - { - // Remove Participant from Session - apiInstance.RemoveParticipantFromSession(accountId, sessionId, participantId); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.RemoveParticipantFromSession: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the RemoveParticipantFromSessionWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Remove Participant from Session - apiInstance.RemoveParticipantFromSessionWithHttpInfo(accountId, sessionId, participantId); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.RemoveParticipantFromSessionWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | -| **participantId** | **string** | Participant ID | | - -### Return type - -void (empty response body) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: Not defined - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - - -# **UpdateParticipantSubscriptions** -> void UpdateParticipantSubscriptions (string accountId, string sessionId, string participantId, Subscriptions subscriptions = null) - -Update Participant Subscriptions - -Update a participant's subscriptions. This is a full update that will replace the participant's subscriptions. It allows subscription to the entire Session, a subset list of Participants in that Session, or specific media streams on any of the listed Participants. First call `getParticipantSubscriptions` if you need the current subscriptions. Calling this API with no `Subscriptions` object to remove all subscriptions. - -### Example -```csharp -using System.Collections.Generic; -using System.Diagnostics; -using Bandwidth.Standard.Api; -using Bandwidth.Standard.Client; -using Bandwidth.Standard.Model; - -namespace Example -{ - public class UpdateParticipantSubscriptionsExample - { - public static void Main() - { - Configuration config = new Configuration(); - config.BasePath = "http://localhost"; - // Configure HTTP basic authorization: Basic - config.Username = "YOUR_USERNAME"; - config.Password = "YOUR_PASSWORD"; - - var apiInstance = new SessionsApi(config); - var accountId = 9900000; // string | Account ID - var sessionId = cb5054ee-a69b-41ac-9ab2-04d6370826b4; // string | Session ID - var participantId = 62e0ecb9-0b1b-5115-aae4-4f36123d6bb1; // string | Participant ID - var subscriptions = new Subscriptions(); // Subscriptions | The body describes the desired subscriptions for the Participant. - -- If a body is provided it will result in direct control over what Participants are subscribed to. - if the participants Array is provided and not empty, that list of Participants will be subscribed To - if the participants Array is missing or empty, and the sessionId is provided, the participant will be subscribed to the session, including all subsequent changes to the membership of the session - if the sessionId and the participant Array are both missing or empty, no subscriptions will be created (optional) - - try - { - // Update Participant Subscriptions - apiInstance.UpdateParticipantSubscriptions(accountId, sessionId, participantId, subscriptions); - } - catch (ApiException e) - { - Debug.Print("Exception when calling SessionsApi.UpdateParticipantSubscriptions: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); - } - } - } -} -``` - -#### Using the UpdateParticipantSubscriptionsWithHttpInfo variant -This returns an ApiResponse object which contains the response data, status code and headers. - -```csharp -try -{ - // Update Participant Subscriptions - apiInstance.UpdateParticipantSubscriptionsWithHttpInfo(accountId, sessionId, participantId, subscriptions); -} -catch (ApiException e) -{ - Debug.Print("Exception when calling SessionsApi.UpdateParticipantSubscriptionsWithHttpInfo: " + e.Message); - Debug.Print("Status Code: " + e.ErrorCode); - Debug.Print(e.StackTrace); -} -``` - -### Parameters - -| Name | Type | Description | Notes | -|------|------|-------------|-------| -| **accountId** | **string** | Account ID | | -| **sessionId** | **string** | Session ID | | -| **participantId** | **string** | Participant ID | | -| **subscriptions** | [**Subscriptions**](Subscriptions.md) | The body describes the desired subscriptions for the Participant. - -- If a body is provided it will result in direct control over what Participants are subscribed to. - if the participants Array is provided and not empty, that list of Participants will be subscribed To - if the participants Array is missing or empty, and the sessionId is provided, the participant will be subscribed to the session, including all subsequent changes to the membership of the session - if the sessionId and the participant Array are both missing or empty, no subscriptions will be created | [optional] | - -### Return type - -void (empty response body) - -### Authorization - -[Basic](../README.md#Basic) - -### HTTP request headers - - - **Content-Type**: application/json - - **Accept**: application/json - - -### HTTP response details -| Status code | Description | Response headers | -|-------------|-------------|------------------| -| **204** | No Content | - | -| **400** | Bad Request | - | -| **401** | Unauthorized | - | -| **403** | Forbidden | - | -| **404** | Not Found | - | -| **500** | Internal Server Error | - | - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) - diff --git a/docs/Subscriptions.md b/docs/Subscriptions.md deleted file mode 100644 index 6a2dcbf..0000000 --- a/docs/Subscriptions.md +++ /dev/null @@ -1,11 +0,0 @@ -# Bandwidth.Standard.Model.Subscriptions - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**SessionId** | **string** | If present, and not overridden by the array of participants, it represents the session the subscriptions are associated with. If this is the only field, the subscriber will be subscribed to all participants in the session (including any participants that are later added to the session). Upon creation of a Participant, returns as an empty object. | [optional] -**Participants** | [**List<ParticipantSubscription>**](ParticipantSubscription.md) | (optional) A list of participants in the session that will be subscribed to. If present and not empty or null, this will override any sessionId specified in the body. Returns empty if used during the creation of a Participant. | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - diff --git a/docs/UnauthorizedRequest.md b/docs/UnauthorizedRequest.md deleted file mode 100644 index ebfc843..0000000 --- a/docs/UnauthorizedRequest.md +++ /dev/null @@ -1,10 +0,0 @@ -# Bandwidth.Standard.Model.UnauthorizedRequest - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Message** | **string** | Unauthorized | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) -