bandwidth-sdk 5.0.0 → 7.0.0

data/lib/bandwidth/http/auth/{two_factor_auth_basic_auth.rb → multi_factor_auth_basic_auth.rb}

@@ -7,13 +7,13 @@ require 'base64'
 
 module Bandwidth
   # Utility class for basic authorization.
-  class TwoFactorAuthBasicAuth
+  class MultiFactorAuthBasicAuth
     # Add basic authentication to the request.
     # @param [HttpRequest] The HttpRequest object to which authentication will
     # be added.
     def self.apply(config, http_request)
-      username = config.two_factor_auth_basic_auth_user_name
-      password = config.two_factor_auth_basic_auth_password
+      username = config.multi_factor_auth_basic_auth_user_name
+      password = config.multi_factor_auth_basic_auth_password
       value = Base64.strict_encode64("#{username}:#{password}")
       header_value = "Basic #{value}"
       http_request.headers['Authorization'] = header_value

data/lib/bandwidth/http/auth/phone_number_lookup_basic_auth.rb

@@ -0,0 +1,22 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+require 'base64'
+
+module Bandwidth
+  # Utility class for basic authorization.
+  class PhoneNumberLookupBasicAuth
+    # Add basic authentication to the request.
+    # @param [HttpRequest] The HttpRequest object to which authentication will
+    # be added.
+    def self.apply(config, http_request)
+      username = config.phone_number_lookup_basic_auth_user_name
+      password = config.phone_number_lookup_basic_auth_password
+      value = Base64.strict_encode64("#{username}:#{password}")
+      header_value = "Basic #{value}"
+      http_request.headers['Authorization'] = header_value
+    end
+  end
+end

data/lib/bandwidth/http/faraday_client.rb

@@ -11,7 +11,8 @@ module Bandwidth
   class FaradayClient < HttpClient
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
-                   backoff_factor:, cache: false, verify: true)
+                   backoff_factor:, retry_statuses:, retry_methods:,
+                   cache: false, verify: true)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
@@ -21,7 +22,9 @@ module Bandwidth
         faraday.ssl[:ca_file] = Certifi.where
         faraday.ssl[:verify] = verify
         faraday.request :retry, max: max_retries, interval: retry_interval,
-                                backoff_factor: backoff_factor
+                                backoff_factor: backoff_factor,
+                                retry_statuses: retry_statuses,
+                                methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout > 0

data/lib/bandwidth/messaging_lib/messaging.rb

@@ -16,6 +16,7 @@ require_relative 'messaging/models/deferred_result.rb'
 require_relative 'messaging/models/bandwidth_callback_message.rb'
 require_relative 'messaging/models/bandwidth_message.rb'
 require_relative 'messaging/models/message_request.rb'
+require_relative 'messaging/models/priority_enum.rb'
 
 # Exceptions
 require_relative 'messaging/exceptions/messaging_exception.rb'

data/lib/bandwidth/messaging_lib/messaging/client.rb

@@ -16,12 +16,17 @@ module Bandwidth
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                       backoff_factor: 1, environment: Environment::PRODUCTION,
+                       backoff_factor: 2,
+                       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524, 408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
+                       retry_methods: %i[get put get put],
+                       environment: Environment::PRODUCTION,
                        base_url: 'https://www.example.com',
                        messaging_basic_auth_user_name: 'TODO: Replace',
                        messaging_basic_auth_password: 'TODO: Replace',
-                       two_factor_auth_basic_auth_user_name: 'TODO: Replace',
-                       two_factor_auth_basic_auth_password: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_user_name: 'TODO: Replace',
+                       multi_factor_auth_basic_auth_password: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_user_name: 'TODO: Replace',
+                       phone_number_lookup_basic_auth_password: 'TODO: Replace',
                        voice_basic_auth_user_name: 'TODO: Replace',
                        voice_basic_auth_password: 'TODO: Replace',
                        web_rtc_basic_auth_user_name: 'TODO: Replace',
@@ -32,12 +37,16 @@ module Bandwidth
                                         max_retries: max_retries,
                                         retry_interval: retry_interval,
                                         backoff_factor: backoff_factor,
+                                        retry_statuses: retry_statuses,
+                                        retry_methods: retry_methods,
                                         environment: environment,
                                         base_url: base_url,
                                         messaging_basic_auth_user_name: messaging_basic_auth_user_name,
                                         messaging_basic_auth_password: messaging_basic_auth_password,
-                                        two_factor_auth_basic_auth_user_name: two_factor_auth_basic_auth_user_name,
-                                        two_factor_auth_basic_auth_password: two_factor_auth_basic_auth_password,
+                                        multi_factor_auth_basic_auth_user_name: multi_factor_auth_basic_auth_user_name,
+                                        multi_factor_auth_basic_auth_password: multi_factor_auth_basic_auth_password,
+                                        phone_number_lookup_basic_auth_user_name: phone_number_lookup_basic_auth_user_name,
+                                        phone_number_lookup_basic_auth_password: phone_number_lookup_basic_auth_password,
                                         voice_basic_auth_user_name: voice_basic_auth_user_name,
                                         voice_basic_auth_password: voice_basic_auth_password,
                                         web_rtc_basic_auth_user_name: web_rtc_basic_auth_user_name,

data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb

@@ -12,18 +12,18 @@ module Messaging
     end
 
     # listMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [String] continuation_token Optional parameter: Continuation token
     # used to retrieve subsequent media.
     # @return [List of Media] response from the API call
-    def list_media(user_id,
+    def list_media(account_id,
                    continuation_token: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media'
+      _query_builder << '/users/{accountId}/media'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -84,17 +84,17 @@ module Messaging
     end
 
     # getMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: Media ID to retrieve
     # @return [Binary] response from the API call
-    def get_media(user_id,
+    def get_media(account_id,
                   media_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -147,11 +147,9 @@ module Messaging
     end
 
     # uploadMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: The user supplied custom
     # media ID
-    # @param [Long] content_length Required parameter: The size of the
-    # entity-body
     # @param [File | UploadIO] body Required parameter: Example:
     # @param [String] content_type Optional parameter: The media type of the
     # entity-body
@@ -159,18 +157,17 @@ module Messaging
     # used to specify directives that MUST be obeyed by all caching mechanisms
     # along the request/response chain.
     # @return [void] response from the API call
-    def upload_media(user_id,
+    def upload_media(account_id,
                      media_id,
-                     content_length,
                      body,
                      content_type: 'application/octet-stream',
                      cache_control: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -187,7 +184,6 @@ module Messaging
       _headers = {
         'content-type' => body_content_type,
         'content-length' => body_wrapper.size.to_s,
-        'Content-Length' => content_length,
         'Cache-Control' => cache_control
       }
 
@@ -239,17 +235,17 @@ module Messaging
     end
 
     # deleteMedia
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [String] media_id Required parameter: The media ID to delete
     # @return [void] response from the API call
-    def delete_media(user_id,
+    def delete_media(account_id,
                      media_id)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/media/{mediaId}'
+      _query_builder << '/users/{accountId}/media/{mediaId}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false },
+        'accountId' => { 'value' => account_id, 'encode' => false },
         'mediaId' => { 'value' => media_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
@@ -300,7 +296,7 @@ module Messaging
     end
 
     # getMessages
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [String] message_id Optional parameter: The ID of the message to
     # search for. Special characters need to be encoded using URL encoding
     # @param [String] source_tn Optional parameter: The phone number that sent
@@ -309,7 +305,7 @@ module Messaging
     # received the message
     # @param [String] message_status Optional parameter: The status of the
     # message. One of RECEIVED, QUEUED, SENDING, SENT, FAILED, DELIVERED,
-    # DLR_EXPIRED
+    # ACCEPTED, UNDELIVERED
     # @param [Integer] error_code Optional parameter: The error code of the
     # message
     # @param [String] from_date_time Optional parameter: The start of the date
@@ -324,7 +320,7 @@ module Messaging
     # in search result. Default 100. The sum of limit and after cannot be more
     # than 10000
     # @return [BandwidthMessagesList] response from the API call
-    def get_messages(user_id,
+    def get_messages(account_id,
                      message_id: nil,
                      source_tn: nil,
                      destination_tn: nil,
@@ -336,10 +332,10 @@ module Messaging
                      limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/messages'
+      _query_builder << '/users/{accountId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -410,17 +406,17 @@ module Messaging
     end
 
     # createMessage
-    # @param [String] user_id Required parameter: User's account ID
+    # @param [String] account_id Required parameter: User's account ID
     # @param [MessageRequest] body Required parameter: Example:
     # @return [BandwidthMessage] response from the API call
-    def create_message(user_id,
+    def create_message(account_id,
                        body)
       # Prepare query url.
       _query_builder = config.get_base_uri(Server::MESSAGINGDEFAULT)
-      _query_builder << '/users/{userId}/messages'
+      _query_builder << '/users/{accountId}/messages'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'userId' => { 'value' => user_id, 'encode' => false }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb

@@ -51,6 +51,10 @@ module Bandwidth
     # @return [String]
     attr_accessor :tag
 
+    # The priority specified by the user
+    # @return [String]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -65,6 +69,7 @@ module Bandwidth
       @_hash['media'] = 'media'
       @_hash['text'] = 'text'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -78,7 +83,8 @@ module Bandwidth
                    from = nil,
                    media = nil,
                    text = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @id = id
       @owner = owner
       @application_id = application_id
@@ -90,6 +96,7 @@ module Bandwidth
       @media = media
       @text = text
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -108,6 +115,7 @@ module Bandwidth
       media = hash['media']
       text = hash['text']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       BandwidthMessage.new(id,
@@ -120,7 +128,8 @@ module Bandwidth
                            from,
                            media,
                            text,
-                           tag)
+                           tag,
+                           priority)
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message_item.rb

@@ -50,6 +50,26 @@ module Bandwidth
     # @return [String]
     attr_accessor :carrier_name
 
+    # The size of the message including message content and headers
+    # @return [Integer]
+    attr_accessor :message_size
+
+    # The length of the message content
+    # @return [Integer]
+    attr_accessor :message_length
+
+    # The number of attachments the message has
+    # @return [Integer]
+    attr_accessor :attachment_count
+
+    # The number of recipients the message has
+    # @return [Integer]
+    attr_accessor :recipient_count
+
+    # The campaign class of the message, if it has one
+    # @return [String]
+    attr_accessor :campaign_class
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -64,6 +84,11 @@ module Bandwidth
       @_hash['error_code'] = 'errorCode'
       @_hash['receive_time'] = 'receiveTime'
       @_hash['carrier_name'] = 'carrierName'
+      @_hash['message_size'] = 'messageSize'
+      @_hash['message_length'] = 'messageLength'
+      @_hash['attachment_count'] = 'attachmentCount'
+      @_hash['recipient_count'] = 'recipientCount'
+      @_hash['campaign_class'] = 'campaignClass'
       @_hash
     end
 
@@ -77,7 +102,12 @@ module Bandwidth
                    segment_count = nil,
                    error_code = nil,
                    receive_time = nil,
-                   carrier_name = nil)
+                   carrier_name = nil,
+                   message_size = nil,
+                   message_length = nil,
+                   attachment_count = nil,
+                   recipient_count = nil,
+                   campaign_class = nil)
       @message_id = message_id
       @account_id = account_id
       @source_tn = source_tn
@@ -89,6 +119,11 @@ module Bandwidth
       @error_code = error_code
       @receive_time = receive_time
       @carrier_name = carrier_name
+      @message_size = message_size
+      @message_length = message_length
+      @attachment_count = attachment_count
+      @recipient_count = recipient_count
+      @campaign_class = campaign_class
     end
 
     # Creates an instance of the object from a hash.
@@ -107,6 +142,11 @@ module Bandwidth
       error_code = hash['errorCode']
       receive_time = hash['receiveTime']
       carrier_name = hash['carrierName']
+      message_size = hash['messageSize']
+      message_length = hash['messageLength']
+      attachment_count = hash['attachmentCount']
+      recipient_count = hash['recipientCount']
+      campaign_class = hash['campaignClass']
 
       # Create object from extracted values.
       BandwidthMessageItem.new(message_id,
@@ -119,7 +159,12 @@ module Bandwidth
                                segment_count,
                                error_code,
                                receive_time,
-                               carrier_name)
+                               carrier_name,
+                               message_size,
+                               message_length,
+                               attachment_count,
+                               recipient_count,
+                               campaign_class)
     end
   end
 end

data/lib/bandwidth/messaging_lib/messaging/models/media.rb

@@ -6,82 +6,33 @@
 module Bandwidth
   # Media Model.
   class Media < BaseModel
-    # TODO: Write general description for this method
-    # @return [Object]
-    attr_accessor :input_stream
-
     # TODO: Write general description for this method
     # @return [String]
     attr_accessor :content
 
     # TODO: Write general description for this method
-    # @return [String]
-    attr_accessor :url
-
-    # TODO: Write general description for this method
-    # @return [String]
+    # @return [Integer]
     attr_accessor :content_length
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :content_type
-
-    # TODO: Write general description for this method
-    # @return [List of Tag]
-    attr_accessor :tags
-
-    # User's account ID
-    # @return [String]
-    attr_accessor :user_id
-
-    # User's account ID
-    # @return [String]
     attr_accessor :media_name
 
-    # User's account ID
-    # @return [String]
-    attr_accessor :media_id
-
-    # User's account ID
-    # @return [String]
-    attr_accessor :cache_control
-
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
-      @_hash['input_stream'] = 'inputStream'
       @_hash['content'] = 'content'
-      @_hash['url'] = 'url'
       @_hash['content_length'] = 'contentLength'
-      @_hash['content_type'] = 'contentType'
-      @_hash['tags'] = 'tags'
-      @_hash['user_id'] = 'userId'
       @_hash['media_name'] = 'mediaName'
-      @_hash['media_id'] = 'mediaId'
-      @_hash['cache_control'] = 'cacheControl'
       @_hash
     end
 
-    def initialize(input_stream = nil,
-                   content = nil,
-                   url = nil,
+    def initialize(content = nil,
                    content_length = nil,
-                   content_type = nil,
-                   tags = nil,
-                   user_id = nil,
-                   media_name = nil,
-                   media_id = nil,
-                   cache_control = nil)
-      @input_stream = input_stream
+                   media_name = nil)
       @content = content
-      @url = url
       @content_length = content_length
-      @content_type = content_type
-      @tags = tags
-      @user_id = user_id
       @media_name = media_name
-      @media_id = media_id
-      @cache_control = cache_control
     end
 
     # Creates an instance of the object from a hash.
@@ -89,35 +40,14 @@ module Bandwidth
       return nil unless hash
 
       # Extract variables from the hash.
-      input_stream = hash['inputStream']
       content = hash['content']
-      url = hash['url']
       content_length = hash['contentLength']
-      content_type = hash['contentType']
-      # Parameter is an array, so we need to iterate through it
-      tags = nil
-      unless hash['tags'].nil?
-        tags = []
-        hash['tags'].each do |structure|
-          tags << (Tag.from_hash(structure) if structure)
-        end
-      end
-      user_id = hash['userId']
       media_name = hash['mediaName']
-      media_id = hash['mediaId']
-      cache_control = hash['cacheControl']
 
       # Create object from extracted values.
-      Media.new(input_stream,
-                content,
-                url,
+      Media.new(content,
                 content_length,
-                content_type,
-                tags,
-                user_id,
-                media_name,
-                media_id,
-                cache_control)
+                media_name)
     end
   end
 end