bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/forex_request.rb

@@ -0,0 +1,97 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ForexRequest Model.
+  class ForexRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Source ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :from
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Destination ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['from'] = 'from'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['to'] = 'to'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(from = nil, merchant_id = nil, to = nil)
+      @from = from
+      @merchant_id = merchant_id
+      @to = to
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      from = hash.key?('from') ? hash['from'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      to = hash.key?('to') ? hash['to'] : nil
+
+      # Create object from extracted values.
+      ForexRequest.new(from,
+                       merchant_id,
+                       to)
+    end
+
+    def self.from_element(root)
+      from = XmlUtilities.from_element(root, 'from', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      to = XmlUtilities.from_element(root, 'to', String)
+
+      new(from,
+          merchant_id,
+          to)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'from', from)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'to', to)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from: #{@from}, merchant_id: #{@merchant_id}, to: #{@to}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} from: #{@from.inspect}, merchant_id: #{@merchant_id.inspect}, to:"\
+      " #{@to.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/forex_response.rb

@@ -0,0 +1,127 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ForexResponse Model.
+  class ForexResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # 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
+
+    # Latest available foreign exchange rate between source and destination
+    # currency.
+    # @return [Float]
+    attr_accessor :exchange_rate
+
+    # Source ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :from
+
+    # Destination ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :to
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['result'] = 'result'
+      @_hash['exchange_rate'] = 'exchange-rate'
+      @_hash['from'] = 'from'
+      @_hash['to'] = 'to'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        exchange_rate
+        from
+        to
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, result = nil, exchange_rate = SKIP,
+                   from = SKIP, to = SKIP)
+      @merchant_id = merchant_id
+      @result = result
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @from = from unless from == SKIP
+      @to = to unless to == 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.
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      exchange_rate = hash.key?('exchange-rate') ? hash['exchange-rate'] : SKIP
+      from = hash.key?('from') ? hash['from'] : SKIP
+      to = hash.key?('to') ? hash['to'] : SKIP
+
+      # Create object from extracted values.
+      ForexResponse.new(merchant_id,
+                        result,
+                        exchange_rate,
+                        from,
+                        to)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      exchange_rate = XmlUtilities.from_element(root, 'exchange-rate', Float)
+      from = XmlUtilities.from_element(root, 'from', String)
+      to = XmlUtilities.from_element(root, 'to', String)
+
+      new(merchant_id,
+          result,
+          exchange_rate,
+          from,
+          to)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'exchange-rate', exchange_rate)
+      XmlUtilities.add_as_subelement(doc, root, 'from', from)
+      XmlUtilities.add_as_subelement(doc, root, 'to', to)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id}, result: #{@result}, exchange_rate:"\
+      " #{@exchange_rate}, from: #{@from}, to: #{@to}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id.inspect}, result: #{@result.inspect},"\
+      " exchange_rate: #{@exchange_rate.inspect}, from: #{@from.inspect}, to: #{@to.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/fund_check_request.rb

@@ -0,0 +1,132 @@
+# 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.** 'fund-check' Request - General
+  # Parameters
+  class FundCheckRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount to be charged in the next charge request, against which the fund
+    # check is performed.
+    # @return [Float]
+    attr_accessor :amount
+
+    # ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Merchant-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Boku-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :optin_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['amount'] = 'amount'
+      @_hash['currency'] = 'currency'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_optin_id
+        optin_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(amount = nil, currency = nil, merchant_id = nil,
+                   merchant_optin_id = SKIP, optin_id = SKIP)
+      @amount = amount
+      @currency = currency
+      @merchant_id = merchant_id
+      @merchant_optin_id = merchant_optin_id unless merchant_optin_id == SKIP
+      @optin_id = optin_id unless optin_id == 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.
+      amount = hash.key?('amount') ? hash['amount'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_optin_id =
+        hash.key?('merchant-optin-id') ? hash['merchant-optin-id'] : SKIP
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : SKIP
+
+      # Create object from extracted values.
+      FundCheckRequest.new(amount,
+                           currency,
+                           merchant_id,
+                           merchant_optin_id,
+                           optin_id)
+    end
+
+    def self.from_element(root)
+      amount = XmlUtilities.from_element(root, 'amount', Float)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+
+      new(amount,
+          currency,
+          merchant_id,
+          merchant_optin_id,
+          optin_id)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'amount', amount)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-optin-id',
+                                     merchant_optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-id', optin_id)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount}, currency: #{@currency}, merchant_id: #{@merchant_id},"\
+      " merchant_optin_id: #{@merchant_optin_id}, optin_id: #{@optin_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} amount: #{@amount.inspect}, currency: #{@currency.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, merchant_optin_id: #{@merchant_optin_id.inspect}, optin_id:"\
+      " #{@optin_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/fund_check_response.rb

@@ -0,0 +1,89 @@
+# 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.** 'fund-check' Response - General
+  # Parameters
+  class FundCheckResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # 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
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['result'] = 'result'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, result = nil)
+      @merchant_id = merchant_id
+      @result = result
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+
+      # Create object from extracted values.
+      FundCheckResponse.new(merchant_id,
+                            result)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+
+      new(merchant_id,
+          result)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id}, result: #{@result}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_id: #{@merchant_id.inspect}, result: #{@result.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/invalid_request_field.rb

@@ -0,0 +1,93 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Provides per-field error information when the submitted request does not
+  # satisfy validation constraints.
+  class InvalidRequestField < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Property path of the field in error. The element or attribute name is
+    # given in camel-case, with nested objects delimited by `.` (period).
+    # If there are multiple distinct errors regarding a particular field, it may
+    # appear more than once. I.e., `field[path]` is not necessarily unique.
+    # @return [String]
+    attr_accessor :path
+
+    # A descriptive reason why the field was invalid. This message is not
+    # localized and is not appropriate for user messaging.
+    # @return [String]
+    attr_accessor :reason
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['path'] = 'path'
+      @_hash['reason'] = 'reason'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        path
+        reason
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(path = SKIP, reason = SKIP)
+      @path = path unless path == SKIP
+      @reason = reason unless reason == 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.
+      path = hash.key?('path') ? hash['path'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+
+      # Create object from extracted values.
+      InvalidRequestField.new(path,
+                              reason)
+    end
+
+    def self.from_element(root)
+      path = XmlUtilities.from_attribute(root, 'path', String)
+      reason = XmlUtilities.from_attribute(root, 'reason', String)
+
+      new(path,
+          reason)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'path', path)
+      XmlUtilities.add_as_attribute(root, 'reason', reason)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} path: #{@path}, reason: #{@reason}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} path: #{@path.inspect}, reason: #{@reason.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/mandate_constraint.rb

@@ -0,0 +1,92 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Defines transaction behavior constraints associated with a mandate. This
+  # field is used to specify conditions under which transactions may be
+  # processed. Applicable only when `optin-purpose` is set to
+  # `standing-approval-mandate` or `subscription-mandate`and `optin-type` is set
+  # to `hosted`.
+  class MandateConstraint < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Period over which the specified maximum amount will be enforced.
+    # @return [MandatePeriodEnum]
+    attr_accessor :mandate_period
+
+    # The maximum amount that can be processed per period.
+    # @return [Float]
+    attr_accessor :max_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['mandate_period'] = 'mandate-period'
+      @_hash['max_amount'] = 'max-amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(mandate_period = nil, max_amount = nil)
+      @mandate_period = mandate_period
+      @max_amount = max_amount
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      mandate_period =
+        hash.key?('mandate-period') ? hash['mandate-period'] : nil
+      max_amount = hash.key?('max-amount') ? hash['max-amount'] : nil
+
+      # Create object from extracted values.
+      MandateConstraint.new(mandate_period,
+                            max_amount)
+    end
+
+    def self.from_element(root)
+      mandate_period = XmlUtilities.from_element(root, 'mandate-period', String)
+      max_amount = XmlUtilities.from_element(root, 'max-amount', Float)
+
+      new(mandate_period,
+          max_amount)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'mandate-period',
+                                     mandate_period)
+      XmlUtilities.add_as_subelement(doc, root, 'max-amount', max_amount)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mandate_period: #{@mandate_period}, max_amount: #{@max_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} mandate_period: #{@mandate_period.inspect}, max_amount:"\
+      " #{@max_amount.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/mandate_period_enum.rb

@@ -0,0 +1,48 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Period over which the specified maximum amount will be enforced.
+  class MandatePeriodEnum
+    MANDATE_PERIOD_ENUM = [
+      # TODO: Write general description for DAY
+      DAY = 'day'.freeze,
+
+      # TODO: Write general description for WEEK
+      WEEK = 'week'.freeze,
+
+      # TODO: Write general description for MONTH
+      MONTH = 'month'.freeze,
+
+      # TODO: Write general description for YEAR
+      YEAR = 'year'.freeze,
+
+      # TODO: Write general description for TRANSACTION
+      TRANSACTION = 'transaction'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      MANDATE_PERIOD_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = DAY)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'day' then DAY
+      when 'week' then WEEK
+      when 'month' then MONTH
+      when 'year' then YEAR
+      when 'transaction' then TRANSACTION
+      else
+        default_value
+      end
+    end
+  end
+end