bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/send_sms.rb

@@ -0,0 +1,89 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Describes an SMS to be sent from the client device.
+  class SendSms < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Destination address (short-code or phone number) to send the message to
+    # @return [String]
+    attr_accessor :destination
+
+    # Body of the message to be sent, containing placeholders that must be
+    # replaced before using
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['destination'] = 'destination'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        destination
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(destination = SKIP, value = SKIP)
+      @destination = destination unless destination == 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.
+      destination = hash.key?('destination') ? hash['destination'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      SendSms.new(destination,
+                  value)
+    end
+
+    def self.from_element(root)
+      destination = XmlUtilities.from_attribute(root, 'destination', String)
+      value = XmlUtilities.from_element(root, 'value', String)
+
+      new(destination,
+          value)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'destination', destination)
+      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} destination: #{@destination}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} destination: #{@destination.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/settlement.rb

@@ -0,0 +1,126 @@
+# 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.** Element containing settlement
+  # information about the original charge.
+  class Settlement < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Merchant-supplied identifier used to route funds to the appropriate
+    # settlement bank account for the transaction.
+    # @return [String]
+    attr_accessor :account_id
+
+    # ISO 4217 three-letter settlement currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # This is the exchange rate that is used to calculate the gross merchant
+    # amount.
+    # gross merchant amount = local currency (charge amount) * exchange rate
+    # @return [Float]
+    attr_accessor :exchange_rate
+
+    # Gross transaction amount converted to desired settlement currency
+    # @return [Float]
+    attr_accessor :gross_merchant_amount
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['account_id'] = 'account-id'
+      @_hash['currency'] = 'currency'
+      @_hash['exchange_rate'] = 'exchange-rate'
+      @_hash['gross_merchant_amount'] = 'gross-merchant-amount'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        account_id
+        currency
+        exchange_rate
+        gross_merchant_amount
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(account_id = SKIP, currency = SKIP, exchange_rate = SKIP,
+                   gross_merchant_amount = SKIP)
+      @account_id = account_id unless account_id == SKIP
+      @currency = currency unless currency == SKIP
+      @exchange_rate = exchange_rate unless exchange_rate == SKIP
+      @gross_merchant_amount = gross_merchant_amount unless gross_merchant_amount == 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.
+      account_id = hash.key?('account-id') ? hash['account-id'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      exchange_rate = hash.key?('exchange-rate') ? hash['exchange-rate'] : SKIP
+      gross_merchant_amount =
+        hash.key?('gross-merchant-amount') ? hash['gross-merchant-amount'] : SKIP
+
+      # Create object from extracted values.
+      Settlement.new(account_id,
+                     currency,
+                     exchange_rate,
+                     gross_merchant_amount)
+    end
+
+    def self.from_element(root)
+      account_id = XmlUtilities.from_element(root, 'account-id', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      exchange_rate = XmlUtilities.from_element(root, 'exchange-rate', Float)
+      gross_merchant_amount = XmlUtilities.from_element(root,
+                                                        'gross-merchant-amount',
+                                                        Float)
+
+      new(account_id,
+          currency,
+          exchange_rate,
+          gross_merchant_amount)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'account-id', account_id)
+      XmlUtilities.add_as_subelement(doc, root, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'exchange-rate', exchange_rate)
+      XmlUtilities.add_as_subelement(doc, root, 'gross-merchant-amount',
+                                     gross_merchant_amount)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id}, currency: #{@currency}, exchange_rate:"\
+      " #{@exchange_rate}, gross_merchant_amount: #{@gross_merchant_amount}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} account_id: #{@account_id.inspect}, currency: #{@currency.inspect},"\
+      " exchange_rate: #{@exchange_rate.inspect}, gross_merchant_amount:"\
+      " #{@gross_merchant_amount.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/silent_mo.rb

@@ -0,0 +1,78 @@
+# 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.** Indicates that this network
+  # supports "silent MO" based opt-in verification, and gives instructions on
+  # the MO to send.
+  class SilentMo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Describes an SMS to be sent from the client device.
+    # @return [SendSms]
+    attr_accessor :send_sms
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['send_sms'] = 'send-sms'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(send_sms = nil)
+      @send_sms = send_sms
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      send_sms = SendSms.from_hash(hash['send-sms']) if hash['send-sms']
+
+      # Create object from extracted values.
+      SilentMo.new(send_sms)
+    end
+
+    def self.from_element(root)
+      send_sms = XmlUtilities.from_element(root, 'SendSms', SendSms)
+
+      new(send_sms)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'SendSms', send_sms)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} send_sms: #{@send_sms}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} send_sms: #{@send_sms.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/status_enum.rb

@@ -0,0 +1,40 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Status.
+  class StatusEnum
+    STATUS_ENUM = [
+      # TODO: Write general description for APPROVED
+      APPROVED = 'approved'.freeze,
+
+      # TODO: Write general description for PENDING
+      PENDING = 'pending'.freeze,
+
+      # TODO: Write general description for DISABLED
+      DISABLED = 'disabled'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = APPROVED)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'approved' then APPROVED
+      when 'pending' then PENDING
+      when 'disabled' then DISABLED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/subscription.rb

@@ -0,0 +1,105 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Subscription Model.
+  class Subscription < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # True if the charge is for a subscription, false otherwise
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_subscription
+
+    # The period of the subscription (at which interval the consumer is being
+    # charged)
+    # @return [Period]
+    attr_accessor :period
+
+    # False if this is the first charge in a subscription, true if the charge is
+    # a renewal (second period onwards)
+    # @return [TrueClass | FalseClass]
+    attr_accessor :renewal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['is_subscription'] = 'is-subscription'
+      @_hash['period'] = 'period'
+      @_hash['renewal'] = 'renewal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        period
+        renewal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(is_subscription = nil, period = SKIP, renewal = SKIP)
+      @is_subscription = is_subscription
+      @period = period unless period == SKIP
+      @renewal = renewal unless renewal == 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.
+      is_subscription =
+        hash.key?('is-subscription') ? hash['is-subscription'] : nil
+      period = Period.from_hash(hash['period']) if hash['period']
+      renewal = hash.key?('renewal') ? hash['renewal'] : SKIP
+
+      # Create object from extracted values.
+      Subscription.new(is_subscription,
+                       period,
+                       renewal)
+    end
+
+    def self.from_element(root)
+      is_subscription = XmlUtilities.from_attribute(root, 'is-subscription',
+                                                    TrueClass)
+      period = XmlUtilities.from_element(root, 'period', Period)
+      renewal = XmlUtilities.from_element(root, 'renewal', TrueClass)
+
+      new(is_subscription,
+          period,
+          renewal)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'is-subscription', is_subscription)
+      XmlUtilities.add_as_subelement(doc, root, 'period', period)
+      XmlUtilities.add_as_subelement(doc, root, 'renewal', renewal)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_subscription: #{@is_subscription}, period: #{@period}, renewal:"\
+      " #{@renewal}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} is_subscription: #{@is_subscription.inspect}, period: #{@period.inspect},"\
+      " renewal: #{@renewal.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/timeout.rb

@@ -0,0 +1,75 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Specifies how long to block waiting for a response
+  class Timeout < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Maximum time to block before returning a response, in milliseconds. The
+    # value `0` means do not block, and there is no way to specify infinity.
+    # @return [Integer]
+    attr_accessor :after
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['after'] = 'after'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(after = 0)
+      @after = after
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      after = hash['after'] ||= 0
+
+      # Create object from extracted values.
+      Timeout.new(after)
+    end
+
+    def self.from_element(root)
+      after = XmlUtilities.from_attribute(root, 'after', Integer)
+
+      new(after)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'after', after)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after: #{@after}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} after: #{@after.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/type_enum.rb

@@ -0,0 +1,36 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Type.
+  class TypeEnum
+    TYPE_ENUM = [
+      # TODO: Write general description for QRCONTENT
+      QRCONTENT = 'qr-content'.freeze,
+
+      # TODO: Write general description for QRIMAGELINK
+      QRIMAGELINK = 'qr-image-link'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      TYPE_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = QRCONTENT)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'qrcontent' then QRCONTENT
+      when 'qrimagelink' then QRIMAGELINK
+      else
+        default_value
+      end
+    end
+  end
+end