bandwidth-sdk 13.1.4 → 14.1.0

data/custom_templates/README.mustache

@@ -5,12 +5,12 @@
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
 
 
-| **OS** | **Ruby** |
-|:---:|:---:|
-| Windows 2019 | 2.7, 3.0, 3.1, 3.2, 3.3 |
-| Windows 2022 | 2.7, 3.0, 3.1, 3.2, 3.3 |
-| Ubuntu 20.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
-| Ubuntu 22.04 | 2.7, 3.0, 3.1, 3.2, 3.3 |
+|    **OS**    |      **Ruby**      |
+|:------------:|:------------------:|
+| Windows 2019 | 3.0, 3.1, 3.2, 3.3 |
+| Windows 2022 | 3.0, 3.1, 3.2, 3.3 |
+| Ubuntu 22.04 | 3.0, 3.1, 3.2, 3.3 |
+| Ubuntu 24.04 | 3.0, 3.1, 3.2, 3.3 |
 
 {{moduleName}} - the Ruby gem for the {{appName}} SDK
 

data/custom_templates/gemspec.mustache

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   {{^isFaraday}}
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
   {{/isFaraday}}
-  s.add_runtime_dependency 'ox', '~> 2.4'
+  s.add_runtime_dependency 'ox', '~> 2.14'
   s.add_runtime_dependency 'marcel'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'

data/docs/AdditionalDenialReason.md

@@ -0,0 +1,22 @@
+# Bandwidth::AdditionalDenialReason
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status_code** | **Integer** | Reason code for denial. |  |
+| **reason** | **String** | Explanation for why a verification request was declined. |  |
+| **resubmit_allowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::AdditionalDenialReason.new(
+  status_code: 511,
+  reason: Invalid Information - Can't Validate URL - Website is not accessible / not available,
+  resubmit_allowed: true
+)
+```
+

data/docs/Address.md

@@ -0,0 +1,30 @@
+# Bandwidth::Address
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the business using the toll-free number. |  |
+| **addr1** | **String** | The address of the business using the toll-free number. |  |
+| **addr2** | **String** | The address of the business using the toll-free number. | [optional] |
+| **city** | **String** | The city of the business using the toll-free number. |  |
+| **state** | **String** | The state of the business using the toll-free number. |  |
+| **zip** | **String** | The zip of the business using the toll-free number. |  |
+| **url** | **String** | The website of the business using the toll-free number. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Address.new(
+  name: Bandwidth Inc.,
+  addr1: 2230 Bandmate Way,
+  addr2: null,
+  city: Raleigh,
+  state: NC,
+  zip: 27606,
+  url: https://www.example.com/path/to/resource
+)
+```
+

data/docs/CallbackTypeEnum.md

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

data/docs/Contact.md

@@ -0,0 +1,24 @@
+# Bandwidth::Contact
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first_name** | **String** | The first name of the business contact using the toll-free number. |  |
+| **last_name** | **String** | The last name of the business contact using the toll-free number. |  |
+| **email** | **String** |  |  |
+| **phone_number** | **String** | Contact telephone number |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Contact.new(
+  first_name: John,
+  last_name: Doe,
+  email: foo@bar.com,
+  phone_number: +19192654500
+)
+```
+

data/docs/Error.md

@@ -0,0 +1,22 @@
+# Bandwidth::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **Integer** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **telephone_numbers** | [**Array<TelephoneNumber>**](TelephoneNumber.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::Error.new(
+  code: null,
+  description: null,
+  telephone_numbers: null
+)
+```
+

data/docs/FailureWebhook.md

@@ -0,0 +1,28 @@
+# Bandwidth::FailureWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | User's account ID. | [optional] |
+| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
+| **error_code** | **String** | An error code indicating what error was encountered. This code can be interpreted as an HTTP status code in regards to the error that was encountered. | [optional] |
+| **error_description** | **String** | A description of the error that was encountered. | [optional] |
+| **errors** | **Array<String>** | Details of the errors that were encountered when processing the request. | [optional] |
+| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::FailureWebhook.new(
+  account_id: 1234567,
+  phone_number: +18005555555,
+  error_code: 400,
+  error_description: cannot process request.,
+  errors: null,
+  internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333
+)
+```
+

data/docs/LinksObject.md

@@ -0,0 +1,24 @@
+# Bandwidth::LinksObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **first** | **String** | The first (or only) page of results matching the query. | [optional] |
+| **_next** | **String** | If more results exist than specified by 'size', this link returns the next page of 'size' results. | [optional] |
+| **previous** | **String** | If the results are more than one page, this link returns the previous page of 'size' results. | [optional] |
+| **last** | **String** | If more results exist than specified by 'size', this link return the last page of result. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::LinksObject.new(
+  first: null,
+  _next: null,
+  previous: null,
+  last: null
+)
+```
+

data/docs/MediaApi.md

@@ -302,6 +302,6 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json, application/ogg, application/pdf, application/rtf, application/zip, application/x-tar, application/xml, application/gzip, application/x-bzip2, application/x-gzip, application/smil, application/javascript, audio/mp4, audio/mpeg, audio/ogg, audio/flac, audio/webm, audio/wav, audio/amr, audio/3gpp, image/bmp, image/gif, image/jpeg, image/pjpeg, image/png, image/svg+xml, image/tiff, image/webp, image/x-icon, text/css, text/csv, text/calendar, text/plain, text/javascript, text/vcard, text/vnd.wap.wml, text/xml, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-ms-wmv
+- **Content-Type**: application/json, application/ogg, application/pdf, application/rtf, application/zip, application/x-tar, application/xml, application/gzip, application/x-bzip2, application/x-gzip, application/smil, application/javascript, audio/mp4, audio/mpeg, audio/ogg, audio/flac, audio/webm, audio/wav, audio/amr, audio/3gpp, image/bmp, image/gif, image/heic, image/heif, image/jpeg, image/pjpeg, image/png, image/svg+xml, image/tiff, image/webp, image/x-icon, text/css, text/csv, text/calendar, text/html, text/plain, text/javascript, text/vcard, text/vnd.wap.wml, text/xml, video/avi, video/mp4, video/mpeg, video/ogg, video/quicktime, video/webm, video/x-ms-wmv, video/x-flv
 - **Accept**: application/json
 

data/docs/Message.md

@@ -27,7 +27,7 @@ instance = Bandwidth::Message.new(
   id: 1589228074636lm4k2je7j7jklbn2,
   owner: +15554443333,
   application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
-  time: 2022-09-14T18:20:16Z,
+  time: 2024-12-02T20:15:57.278Z,
   segment_count: 2,
   direction: null,
   to: ["+15552223333"],

data/docs/MessageCallback.md

@@ -0,0 +1,28 @@
+# Bandwidth::MessageCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **type** | [**CallbackTypeEnum**](CallbackTypeEnum.md) |  |  |
+| **to** | **String** |  |  |
+| **description** | **String** | A detailed description of the event described by the callback. |  |
+| **message** | [**MessageCallbackMessage**](MessageCallbackMessage.md) |  |  |
+| **error_code** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageCallback.new(
+  time: 2024-12-02T20:15:57.278Z,
+  type: null,
+  to: +15552223333,
+  description: rejected-unallocated-from-number,
+  message: null,
+  error_code: 4405
+)
+```
+

data/docs/MessageCallbackMessage.md

@@ -0,0 +1,40 @@
+# Bandwidth::MessageCallbackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **owner** | **String** |  |  |
+| **application_id** | **String** |  |  |
+| **time** | **Time** |  |  |
+| **segment_count** | **Integer** |  |  |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
+| **to** | **Array<String>** |  |  |
+| **from** | **String** |  |  |
+| **text** | **String** |  |  |
+| **tag** | **String** |  | [optional] |
+| **media** | **Array<String>** | Optional media, applicable only for mms | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::MessageCallbackMessage.new(
+  id: 1661365814859loidf7mcwd4qacn7,
+  owner: +15553332222,
+  application_id: 93de2206-9669-4e07-948d-329f4b722ee2,
+  time: 2024-12-02T20:15:57.666Z,
+  segment_count: 1,
+  direction: null,
+  to: ["+15552223333"],
+  from: +15553332222,
+  text: Hello world,
+  tag: custom string,
+  media: ["https://dev.bandwidth.com/images/bandwidth-logo.png","https://dev.bandwidth.com/images/github_logo.png"],
+  priority: null
+)
+```
+

data/docs/OptInWorkflow.md

@@ -0,0 +1,20 @@
+# Bandwidth::OptInWorkflow
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **description** | **String** |  |  |
+| **image_urls** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::OptInWorkflow.new(
+  description: Opt In Flow,
+  image_urls: null
+)
+```
+

data/docs/TelephoneNumber.md

@@ -0,0 +1,18 @@
+# Bandwidth::TelephoneNumber
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **telephone_number** | **String** | Simple Telephone Number. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TelephoneNumber.new(
+  telephone_number: null
+)
+```
+

data/docs/TfvBasicAuthentication.md

@@ -0,0 +1,20 @@
+# Bandwidth::TfvBasicAuthentication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **username** | **String** |  |  |
+| **password** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TfvBasicAuthentication.new(
+  username: null,
+  password: null
+)
+```
+

data/docs/TfvCallbackStatusEnum.md

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

data/docs/TfvError.md

@@ -0,0 +1,22 @@
+# Bandwidth::TfvError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  | [optional] |
+| **description** | **String** |  | [optional] |
+| **errors** | **Object** | Each key of this errors object refers to a field of the submitted object (using dot notation for nested objects), with the field being a key to an array of one or more errors for that field. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TfvError.new(
+  type: Error Type,
+  description: Error Message,
+  errors: {"field":"error message"}
+)
+```
+

data/docs/TfvStatus.md

@@ -0,0 +1,32 @@
+# Bandwidth::TfvStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
+| **status** | [**TfvStatusEnum**](TfvStatusEnum.md) |  | [optional] |
+| **internal_ticket_number** | **String** | Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number - included in all webhook payloads. | [optional] |
+| **decline_reason_description** | **String** | Explanation for why a verification request was declined. | [optional] |
+| **resubmit_allowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
+| **created_date_time** | **Time** | Date and time the verification request was created. | [optional] |
+| **modified_date_time** | **Time** | Date and time the verification request was last modified. | [optional] |
+| **submission** | [**TfvSubmissionInfo**](TfvSubmissionInfo.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TfvStatus.new(
+  phone_number: +18005555555,
+  status: null,
+  internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333,
+  decline_reason_description: Invalid Information - Can't Validate URL - Website is not accessible / not available,
+  resubmit_allowed: true,
+  created_date_time: 2021-06-08T06:45:13Z,
+  modified_date_time: 2021-06-08T06:45:13Z,
+  submission: null
+)
+```
+

data/docs/TfvStatusEnum.md

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

data/docs/TfvSubmissionInfo.md

@@ -0,0 +1,34 @@
+# Bandwidth::TfvSubmissionInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **business_address** | [**Address**](Address.md) |  | [optional] |
+| **business_contact** | [**Contact**](Contact.md) |  | [optional] |
+| **message_volume** | **Integer** | Estimated monthly volume of messages from the toll-free number. | [optional] |
+| **use_case** | **String** | The category of the use case. | [optional] |
+| **use_case_summary** | **String** | A general idea of the use case and customer. | [optional] |
+| **production_message_content** | **String** | Example of message content. | [optional] |
+| **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) |  | [optional] |
+| **additional_information** | **String** | Any additional information. | [optional] |
+| **isv_reseller** | **String** | ISV name. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TfvSubmissionInfo.new(
+  business_address: null,
+  business_contact: null,
+  message_volume: 10000,
+  use_case: 2FA,
+  use_case_summary: Text summarizing the use case for the toll-free number,
+  production_message_content: Production message content,
+  opt_in_workflow: null,
+  additional_information: Any additional information,
+  isv_reseller: Test ISV
+)
+```
+

data/docs/TfvSubmissionWrapper.md

@@ -0,0 +1,18 @@
+# Bandwidth::TfvSubmissionWrapper
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **submission** | [**VerificationUpdateRequest**](VerificationUpdateRequest.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::TfvSubmissionWrapper.new(
+  submission: null
+)
+```
+