bk-apimatic-sdk 1.0.0

data/lib/boku_direct_payments_api/models/query_optin_request.rb

@@ -0,0 +1,104 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'query-optin' Request - General Elements
+  class QueryOptinRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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['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(merchant_id = nil, merchant_optin_id = SKIP, optin_id = SKIP)
+      @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.
+      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.
+      QueryOptinRequest.new(merchant_id,
+                            merchant_optin_id,
+                            optin_id)
+    end
+
+    def self.from_element(root)
+      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(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, '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} 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} 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/query_optin_response.rb

@@ -0,0 +1,129 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'query-optin' Response - General Elements
+  class QueryOptinResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # Boku-assigned consumer opt-in ID.
+    # @return [String]
+    attr_accessor :optin_id
+
+    # Gives the state of the opt-in at the time this response was returned
+    # @return [OptinState]
+    attr_accessor :optin_state
+
+    # Time original optin 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['result'] = 'result'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['optin_id'] = 'optin-id'
+      @_hash['optin_state'] = 'optin-state'
+      @_hash['timestamp'] = 'timestamp'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_id
+        optin_id
+        optin_state
+        timestamp
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, merchant_id = SKIP, optin_id = SKIP,
+                   optin_state = SKIP, timestamp = SKIP)
+      @result = result
+      @merchant_id = merchant_id unless merchant_id == SKIP
+      @optin_id = optin_id unless optin_id == SKIP
+      @optin_state = optin_state unless optin_state == 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.
+      result = Result.from_hash(hash['result']) if hash['result']
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : SKIP
+      optin_id = hash.key?('optin-id') ? hash['optin-id'] : SKIP
+      optin_state = OptinState.from_hash(hash['optin-state']) if hash['optin-state']
+      timestamp = hash.key?('timestamp') ? hash['timestamp'] : SKIP
+
+      # Create object from extracted values.
+      QueryOptinResponse.new(result,
+                             merchant_id,
+                             optin_id,
+                             optin_state,
+                             timestamp)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      optin_id = XmlUtilities.from_element(root, 'optin-id', String)
+      optin_state = XmlUtilities.from_element(root, 'optin-state', OptinState)
+      timestamp = XmlUtilities.from_element(root, 'timestamp', String)
+
+      new(result,
+          merchant_id,
+          optin_id,
+          optin_state,
+          timestamp)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      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, 'optin-state', optin_state)
+      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} result: #{@result}, merchant_id: #{@merchant_id}, optin_id: #{@optin_id},"\
+      " optin_state: #{@optin_state}, timestamp: #{@timestamp}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, merchant_id: #{@merchant_id.inspect}, optin_id:"\
+      " #{@optin_id.inspect}, optin_state: #{@optin_state.inspect}, timestamp:"\
+      " #{@timestamp.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/query_refund_request.rb

@@ -0,0 +1,122 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # 'query-refund' Request
+  class QueryRefundRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # ISO 3166-1 alpha-2 country code within which to search for refunds.
+    # @return [String]
+    attr_accessor :country
+
+    # Boku-assigned merchant ID.
+    # @return [String]
+    attr_accessor :merchant_id
+
+    # The merchant-refund-id of the original refund-charge-request.
+    # Can match multiple transactions
+    # Required if refund-id is not provided.  Do not include if refund-id is
+    # provided.
+    # @return [String]
+    attr_accessor :merchant_refund_id
+
+    # The refund-id returned from the original refund-charge-response.
+    # Will match only a single transaction.
+    # Required if merchant-refund-id is not provided.  Do not include if
+    # merchant-refund-id is provided.
+    # @return [String]
+    attr_accessor :refund_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['country'] = 'country'
+      @_hash['merchant_id'] = 'merchant-id'
+      @_hash['merchant_refund_id'] = 'merchant-refund-id'
+      @_hash['refund_id'] = 'refund-id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_refund_id
+        refund_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(country = nil, merchant_id = nil, merchant_refund_id = SKIP,
+                   refund_id = SKIP)
+      @country = country
+      @merchant_id = merchant_id
+      @merchant_refund_id = merchant_refund_id unless merchant_refund_id == SKIP
+      @refund_id = refund_id unless refund_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.
+      country = hash.key?('country') ? hash['country'] : nil
+      merchant_id = hash.key?('merchant-id') ? hash['merchant-id'] : nil
+      merchant_refund_id =
+        hash.key?('merchant-refund-id') ? hash['merchant-refund-id'] : SKIP
+      refund_id = hash.key?('refund-id') ? hash['refund-id'] : SKIP
+
+      # Create object from extracted values.
+      QueryRefundRequest.new(country,
+                             merchant_id,
+                             merchant_refund_id,
+                             refund_id)
+    end
+
+    def self.from_element(root)
+      country = XmlUtilities.from_element(root, 'country', String)
+      merchant_id = XmlUtilities.from_element(root, 'merchant-id', String)
+      merchant_refund_id = XmlUtilities.from_element(root, 'merchant-refund-id',
+                                                     String)
+      refund_id = XmlUtilities.from_element(root, 'refund-id', String)
+
+      new(country,
+          merchant_id,
+          merchant_refund_id,
+          refund_id)
+    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, 'merchant-id', merchant_id)
+      XmlUtilities.add_as_subelement(doc, root, 'merchant-refund-id',
+                                     merchant_refund_id)
+      XmlUtilities.add_as_subelement(doc, root, 'refund-id', refund_id)
+
+      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}, merchant_id: #{@merchant_id}, merchant_refund_id:"\
+      " #{@merchant_refund_id}, refund_id: #{@refund_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} country: #{@country.inspect}, merchant_id: #{@merchant_id.inspect},"\
+      " merchant_refund_id: #{@merchant_refund_id.inspect}, refund_id: #{@refund_id.inspect}>"
+    end
+  end
+end

data/lib/boku_direct_payments_api/models/query_refund_response.rb

@@ -0,0 +1,101 @@
+# boku_direct_payments_api
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module BokuDirectPaymentsApi
+  # QueryRefundResponse Model.
+  class QueryRefundResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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
+
+    # The 'result' element is defined in every response type. It is used to
+    # convey the outcome of an API request.
+    # @return [Array[Refund]]
+    attr_accessor :refunds
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['result'] = 'result'
+      @_hash['refunds'] = 'refunds'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        refunds
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(result = nil, refunds = SKIP)
+      @result = result
+      @refunds = refunds unless refunds == 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.
+      result = Result.from_hash(hash['result']) if hash['result']
+      # Parameter is an array, so we need to iterate through it
+      refunds = nil
+      unless hash['refunds'].nil?
+        refunds = []
+        hash['refunds'].each do |structure|
+          refunds << (Refund.from_hash(structure) if structure)
+        end
+      end
+
+      refunds = SKIP unless hash.key?('refunds')
+
+      # Create object from extracted values.
+      QueryRefundResponse.new(result,
+                              refunds)
+    end
+
+    def self.from_element(root)
+      result = XmlUtilities.from_element(root, 'result', Result)
+      refunds = XmlUtilities.from_element_to_array(
+        root, 'refund', Refund, wrapping_element_name: 'refunds'
+      )
+
+      new(result,
+          refunds)
+    end
+
+    def to_xml_element(doc, root_name)
+      root = doc.create_element(root_name)
+
+      XmlUtilities.add_as_subelement(doc, root, 'result', result)
+      XmlUtilities.add_array_as_subelement(doc, root, 'refund', refunds,
+                                           wrapping_element_name: 'refunds')
+
+      root
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result}, refunds: #{@refunds}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} result: #{@result.inspect}, refunds: #{@refunds.inspect}>"
+    end
+  end
+end