bandwidth-sdk 10.3.0 → 11.0.0.pre.beta.1

data/docs/PhoneNumberLookupApi.md

@@ -0,0 +1,153 @@
+# Bandwidth::PhoneNumberLookupApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_lookup**](PhoneNumberLookupApi.md#create_lookup) | **POST** /accounts/{accountId}/tnlookup | Create Lookup |
+| [**get_lookup_status**](PhoneNumberLookupApi.md#get_lookup_status) | **GET** /accounts/{accountId}/tnlookup/{requestId} | Get Lookup Request Status |
+
+
+## create_lookup
+
+> <CreateLookupResponse> create_lookup(account_id, lookup_request)
+
+Create Lookup
+
+Create a Phone Number Lookup Request.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::PhoneNumberLookupApi.new
+account_id = '9900000' # String | The ID of the Bandwidth account that the user belongs to.
+lookup_request = Bandwidth::LookupRequest.new({tns: ['tns_example']}) # LookupRequest | Phone number lookup request.
+
+begin
+  # Create Lookup
+  result = api_instance.create_lookup(account_id, lookup_request)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->create_lookup: #{e}"
+end
+```
+
+#### Using the create_lookup_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateLookupResponse>, Integer, Hash)> create_lookup_with_http_info(account_id, lookup_request)
+
+```ruby
+begin
+  # Create Lookup
+  data, status_code, headers = api_instance.create_lookup_with_http_info(account_id, lookup_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateLookupResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->create_lookup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The ID of the Bandwidth account that the user belongs to. |  |
+| **lookup_request** | [**LookupRequest**](LookupRequest.md) | Phone number lookup request. |  |
+
+### Return type
+
+[**CreateLookupResponse**](CreateLookupResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_lookup_status
+
+> <LookupStatus> get_lookup_status(account_id, request_id)
+
+Get Lookup Request Status
+
+Get an existing Phone Number Lookup Request.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bandwidth-sdk'
+# setup authorization
+Bandwidth.configure do |config|
+  # Configure HTTP basic authorization: Basic
+  config.username = 'YOUR USERNAME'
+  config.password = 'YOUR PASSWORD'
+end
+
+api_instance = Bandwidth::PhoneNumberLookupApi.new
+account_id = '9900000' # String | The ID of the Bandwidth account that the user belongs to.
+request_id = '004223a0-8b17-41b1-bf81-20732adf5590' # String | The phone number lookup request ID from Bandwidth.
+
+begin
+  # Get Lookup Request Status
+  result = api_instance.get_lookup_status(account_id, request_id)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->get_lookup_status: #{e}"
+end
+```
+
+#### Using the get_lookup_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LookupStatus>, Integer, Hash)> get_lookup_status_with_http_info(account_id, request_id)
+
+```ruby
+begin
+  # Get Lookup Request Status
+  data, status_code, headers = api_instance.get_lookup_status_with_http_info(account_id, request_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LookupStatus>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling PhoneNumberLookupApi->get_lookup_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | The ID of the Bandwidth account that the user belongs to. |  |
+| **request_id** | **String** | The phone number lookup request ID from Bandwidth. |  |
+
+### Return type
+
+[**LookupStatus**](LookupStatus.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PriorityEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::PriorityEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::PriorityEnum.new()
+```
+

data/docs/PublishPermissionsEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::PublishPermissionsEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::PublishPermissionsEnum.new()
+```
+

data/docs/RecordingAvailableCallback.md

@@ -0,0 +1,60 @@
+# Bandwidth::RecordingAvailableCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **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] |
+| **event_time** | **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] |
+| **account_id** | **String** | The user account associated with the call. | [optional] |
+| **application_id** | **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] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **call_id** | **String** | The call id associated with the event. | [optional] |
+| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
+| **parent_call_id** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] |
+| **recording_id** | **String** | The unique ID of this recording | [optional] |
+| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
+| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
+| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
+| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [optional] |
+| **channels** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [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] |
+| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
+| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
+| **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RecordingAvailableCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  account_id: 920012,
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  from: +15555555555,
+  to: +15555555555,
+  direction: null,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  end_time: 2022-06-17T22:20Z,
+  duration: PT13.67S,
+  file_format: null,
+  channels: completed,
+  tag: exampleTag,
+  status: completed,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555)
+)
+```
+

data/docs/RecordingCompleteCallback.md

@@ -0,0 +1,60 @@
+# Bandwidth::RecordingCompleteCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_type** | **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] |
+| **event_time** | **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] |
+| **account_id** | **String** | The user account associated with the call. | [optional] |
+| **application_id** | **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] |
+| **direction** | [**CallDirectionEnum**](CallDirectionEnum.md) |  | [optional] |
+| **call_id** | **String** | The call id associated with the event. | [optional] |
+| **call_url** | **String** | The URL of the call associated with the event. | [optional] |
+| **parent_call_id** | **String** | (optional) If the event is related to the B leg of a <Transfer>, the call id of the original call leg that executed the <Transfer>. Otherwise, this field will not be present. | [optional] |
+| **recording_id** | **String** | The unique ID of this recording | [optional] |
+| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
+| **enqueued_time** | **Time** | (optional) If call queueing is enabled and this is an outbound call, time the call was queued, in ISO 8601 format. | [optional] |
+| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
+| **answer_time** | **Time** | Time the call was answered, in ISO 8601 format. | [optional] |
+| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
+| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
+| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) |  | [optional] |
+| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [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] |
+| **transfer_caller_id** | **String** | The phone number used as the from field of the B-leg call, in E.164 format (e.g. +15555555555) or one of Restricted, Anonymous, Private, or Unavailable. | [optional] |
+| **transfer_to** | **String** | The phone number used as the to field of the B-leg call, in E.164 format (e.g. +15555555555). | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RecordingCompleteCallback.new(
+  event_type: bridgeComplete,
+  event_time: null,
+  account_id: 920012,
+  application_id: 04e88489-df02-4e34-a0ee-27a91849555f,
+  from: +15555555555,
+  to: +15555555555,
+  direction: null,
+  call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  call_url: https://voice.bandwidth.com/api/v2/accounts/9900000/calls/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  parent_call_id: c-95ac8d6e-1a31c52e-b38f-4198-93c1-51633ec68f8d,
+  recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
+  media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  answer_time: 2022-06-17T22:20Z,
+  end_time: 2022-06-17T22:20Z,
+  duration: PT13.67S,
+  file_format: null,
+  channels: 1,
+  tag: exampleTag,
+  transfer_caller_id: +15555555555,
+  transfer_to: +15555555555)
+)
+```
+

data/docs/RecordingStateEnum.md

@@ -0,0 +1,15 @@
+# Bandwidth::RecordingStateEnum
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RecordingStateEnum.new()
+```
+