bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/begin_single_charge_request_hosted.rb

@@ -0,0 +1,110 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # BeginSingleChargeRequestHosted Model.
+  class BeginSingleChargeRequestHosted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Supplies the URL for Boku to redirect the consumer back to the merchant UI
+    # to complete authentication.
+    # @return [String]
+    attr_accessor :forward_url
+
+    # 'Begin Single Charge request QR info' - General Parameters
+    # @return [BeginSingleChargeRequestQrInfo]
+    attr_accessor :qr_info
+
+    # True if a mobile-optimized purchase flow should be used for this request,
+    # false otherwise.
+    # Example: A non-mobile-optimized flow could display a QR code on the user's
+    # mobile. The user would be unable to scan the QR code because they are
+    # already on their mobile.
+    # A mobile-optimized flow could display a mobile login page to the user.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :use_mobile_flow
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['forward_url'] = 'forward-url'
+      @_hash['qr_info'] = 'qr-info'
+      @_hash['use_mobile_flow'] = 'use-mobile-flow'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        qr_info
+        use_mobile_flow
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(forward_url = nil, qr_info = SKIP, use_mobile_flow = false)
+      @forward_url = forward_url
+      @qr_info = qr_info unless qr_info == SKIP
+      @use_mobile_flow = use_mobile_flow unless use_mobile_flow == 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.
+      forward_url = hash.key?('forward-url') ? hash['forward-url'] : nil
+      qr_info = BeginSingleChargeRequestQrInfo.from_hash(hash['qr-info']) if hash['qr-info']
+      use_mobile_flow = hash['use-mobile-flow'] ||= false
+
+      # Create object from extracted values.
+      BeginSingleChargeRequestHosted.new(forward_url,
+                                         qr_info,
+                                         use_mobile_flow)
+    end
+
+    def self.from_element(root)
+      forward_url = XmlUtilities.from_element(root, 'forward-url', String)
+      qr_info = XmlUtilities.from_element(root, 'qr-info',
+                                          BeginSingleChargeRequestQrInfo)
+      use_mobile_flow = XmlUtilities.from_element(root, 'use-mobile-flow',
+                                                  TrueClass)
+
+      new(forward_url,
+          qr_info,
+          use_mobile_flow)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'forward-url', forward_url)
+      XmlUtilities.add_as_subelement(doc, root, 'qr-info', qr_info)
+      XmlUtilities.add_as_subelement(doc, root, 'use-mobile-flow',
+                                     use_mobile_flow)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url}, qr_info: #{@qr_info}, use_mobile_flow:"\
+      " #{@use_mobile_flow}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} forward_url: #{@forward_url.inspect}, qr_info: #{@qr_info.inspect},"\
+      " use_mobile_flow: #{@use_mobile_flow.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/begin_single_charge_request_qr_info.rb

@@ -0,0 +1,74 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'Begin Single Charge request QR info' - General Parameters
+  class BeginSingleChargeRequestQrInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = nil)
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      BeginSingleChargeRequestQrInfo.new(type)
+    end
+
+    def self.from_element(root)
+      type = XmlUtilities.from_element(root, 'type', String)
+
+      new(type)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'type', type)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/begin_single_charge_response.rb

@@ -0,0 +1,254 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # BeginSingleChargeResponse Model.
+  class BeginSingleChargeResponse < 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
+
+    # The payment method selected.
+    # @return [String]
+    attr_accessor :payment_method
+
+    # 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
+
+    # ISO 3166-1 alpha-2 country code.
+    # @return [BeginSingleChargeResponseHosted]
+    attr_accessor :hosted
+
+    # Merchant-supplied metadata
+    # @return [String]
+    attr_accessor :merchant_data
+
+    # 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 request was received ("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['payment_method'] = 'payment-method'
+      @_hash['result'] = 'result'
+      @_hash['charge_id'] = 'charge-id'
+      @_hash['charge_status'] = 'charge-status'
+      @_hash['country'] = 'country'
+      @_hash['hosted'] = 'hosted'
+      @_hash['merchant_data'] = 'merchant-data'
+      @_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
+        hosted
+        merchant_data
+        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, payment_method = nil,
+                   result = nil, charge_id = SKIP, charge_status = SKIP,
+                   country = SKIP, hosted = SKIP, merchant_data = 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
+      @payment_method = payment_method
+      @result = result
+      @charge_id = charge_id unless charge_id == SKIP
+      @charge_status = charge_status unless charge_status == SKIP
+      @country = country unless country == SKIP
+      @hosted = hosted unless hosted == SKIP
+      @merchant_data = merchant_data unless merchant_data == 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
+      payment_method =
+        hash.key?('payment-method') ? hash['payment-method'] : 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
+      hosted = BeginSingleChargeResponseHosted.from_hash(hash['hosted']) if hash['hosted']
+      merchant_data = hash.key?('merchant-data') ? hash['merchant-data'] : 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.
+      BeginSingleChargeResponse.new(merchant_id,
+                                    merchant_request_id,
+                                    merchant_transaction_id,
+                                    payment_method,
+                                    result,
+                                    charge_id,
+                                    charge_status,
+                                    country,
+                                    hosted,
+                                    merchant_data,
+                                    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
+      )
+      payment_method = XmlUtilities.from_element(root, 'payment-method', 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)
+      hosted = XmlUtilities.from_element(root, 'hosted',
+                                         BeginSingleChargeResponseHosted)
+      merchant_data = XmlUtilities.from_element(root, 'merchant-data', 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,
+          payment_method,
+          result,
+          charge_id,
+          charge_status,
+          country,
+          hosted,
+          merchant_data,
+          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, 'payment-method',
+                                     payment_method)
+      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, 'hosted', hosted)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-data', merchant_data)
+      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}, payment_method: #{@payment_method},"\
+      " result: #{@result}, charge_id: #{@charge_id}, charge_status: #{@charge_status}, country:"\
+      " #{@country}, hosted: #{@hosted}, merchant_data: #{@merchant_data}, 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}, payment_method: #{@payment_method.inspect}, result:"\
+      " #{@result.inspect}, charge_id: #{@charge_id.inspect}, charge_status:"\
+      " #{@charge_status.inspect}, country: #{@country.inspect}, hosted: #{@hosted.inspect},"\
+      " merchant_data: #{@merchant_data.inspect}, seller_of_record: #{@seller_of_record.inspect},"\
+      " settlement: #{@settlement.inspect}, timestamp: #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/begin_single_charge_response_hosted.rb

@@ -0,0 +1,90 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # BeginSingleChargeResponseHosted Model.
+  class BeginSingleChargeResponseHosted < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # URL, where the user should be redirected to so the charge, can be
+    # authorized
+    # @return [String]
+    attr_accessor :redirect_url
+
+    # URL, where the user should be redirected to so the charge, can be
+    # authorized
+    # @return [BeginSingleChargeResponseQrInfo]
+    attr_accessor :qr_info
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['redirect_url'] = 'redirect-url'
+      @_hash['qr_info'] = 'qr-info'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        qr_info
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(redirect_url = nil, qr_info = SKIP)
+      @redirect_url = redirect_url
+      @qr_info = qr_info unless qr_info == 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.
+      redirect_url = hash.key?('redirect-url') ? hash['redirect-url'] : nil
+      qr_info = BeginSingleChargeResponseQrInfo.from_hash(hash['qr-info']) if hash['qr-info']
+
+      # Create object from extracted values.
+      BeginSingleChargeResponseHosted.new(redirect_url,
+                                          qr_info)
+    end
+
+    def self.from_element(root)
+      redirect_url = XmlUtilities.from_element(root, 'redirect-url', String)
+      qr_info = XmlUtilities.from_element(root, 'qr-info',
+                                          BeginSingleChargeResponseQrInfo)
+
+      new(redirect_url,
+          qr_info)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'redirect-url', redirect_url)
+      XmlUtilities.add_as_subelement(doc, root, 'qr-info', qr_info)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} redirect_url: #{@redirect_url}, qr_info: #{@qr_info}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} redirect_url: #{@redirect_url.inspect}, qr_info: #{@qr_info.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/begin_single_charge_response_qr_info.rb

@@ -0,0 +1,85 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # BeginSingleChargeResponseQrInfo Model.
+  class BeginSingleChargeResponseQrInfo < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :source
+
+    # TODO: Write general description for this method
+    # @return [TypeEnum]
+    attr_accessor :type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source'] = 'source'
+      @_hash['type'] = 'type'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source = nil, type = nil)
+      @source = source
+      @type = type
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      source = hash.key?('source') ? hash['source'] : nil
+      type = hash.key?('type') ? hash['type'] : nil
+
+      # Create object from extracted values.
+      BeginSingleChargeResponseQrInfo.new(source,
+                                          type)
+    end
+
+    def self.from_element(root)
+      source = XmlUtilities.from_element(root, 'source', String)
+      type = XmlUtilities.from_element(root, 'type', String)
+
+      new(source,
+          type)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'source', source)
+      XmlUtilities.add_as_subelement(doc, root, 'type', type)
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source: #{@source}, type: #{@type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source: #{@source.inspect}, type: #{@type.inspect}>"
+    end
+  end
+end