bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/charge_response.rb

@@ -0,0 +1,253 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'charge' Response - General Elements
+  class ChargeResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # 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
+
+    # Boku-assigned consumer opt-in ID.
+    # @return [String]
+    attr_accessor :optin_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
+
+    # Boku-generated unique ID for the charge.
+    # If null, no charge was created (e.g., because the request was rejected).
+    # @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
+
+    # Merchant-supplied metadata.
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # Issuer's Network ID.
+    # @return [String]
+    attr_accessor :network_id
+
+    # Optin and Charge Request API can be made for specific Seller of Record
+    # previously registered with Boku.
+    # @return [SellerOfRecord]
+    attr_accessor :seller_of_record
+
+    # **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.
+    # @return [Settlement]
+    attr_accessor :settlement
+
+    # Time the request was received (format: 'YYYY-MM-DD hh:mm:ss').
+    # All timestamps are in UTC.
+    # @return [String]
+    attr_accessor :timestamp
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_request_id'] = 'merchant-request-id'
+      @_hash['merchant_transaction_id'] = 'merchant-transaction-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash['result'] = 'result'
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['charge_status'] = 'charge-status'
+      @_hash['country'] = 'country'
+      @_hash['merchant_data'] = 'merchant-data'
+      @_hash['network_id'] = 'network-id'
+      @_hash['seller_of_record'] = 'seller-of-record'
+      @_hash['settlement'] = 'settlement'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        charge_id
+        charge_status
+        country
+        merchant_data
+        network_id
+        seller_of_record
+        settlement
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, merchant_request_id = nil,
+                   merchant_transaction_id = nil, optin_id = nil, result = nil,
+                   charge_id = SKIP, charge_status = SKIP, country = SKIP,
+                   merchant_data = SKIP, network_id = SKIP,
+                   seller_of_record = SKIP, settlement = SKIP, timestamp = SKIP)
+      @merchant_id = merchant_id
+      @merchant_request_id = merchant_request_id
+      @merchant_transaction_id = merchant_transaction_id
+      @optin_id = optin_id
+      @result = result
+      @charge_id = charge_id unless charge_id == SKIP
+      @charge_status = charge_status unless charge_status == SKIP
+      @country = country unless country == SKIP
+      @merchant_data = merchant_data unless merchant_data == SKIP
+      @network_id = network_id unless network_id == SKIP
+      @seller_of_record = seller_of_record unless seller_of_record == SKIP
+      @settlement = settlement unless settlement == SKIP
+      @timestamp = timestamp unless timestamp == 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
+      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
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      charge_id = hash.key?('charge-id') ? hash['charge-id'] : SKIP
+      charge_status = hash.key?('charge-status') ? hash['charge-status'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      merchant_data = hash.key?('merchant-data') ? hash['merchant-data'] : SKIP
+      network_id = hash.key?('network-id') ? hash['network-id'] : SKIP
+      seller_of_record = SellerOfRecord.from_hash(hash['seller-of-record']) if
+        hash['seller-of-record']
+      settlement = Settlement.from_hash(hash['settlement']) if hash['settlement']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      ChargeResponse.new(merchant_id,
+                         merchant_request_id,
+                         merchant_transaction_id,
+                         optin_id,
+                         result,
+                         charge_id,
+                         charge_status,
+                         country,
+                         merchant_data,
+                         network_id,
+                         seller_of_record,
+                         settlement,
+                         timestamp)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_request_id = XmlUtilities.from_element(root,
+                                                      'merchant-request-id',
+                                                      String)
+      merchant_transaction_id = XmlUtilities.from_element(
+        root, 'merchant-transaction-id', String
+      )
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      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)
+      merchant_data = XmlUtilities.from_element(root, 'merchant-data', String)
+      network_id = XmlUtilities.from_element(root, 'network-id', String)
+      seller_of_record = XmlUtilities.from_element(root, 'seller-of-record',
+                                                   SellerOfRecord)
+      settlement = XmlUtilities.from_element(root, 'Settlement', Settlement)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(merchant_id,
+          merchant_request_id,
+          merchant_transaction_id,
+          optin_id,
+          result,
+          charge_id,
+          charge_status,
+          country,
+          merchant_data,
+          network_id,
+          seller_of_record,
+          settlement,
+          timestamp)
+    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, 'merchant-request-id',
+                                     merchant_request_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-transaction-id',
+                                     merchant_transaction_id)
+      XmlUtilities.add_as_subelement(doc, root, 'optin-id', optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      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, 'merchant-data', merchant_data)
+      XmlUtilities.add_as_subelement(doc, root, 'network-id', network_id)
+      XmlUtilities.add_as_subelement(doc, root, 'seller-of-record',
+                                     seller_of_record)
+      XmlUtilities.add_as_subelement(doc, root, 'Settlement', settlement)
+      XmlUtilities.add_as_subelement(doc, root, 'timestamp', timestamp)
+
+      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}, merchant_request_id: #{@merchant_request_id},"\
+      " merchant_transaction_id: #{@merchant_transaction_id}, optin_id: #{@optin_id}, result:"\
+      " #{@result}, charge_id: #{@charge_id}, charge_status: #{@charge_status}, country:"\
+      " #{@country}, merchant_data: #{@merchant_data}, network_id: #{@network_id},"\
+      " seller_of_record: #{@seller_of_record}, settlement: #{@settlement}, timestamp:"\
+      " #{@timestamp}>"
+    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}, merchant_request_id:"\
+      " #{@merchant_request_id.inspect}, merchant_transaction_id:"\
+      " #{@merchant_transaction_id.inspect}, optin_id: #{@optin_id.inspect}, result:"\
+      " #{@result.inspect}, charge_id: #{@charge_id.inspect}, charge_status:"\
+      " #{@charge_status.inspect}, country: #{@country.inspect}, merchant_data:"\
+      " #{@merchant_data.inspect}, network_id: #{@network_id.inspect}, seller_of_record:"\
+      " #{@seller_of_record.inspect}, settlement: #{@settlement.inspect}, timestamp:"\
+      " #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/charge_status_enum.rb

@@ -0,0 +1,43 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 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).
+  class ChargeStatusEnum
+    CHARGE_STATUS_ENUM = [
+      # TODO: Write general description for SUCCESS
+      SUCCESS = 'success'.freeze,
+
+      # TODO: Write general description for FAILED
+      FAILED = 'failed'.freeze,
+
+      # TODO: Write general description for INPROGRESS
+      INPROGRESS = 'in-progress'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      CHARGE_STATUS_ENUM.include?(value)
+    end
+
+    def self.from_value(value, default_value = SUCCESS)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'success' then SUCCESS
+      when 'failed' then FAILED
+      when 'inprogress' then INPROGRESS
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/check_eligibility_request.rb

@@ -0,0 +1,117 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'check-eligibility' Request - General Parameters
+  class CheckEligibilityRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [String]
+    attr_accessor :country
+
+    # Merchant-assigned unique opt-in ID.
+    # @return [String]
+    attr_accessor :merchant_optin_id
+
+    # Boku-assigned consumer 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['merchant_id'] = 'merchant-id'
+      @_hash['country'] = 'country'
+      @_hash['merchant_optin_id'] = 'merchant-optin-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        country
+        merchant_optin_id
+        optin_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, country = SKIP, merchant_optin_id = SKIP,
+                   optin_id = SKIP)
+      @merchant_id = merchant_id
+      @country = country unless country == SKIP
+      @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.
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      country = hash.key?('country') ? hash['country'] : SKIP
+      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.
+      CheckEligibilityRequest.new(merchant_id,
+                                  country,
+                                  merchant_optin_id,
+                                  optin_id)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_optin_id = XmlUtilities.from_element(root, 'merchant-optin-id',
+                                                    String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+
+      new(merchant_id,
+          country,
+          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, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'country', country)
+      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} merchant_id: #{@merchant_id}, country: #{@country}, 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} merchant_id: #{@merchant_id.inspect}, country: #{@country.inspect},"\
+      " merchant_optin_id: #{@merchant_optin_id.inspect}, optin_id: #{@optin_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/check_eligibility_response.rb

@@ -0,0 +1,116 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'check-eligibility' Response - General Elements
+  class CheckEligibilityResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Boku-assigned consumer opt-in ID.
+    # @return [String]
+    attr_accessor :optin_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
+
+    # Eligibility status of the consumer. Provided if result.status == OK.
+    # @return [EligibilityStatusEnum]
+    attr_accessor :eligibility_status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash['result'] = 'result'
+      @_hash['eligibility_status'] = 'eligibility-status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        eligibility_status
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_id = nil, optin_id = nil, result = nil,
+                   eligibility_status = SKIP)
+      @merchant_id = merchant_id
+      @optin_id = optin_id
+      @result = result
+      @eligibility_status = eligibility_status unless eligibility_status == 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
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : nil
+      result = Result.from_hash(hash['result']) if hash['result']
+      eligibility_status =
+        hash.key?('eligibility-status') ? hash['eligibility-status'] : SKIP
+
+      # Create object from extracted values.
+      CheckEligibilityResponse.new(merchant_id,
+                                   optin_id,
+                                   result,
+                                   eligibility_status)
+    end
+
+    def self.from_element(root)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      eligibility_status = XmlUtilities.from_element(root, 'eligibility-status',
+                                                     String)
+
+      new(merchant_id,
+          optin_id,
+          result,
+          eligibility_status)
+    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, 'optin-id', optin_id)
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_as_subelement(doc, root, 'eligibility-status',
+                                     eligibility_status)
+
+      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}, optin_id: #{@optin_id}, result: #{@result},"\
+      " eligibility_status: #{@eligibility_status}>"
+    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}, optin_id: #{@optin_id.inspect},"\
+      " result: #{@result.inspect}, eligibility_status: #{@eligibility_status.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/client_call.rb

@@ -0,0 +1,91 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # Describes a HTTP call to be made from the client device via cellular data
+  # network as part of the opt-in. If absent from an optin-info carrier-gw
+  # element, indicates that though carrier-gw is supported, the URL must be
+  # generated on a per-request basis via a call to `optin`.
+  class ClientCall < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL to be called, containing placeholders that must be replaced before
+    # using
+    # @return [String]
+    attr_accessor :url
+
+    # HTTP method to use for the call, usually 'GET'
+    # @return [MethodEnum]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['url'] = 'url'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(url = nil, method = SKIP)
+      @url = url
+      @method = method unless method == 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.
+      url = hash.key?('url') ? hash['url'] : nil
+      method = hash.key?('method') ? hash['method'] : SKIP
+
+      # Create object from extracted values.
+      ClientCall.new(url,
+                     method)
+    end
+
+    def self.from_element(root)
+      url = XmlUtilities.from_attribute(root, 'url', String)
+      method = XmlUtilities.from_attribute(root, 'method', String)
+
+      new(url,
+          method)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_attribute(root, 'url', url)
+      XmlUtilities.add_as_attribute(root, 'method', method)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} url: #{@url}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} url: #{@url.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end