bandwidth-sdk 14.1.3 → 15.0.0

data/docs/RbmActionTypeEnum.md

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

data/docs/RbmActionViewLocation.md

@@ -0,0 +1,28 @@
+# Bandwidth::RbmActionViewLocation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | [**RbmActionTypeEnum**](RbmActionTypeEnum.md) |  |  |
+| **text** | **String** | Displayed text for user to click |  |
+| **post_back_data** | **String** | Base64 payload the customer receives when the reply is clicked. |  |
+| **latitude** | **Float** | The latitude of the location. |  |
+| **longitude** | **Float** | The longitude of the location. |  |
+| **label** | **String** | The label of the location. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmActionViewLocation.new(
+  type: null,
+  text: Hello world,
+  post_back_data: U0dWc2JHOGdkMjl5YkdRPQ==,
+  latitude: 37.7749,
+  longitude: -122.4194,
+  label: San Francisco
+)
+```
+

data/docs/RbmCardContent.md

@@ -0,0 +1,24 @@
+# Bandwidth::RbmCardContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The title of the card. Must be 200 characters or less. | [optional] |
+| **description** | **String** | The description of the card. Must be 2000 characters or less. | [optional] |
+| **media** | [**RbmCardContentMedia**](RbmCardContentMedia.md) |  | [optional] |
+| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient that will be displayed on the rich card. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmCardContent.new(
+  title: Bandwidth,
+  description: Bandwidth is a communications platform as a service (CPaaS) company.,
+  media: null,
+  suggestions: null
+)
+```
+

data/docs/RbmCardContentMedia.md

@@ -0,0 +1,22 @@
+# Bandwidth::RbmCardContentMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | The URL of the media file. 100MB is the maximum file size. |  |
+| **thumbnail_url** | **String** | The URL of the thumbnail image. Applies only to video file media. | [optional] |
+| **height** | [**RbmMediaHeightEnum**](RbmMediaHeightEnum.md) |  |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmCardContentMedia.new(
+  file_url: https://dev.bandwidth.com/images/bandwidth-logo.png,
+  thumbnail_url: https://dev.bandwidth.com/images/bandwidth-logo.png,
+  height: null
+)
+```
+

data/docs/RbmMediaHeightEnum.md

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

data/docs/RbmMessageCarouselCard.md

@@ -0,0 +1,22 @@
+# Bandwidth::RbmMessageCarouselCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **card_width** | [**CardWidthEnum**](CardWidthEnum.md) |  |  |
+| **card_contents** | [**Array<RbmCardContent>**](RbmCardContent.md) |  |  |
+| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmMessageCarouselCard.new(
+  card_width: null,
+  card_contents: null,
+  suggestions: null
+)
+```
+

data/docs/RbmMessageContentFile.md

@@ -0,0 +1,20 @@
+# Bandwidth::RbmMessageContentFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file_url** | **String** | The URL of the media file. 100MB is the maximum file size. |  |
+| **thumbnail_url** | **String** | The URL of the thumbnail image. Applies only to video file media. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmMessageContentFile.new(
+  file_url: https://dev.bandwidth.com/images/bandwidth-logo.png,
+  thumbnail_url: https://dev.bandwidth.com/images/bandwidth-logo.png
+)
+```
+

data/docs/RbmMessageContentRichCard.md

@@ -0,0 +1,49 @@
+# Bandwidth::RbmMessageContentRichCard
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'bandwidth-sdk'
+
+Bandwidth::RbmMessageContentRichCard.openapi_one_of
+# =>
+# [
+#   :'RbmMessageCarouselCard',
+#   :'RbmStandaloneCard'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'bandwidth-sdk'
+
+Bandwidth::RbmMessageContentRichCard.build(data)
+# => #<RbmMessageCarouselCard:0x00007fdd4aab02a0>
+
+Bandwidth::RbmMessageContentRichCard.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `RbmMessageCarouselCard`
+- `RbmStandaloneCard`
+- `nil` (if no type matches)
+

data/docs/RbmMessageContentText.md

@@ -0,0 +1,20 @@
+# Bandwidth::RbmMessageContentText
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The text associated with the message. Must be 3270 characters or less |  |
+| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmMessageContentText.new(
+  text: Hello world,
+  suggestions: null
+)
+```
+

data/docs/RbmMessageMedia.md

@@ -0,0 +1,20 @@
+# Bandwidth::RbmMessageMedia
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **media** | [**RbmMessageContentFile**](RbmMessageContentFile.md) |  |  |
+| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmMessageMedia.new(
+  media: null,
+  suggestions: null
+)
+```
+

data/docs/RbmStandaloneCard.md

@@ -0,0 +1,24 @@
+# Bandwidth::RbmStandaloneCard
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **orientation** | [**StandaloneCardOrientationEnum**](StandaloneCardOrientationEnum.md) |  |  |
+| **thumbnail_image_alignment** | [**ThumbnailAlignmentEnum**](ThumbnailAlignmentEnum.md) |  |  |
+| **card_content** | [**RbmCardContent**](RbmCardContent.md) |  |  |
+| **suggestions** | [**Array<MultiChannelAction>**](MultiChannelAction.md) | An array of suggested actions for the recipient. | [optional] |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::RbmStandaloneCard.new(
+  orientation: null,
+  thumbnail_image_alignment: null,
+  card_content: null,
+  suggestions: null
+)
+```
+

data/docs/SmsMessageContent.md

@@ -0,0 +1,18 @@
+# Bandwidth::SmsMessageContent
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **text** | **String** | The contents of the text message. Must be 2048 characters or less. |  |
+
+## Example
+
+```ruby
+require 'bandwidth-sdk'
+
+instance = Bandwidth::SmsMessageContent.new(
+  text: Hello world
+)
+```
+

data/docs/StandaloneCardOrientationEnum.md

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

data/docs/TfvStatus.md

@@ -12,6 +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] |
 
 ## Example
 
@@ -26,7 +28,9 @@ instance = Bandwidth::TfvStatus.new(
   resubmit_allowed: true,
   created_date_time: 2021-06-08T06:45:13Z,
   modified_date_time: 2021-06-08T06:45:13Z,
-  submission: null
+  submission: null,
+  blocked: true,
+  blocked_reason: Toll-free number was used to send spam messages
 )
 ```
 

data/docs/TfvSubmissionInfo.md

@@ -13,6 +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] |
 
 ## Example
 
@@ -27,8 +30,11 @@ instance = Bandwidth::TfvSubmissionInfo.new(
   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: null,
-  isv_reseller: Test ISV
+  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
 )
 ```
 

data/docs/ThumbnailAlignmentEnum.md

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

data/docs/VerificationDenialWebhook.md

@@ -12,6 +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] |
 
 ## Example
 
@@ -26,7 +28,9 @@ instance = Bandwidth::VerificationDenialWebhook.new(
   internal_ticket_number: acde070d-8c4c-4f0d-9d8a-162843c10333,
   phone_number: +18005555555,
   resubmit_allowed: true,
-  status: UNVERIFIED
+  status: UNVERIFIED,
+  blocked: true,
+  blocked_reason: Toll-free number was used to send spam messages
 )
 ```
 

data/docs/VerificationRequest.md

@@ -14,6 +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] |
 
 ## Example
 
@@ -30,7 +33,10 @@ instance = Bandwidth::VerificationRequest.new(
   production_message_content: Production message content,
   opt_in_workflow: null,
   additional_information: Any additional information,
-  isv_reseller: Test ISV
+  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
 )
 ```
 

data/docs/VerificationUpdateRequest.md

@@ -13,6 +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] |
 
 ## Example
 
@@ -27,8 +30,11 @@ instance = Bandwidth::VerificationUpdateRequest.new(
   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: null,
-  isv_reseller: Test ISV
+  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
 )
 ```
 

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

@@ -0,0 +1,96 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'cgi'
+
+module Bandwidth
+  class MultiChannelApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Multi-Channel Message
+    # Endpoint for sending Multi-Channel messages.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param multi_channel_message_request [MultiChannelMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateMultiChannelMessageResponse]
+    def create_multi_channel_message(account_id, multi_channel_message_request, opts = {})
+      data, _status_code, _headers = create_multi_channel_message_with_http_info(account_id, multi_channel_message_request, opts)
+      data
+    end
+
+    # Create Multi-Channel Message
+    # Endpoint for sending Multi-Channel messages.
+    # @param account_id [String] Your Bandwidth Account ID.
+    # @param multi_channel_message_request [MultiChannelMessageRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateMultiChannelMessageResponse, Integer, Hash)>] CreateMultiChannelMessageResponse data, response status code and response headers
+    def create_multi_channel_message_with_http_info(account_id, multi_channel_message_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MultiChannelApi.create_multi_channel_message ...'
+      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 MultiChannelApi.create_multi_channel_message"
+      end
+      # verify the required parameter 'multi_channel_message_request' is set
+      if @api_client.config.client_side_validation && multi_channel_message_request.nil?
+        fail ArgumentError, "Missing the required parameter 'multi_channel_message_request' when calling MultiChannelApi.create_multi_channel_message"
+      end
+      # resource path
+      local_var_path = '/users/{accountId}/messages/multiChannel'.sub('{' + 'accountId' + '}', CGI.escape(account_id.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']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+        header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(multi_channel_message_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateMultiChannelMessageResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"MultiChannelApi.create_multi_channel_message",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MultiChannelApi#create_multi_channel_message\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/bandwidth-sdk/configuration.rb

@@ -408,6 +408,12 @@ module Bandwidth
           description: "Production",
           }
         ],
+        "MultiChannelApi.create_multi_channel_message": [
+          {
+          url: "https://messaging.bandwidth.com/api/v2",
+          description: "Production",
+          }
+        ],
         "PhoneNumberLookupApi.create_lookup": [
           {
           url: "https://numbers.bandwidth.com/api/v1",

data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb

@@ -19,6 +19,7 @@ module Bandwidth
           fallback_username: 'fallbackUsername',                            # Optional [String]: The username to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
           fallback_password: 'fallbackPassword',                            # Optional [String]: The password to send in the HTTP request to transferAnswerFallbackUrl. Defaults to None.
           tag: 'tag',                                                       # Optional [String]: A custom string that will be sent with these and all future callbacks unless overwritten by a future tag attribute or cleared. May be cleared by setting tag="" Max length 256 characters. Defaults to None.
+          uui: 'uui',                                                       # Optional [String]: The value of the User-To-User header to send within the initial INVITE. Must include the encoding parameter as specified in RFC 7433. Only base64, jwt and hex encoding are currently allowed. This value, including the encoding specifier, may not exceed 256 characters.
         }
       end
     end

data/lib/bandwidth-sdk/models/card_width_enum.rb

@@ -0,0 +1,40 @@
+=begin
+#Bandwidth
+
+#Bandwidth's Communication APIs
+
+The version of the OpenAPI document: 1.0.0
+Contact: letstalk@bandwidth.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.8.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Bandwidth
+  class CardWidthEnum
+    SMALL = 'SMALL'.freeze
+    MEDIUM = 'MEDIUM'.freeze
+
+    def self.all_vars
+      @all_vars ||= [SMALL, MEDIUM].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CardWidthEnum.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CardWidthEnum"
+    end
+  end
+end