bandwidth-sdk 3.13.0 → 6.0.0

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

@@ -0,0 +1,60 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BandwidthMessagesList Model.
+  class BandwidthMessagesList < BaseModel
+    # Total number of messages matched by the search
+    # @return [Integer]
+    attr_accessor :total_count
+
+    # Total number of messages matched by the search
+    # @return [PageInfo]
+    attr_accessor :page_info
+
+    # Total number of messages matched by the search
+    # @return [List of BandwidthMessageItem]
+    attr_accessor :messages
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['total_count'] = 'totalCount'
+      @_hash['page_info'] = 'pageInfo'
+      @_hash['messages'] = 'messages'
+      @_hash
+    end
+
+    def initialize(total_count = nil,
+                   page_info = nil,
+                   messages = nil)
+      @total_count = total_count
+      @page_info = page_info
+      @messages = messages
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      total_count = hash['totalCount']
+      page_info = PageInfo.from_hash(hash['pageInfo']) if hash['pageInfo']
+      # Parameter is an array, so we need to iterate through it
+      messages = nil
+      unless hash['messages'].nil?
+        messages = []
+        hash['messages'].each do |structure|
+          messages << (BandwidthMessageItem.from_hash(structure) if structure)
+        end
+      end
+
+      # Create object from extracted values.
+      BandwidthMessagesList.new(total_count,
+                                page_info,
+                                messages)
+    end
+  end
+end

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

@@ -30,19 +30,19 @@ module Bandwidth
     # @return [List of Tag]
     attr_accessor :tags
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :user_id
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :media_name
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :media_id
 
-    # TODO: Write general description for this method
+    # User's account ID
     # @return [String]
     attr_accessor :cache_control
 

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

@@ -6,30 +6,38 @@
 module Bandwidth
   # MessageRequest Model.
   class MessageRequest < BaseModel
-    # TODO: Write general description for this method
+    # The ID of the Application your from number is associated with in the
+    # Bandwidth Phone Number Dashboard.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # The phone number(s) the message should be sent to in E164 format
     # @return [List of String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # One of your telephone numbers the message should come from in E164 format
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The contents of the text message. Must be 2048 characters or less.
     # @return [String]
     attr_accessor :text
 
-    # TODO: Write general description for this method
+    # A list of URLs to include as media attachments as part of the message.
     # @return [List of String]
     attr_accessor :media
 
-    # TODO: Write general description for this method
+    # A custom string that will be included in callback events of the message.
+    # Max 1024 characters
     # @return [String]
     attr_accessor :tag
 
+    # The message's priority, currently for toll-free or short code SMS only.
+    # Messages with a priority value of `"high"` are given preference over your
+    # other traffic.
+    # @return [PriorityEnum]
+    attr_accessor :priority
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -39,6 +47,7 @@ module Bandwidth
       @_hash['text'] = 'text'
       @_hash['media'] = 'media'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -47,13 +56,15 @@ module Bandwidth
                    from = nil,
                    text = nil,
                    media = nil,
-                   tag = nil)
+                   tag = nil,
+                   priority = nil)
       @application_id = application_id
       @to = to
       @from = from
       @text = text
       @media = media
       @tag = tag
+      @priority = priority
     end
 
     # Creates an instance of the object from a hash.
@@ -67,6 +78,7 @@ module Bandwidth
       text = hash['text']
       media = hash['media']
       tag = hash['tag']
+      priority = hash['priority']
 
       # Create object from extracted values.
       MessageRequest.new(application_id,
@@ -74,7 +86,8 @@ module Bandwidth
                          from,
                          text,
                          media,
-                         tag)
+                         tag,
+                         priority)
     end
   end
 end

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

@@ -0,0 +1,62 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # PageInfo Model.
+  class PageInfo < BaseModel
+    # The link to the previous page for pagination
+    # @return [String]
+    attr_accessor :prev_page
+
+    # The link to the next page for pagination
+    # @return [String]
+    attr_accessor :next_page
+
+    # The isolated pagination token for the previous page
+    # @return [String]
+    attr_accessor :prev_page_token
+
+    # The isolated pagination token for the next page
+    # @return [String]
+    attr_accessor :next_page_token
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['prev_page'] = 'prevPage'
+      @_hash['next_page'] = 'nextPage'
+      @_hash['prev_page_token'] = 'prevPageToken'
+      @_hash['next_page_token'] = 'nextPageToken'
+      @_hash
+    end
+
+    def initialize(prev_page = nil,
+                   next_page = nil,
+                   prev_page_token = nil,
+                   next_page_token = nil)
+      @prev_page = prev_page
+      @next_page = next_page
+      @prev_page_token = prev_page_token
+      @next_page_token = next_page_token
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      prev_page = hash['prevPage']
+      next_page = hash['nextPage']
+      prev_page_token = hash['prevPageToken']
+      next_page_token = hash['nextPageToken']
+
+      # Create object from extracted values.
+      PageInfo.new(prev_page,
+                   next_page,
+                   prev_page_token,
+                   next_page_token)
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # The message's priority, currently for toll-free or short code SMS only.
+  # Messages with a priority value of `"high"` are given preference over your
+  # other traffic.
+  class PriorityEnum
+    PRIORITY_ENUM = [
+      # TODO: Write general description for DEFAULT
+      DEFAULT = 'default'.freeze,
+
+      # TODO: Write general description for HIGH
+      HIGH = 'high'.freeze
+    ].freeze
+  end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb

@@ -14,7 +14,9 @@ require_relative 'two_factor_auth/models/two_factor_verify_request_schema.rb'
 require_relative 'two_factor_auth/models/two_factor_verify_code_response.rb'
 
 # Exceptions
-require_relative 'two_factor_auth/exceptions/invalid_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/error_with_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/unauthorized_request_exception.rb'
+require_relative 'two_factor_auth/exceptions/forbidden_request_exception.rb'
 # Controllers
 require_relative 'two_factor_auth/controllers/base_controller.rb'
-require_relative 'two_factor_auth/controllers/api_controller.rb'
+require_relative 'two_factor_auth/controllers/mfa_controller.rb'

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/client.rb

@@ -9,10 +9,10 @@ module Bandwidth
       class Client
         attr_reader :config
 
-        # Access to client controller.
-        # @return [APIController] Returns the controller instance.
-        def client
-          @client ||= APIController.new config
+        # Access to mfa controller.
+        # @return [MFAController] Returns the controller instance.
+        def mfa
+          @mfa ||= MFAController.new config
         end
 
         def initialize(timeout: 60, max_retries: 0, retry_interval: 1,

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/base_controller.rb

@@ -13,7 +13,7 @@ module Bandwidth
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'ruby-sdk-refs/tags/ruby3.12.1'
+        'user-agent' => 'ruby-sdk'
       }
     end
 

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/{api_controller.rb → mfa_controller.rb}

@@ -5,13 +5,13 @@
 
 module Bandwidth
 module TwoFactorAuth
-  # APIController
-  class APIController < BaseController
+  # MFAController
+  class MFAController < BaseController
     def initialize(config, http_call_back: nil)
       super(config, http_call_back: http_call_back)
     end
 
-    # Two-Factor authentication with Bandwidth Voice services
+    # Allows a user to send a MFA code through a phone call
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Voice service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -23,7 +23,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/voice'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -44,8 +44,23 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -58,7 +73,7 @@ module TwoFactorAuth
       )
     end
 
-    # Two-Factor authentication with Bandwidth messaging services
+    # Allows a user to send a MFA code through a text message (SMS)
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Messaging service enabled
     # @param [TwoFactorCodeRequestSchema] body Required parameter: Example:
@@ -70,7 +85,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/messaging'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -91,8 +106,23 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end
@@ -106,7 +136,7 @@ module TwoFactorAuth
       )
     end
 
-    # Verify a previously sent two-factor authentication code
+    # Allows a user to verify an MFA code
     # @param [String] account_id Required parameter: Bandwidth Account ID with
     # Two-Factor enabled
     # @param [TwoFactorVerifyRequestSchema] body Required parameter: Example:
@@ -118,7 +148,7 @@ module TwoFactorAuth
       _query_builder << '/accounts/{accountId}/code/verify'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'accountId' => { 'value' => account_id, 'encode' => true }
+        'accountId' => { 'value' => account_id, 'encode' => false }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -139,8 +169,29 @@ module TwoFactorAuth
 
       # Validate response against endpoint and global error codes.
       if _response.status_code == 400
-        raise InvalidRequestException.new(
-          'client request error',
+        raise ErrorWithRequestException.new(
+          'If there is any issue with values passed in by the user',
+          _response
+        )
+      elsif _response.status_code == 401
+        raise UnauthorizedRequestException.new(
+          'Authentication is either incorrect or not present',
+          _response
+        )
+      elsif _response.status_code == 403
+        raise ForbiddenRequestException.new(
+          'The user is not authorized to access this resource',
+          _response
+        )
+      elsif _response.status_code == 429
+        raise ErrorWithRequestException.new(
+          'The user has made too many bad requests and is temporarily locked' \
+          ' out',
+          _response
+        )
+      elsif _response.status_code == 500
+        raise ErrorWithRequestException.new(
+          'An internal server error occurred',
           _response
         )
       end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/error_with_request_exception.rb

@@ -0,0 +1,34 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # ErrorWithRequest class.
+  class ErrorWithRequestException < APIException
+    # An error message pertaining to what the issue could be
+    # @return [String]
+    attr_accessor :error
+
+    # The associated requestId from AWS
+    # @return [String]
+    attr_accessor :request_id
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
+      @error = hash['error']
+      @request_id = hash['requestId']
+    end
+  end
+end