bandwidth-sdk 18.0.0 → 18.1.0

data/docs/BrtcError.md

@@ -0,0 +1,26 @@
+# Bandwidth::BrtcError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier for the error. | [optional] |
+| **type** | **String** | The type of error. |  |
+| **description** | **String** | A description of the error. |  |
+| **code** | **String** | A code that uniquely identifies the error. | [optional] |
+| **source** | [**BrtcErrorSource**](BrtcErrorSource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BrtcError.new(
+  id: 59512d87-7a92-4040-8e4a-78fb772019b9,
+  type: resource.not_found,
+  description: The requested resource was not found.,
+  code: 404,
+  source: null
+)
+```
+

data/docs/BrtcErrorResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::BrtcErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<BrtcLink>**](BrtcLink.md) |  |  |
+| **data** | **Object** |  |  |
+| **errors** | [**Array<BrtcError>**](BrtcError.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BrtcErrorResponse.new(
+  links: null,
+  data: null,
+  errors: null
+)
+```
+

data/docs/BrtcErrorSource.md

@@ -0,0 +1,24 @@
+# Bandwidth::BrtcErrorSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **parameter** | **String** | The URI parameter that caused the error. | [optional] |
+| **field** | **String** | The request body field that caused the error. | [optional] |
+| **header** | **String** | The header that caused the error. | [optional] |
+| **reference** | **String** | The resource ID or path to the resource (or non-existent resource) causing the error. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BrtcErrorSource.new(
+  parameter: accountId,
+  field: accountId,
+  header: Authorization,
+  reference: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85
+)
+```
+

data/docs/BrtcLink.md

@@ -0,0 +1,22 @@
+# Bandwidth::BrtcLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **href** | **String** | The full URL of the link. | [optional] |
+| **rel** | **String** | The relationship of the link to the current resource. | [optional] |
+| **method** | **String** | The HTTP method to use when making the request. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::BrtcLink.new(
+  href: https://api.bandwidth.com/v2/accounts/5500123/endpoints/e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  rel: self,
+  method: GET
+)
+```
+

data/docs/CreateCall.md

@@ -7,7 +7,7 @@
 | **to** | **String** | The destination to call (must be an E.164 formatted number (e.g. `+15555551212`) or a SIP URI (e.g. `sip:user@server.example`)). |  |
 | **from** | **String** | A Bandwidth phone number on your account the call should come from (must be in E.164 format, like `+15555551212`) even if `privacy` is set to true. |  |
 | **privacy** | **Boolean** | Hide the calling number. The `displayName` field can be used to customize the displayed name. | [optional] |
-| **display_name** | **String** | The caller display name to use when the call is created.  May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] |
+| **display_name** | **String** | The caller display name to use when the call is created. May not exceed 256 characters nor contain control characters such as new lines. If `privacy` is true, only the following values are valid: `Restricted`, `Anonymous`, `Private`, or `Unavailable`. | [optional] |
 | **uui** | **String** | A comma-separated list of 'User-To-User' headers to be sent in the INVITE when calling a SIP URI. Each value must end with an 'encoding' parameter as described in <a href='https://tools.ietf.org/html/rfc7433'>RFC 7433</a>. Only 'jwt', 'base64' and 'hex' encodings are allowed. The entire value cannot exceed 350 characters, including parameters and separators. | [optional] |
 | **application_id** | **String** | The id of the application associated with the `from` number. |  |
 | **answer_url** | **String** | The full URL to send the <a href='/docs/voice/webhooks/answer'>Answer</a> event to when the called party answers. This endpoint should return the first <a href='/docs/voice/bxml'>BXML document</a> to be executed in the call.  Must use `https` if specifying `username` and `password`. |  |
@@ -24,7 +24,7 @@
 | **callback_timeout** | **Float** | This is the timeout (in seconds) to use when delivering webhooks for the call. Can be any numeric value (including decimals) between 1 and 25. | [optional][default to 15] |
 | **machine_detection** | [**MachineDetectionConfiguration**](MachineDetectionConfiguration.md) |  | [optional] |
 | **priority** | **Integer** | The priority of this call over other calls from your account. For example, if during a call your application needs to place a new call and bridge it with the current call, you might want to create the call with priority 1 so that it will be the next call picked off your queue, ahead of other less time sensitive calls. A lower value means higher priority, so a priority 1 call takes precedence over a priority 2 call. | [optional][default to 5] |
-| **tag** | **String** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href='/docs/voice/bxml/tag'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared.  May be cleared by setting `tag=\"\"`  Max length 256 characters. | [optional] |
+| **tag** | **String** | A custom string that will be sent with all webhooks for this call unless overwritten by a future <a href='/docs/voice/bxml/tag'>`<Tag>`</a> verb or `tag` attribute on another verb, or cleared.  May be cleared by setting `tag=\"\"`  Max length 4096 characters. | [optional] |
 
 ## Example
 

data/docs/CreateEndpointRequestBase.md

@@ -0,0 +1,26 @@
+# Bandwidth::CreateEndpointRequestBase
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **direction** | [**EndpointDirectionEnum**](EndpointDirectionEnum.md) |  |  |
+| **event_callback_url** | **String** | The URL to send event callbacks to. | [optional] |
+| **event_fallback_url** | **String** | The URL to send event fallbacks to. | [optional] |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateEndpointRequestBase.new(
+  type: null,
+  direction: null,
+  event_callback_url: https://myapp.com/callback,
+  event_fallback_url: https://fallback.myapp.com/callback,
+  tag: my-tag
+)
+```
+

data/docs/CreateEndpointResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::CreateEndpointResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<BrtcLink>**](BrtcLink.md) |  |  |
+| **data** | [**CreateEndpointResponseData**](CreateEndpointResponseData.md) |  |  |
+| **errors** | [**Array<BrtcError>**](BrtcError.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateEndpointResponse.new(
+  links: null,
+  data: null,
+  errors: null
+)
+```
+

data/docs/CreateEndpointResponseData.md

@@ -0,0 +1,32 @@
+# Bandwidth::CreateEndpointResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** | The unique ID of the endpoint. |  |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) |  |  |
+| **creation_timestamp** | **Time** | The time the endpoint was created. In ISO-8601 format. |  |
+| **expiration_timestamp** | **Time** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |  |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+| **devices** | [**Array<Device>**](Device.md) |  | [optional] |
+| **token** | **String** | The json web token specific to the endpoint. Used to authenticate the client with the media gateway. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateEndpointResponseData.new(
+  endpoint_id: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  type: null,
+  status: null,
+  creation_timestamp: 2021-01-01T00:00Z,
+  expiration_timestamp: 2021-01-02T00:00Z,
+  tag: my-tag,
+  devices: null,
+  token: xxxxx.yyyyy.zzzzz
+)
+```
+

data/docs/CreateWebRtcConnectionRequest.md

@@ -0,0 +1,28 @@
+# Bandwidth::CreateWebRtcConnectionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **direction** | [**EndpointDirectionEnum**](EndpointDirectionEnum.md) |  |  |
+| **event_callback_url** | **String** | The URL to send event callbacks to. | [optional] |
+| **event_fallback_url** | **String** | The URL to send event fallbacks to. | [optional] |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+| **connection_metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::CreateWebRtcConnectionRequest.new(
+  type: null,
+  direction: null,
+  event_callback_url: https://myapp.com/callback,
+  event_fallback_url: https://fallback.myapp.com/callback,
+  tag: my-tag,
+  connection_metadata: null
+)
+```
+

data/docs/Device.md

@@ -0,0 +1,24 @@
+# Bandwidth::Device
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **device_id** | **String** | The unique ID of the device. |  |
+| **device_name** | **String** | The name of the device. | [optional] |
+| **status** | [**DeviceStatusEnum**](DeviceStatusEnum.md) |  |  |
+| **creation_timestamp** | **Time** | The time the device was created. In ISO-8601 format. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Device.new(
+  device_id: d-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  device_name: David's iPhone,
+  status: null,
+  creation_timestamp: 2021-01-01T00:00Z
+)
+```
+

data/docs/DeviceStatusEnum.md

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

data/docs/Endpoint.md

@@ -0,0 +1,30 @@
+# Bandwidth::Endpoint
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** | The unique ID of the endpoint. |  |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) |  |  |
+| **creation_timestamp** | **Time** | The time the endpoint was created. In ISO-8601 format. |  |
+| **expiration_timestamp** | **Time** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |  |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+| **devices** | [**Array<Device>**](Device.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Endpoint.new(
+  endpoint_id: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  type: null,
+  status: null,
+  creation_timestamp: 2021-01-01T00:00Z,
+  expiration_timestamp: 2021-01-02T00:00Z,
+  tag: my-tag,
+  devices: null
+)
+```
+

data/docs/EndpointDirectionEnum.md

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

data/docs/EndpointEvent.md

@@ -0,0 +1,34 @@
+# Bandwidth::EndpointEvent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** | The unique ID of the endpoint. |  |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) |  |  |
+| **creation_timestamp** | **Time** | The time the endpoint was created. In ISO-8601 format. |  |
+| **expiration_timestamp** | **Time** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |  |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+| **event_time** | **Time** | The time the event occurred. In ISO-8601 format. |  |
+| **event_type** | [**EndpointEventTypeEnum**](EndpointEventTypeEnum.md) |  |  |
+| **device** | [**Device**](Device.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::EndpointEvent.new(
+  endpoint_id: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  type: null,
+  status: null,
+  creation_timestamp: 2021-01-01T00:00Z,
+  expiration_timestamp: 2021-01-02T00:00Z,
+  tag: my-tag,
+  event_time: 2021-01-01T00:00Z,
+  event_type: null,
+  device: null
+)
+```
+

data/docs/EndpointEventTypeEnum.md

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

data/docs/EndpointResponse.md

@@ -0,0 +1,22 @@
+# Bandwidth::EndpointResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **links** | [**Array<BrtcLink>**](BrtcLink.md) |  |  |
+| **data** | [**Endpoint**](Endpoint.md) |  |  |
+| **errors** | [**Array<BrtcError>**](BrtcError.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::EndpointResponse.new(
+  links: null,
+  data: null,
+  errors: null
+)
+```
+

data/docs/EndpointStatusEnum.md

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

data/docs/EndpointTypeEnum.md

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

data/docs/Endpoints.md

@@ -0,0 +1,28 @@
+# Bandwidth::Endpoints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint_id** | **String** | The unique ID of the endpoint. |  |
+| **type** | [**EndpointTypeEnum**](EndpointTypeEnum.md) |  |  |
+| **status** | [**EndpointStatusEnum**](EndpointStatusEnum.md) |  |  |
+| **creation_timestamp** | **Time** | The time the endpoint was created. In ISO-8601 format. |  |
+| **expiration_timestamp** | **Time** | The time the endpoint token will expire. In ISO-8601 format. Tokens last 24 hours. |  |
+| **tag** | **String** | A tag for the endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Endpoints.new(
+  endpoint_id: e-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
+  type: null,
+  status: null,
+  creation_timestamp: 2021-01-01T00:00Z,
+  expiration_timestamp: 2021-01-02T00:00Z,
+  tag: my-tag
+)
+```
+