visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/create_session_request.rb

@@ -0,0 +1,195 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CreateSessionRequest Model.
+  class CreateSessionRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ClientReferenceInformation26]
+    attr_accessor :client_reference_information
+
+    # TODO: Write general description for this method
+    # @return [ProcessingInformation23]
+    attr_accessor :processing_information
+
+    # TODO: Write general description for this method
+    # @return [PaymentInformation22]
+    attr_accessor :payment_information
+
+    # TODO: Write general description for this method
+    # @return [OrderInformation26]
+    attr_accessor :order_information
+
+    # TODO: Write general description for this method
+    # @return [BuyerInformation9]
+    attr_accessor :buyer_information
+
+    # TODO: Write general description for this method
+    # @return [DeviceInformation7]
+    attr_accessor :device_information
+
+    # TODO: Write general description for this method
+    # @return [MerchantInformation14]
+    attr_accessor :merchant_information
+
+    # TODO: Write general description for this method
+    # @return [UserInterface]
+    attr_accessor :user_interface
+
+    # The object containing the custom data that the merchant defines.
+    # @return [Array[MerchantDefinedInformation]]
+    attr_accessor :merchant_defined_information
+
+    # The object containing the custom data that the merchant defines.
+    # @return [AgreementInformation10]
+    attr_accessor :agreement_information
+
+    # The object containing the custom data that the merchant defines.
+    # @return [TravelInformation6]
+    attr_accessor :travel_information
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_reference_information'] = 'clientReferenceInformation'
+      @_hash['processing_information'] = 'processingInformation'
+      @_hash['payment_information'] = 'paymentInformation'
+      @_hash['order_information'] = 'orderInformation'
+      @_hash['buyer_information'] = 'buyerInformation'
+      @_hash['device_information'] = 'deviceInformation'
+      @_hash['merchant_information'] = 'merchantInformation'
+      @_hash['user_interface'] = 'userInterface'
+      @_hash['merchant_defined_information'] = 'merchantDefinedInformation'
+      @_hash['agreement_information'] = 'agreementInformation'
+      @_hash['travel_information'] = 'travelInformation'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_reference_information
+        processing_information
+        payment_information
+        order_information
+        buyer_information
+        device_information
+        merchant_information
+        user_interface
+        merchant_defined_information
+        agreement_information
+        travel_information
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_reference_information = SKIP,
+                   processing_information = SKIP, payment_information = SKIP,
+                   order_information = SKIP, buyer_information = SKIP,
+                   device_information = SKIP, merchant_information = SKIP,
+                   user_interface = SKIP, merchant_defined_information = SKIP,
+                   agreement_information = SKIP, travel_information = SKIP)
+      unless client_reference_information == SKIP
+        @client_reference_information =
+          client_reference_information
+      end
+      @processing_information = processing_information unless processing_information == SKIP
+      @payment_information = payment_information unless payment_information == SKIP
+      @order_information = order_information unless order_information == SKIP
+      @buyer_information = buyer_information unless buyer_information == SKIP
+      @device_information = device_information unless device_information == SKIP
+      @merchant_information = merchant_information unless merchant_information == SKIP
+      @user_interface = user_interface unless user_interface == SKIP
+      unless merchant_defined_information == SKIP
+        @merchant_defined_information =
+          merchant_defined_information
+      end
+      @agreement_information = agreement_information unless agreement_information == SKIP
+      @travel_information = travel_information unless travel_information == 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.
+      if hash['clientReferenceInformation']
+        client_reference_information = ClientReferenceInformation26.from_hash(hash['clientReferenceInformation'])
+      end
+      processing_information = ProcessingInformation23.from_hash(hash['processingInformation']) if
+        hash['processingInformation']
+      payment_information = PaymentInformation22.from_hash(hash['paymentInformation']) if
+        hash['paymentInformation']
+      order_information = OrderInformation26.from_hash(hash['orderInformation']) if
+        hash['orderInformation']
+      buyer_information = BuyerInformation9.from_hash(hash['buyerInformation']) if
+        hash['buyerInformation']
+      device_information = DeviceInformation7.from_hash(hash['deviceInformation']) if
+        hash['deviceInformation']
+      merchant_information = MerchantInformation14.from_hash(hash['merchantInformation']) if
+        hash['merchantInformation']
+      user_interface = UserInterface.from_hash(hash['userInterface']) if hash['userInterface']
+      # Parameter is an array, so we need to iterate through it
+      merchant_defined_information = nil
+      unless hash['merchantDefinedInformation'].nil?
+        merchant_defined_information = []
+        hash['merchantDefinedInformation'].each do |structure|
+          merchant_defined_information << (MerchantDefinedInformation.from_hash(structure) if structure)
+        end
+      end
+
+      merchant_defined_information = SKIP unless hash.key?('merchantDefinedInformation')
+      agreement_information = AgreementInformation10.from_hash(hash['agreementInformation']) if
+        hash['agreementInformation']
+      travel_information = TravelInformation6.from_hash(hash['travelInformation']) if
+        hash['travelInformation']
+
+      # Create object from extracted values.
+      CreateSessionRequest.new(client_reference_information,
+                               processing_information,
+                               payment_information,
+                               order_information,
+                               buyer_information,
+                               device_information,
+                               merchant_information,
+                               user_interface,
+                               merchant_defined_information,
+                               agreement_information,
+                               travel_information)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_information: #{@client_reference_information},"\
+      " processing_information: #{@processing_information}, payment_information:"\
+      " #{@payment_information}, order_information: #{@order_information}, buyer_information:"\
+      " #{@buyer_information}, device_information: #{@device_information}, merchant_information:"\
+      " #{@merchant_information}, user_interface: #{@user_interface},"\
+      " merchant_defined_information: #{@merchant_defined_information}, agreement_information:"\
+      " #{@agreement_information}, travel_information: #{@travel_information}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_reference_information: #{@client_reference_information.inspect},"\
+      " processing_information: #{@processing_information.inspect}, payment_information:"\
+      " #{@payment_information.inspect}, order_information: #{@order_information.inspect},"\
+      " buyer_information: #{@buyer_information.inspect}, device_information:"\
+      " #{@device_information.inspect}, merchant_information: #{@merchant_information.inspect},"\
+      " user_interface: #{@user_interface.inspect}, merchant_defined_information:"\
+      " #{@merchant_defined_information.inspect}, agreement_information:"\
+      " #{@agreement_information.inspect}, travel_information: #{@travel_information.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/credit_amount_details.rb

@@ -0,0 +1,101 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CreditAmountDetails Model.
+  class CreditAmountDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Amount that was credited to the cardholder’s account.
+    # Returned by PIN debit credit.
+    # @return [String]
+    attr_accessor :credit_amount
+
+    # Currency used for the order. Use the three-character [ISO Standard
+    # Currency Codes.](
+    # #### Used by
+    # **Authorization**
+    # Required field.
+    # **Authorization Reversal**
+    # For an authorization reversal (`reversalInformation`) or a capture
+    # (`processingOptions.capture` is set to `true`), you must use the same
+    # currency that you used in your payment authorization request.
+    # #### PIN Debit
+    # Currency for the amount you requested for the PIN debit purchase. This
+    # value is returned for partial authorizations. The issuing bank can approve
+    # a partial amount if the balance on the debit card is less than the
+    # requested transaction amount. For the possible values, see the [ISO
+    # Standard Currency Codes](
+    # Returned by PIN debit purchase.
+    # For PIN debit reversal requests, you must use the same currency that was
+    # used for the PIN debit purchase or PIN debit credit that you are
+    # reversing.
+    # For the possible values, see the [ISO Standard Currency Codes](
+    # Required field for PIN Debit purchase and PIN Debit credit requests.
+    # Optional field for PIN Debit reversal requests.
+    # #### GPX
+    # This field is optional for reversing an authorization or credit.
+    # #### DCC for First Data
+    # Your local currency.
+    # #### Tax Calculation
+    # Required for international tax and value added tax only.
+    # Optional for U.S. and Canadian taxes.
+    # Your local currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['credit_amount'] = 'creditAmount'
+      @_hash['currency'] = 'currency'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        credit_amount
+        currency
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(credit_amount = SKIP, currency = SKIP)
+      @credit_amount = credit_amount unless credit_amount == SKIP
+      @currency = currency unless currency == 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.
+      credit_amount = hash.key?('creditAmount') ? hash['creditAmount'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+
+      # Create object from extracted values.
+      CreditAmountDetails.new(credit_amount,
+                              currency)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit_amount: #{@credit_amount}, currency: #{@currency}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} credit_amount: #{@credit_amount.inspect}, currency: #{@currency.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/currency_conversion.rb

@@ -0,0 +1,86 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CurrencyConversion Model.
+  class CurrencyConversion < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Flag indicating that DCC Lookup has been performed before this
+    # transaction. Set this field to 1 when cardholders opts to use DCC on the
+    # transaction.
+    # @return [String]
+    attr_accessor :indicator
+
+    # Unique identifier generated by the DCC provider.
+    # @return [String]
+    attr_accessor :reconciliation_id
+
+    # Value of the Visa Acceptance request ID returned in a DCC Lookup
+    # transaction.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['indicator'] = 'indicator'
+      @_hash['reconciliation_id'] = 'reconciliationId'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        indicator
+        reconciliation_id
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(indicator = SKIP, reconciliation_id = SKIP, id = SKIP)
+      @indicator = indicator unless indicator == SKIP
+      @reconciliation_id = reconciliation_id unless reconciliation_id == SKIP
+      @id = id unless 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.
+      indicator = hash.key?('indicator') ? hash['indicator'] : SKIP
+      reconciliation_id =
+        hash.key?('reconciliationId') ? hash['reconciliationId'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      CurrencyConversion.new(indicator,
+                             reconciliation_id,
+                             id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} indicator: #{@indicator}, reconciliation_id: #{@reconciliation_id}, id:"\
+      " #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} indicator: #{@indicator.inspect}, reconciliation_id:"\
+      " #{@reconciliation_id.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/customer.rb

@@ -0,0 +1,86 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Customer Model.
+  class Customer < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the customer's card and billing information.
+    # When you use Payment Tokenization or Recurring Billing and you include
+    # this value in
+    # your request, many of the fields that are normally required for an
+    # authorization or credit
+    # become optional.
+    # **NOTE** When you use Payment Tokenization or Recurring Billing, the value
+    # for the Customer ID is actually the Visa Acceptance payment token for a
+    # customer. This token stores information such as the consumer’s card number
+    # so it can be applied towards bill payments, recurring payments, or
+    # one-time payments. By using this token in a payment API request, the
+    # merchant doesn't need to pass in data such as the card number or
+    # expiration date in the request itself.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # Unique identifier for the Customer token used in the transaction.
+    # When you include this value in your request, many of the fields that are
+    # normally required for an authorization or credit
+    # become optional.
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customerId'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_id = SKIP, id = SKIP)
+      @customer_id = customer_id unless customer_id == SKIP
+      @id = id unless 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.
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      Customer.new(customer_id,
+                   id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id}, id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/customer1.rb

@@ -0,0 +1,73 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Customer1 Model.
+  class Customer1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This is the endpoint of the resource that was created by the successful
+    # request.
+    # @return [String]
+    attr_accessor :href
+
+    # `method` refers to the HTTP method that you can send to the `self`
+    # endpoint to retrieve details of the resource.
+    # @return [String]
+    attr_accessor :method
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash['method'] = 'method'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+        method
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP, method = SKIP)
+      @href = href unless href == SKIP
+      @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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+      method = hash.key?('method') ? hash['method'] : SKIP
+
+      # Create object from extracted values.
+      Customer1.new(href,
+                    method)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}, method: #{@method}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}, method: #{@method.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/customer10.rb

@@ -0,0 +1,74 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Customer10 Model.
+  class Customer10 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the customer's card and billing information.
+    # When you use Payment Tokenization or Recurring Billing and you include
+    # this value in
+    # your request, many of the fields that are normally required for an
+    # authorization or credit
+    # become optional.
+    # **NOTE** When you use Payment Tokenization or Recurring Billing, the value
+    # for the Customer ID is actually the Visa Acceptance payment token for a
+    # customer. This token stores information such as the consumer’s card number
+    # so it can be applied towards bill payments, recurring payments, or
+    # one-time payments. By using this token in a payment API request, the
+    # merchant doesn't need to pass in data such as the card number or
+    # expiration date in the request itself.
+    # @return [String]
+    attr_accessor :customer_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_id'] = 'customerId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_id = SKIP)
+      @customer_id = customer_id unless customer_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.
+      customer_id = hash.key?('customerId') ? hash['customerId'] : SKIP
+
+      # Create object from extracted values.
+      Customer10.new(customer_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_id: #{@customer_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/customer14.rb

@@ -0,0 +1,62 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Customer14 Model.
+  class Customer14 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Link to the Customer.
+    # @return [String]
+    attr_accessor :href
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['href'] = 'href'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        href
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(href = SKIP)
+      @href = href unless href == 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.
+      href = hash.key?('href') ? hash['href'] : SKIP
+
+      # Create object from extracted values.
+      Customer14.new(href)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} href: #{@href.inspect}>"
+    end
+  end
+end