bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/charge.rb

@@ -0,0 +1,288 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Charge Model.
+  class Charge < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-generated unique ID for the charge.
+    # @return [String]
+    attr_accessor :charge_id
+
+    # Status of the charge at the time this response was returned.
+    # If 'in-progress' is returned, the charge call should be re-issued with the
+    # same request ID until a final status is reached.
+    # If null, no charge was created (e.g., because the request was rejected).
+    # @return [ChargeStatusEnum]
+    attr_accessor :charge_status
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A short purchase description that appears on the consumer bill.
+    # @return [String]
+    attr_accessor :merchant_item_description
+
+    # Merchant-assigned transaction ID.
+    # _***Boku recommends merchants send this ID for future reference**_
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # Issuer's Network ID.
+    # @return [String]
+    attr_accessor :network_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
+
+    # Time original charge request was received ("YYYY-MM-DD hh:mm:ss").
+    # All timestamps are in UTC.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # Total amount charged or attempted to charge, including tax.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # **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.**
+    # Issuer Transaction Reference
+    # @return [String]
+    attr_accessor :issuer_transaction_reference
+
+    # **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.**
+    #  Unique user ID provided by the payment provider. This value could be an
+    # ID that is not recognizable to the user.
+    # @return [String]
+    attr_accessor :issuer_unique_user_id
+
+    # Merchant-supplied metadata
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # Contains information about the reversal status of this transaction.
+    # If present, charge may be considered reversed. If not present, no reversal
+    # request has been received.
+    # @return [Reversal]
+    attr_accessor :reversal
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['charge_status'] = 'charge-status'
+      @_hash['country'] = 'country'
+      @_hash['currency'] = 'currency'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_item_description'] = 'merchant-item-description'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash['network_id'] = 'network-id'
+      @_hash['result'] = 'result'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash['total_amount'] = 'total-amount'
+      @_hash['issuer_transaction_reference'] = 'issuer-transaction-reference'
+      @_hash['issuer_unique_user_id'] = 'issuer-unique-user-id'
+      @_hash['merchant_data'] = 'merchant-data'
+      @_hash['reversal'] = 'reversal'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        issuer_transaction_reference
+        issuer_unique_user_id
+        merchant_data
+        reversal
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(charge_id = nil, charge_status = nil, country = nil,
+                   currency = nil, merchant_id = nil,
+                   merchant_item_description = nil,
+                   merchant_transaction_id = nil, network_id = nil,
+                   result = nil, timestamp = nil, total_amount = nil,
+                   issuer_transaction_reference = SKIP,
+                   issuer_unique_user_id = SKIP, merchant_data = SKIP,
+                   reversal = SKIP)
+      @charge_id = charge_id
+      @charge_status = charge_status
+      @country = country
+      @currency = currency
+      @merchant_id = merchant_id
+      @merchant_item_description = merchant_item_description
+      @merchant_transaction_id = merchant_transaction_id
+      @network_id = network_id
+      @result = result
+      @timestamp = timestamp
+      @total_amount = total_amount
+      unless issuer_transaction_reference == SKIP
+        @issuer_transaction_reference =
+          issuer_transaction_reference
+      end
+      @issuer_unique_user_id = issuer_unique_user_id unless issuer_unique_user_id == SKIP
+      @merchant_data = merchant_data unless merchant_data == SKIP
+      @reversal = reversal unless reversal == 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.
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : nil
+      charge_status = hash.key?('charge-status') ? hash['charge-status'] : nil
+      country = hash.key?('country') ? hash['country'] : nil
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_item_description =
+        hash.key?('merchant-item-description') ? hash['merchant-item-description'] : nil
+      merchant_transaction_id =
+        hash.key?('merchant-transaction-id') ? hash['merchant-transaction-id'] : nil
+      network_id = hash.key?('network-id') ? hash['network-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : nil
+      total_amount = hash.key?('total-amount') ? hash['total-amount'] : nil
+      issuer_transaction_reference =
+        hash.key?('issuer-transaction-reference') ? hash['issuer-transaction-reference'] : SKIP
+      issuer_unique_user_id =
+        hash.key?('issuer-unique-user-id') ? hash['issuer-unique-user-id'] : SKIP
+      merchant_data = hash.key?('merchant-data') ? hash['merchant-data'] : SKIP
+      reversal = Reversal.from_hash(hash['reversal']) if hash['reversal']
+
+      # Create object from extracted values.
+      Charge.new(charge_id,
+                 charge_status,
+                 country,
+                 currency,
+                 merchant_id,
+                 merchant_item_description,
+                 merchant_transaction_id,
+                 network_id,
+                 result,
+                 timestamp,
+                 total_amount,
+                 issuer_transaction_reference,
+                 issuer_unique_user_id,
+                 merchant_data,
+                 reversal)
+    end
+
+    def self.from_element(root)
+      charge_id = XmlUtilities.from_element(root, 'charge-id', String)
+      charge_status = XmlUtilities.from_element(root, 'charge-status', String)
+      country = XmlUtilities.from_element(root, 'country', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_item_description = XmlUtilities.from_element(
+        root, 'merchant-item-description', String
+      )
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+      total_amount = XmlUtilities.from_element(root, 'total-amount', Float)
+      issuer_transaction_reference = XmlUtilities.from_element(
+        root, 'issuer-transaction-reference', String
+      )
+      issuer_unique_user_id = XmlUtilities.from_element(root,
+                                                        'issuer-unique-user-id',
+                                                        String)
+      merchant_data = XmlUtilities.from_element(root, 'merchant-data', String)
+      reversal = XmlUtilities.from_element(root, 'reversal', Reversal)
+
+      new(charge_id,
+          charge_status,
+          country,
+          currency,
+          merchant_id,
+          merchant_item_description,
+          merchant_transaction_id,
+          network_id,
+          result,
+          timestamp,
+          total_amount,
+          issuer_transaction_reference,
+          issuer_unique_user_id,
+          merchant_data,
+          reversal)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'charge-id', charge_id)
+      XmlUtilities.add_as_subelement(doc, root, 'charge-status', charge_status)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      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-item-description',
+                                     merchant_item_description)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_id)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'timestamp', timestamp)
+      XmlUtilities.add_as_subelement(doc, root, 'total-amount', total_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'issuer-transaction-reference',
+                                     issuer_transaction_reference)
+      XmlUtilities.add_as_subelement(doc, root, 'issuer-unique-user-id',
+                                     issuer_unique_user_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-data', merchant_data)
+      XmlUtilities.add_as_subelement(doc, root, 'reversal', reversal)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_id: #{@charge_id}, charge_status: #{@charge_status}, country:"\
+      " #{@country}, currency: #{@currency}, merchant_id: #{@merchant_id},"\
+      " merchant_item_description: #{@merchant_item_description}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id}, network_id: #{@network_id}, result: #{@result}, timestamp:"\
+      " #{@timestamp}, total_amount: #{@total_amount}, issuer_transaction_reference:"\
+      " #{@issuer_transaction_reference}, issuer_unique_user_id: #{@issuer_unique_user_id},"\
+      " merchant_data: #{@merchant_data}, reversal: #{@reversal}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} charge_id: #{@charge_id.inspect}, charge_status: #{@charge_status.inspect},"\
+      " country: #{@country.inspect}, currency: #{@currency.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, merchant_item_description: #{@merchant_item_description.inspect},"\
+      " merchant_transaction_id: #{@merchant_transaction_id.inspect}, network_id:"\
+      " #{@network_id.inspect}, result: #{@result.inspect}, timestamp: #{@timestamp.inspect},"\
+      " total_amount: #{@total_amount.inspect}, issuer_transaction_reference:"\
+      " #{@issuer_transaction_reference.inspect}, issuer_unique_user_id:"\
+      " #{@issuer_unique_user_id.inspect}, merchant_data: #{@merchant_data.inspect}, reversal:"\
+      " #{@reversal.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/charge_msisdn_request.rb

@@ -0,0 +1,233 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # ChargeMsisdnRequest Model.
+  class ChargeMsisdnRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # ISO 4217 three-letter currency code.
+    # @return [String]
+    attr_accessor :currency
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # A short purchase description that appears on the consumer bill. A string
+    # longer than 20 characters will be truncated.
+    # @return [String]
+    attr_accessor :merchant_item_description
+
+    # Merchant-assigned unique request ID.
+    # @return [String]
+    attr_accessor :merchant_request_id
+
+    # Merchant-assigned transaction ID.
+    # _***Boku recommends merchants send this ID for future reference**_
+    # @return [String]
+    attr_accessor :merchant_transaction_id
+
+    # Consumer's mobile phone number.
+    # @return [String]
+    attr_accessor :msisdn
+
+    # Alphanumeric code for the Carrier's Network ID. Any alphabetical
+    # characters must be in lower case (i.e. a-z)
+    # @return [String]
+    attr_accessor :network
+
+    # Total amount to charge, including tax.
+    # @return [Float]
+    attr_accessor :total_amount
+
+    # Merchant-supplied metadata. This metadata is returned in the 'charge'
+    # response and can be available in merchant reports.
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # Merchant-supplied metadata. This metadata is returned in the 'charge'
+    # response and can be available in merchant reports.
+    # @return [String]
+    attr_accessor :notification_url
+
+    # Specifies how long to block waiting for a response
+    # @return [Timeout]
+    attr_accessor :timeout
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['currency'] = 'currency'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_item_description'] = 'merchant-item-description'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash['msisdn'] = 'msisdn'
+      @_hash['network'] = 'network'
+      @_hash['total_amount'] = 'total-amount'
+      @_hash['merchant_data'] = 'merchant-data'
+      @_hash['notification_url'] = 'notification-url'
+      @_hash['timeout'] = 'timeout'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_data
+        notification_url
+        timeout
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, currency = nil, merchant_id = nil,
+                   merchant_item_description = nil, merchant_request_id = nil,
+                   merchant_transaction_id = nil, msisdn = nil, network = nil,
+                   total_amount = nil, merchant_data = SKIP,
+                   notification_url = SKIP, timeout = SKIP)
+      @country = country
+      @currency = currency
+      @merchant_id = merchant_id
+      @merchant_item_description = merchant_item_description
+      @merchant_request_id = merchant_request_id
+      @merchant_transaction_id = merchant_transaction_id
+      @msisdn = msisdn
+      @network = network
+      @total_amount = total_amount
+      @merchant_data = merchant_data unless merchant_data == SKIP
+      @notification_url = notification_url unless notification_url == SKIP
+      @timeout = timeout unless timeout == 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
+      currency = hash.key?('currency') ? hash['currency'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_item_description =
+        hash.key?('merchant-item-description') ? hash['merchant-item-description'] : nil
+      merchant_request_id =
+        hash.key?('merchant-request-id') ? hash['merchant-request-id'] : nil
+      merchant_transaction_id =
+        hash.key?('merchant-transaction-id') ? hash['merchant-transaction-id'] : nil
+      msisdn = hash.key?('msisdn') ? hash['msisdn'] : nil
+      network = hash.key?('network') ? hash['network'] : nil
+      total_amount = hash.key?('total-amount') ? hash['total-amount'] : nil
+      merchant_data = hash.key?('merchant-data') ? hash['merchant-data'] : SKIP
+      notification_url =
+        hash.key?('notification-url') ? hash['notification-url'] : SKIP
+      timeout = Timeout.from_hash(hash['timeout']) if hash['timeout']
+
+      # Create object from extracted values.
+      ChargeMsisdnRequest.new(country,
+                              currency,
+                              merchant_id,
+                              merchant_item_description,
+                              merchant_request_id,
+                              merchant_transaction_id,
+                              msisdn,
+                              network,
+                              total_amount,
+                              merchant_data,
+                              notification_url,
+                              timeout)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      currency = XmlUtilities.from_element(root, 'currency', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_item_description = XmlUtilities.from_element(
+        root, 'merchant-item-description', String
+      )
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+      msisdn = XmlUtilities.from_element(root, 'msisdn', String)
+      network = XmlUtilities.from_element(root, 'network', String)
+      total_amount = XmlUtilities.from_element(root, 'total-amount', Float)
+      merchant_data = XmlUtilities.from_element(root, 'merchant-data', String)
+      notification_url = XmlUtilities.from_element(root, 'notification-url',
+                                                   String)
+      timeout = XmlUtilities.from_element(root, 'timeout', Timeout)
+
+      new(country,
+          currency,
+          merchant_id,
+          merchant_item_description,
+          merchant_request_id,
+          merchant_transaction_id,
+          msisdn,
+          network,
+          total_amount,
+          merchant_data,
+          notification_url,
+          timeout)
+    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, 'currency', currency)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-item-description',
+                                     merchant_item_description)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_id)
+      XmlUtilities.add_as_subelement(doc, root, 'msisdn', msisdn)
+      XmlUtilities.add_as_subelement(doc, root, 'network', network)
+      XmlUtilities.add_as_subelement(doc, root, 'total-amount', total_amount)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-data', merchant_data)
+      XmlUtilities.add_as_subelement(doc, root, 'notification-url',
+                                     notification_url)
+      XmlUtilities.add_as_subelement(doc, root, 'timeout', timeout)
+
+      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}, currency: #{@currency}, merchant_id: #{@merchant_id},"\
+      " merchant_item_description: #{@merchant_item_description}, merchant_request_id:"\
+      " #{@merchant_request_id}, merchant_transaction_id: #{@merchant_transaction_id}, msisdn:"\
+      " #{@msisdn}, network: #{@network}, total_amount: #{@total_amount}, merchant_data:"\
+      " #{@merchant_data}, notification_url: #{@notification_url}, timeout: #{@timeout}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, currency: #{@currency.inspect}, merchant_id:"\
+      " #{@merchant_id.inspect}, merchant_item_description: #{@merchant_item_description.inspect},"\
+      " merchant_request_id: #{@merchant_request_id.inspect}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id.inspect}, msisdn: #{@msisdn.inspect}, network:"\
+      " #{@network.inspect}, total_amount: #{@total_amount.inspect}, merchant_data:"\
+      " #{@merchant_data.inspect}, notification_url: #{@notification_url.inspect}, timeout:"\
+      " #{@timeout.inspect}>"
+    end
+  end
+end