bandwidth-sdk 2.1.1 → 3.7.0

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

@@ -0,0 +1,49 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # BaseController.
+  class BaseController
+    attr_accessor :config, :http_call_back
+
+    def initialize(config, http_call_back: nil)
+      @config = config
+      @http_call_back = http_call_back
+
+      @global_headers = {
+        'user-agent' => 'ruby-sdk-refs/tags/ruby3.7.0'
+      }
+    end
+
+    def validate_parameters(args)
+      args.each do |_name, value|
+        if value.nil?
+          raise ArgumentError, "Required parameter #{_name} cannot be nil."
+        end
+      end
+    end
+
+    def execute_request(request, binary: false)
+      @http_call_back.on_before_request(request) if @http_call_back
+
+      APIHelper.clean_hash(request.headers)
+      request.headers.merge!(@global_headers)
+
+      response = if binary
+                   config.http_client.execute_as_binary(request)
+                 else
+                   config.http_client.execute_as_string(request)
+                 end
+      @http_call_back.on_after_response(response) if @http_call_back
+
+      response
+    end
+
+    def validate_response(response)
+      raise APIException.new 'HTTP Response Not OK', response unless
+        response.status_code.between?(200, 208) # [200,208] = HTTP OK
+    end
+  end
+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

@@ -0,0 +1,88 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorCodeRequestSchema Model.
+  class TwoFactorCodeRequestSchema < BaseModel
+    # The phone number to send the 2fa code to.
+    # @return [String]
+    attr_accessor :to
+
+    # The application phone number, the sender of the 2fa code.
+    # @return [String]
+    attr_accessor :from
+
+    # The application unique ID, obtained from Bandwidth.
+    # @return [String]
+    attr_accessor :application_id
+
+    # 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?
+      @_hash['to'] = 'to'
+      @_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.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      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
+end

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

@@ -0,0 +1,35 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorMessagingResponse Model.
+  class TwoFactorMessagingResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :message_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['message_id'] = 'messageId'
+      @_hash
+    end
+
+    def initialize(message_id = nil)
+      @message_id = message_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      message_id = hash['messageId']
+
+      # Create object from extracted values.
+      TwoFactorMessagingResponse.new(message_id)
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorVerifyCodeResponse Model.
+  class TwoFactorVerifyCodeResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [Boolean]
+    attr_accessor :valid
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['valid'] = 'valid'
+      @_hash
+    end
+
+    def initialize(valid = nil)
+      @valid = valid
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      valid = hash['valid']
+
+      # Create object from extracted values.
+      TwoFactorVerifyCodeResponse.new(valid)
+    end
+  end
+end

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

@@ -0,0 +1,94 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorVerifyRequestSchema Model.
+  class TwoFactorVerifyRequestSchema < BaseModel
+    # The phone number to send the 2fa code to.
+    # @return [String]
+    attr_accessor :to
+
+    # The application phone number, the sender of the 2fa code.
+    # @return [String]
+    attr_accessor :from
+
+    # The application unique ID, obtained from Bandwidth.
+    # @return [String]
+    attr_accessor :application_id
+
+    # 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 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['to'] = 'to'
+      @_hash['from'] = 'from'
+      @_hash['application_id'] = 'applicationId'
+      @_hash['scope'] = 'scope'
+      @_hash['digits'] = 'digits'
+      @_hash['expiration_time_in_minutes'] = 'expirationTimeInMinutes'
+      @_hash['code'] = 'code'
+      @_hash
+    end
+
+    def initialize(to = nil,
+                   from = nil,
+                   application_id = 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
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      to = hash['to']
+      from = hash['from']
+      application_id = hash['applicationId']
+      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,
+                                       digits,
+                                       expiration_time_in_minutes,
+                                       code,
+                                       scope)
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # TwoFactorVoiceResponse Model.
+  class TwoFactorVoiceResponse < BaseModel
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :call_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['call_id'] = 'callId'
+      @_hash
+    end
+
+    def initialize(call_id = nil)
+      @call_id = call_id
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      call_id = hash['callId']
+
+      # Create object from extracted values.
+      TwoFactorVoiceResponse.new(call_id)
+    end
+  end
+end

data/lib/bandwidth/utilities/file_wrapper.rb

@@ -0,0 +1,17 @@
+# bandwidth
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Bandwidth
+  # A utility to allow users to set the content-type for files
+  class FileWrapper
+    attr_reader :content_type
+    attr_reader :file
+
+    def initialize(file, content_type: 'application/octet-stream')
+      @file = file
+      @content_type = content_type
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/bridge.rb

@@ -0,0 +1,22 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Bridge verb allows you to connect 2 calls 
+    class Bridge
+      include XmlVerb
+
+      def to_bxml(xml)
+        xml.Bridge(call_id, compact_hash({
+         'bridgeCompleteUrl' => bridge_complete_url,
+         'bridgeCompleteMethod' => bridge_complete_method,
+         'bridgeTargetCompleteUrl' => bridge_target_complete_url,
+         'bridgeTargetCompleteMethod' => bridge_target_complete_method,
+         'username' => username,
+         'password' => password,
+         'tag' => tag
+        }))
+      end
+    end
+  end
+end

data/lib/bandwidth/voice_lib/bxml/verbs/conference.rb

@@ -0,0 +1,28 @@
+require_relative 'xml_verb'
+
+module Bandwidth 
+  module Voice 
+    # The Conference verb is used to add callees to conferences 
+    class Conference
+      include XmlVerb
+
+      def to_bxml(xml)
+        if not call_ids_to_coach.nil?
+          coach_ids = call_ids_to_coach.instance_of?(String) ? call_ids_to_coach : call_ids_to_coach.join(",")
+        else
+          coach_ids = nil
+        end
+        xml.Conference(conference_name, compact_hash({
+         'mute' => mute,
+         'hold' => hold,
+         'callIdsToCoach' => coach_ids,
+         'conferenceEventUrl' => conference_event_url,
+         'conferenceEventMethod' => conference_event_method,
+         'username' => username,
+         'password' => password,
+         'tag' => tag
+        }))
+      end
+    end
+  end
+end