bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/exceptions/api_exception.rb

@@ -0,0 +1,21 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Class for exceptions when there is a network error, status code error, etc.
+  class APIException < CoreLibrary::ApiException
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status_code: #{@response_code.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/http/http_call_back.rb

@@ -0,0 +1,10 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # HttpCallBack allows defining callables for pre and post API calls.
+  class HttpCallBack < CoreLibrary::HttpCallback
+  end
+end

data/lib/boku_direct_payments_api/http/http_method_enum.rb

@@ -0,0 +1,10 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # HTTP Methods Enumeration.
+  class HttpMethodEnum < CoreLibrary::HttpMethod
+  end
+end

data/lib/boku_direct_payments_api/http/http_request.rb

@@ -0,0 +1,10 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Represents a single Http Request.
+  class HttpRequest < CoreLibrary::HttpRequest
+  end
+end

data/lib/boku_direct_payments_api/http/http_response.rb

@@ -0,0 +1,10 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Http response received.
+  class HttpResponse < CoreLibrary::HttpResponse
+  end
+end

data/lib/boku_direct_payments_api/http/proxy_settings.rb

@@ -0,0 +1,22 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  ##
+  # ProxySettings encapsulates HTTP proxy configuration for Faraday,
+  # including optional basic authentication.
+  #
+  class ProxySettings < CoreLibrary::ProxySettings
+    def self.from_env
+      address = ENV['PROXY_ADDRESS']
+      port = ENV['PROXY_PORT']
+      username = ENV['PROXY_USERNAME']
+      password = ENV['PROXY_PASSWORD']
+      return nil if address.nil? || address.strip.empty?
+
+      new(address: address, port: port, username: username, password: password)
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/account_profile.rb

@@ -0,0 +1,122 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # **DISCLAIMER: This API or element is use-case specific and not needed for
+  # generic usage of  our payment product. Please disregard unless otherwise
+  # directed to include in your integration.** Returned if result.status == OK
+  # and the include-account-profile flag in the request is not explicitly set to
+  # false.
+  class AccountProfile < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountProfileAttribute]]
+    attr_accessor :carrier_data
+
+    # TODO: Write general description for this method
+    # @return [Array[AccountProfileAttribute]]
+    attr_accessor :local_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['carrier_data'] = 'carrier-data'
+      @_hash['local_data'] = 'local-data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        carrier_data
+        local_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(carrier_data = SKIP, local_data = SKIP)
+      @carrier_data = carrier_data unless carrier_data == SKIP
+      @local_data = local_data unless local_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      # Parameter is an array, so we need to iterate through it
+      carrier_data = nil
+      unless hash['carrier-data'].nil?
+        carrier_data = []
+        hash['carrier-data'].each do |structure|
+          carrier_data << (AccountProfileAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      carrier_data = SKIP unless hash.key?('carrier-data')
+      # Parameter is an array, so we need to iterate through it
+      local_data = nil
+      unless hash['local-data'].nil?
+        local_data = []
+        hash['local-data'].each do |structure|
+          local_data << (AccountProfileAttribute.from_hash(structure) if structure)
+        end
+      end
+
+      local_data = SKIP unless hash.key?('local-data')
+
+      # Create object from extracted values.
+      AccountProfile.new(carrier_data,
+                         local_data)
+    end
+
+    def self.from_element(root)
+      carrier_data = XmlUtilities.from_element_to_array(
+        root, 'AccountProfileAttribute', AccountProfileAttribute,
+        wrapping_element_name: 'carrier-data'
+      )
+      local_data = XmlUtilities.from_element_to_array(
+        root, 'AccountProfileAttribute', AccountProfileAttribute,
+        wrapping_element_name: 'local-data'
+      )
+
+      new(carrier_data,
+          local_data)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_array_as_subelement(
+        doc, root, 'AccountProfileAttribute', carrier_data,
+        wrapping_element_name: 'carrier-data'
+      )
+      XmlUtilities.add_array_as_subelement(doc, root, 'AccountProfileAttribute',
+                                           local_data,
+                                           wrapping_element_name: 'local-data')
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_data: #{@carrier_data}, local_data: #{@local_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} carrier_data: #{@carrier_data.inspect}, local_data:"\
+      " #{@local_data.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/account_profile_attribute.rb

@@ -0,0 +1,90 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # **DISCLAIMER: This API or element is use-case specific and not needed for
+  # generic usage of our payment product. Please disregard unless otherwise
+  # directed to include in your integration.**
+  class AccountProfileAttribute < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :key
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP, value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      key = hash.key?('key') ? hash['key'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      AccountProfileAttribute.new(key,
+                                  value)
+    end
+
+    def self.from_element(root)
+      key = XmlUtilities.from_attribute(root, 'key', String)
+      value = XmlUtilities.from_element(root, 'value', String)
+
+      new(key,
+          value)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'key', key)
+      XmlUtilities.add_as_subelement(doc, root, 'value', value)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/account_profile_request.rb

@@ -0,0 +1,131 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'account-profile-request' Request general elements
+  class AccountProfileRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Container element for a list of account profile selectors.
+    # @return [Array[AccountProfileSelector]]
+    attr_accessor :selectors
+
+    # true (default) to include carrier profile data in the response; false only
+    # include data local to Boku
+    # @return [TrueClass | FalseClass]
+    attr_accessor :include_carrier_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['selectors'] = 'selectors'
+      @_hash['include_carrier_data'] = 'include-carrier-data'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        include_carrier_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, selectors = nil,
+                   include_carrier_data = SKIP)
+      @country = country
+      @merchant_id = merchant_id
+      @selectors = selectors
+      @include_carrier_data = include_carrier_data unless include_carrier_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      country = hash.key?('country') ? hash['country'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      # Parameter is an array, so we need to iterate through it
+      selectors = nil
+      unless hash['selectors'].nil?
+        selectors = []
+        hash['selectors'].each do |structure|
+          selectors << (AccountProfileSelector.from_hash(structure) if structure)
+        end
+      end
+
+      selectors = nil unless hash.key?('selectors')
+      include_carrier_data =
+        hash.key?('include-carrier-data') ? hash['include-carrier-data'] : SKIP
+
+      # Create object from extracted values.
+      AccountProfileRequest.new(country,
+                                merchant_id,
+                                selectors,
+                                include_carrier_data)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      selectors = XmlUtilities.from_element_to_array(
+        root, 'AccountProfileSelector', AccountProfileSelector,
+        wrapping_element_name: 'selectors'
+      )
+      include_carrier_data = XmlUtilities.from_element(root,
+                                                       'include-carrier-data',
+                                                       TrueClass)
+
+      new(country,
+          merchant_id,
+          selectors,
+          include_carrier_data)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_array_as_subelement(doc, root, 'AccountProfileSelector',
+                                           selectors,
+                                           wrapping_element_name: 'selectors')
+      XmlUtilities.add_as_subelement(doc, root, 'include-carrier-data',
+                                     include_carrier_data)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country}, merchant_id: #{@merchant_id}, selectors:"\
+      " #{@selectors}, include_carrier_data: #{@include_carrier_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " selectors: #{@selectors.inspect}, include_carrier_data: #{@include_carrier_data.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/account_profile_response.rb

@@ -0,0 +1,104 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'account-profile' Response - General Elements
+  class AccountProfileResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Result]
+    attr_accessor :result
+
+    # Container element for a list of returned record elements. Provided if
+    # result status == OK.
+    # @return [Array[AccountProfileResponseRecord]]
+    attr_accessor :records
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['records'] = 'records'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        records
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, records = SKIP)
+      @result = result
+      @records = records unless records == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      result = Result.from_hash(hash['result']) if hash['result']
+      # Parameter is an array, so we need to iterate through it
+      records = nil
+      unless hash['records'].nil?
+        records = []
+        hash['records'].each do |structure|
+          records << (AccountProfileResponseRecord.from_hash(structure) if structure)
+        end
+      end
+
+      records = SKIP unless hash.key?('records')
+
+      # Create object from extracted values.
+      AccountProfileResponse.new(result,
+                                 records)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      records = XmlUtilities.from_element_to_array(
+        root, 'AccountProfileResponseRecord',
+        AccountProfileResponseRecord, wrapping_element_name: 'records'
+      )
+
+      new(result,
+          records)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_array_as_subelement(doc, root,
+                                           'AccountProfileResponseRecord',
+                                           records,
+                                           wrapping_element_name: 'records')
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, records: #{@records}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, records: #{@records.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/account_profile_response_record.rb

@@ -0,0 +1,142 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Container element for a list of returned record elements. Provided if result
+  # status == OK.
+  class AccountProfileResponseRecord < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the operation
+    # @return [AccountProfileResultStatusEnum]
+    attr_accessor :result
+
+    # Account Profile Selector - General elements
+    # @return [AccountProfileSelector]
+    attr_accessor :selector
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of 
+    # our payment product. Please disregard unless otherwise directed to include
+    # in your integration.**
+    # Returned if result.status == OK and the include-account-profile flag in
+    # the request is not explicitly set to false.
+    # @return [AccountProfile]
+    attr_accessor :account_profile
+
+    # **DISCLAIMER: This API or element is use-case specific and not needed for
+    # generic usage of 
+    # our payment product. Please disregard unless otherwise directed to include
+    # in your integration.**
+    # Returned if result.status == OK and the include-account-profile flag in
+    # the request is not explicitly set to false.
+    # @return [String]
+    attr_accessor :optin_id
+
+    # Gives the state of the opt-in at the time this response was returned
+    # @return [OptinState]
+    attr_accessor :optin_state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['selector'] = 'selector'
+      @_hash['account_profile'] = 'account-profile'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash['optin_state'] = 'optin-state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_profile
+        optin_id
+        optin_state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, selector = nil, account_profile = SKIP,
+                   optin_id = SKIP, optin_state = SKIP)
+      @result = result
+      @selector = selector
+      @account_profile = account_profile unless account_profile == SKIP
+      @optin_id = optin_id unless optin_id == SKIP
+      @optin_state = optin_state unless optin_state == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      result = hash.key?('result') ? hash['result'] : nil
+      selector = AccountProfileSelector.from_hash(hash['selector']) if hash['selector']
+      account_profile = AccountProfile.from_hash(hash['account-profile']) if
+        hash['account-profile']
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : SKIP
+      optin_state = OptinState.from_hash(hash['optin-state']) if hash['optin-state']
+
+      # Create object from extracted values.
+      AccountProfileResponseRecord.new(result,
+                                       selector,
+                                       account_profile,
+                                       optin_id,
+                                       optin_state)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', String)
+      selector = XmlUtilities.from_element(root, 'AccountProfileSelector',
+                                           AccountProfileSelector)
+      account_profile = XmlUtilities.from_element(root, 'AccountProfile',
+                                                  AccountProfile)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      optin_state = XmlUtilities.from_element(root, 'optin-state', OptinState)
+
+      new(result,
+          selector,
+          account_profile,
+          optin_id,
+          optin_state)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'AccountProfileSelector',
+                                     selector)
+      XmlUtilities.add_as_subelement(doc, root, 'AccountProfile',
+                                     account_profile)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-id', optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-state', optin_state)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, selector: #{@selector}, account_profile:"\
+      " #{@account_profile}, optin_id: #{@optin_id}, optin_state: #{@optin_state}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, selector: #{@selector.inspect},"\
+      " account_profile: #{@account_profile.inspect}, optin_id: #{@optin_id.inspect}, optin_state:"\
+      " #{@optin_state.inspect}>"
+    end
+  end
+end