bandwidth-sdk 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7589bdf9914178c33cc9928e5ef7aa125787264250cc0dbe94de6ebd9cc4c728
-  data.tar.gz: 19fe33d12e403fe6d0528591d8a5e9ad4a631b4bb4707f8f9f75de110e21ce04
+  metadata.gz: 48115c5ef2d3c4b9f64d4ef6afce6b6ecb94cdde4b445afb21fc4c1819b079c0
+  data.tar.gz: d9f295c220a2ac75b090ca8a419a1ae2375779119d9cb4bd7a14d09f0f5fed93
 SHA512:
-  metadata.gz: 4729d4bfc676472e949007c92b09b07dae9d14c6c1376e70980eb9455d666620984eb089a02d17105f8dde864579a633136fa47a77beb3a43f8a3a42ee0844e9
-  data.tar.gz: dd15b63a5fb1cb3b6b23d1a912d5f7878c37fd9375f08eee00d190ca6ce9f95e05c67b7aa30adabb9aa77883bfeb652174aa6b1d6eedbba4d7c9cdc44d22d7ee
+  metadata.gz: e0d4a309e16b781e6e020688cc1ab153b171aa6a9f59e1e34ddaa81d442c851623cae0a4fdc9d081d62623cee0935277e28265b8da883c7dc2a66aab0c762093
+  data.tar.gz: d2c7435d3f124001aa11bc8c610336086309b511e65c9744d3007082b03b812c7c14e200005774b5d078b3fb512e62fa483218d7855791efd8206b6868531fc9

data/lib/bandwidth/messaging_lib/messaging/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.4.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.5.0'
       }
     end
 

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth.rb

@@ -14,6 +14,7 @@ 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'
 # Controllers
 require_relative 'two_factor_auth/controllers/base_controller.rb'
 require_relative 'two_factor_auth/controllers/api_controller.rb'

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

@@ -41,6 +41,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.
@@ -79,6 +87,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.
@@ -117,6 +133,14 @@ module TwoFactorAuth
       )
       TwoFactorAuthBasicAuth.apply(config, _request)
       _response = execute_request(_request)
+
+      # Validate response against endpoint and global error codes.
+      if _response.status_code == 400
+        raise InvalidRequestException.new(
+          'client request error',
+          _response
+        )
+      end
       validate_response(_response)
 
       # Return appropriate response type.

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.4.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.5.0'
       }
     end
 

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

@@ -0,0 +1,29 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # InvalidRequest class.
+  class InvalidRequestException < APIException
+    # An error message pertaining to what the issue could be
+    # @return [String]
+    attr_accessor :result
+
+    # 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)
+      @result = hash['result']
+    end
+  end
+end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_code_request_schema.rb

@@ -6,22 +6,38 @@
 module Bandwidth
   # TwoFactorCodeRequestSchema Model.
   class TwoFactorCodeRequestSchema < BaseModel
-    # TODO: Write general description for this method
+    # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The application phone number, the sender of the 2fa code.
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The application unique ID, obtained from Bandwidth.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # An optional field to denote what scope or action the 2fa code is
+    # addressing.  If not supplied, defaults to "2FA".
     # @return [String]
     attr_accessor :scope
 
+    # The message format of the 2fa code.  There are three values that the
+    # system will replace "{CODE}", "{NAME}", "{SCOPE}".  The "{SCOPE}" and
+    # "{NAME} value template are optional, while "{CODE}" must be supplied.  As
+    # the name would suggest, code will be replace with the actual 2fa code. 
+    # Name is replaced with the application name, configured during provisioning
+    # of 2fa.  The scope value is the same value sent during the call and
+    # partitioned by the server.
+    # @return [String]
+    attr_accessor :message
+
+    # The number of digits for your 2fa code.  The valid number ranges from 2 to
+    # 8, inclusively.
+    # @return [Float]
+    attr_accessor :digits
+
     # A mapping from model property names to API property names.
     def self.names
       @_hash = {} if @_hash.nil?
@@ -29,17 +45,23 @@ module Bandwidth
       @_hash['from'] = 'from'
       @_hash['application_id'] = 'applicationId'
       @_hash['scope'] = 'scope'
+      @_hash['message'] = 'message'
+      @_hash['digits'] = 'digits'
       @_hash
     end
 
     def initialize(to = nil,
                    from = nil,
                    application_id = nil,
+                   message = nil,
+                   digits = nil,
                    scope = nil)
       @to = to
       @from = from
       @application_id = application_id
       @scope = scope
+      @message = message
+      @digits = digits
     end
 
     # Creates an instance of the object from a hash.
@@ -50,12 +72,16 @@ module Bandwidth
       to = hash['to']
       from = hash['from']
       application_id = hash['applicationId']
+      message = hash['message']
+      digits = hash['digits']
       scope = hash['scope']
 
       # Create object from extracted values.
       TwoFactorCodeRequestSchema.new(to,
                                      from,
                                      application_id,
+                                     message,
+                                     digits,
                                      scope)
     end
   end

data/lib/bandwidth/two_factor_auth_lib/two_factor_auth/models/two_factor_verify_request_schema.rb

@@ -6,23 +6,36 @@
 module Bandwidth
   # TwoFactorVerifyRequestSchema Model.
   class TwoFactorVerifyRequestSchema < BaseModel
-    # TODO: Write general description for this method
+    # The phone number to send the 2fa code to.
     # @return [String]
     attr_accessor :to
 
-    # TODO: Write general description for this method
+    # The application phone number, the sender of the 2fa code.
     # @return [String]
     attr_accessor :from
 
-    # TODO: Write general description for this method
+    # The application unique ID, obtained from Bandwidth.
     # @return [String]
     attr_accessor :application_id
 
-    # TODO: Write general description for this method
+    # An optional field to denote what scope or action the 2fa code is
+    # addressing.  If not supplied, defaults to "2FA".
     # @return [String]
     attr_accessor :scope
 
-    # TODO: Write general description for this method
+    # The number of digits for your 2fa code.  The valid number ranges from 2 to
+    # 8, inclusively.
+    # @return [Float]
+    attr_accessor :digits
+
+    # The time period, in minutes, to validate the 2fa code.  By setting this to
+    # 3 minutes, it will mean any code generated within the last 3 minutes are
+    # still valid.  The valid range for expiration time is between 0 and 15
+    # minutes, exclusively and inclusively, respectively.
+    # @return [Float]
+    attr_accessor :expiration_time_in_minutes
+
+    # The generated 2fa code to check if valid
     # @return [String]
     attr_accessor :code
 
@@ -33,6 +46,8 @@ module Bandwidth
       @_hash['from'] = 'from'
       @_hash['application_id'] = 'applicationId'
       @_hash['scope'] = 'scope'
+      @_hash['digits'] = 'digits'
+      @_hash['expiration_time_in_minutes'] = 'expirationTimeInMinutes'
       @_hash['code'] = 'code'
       @_hash
     end
@@ -40,12 +55,16 @@ module Bandwidth
     def initialize(to = nil,
                    from = nil,
                    application_id = nil,
-                   scope = nil,
-                   code = nil)
+                   digits = nil,
+                   expiration_time_in_minutes = nil,
+                   code = nil,
+                   scope = nil)
       @to = to
       @from = from
       @application_id = application_id
       @scope = scope
+      @digits = digits
+      @expiration_time_in_minutes = expiration_time_in_minutes
       @code = code
     end
 
@@ -57,15 +76,19 @@ module Bandwidth
       to = hash['to']
       from = hash['from']
       application_id = hash['applicationId']
-      scope = hash['scope']
+      digits = hash['digits']
+      expiration_time_in_minutes = hash['expirationTimeInMinutes']
       code = hash['code']
+      scope = hash['scope']
 
       # Create object from extracted values.
       TwoFactorVerifyRequestSchema.new(to,
                                        from,
                                        application_id,
-                                       scope,
-                                       code)
+                                       digits,
+                                       expiration_time_in_minutes,
+                                       code,
+                                       scope)
     end
   end
 end

data/lib/bandwidth/voice_lib/voice/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.4.0'
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.5.0'
       }
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bandwidth-sdk
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - APIMatic SDK Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -133,6 +133,7 @@ files:
 - 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/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