bandwidth-sdk 15.0.0 → 16.0.0

data/docs/StatusCallback.md

@@ -0,0 +1,32 @@
+# Bandwidth::StatusCallback
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **time** | **Time** |  |  |
+| **event_time** | **Time** | Represents the time at which the message was read, for `message-read` callbacks. | [optional] |
+| **type** | [**StatusCallbackTypeEnum**](StatusCallbackTypeEnum.md) |  |  |
+| **to** | **String** | The destination phone number the message was sent to. For status callbacks, this the the Bandwidth user's client phone number. |  |
+| **description** | **String** | A detailed description of the event described by the callback. |  |
+| **message** | [**StatusCallbackMessage**](StatusCallbackMessage.md) |  |  |
+| **error_code** | **Integer** | Optional error code, applicable only when type is `message-failed`. | [optional] |
+| **carrier_name** | **String** | The name of the Authorized Message Provider (AMP) that handled this message.  In the US, this is the carrier that the message was sent to. This field is present only when this account feature has been enabled. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::StatusCallback.new(
+  time: 2024-12-02T20:15:57.278Z,
+  event_time: 2024-12-02T20:15:58.278Z,
+  type: null,
+  to: +15552223333,
+  description: Message delivered to carrier.,
+  message: null,
+  error_code: 4405,
+  carrier_name: AT&T
+)
+```
+

data/docs/StatusCallbackMessage.md

@@ -0,0 +1,42 @@
+# Bandwidth::StatusCallbackMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | A unique identifier of the message. |  |
+| **owner** | **String** | The Bandwidth phone number or alphanumeric identifier associated with the message. |  |
+| **application_id** | **String** | The ID of the Application your from number or senderId is associated with in the Bandwidth Phone Number Dashboard. |  |
+| **time** | **Time** |  |  |
+| **segment_count** | **Integer** | The number of segments the user's message is broken into before sending over carrier networks. |  |
+| **direction** | [**MessageDirectionEnum**](MessageDirectionEnum.md) |  |  |
+| **to** | **Array<String>** | The phone number recipients of the message. |  |
+| **from** | **String** | The Bandwidth phone number or alphanumeric identifier the message was sent from. |  |
+| **text** | **String** |  | [optional] |
+| **tag** | **String** | A custom string that will be included in callback events of the message. Max 1024 characters. | [optional] |
+| **media** | **Array<String>** | Optional media, not applicable for sms | [optional] |
+| **priority** | [**PriorityEnum**](PriorityEnum.md) |  | [optional] |
+| **channel** | [**MultiChannelMessageChannelEnum**](MultiChannelMessageChannelEnum.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::StatusCallbackMessage.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,
+  channel: null
+)
+```
+

data/docs/{CallbackTypeEnum.md → StatusCallbackTypeEnum.md}

@@ -1,4 +1,4 @@
-# Bandwidth::CallbackTypeEnum
+# Bandwidth::StatusCallbackTypeEnum
 
 ## Properties
 
@@ -10,6 +10,6 @@
 ```ruby
 require 'bandwidth-sdk'
 
-instance = Bandwidth::CallbackTypeEnum.new()
+instance = Bandwidth::StatusCallbackTypeEnum.new()
 ```
 

data/docs/TfvStatus.md

@@ -12,8 +12,8 @@
 | **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] |
-| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
-| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
+| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
+| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
 
 ## Example
 

data/docs/TfvSubmissionInfo.md

@@ -13,9 +13,9 @@
 | **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) |  | [optional] |
 | **additional_information** | **String** | Any additional information. | [optional] |
 | **isv_reseller** | **String** | ISV name. | [optional] |
-| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
+| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
+| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
+| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
 
 ## Example
 
@@ -32,9 +32,9 @@ instance = Bandwidth::TfvSubmissionInfo.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

data/docs/TollFreeVerificationApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *http://localhost*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_webhook_subscription**](TollFreeVerificationApi.md#create_webhook_subscription) | **POST** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions | Create Webhook Subscription |
+| [**delete_verification_request**](TollFreeVerificationApi.md#delete_verification_request) | **DELETE** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Delete a Toll-Free Verification Submission |
 | [**delete_webhook_subscription**](TollFreeVerificationApi.md#delete_webhook_subscription) | **DELETE** /accounts/{accountId}/tollFreeVerification/webhooks/subscriptions/{id} | Delete Webhook Subscription |
 | [**get_toll_free_verification_status**](TollFreeVerificationApi.md#get_toll_free_verification_status) | **GET** /accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification | Get Toll-Free Verification Status |
 | [**list_toll_free_use_cases**](TollFreeVerificationApi.md#list_toll_free_use_cases) | **GET** /tollFreeVerification/useCases | List Toll-Free Use Cases |
@@ -86,6 +87,77 @@ end
 - **Accept**: application/json
 
 
+## delete_verification_request
+
+> delete_verification_request(account_id, phone_number)
+
+Delete a Toll-Free Verification Submission
+
+Delete a toll-free verification submission for a toll-free number.
+
+### 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::TollFreeVerificationApi.new
+account_id = '9900000' # String | Your Bandwidth Account ID.
+phone_number = '+18885555555' # String | Valid Toll-Free telephone number in E.164 format.
+
+begin
+  # Delete a Toll-Free Verification Submission
+  api_instance.delete_verification_request(account_id, phone_number)
+rescue Bandwidth::ApiError => e
+  puts "Error when calling TollFreeVerificationApi->delete_verification_request: #{e}"
+end
+```
+
+#### Using the delete_verification_request_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> delete_verification_request_with_http_info(account_id, phone_number)
+
+```ruby
+begin
+  # Delete a Toll-Free Verification Submission
+  data, status_code, headers = api_instance.delete_verification_request_with_http_info(account_id, phone_number)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Bandwidth::ApiError => e
+  puts "Error when calling TollFreeVerificationApi->delete_verification_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | Your Bandwidth Account ID. |  |
+| **phone_number** | **String** | Valid Toll-Free telephone number in E.164 format. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[Basic](../README.md#Basic)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## delete_webhook_subscription
 
 > delete_webhook_subscription(account_id, id)

data/docs/VerificationDenialWebhook.md

@@ -12,8 +12,8 @@
 | **phone_number** | **String** | Toll-free telephone number in E.164 format. | [optional] |
 | **resubmit_allowed** | **Boolean** | Whether a Toll-Free Verification request qualifies for resubmission via PUT. | [optional] |
 | **status** | **String** |  | [optional][default to 'UNVERIFIED'] |
-| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
-| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. (Not Available Until 5/28/2025) | [optional] |
+| **blocked** | **Boolean** | Whether a Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
+| **blocked_reason** | **String** | The reason why the Toll-Free Verification is blocked. This attribute will only be defined when the number is blocked. | [optional] |
 
 ## Example
 

data/docs/VerificationRequest.md

@@ -14,9 +14,9 @@
 | **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) |  |  |
 | **additional_information** | **String** | Any additional information. | [optional] |
 | **isv_reseller** | **String** | ISV name. | [optional] |
-| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
+| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
+| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
+| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
 
 ## Example
 
@@ -34,9 +34,9 @@ instance = Bandwidth::VerificationRequest.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

data/docs/VerificationUpdateRequest.md

@@ -13,9 +13,9 @@
 | **opt_in_workflow** | [**OptInWorkflow**](OptInWorkflow.md) |  |  |
 | **additional_information** | **String** | Any additional information. | [optional] |
 | **isv_reseller** | **String** | ISV name. | [optional] |
-| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. (Not Available Until 5/28/2025) | [optional] |
-| **business_dba** | **String** | The company 'Doing Business As'. (Not Available Until 5/28/2025) | [optional] |
+| **privacy_policy_url** | **String** | The Toll-Free Verification request privacy policy URL. | [optional] |
+| **terms_and_conditions_url** | **String** | The Toll-Free Verification request terms and conditions policy URL. | [optional] |
+| **business_dba** | **String** | The company 'Doing Business As'. | [optional] |
 
 ## Example
 
@@ -32,9 +32,9 @@ instance = Bandwidth::VerificationUpdateRequest.new(
   opt_in_workflow: null,
   additional_information: Any additional information,
   isv_reseller: Test ISV,
-  privacy_policy_url: http://your-company.com/privacyPolicyUrl.pdf,
-  terms_and_conditions_url: http://your-company.com/termsAndConditionsUrl.pdf,
-  business_dba: SecondCompany Name
+  privacy_policy_url: http://your-company.com/privacyPolicy,
+  terms_and_conditions_url: http://your-company.com/termsAndConditions,
+  business_dba: Another Company Name Inc.
 )
 ```
 

data/lib/bandwidth-sdk/api/toll_free_verification_api.rb

@@ -93,6 +93,88 @@ module Bandwidth
       return data, status_code, headers
     end
 
+    # Delete a Toll-Free Verification Submission
+    # Delete a toll-free verification submission for a toll-free number.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_verification_request(account_id, phone_number, opts = {})
+      delete_verification_request_with_http_info(account_id, phone_number, opts)
+      nil
+    end
+
+    # Delete a Toll-Free Verification Submission
+    # Delete a toll-free verification submission for a toll-free number.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param phone_number [String] Valid Toll-Free telephone number in E.164 format.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_verification_request_with_http_info(account_id, phone_number, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: TollFreeVerificationApi.delete_verification_request ...'
+      end
+      # verify the required parameter 'account_id' is set
+      if @api_client.config.client_side_validation && account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_id' when calling TollFreeVerificationApi.delete_verification_request"
+      end
+      # verify the required parameter 'phone_number' is set
+      if @api_client.config.client_side_validation && phone_number.nil?
+        fail ArgumentError, "Missing the required parameter 'phone_number' when calling TollFreeVerificationApi.delete_verification_request"
+      end
+      if @api_client.config.client_side_validation && phone_number.to_s.length > 12
+        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.delete_verification_request, the character length must be smaller than or equal to 12.'
+      end
+
+      if @api_client.config.client_side_validation && phone_number.to_s.length < 12
+        fail ArgumentError, 'invalid value for "phone_number" when calling TollFreeVerificationApi.delete_verification_request, the character length must be great than or equal to 12.'
+      end
+
+      pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
+      if @api_client.config.client_side_validation && phone_number !~ pattern
+        fail ArgumentError, "invalid value for 'phone_number' when calling TollFreeVerificationApi.delete_verification_request, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/accounts/{accountId}/phoneNumbers/{phoneNumber}/tollFreeVerification'.sub('{' + 'accountId' + '}', CGI.escape(account_id.to_s)).sub('{' + 'phoneNumber' + '}', CGI.escape(phone_number.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"TollFreeVerificationApi.delete_verification_request",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: TollFreeVerificationApi#delete_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete Webhook Subscription
     # Delete a webhook subscription by ID.
     # @param account_id [String] Your Bandwidth Account ID.

data/lib/bandwidth-sdk/configuration.rb

@@ -498,6 +498,12 @@ module Bandwidth
           description: "Production",
           }
         ],
+        "TollFreeVerificationApi.delete_verification_request": [
+          {
+          url: "https://api.bandwidth.com/api/v2",
+          description: "Production",
+          }
+        ],
         "TollFreeVerificationApi.delete_webhook_subscription": [
           {
           url: "https://api.bandwidth.com/api/v2",