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

data/docs/ListMessageDirectionEnum.md

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

data/docs/ListMessageItem.md

@@ -0,0 +1,48 @@
+# Bandwidth::ListMessageItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message_id** | **String** | The message id | [optional] |
+| **account_id** | **String** | The account id associated with this message. | [optional] |
+| **source_tn** | **String** | The source phone number of the message. | [optional] |
+| **destination_tn** | **String** | The recipient phone number of the message. | [optional] |
+| **message_status** | [**MessageStatusEnum**](MessageStatusEnum.md) |  | [optional] |
+| **message_direction** | [**ListMessageDirectionEnum**](ListMessageDirectionEnum.md) |  | [optional] |
+| **message_type** | [**MessageTypeEnum**](MessageTypeEnum.md) |  | [optional] |
+| **segment_count** | **Integer** | The number of segments the message was sent as. | [optional] |
+| **error_code** | **Integer** | The numeric error code of the message. | [optional] |
+| **receive_time** | **String** | The ISO 8601 datetime of the message. | [optional] |
+| **carrier_name** | **String** | The name of the carrier. Not currently supported for MMS coming soon. | [optional] |
+| **message_size** | **Integer** | The size of the message including message content and headers. | [optional] |
+| **message_length** | **Integer** | The length of the message content. | [optional] |
+| **attachment_count** | **Integer** | The number of attachments the message has. | [optional] |
+| **recipient_count** | **Integer** | The number of recipients the message has. | [optional] |
+| **campaign_class** | **String** | The campaign class of the message if it has one. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::ListMessageItem.new(
+  message_id: 1589228074636lm4k2je7j7jklbn2,
+  account_id: 9900000,
+  source_tn: +15554443333,
+  destination_tn: +15554442222,
+  message_status: null,
+  message_direction: null,
+  message_type: null,
+  segment_count: 1,
+  error_code: 9902,
+  receive_time: 2020-04-07T14:03:07.000Z,
+  carrier_name: other,
+  message_size: 27,
+  message_length: 18,
+  attachment_count: 1,
+  recipient_count: 1,
+  campaign_class: T
+)
+```
+

data/docs/LookupRequest.md

@@ -0,0 +1,18 @@
+# Bandwidth::LookupRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tns** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupRequest.new(
+  tns: null
+)
+```
+

data/docs/LookupResult.md

@@ -0,0 +1,34 @@
+# Bandwidth::LookupResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **response_code** | **Integer** | Our vendor's response code. | [optional] |
+| **message** | **String** | Message associated with the response code. | [optional] |
+| **e_164_format** | **String** | The telephone number in E.164 format. | [optional] |
+| **formatted** | **String** | The formatted version of the telephone number. | [optional] |
+| **country** | **String** | The country of the telephone number. | [optional] |
+| **line_type** | **String** | The line type of the telephone number. | [optional] |
+| **line_provider** | **String** | The messaging service provider of the telephone number. | [optional] |
+| **mobile_country_code** | **String** | The first half of the Home Network Identity (HNI). | [optional] |
+| **mobile_network_code** | **String** | The second half of the HNI. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupResult.new(
+  response_code: 0,
+  message: NOERROR,
+  e_164_format: +19195551234,
+  formatted: (919) 555-1234,
+  country: US,
+  line_type: Mobile,
+  line_provider: Verizon Wireless,
+  mobile_country_code: 310,
+  mobile_network_code: 010
+)
+```
+

data/docs/LookupStatus.md

@@ -0,0 +1,24 @@
+# Bandwidth::LookupStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** | The requestId. | [optional] |
+| **status** | [**LookupStatusEnum**](LookupStatusEnum.md) |  | [optional] |
+| **result** | [**Array<LookupResult>**](LookupResult.md) | The carrier information results for the specified telephone number. | [optional] |
+| **failed_telephone_numbers** | **Array<String>** | The telephone numbers whose lookup failed. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LookupStatus.new(
+  request_id: 004223a0-8b17-41b1-bf81-20732adf5590,
+  status: null,
+  result: null,
+  failed_telephone_numbers: ["+191955512345"]
+)
+```
+

data/docs/LookupStatusEnum.md

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

data/docs/MFAApi.md

@@ -0,0 +1,226 @@
+# Bandwidth::MFAApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**generate_messaging_code**](MFAApi.md#generate_messaging_code) | **POST** /accounts/{accountId}/code/messaging | Messaging Authentication Code |
+| [**generate_voice_code**](MFAApi.md#generate_voice_code) | **POST** /accounts/{accountId}/code/voice | Voice Authentication Code |
+| [**verify_code**](MFAApi.md#verify_code) | **POST** /accounts/{accountId}/code/verify | Verify Authentication Code |
+
+
+## generate_messaging_code
+
+> <MessagingCodeResponse> generate_messaging_code(account_id, code_request)
+
+Messaging Authentication Code
+
+Send an MFA code via text message (SMS).
+
+### 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::MFAApi.new
+account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
+code_request = Bandwidth::CodeRequest.new({to: '+19195551234', from: '+19195554321', application_id: '66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1', message: 'Your temporary {NAME} {SCOPE} code is {CODE}', digits: 6}) # CodeRequest | MFA code request body.
+
+begin
+  # Messaging Authentication Code
+  result = api_instance.generate_messaging_code(account_id, code_request)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->generate_messaging_code: #{e}"
+end
+```
+
+#### Using the generate_messaging_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MessagingCodeResponse>, Integer, Hash)> generate_messaging_code_with_http_info(account_id, code_request)
+
+```ruby
+begin
+  # Messaging Authentication Code
+  data, status_code, headers = api_instance.generate_messaging_code_with_http_info(account_id, code_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MessagingCodeResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->generate_messaging_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Bandwidth Account ID with Voice service enabled. |  |
+| **code_request** | [**CodeRequest**](CodeRequest.md) | MFA code request body. |  |
+
+### Return type
+
+[**MessagingCodeResponse**](MessagingCodeResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## generate_voice_code
+
+> <VoiceCodeResponse> generate_voice_code(account_id, code_request)
+
+Voice Authentication Code
+
+Send an MFA Code via a phone call.
+
+### 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::MFAApi.new
+account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
+code_request = Bandwidth::CodeRequest.new({to: '+19195551234', from: '+19195554321', application_id: '66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1', message: 'Your temporary {NAME} {SCOPE} code is {CODE}', digits: 6}) # CodeRequest | MFA code request body.
+
+begin
+  # Voice Authentication Code
+  result = api_instance.generate_voice_code(account_id, code_request)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->generate_voice_code: #{e}"
+end
+```
+
+#### Using the generate_voice_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VoiceCodeResponse>, Integer, Hash)> generate_voice_code_with_http_info(account_id, code_request)
+
+```ruby
+begin
+  # Voice Authentication Code
+  data, status_code, headers = api_instance.generate_voice_code_with_http_info(account_id, code_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VoiceCodeResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->generate_voice_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Bandwidth Account ID with Voice service enabled. |  |
+| **code_request** | [**CodeRequest**](CodeRequest.md) | MFA code request body. |  |
+
+### Return type
+
+[**VoiceCodeResponse**](VoiceCodeResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_code
+
+> <VerifyCodeResponse> verify_code(account_id, verify_code_request)
+
+Verify Authentication Code
+
+Verify a previously sent MFA code.
+
+### 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::MFAApi.new
+account_id = 'account_id_example' # String | Bandwidth Account ID with Voice service enabled.
+verify_code_request = Bandwidth::VerifyCodeRequest.new({to: '+19195551234', expiration_time_in_minutes: 3, code: '123456'}) # VerifyCodeRequest | MFA code verify request body.
+
+begin
+  # Verify Authentication Code
+  result = api_instance.verify_code(account_id, verify_code_request)
+  p result
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->verify_code: #{e}"
+end
+```
+
+#### Using the verify_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerifyCodeResponse>, Integer, Hash)> verify_code_with_http_info(account_id, verify_code_request)
+
+```ruby
+begin
+  # Verify Authentication Code
+  data, status_code, headers = api_instance.verify_code_with_http_info(account_id, verify_code_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerifyCodeResponse>
+rescue Bandwidth::ApiError => e
+  puts "Error when calling MFAApi->verify_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Bandwidth Account ID with Voice service enabled. |  |
+| **verify_code_request** | [**VerifyCodeRequest**](VerifyCodeRequest.md) | MFA code verify request body. |  |
+
+### Return type
+
+[**VerifyCodeResponse**](VerifyCodeResponse.md)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MachineDetectionCompleteCallback.md

@@ -0,0 +1,44 @@
+# Bandwidth::MachineDetectionCompleteCallback
+
+## 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] |
+| **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] |
+| **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] |
+| **machine_detection_result** | **String** | (optional) if machine detection was requested in sync mode, the result will be specified here. Possible values are the same as the async counterpart: Machine Detection Complete | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MachineDetectionCompleteCallback.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,
+  enqueued_time: 2022-06-17T22:20Z,
+  start_time: 2022-06-17T22:19:40.375Z,
+  answer_time: 2022-06-17T22:20Z,
+  tag: exampleTag,
+  machine_detection_result: null
+)
+```
+

data/docs/MachineDetectionConfiguration.md

@@ -0,0 +1,46 @@
+# Bandwidth::MachineDetectionConfiguration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | [**MachineDetectionModeEnum**](MachineDetectionModeEnum.md) |  | [optional][default to 'async'] |
+| **detection_timeout** | **Float** | The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent. | [optional][default to 15] |
+| **silence_timeout** | **Float** | If no speech is detected in this period, a callback with a 'silence' result is sent. | [optional][default to 10] |
+| **speech_threshold** | **Float** | When speech has ended and a result couldn't be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be 'answering-machine'. If the length of speech detected is below this threshold, the result will be 'human'. | [optional][default to 10] |
+| **speech_end_threshold** | **Float** | Amount of silence (in seconds) before assuming the callee has finished speaking. | [optional][default to 5] |
+| **machine_speech_end_threshold** | **Float** | When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing.  If not provided it will default to the speechEndThreshold value. | [optional] |
+| **delay_result** | **Boolean** | If set to 'true' and if an answering machine is detected, the 'answering-machine' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the 'detectionTimeout' is exceeded. If false, the 'answering-machine' result is sent immediately. | [optional][default to false] |
+| **callback_url** | **String** | The URL to send the 'machineDetectionComplete' webhook when the detection is completed. Only for 'async' mode. | [optional] |
+| **callback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **username** | **String** | Basic auth username. | [optional] |
+| **password** | **String** | Basic auth password. | [optional] |
+| **fallback_url** | **String** | A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond | [optional] |
+| **fallback_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) |  | [optional][default to 'POST'] |
+| **fallback_username** | **String** | Basic auth username. | [optional] |
+| **fallback_password** | **String** | Basic auth password. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MachineDetectionConfiguration.new(
+  mode: null,
+  detection_timeout: 15,
+  silence_timeout: 10,
+  speech_threshold: 10,
+  speech_end_threshold: 5,
+  machine_speech_end_threshold: 5,
+  delay_result: false,
+  callback_url: https://myServer.com/bandwidth/webhooks/machineDetectionComplete,
+  callback_method: null,
+  username: mySecretUsername,
+  password: mySecretPassword1!,
+  fallback_url: https://myFallbackServer.com/bandwidth/webhooks/machineDetectionComplete,
+  fallback_method: null,
+  fallback_username: mySecretUsername,
+  fallback_password: mySecretPassword1!
+)
+```
+

data/docs/MachineDetectionModeEnum.md

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

data/docs/Media.md

@@ -0,0 +1,22 @@
+# Bandwidth::Media
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **String** |  | [optional] |
+| **content_length** | **Integer** |  | [optional] |
+| **media_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Media.new(
+  content: null,
+  content_length: null,
+  media_name: null
+)
+```
+