bandwidth-sdk 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc4d4b047d53e1e8c3f34b37696455d916a753aa3566dad6d6fb666fc2b3fa61
-  data.tar.gz: b5cdf37c09788e890f36ef3c78ccf41f0ba18a69291f1424be7f798f207881f9
+  metadata.gz: e18aadfe51bc80e15e60e4bc4d67b175f10a6c5675c25eadccd4f8a878253dbb
+  data.tar.gz: 10f37b0a59cb13126b410b549372a54ab7aac33ae3bd236ecb058692a981bbe4
 SHA512:
-  metadata.gz: 59761140cdddf9f6cda37d7aeeaeff6341a5c0bcc357cf577ae29e8fff0a6cf347f1070536f99db3b2f3f6baae3c2b93edbefb2e94468036c57ffd7a65c279b0
-  data.tar.gz: bdf68653a8640403d2bc5402c9f5af06055079640ab9229b16ac12cf48290ccffbe2ac38e40c11c3e6b518b1ebaad05344779249d0f79c940d32c3a57b36f5ed
+  metadata.gz: 52c78cc210f261df7338ef3fea73c6a1ac7e1b15ed247fc7631db68ea9caaf7b9b09465e9694dfd4de83fd5d4ed53d9a57d421a0dfc66da71109911024d01490
+  data.tar.gz: 06404ecbc6c77c435ccb96b56369916120d25d7124ef57850231f59f92ee16d8b7520042d838614a126bca4fec1829f21d5d05d57f9fe28066126060a911b71f

data/lib/bandwidth/configuration.rb

@@ -156,7 +156,7 @@ module Bandwidth
       Environment::PRODUCTION => {
         Server::DEFAULT => 'api.bandwidth.com',
         Server::MESSAGINGDEFAULT => 'https://messaging.bandwidth.com/api/v2',
-        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1/',
+        Server::TWOFACTORAUTHDEFAULT => 'https://mfa.bandwidth.com/api/v1',
         Server::VOICEDEFAULT => 'https://voice.bandwidth.com',
         Server::WEBRTCDEFAULT => 'https://api.webrtc.bandwidth.com/v1'
       },

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/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/message_request.rb

@@ -32,6 +32,12 @@ module Bandwidth
     # @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?
@@ -41,6 +47,7 @@ module Bandwidth
       @_hash['text'] = 'text'
       @_hash['media'] = 'media'
       @_hash['tag'] = 'tag'
+      @_hash['priority'] = 'priority'
       @_hash
     end
 
@@ -49,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.
@@ -69,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,
@@ -76,7 +86,8 @@ module Bandwidth
                          from,
                          text,
                          media,
-                         tag)
+                         tag,
+                         priority)
     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/{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:
@@ -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:
@@ -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:
@@ -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

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/{invalid_request_exception.rb → forbidden_request_exception.rb}

@@ -4,11 +4,11 @@
 # ( https://apimatic.io ).
 
 module Bandwidth
-  # InvalidRequest class.
-  class InvalidRequestException < APIException
-    # An error message pertaining to what the issue could be
+  # ForbiddenRequest class.
+  class ForbiddenRequestException < APIException
+    # The message containing the reason behind the request being forbidden
     # @return [String]
-    attr_accessor :result
+    attr_accessor :message
 
     # The constructor.
     # @param [String] The reason for raising an exception.
@@ -23,7 +23,7 @@ module Bandwidth
     # @param [Hash] The deserialized response sent by the server in the
     # response body.
     def unbox(hash)
-      @result = hash['result']
+      @message = hash['Message']
     end
   end
 end

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

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # UnauthorizedRequest class.
+  class UnauthorizedRequestException < APIException
+    # The message containing the reason behind the request being unauthorized
+    # @return [String]
+    attr_accessor :message
+
+    # 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)
+      @message = hash['message']
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -177,13 +177,16 @@ files:
 - lib/bandwidth/messaging_lib/messaging/models/media.rb
 - lib/bandwidth/messaging_lib/messaging/models/message_request.rb
 - lib/bandwidth/messaging_lib/messaging/models/page_info.rb
+- lib/bandwidth/messaging_lib/messaging/models/priority_enum.rb
 - lib/bandwidth/messaging_lib/messaging/models/tag.rb
 - lib/bandwidth/models/base_model.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth/client.rb
-- lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/base_controller.rb
-- lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/invalid_request_exception.rb
+- lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/mfa_controller.rb
+- lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/error_with_request_exception.rb
+- lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/forbidden_request_exception.rb
+- lib/bandwidth/two_factor_auth_lib/two_factor_auth/exceptions/unauthorized_request_exception.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_code_request_schema.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_messaging_response.rb
 - lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_verify_code_response.rb