visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/installment_information3.rb

@@ -0,0 +1,106 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstallmentInformation3 Model.
+  class InstallmentInformation3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # #### American Express Direct, Cielo, and Visa Acceptance Latin American
+    # Processing
+    # Flag that indicates the type of funding for the installment plan
+    # associated with the payment.
+    # Possible values:
+    # - `1`: Merchant-funded installment plan
+    # - `2`: Issuer-funded installment plan
+    # If you do not include this field in the request, Visa Acceptance uses the
+    # value in your Visa Acceptance account.
+    # To change the value in your Visa Acceptance account, contact Visa
+    # Acceptance Customer Service.
+    # #### Visa Acceptance through VisaNet and American Express
+    # Defined code that indicates the type of installment plan for this
+    # transaction.
+    # Contact American Express for:
+    # - Information about the kinds of installment plans that American Express
+    # provides
+    # - Values for this field
+    # For installment payments with American Express in Brazil, the value for
+    # this field corresponds to the following data in the TC 33 capture file*:
+    # - Record: CP07 TCR3
+    # - Position: 5-6
+    # - Field: Plan Type
+    # * The TC 33 Capture file contains information about the purchases and
+    # refunds that a merchant submits to Visa Acceptance. Visa Acceptance
+    # through VisaNet creates the TC 33 Capture file at the end of the day and
+    # sends it to the merchant’s acquirer, who uses this information to
+    # facilitate end-of-day clearing processing with payment card companies.
+    # #### Visa Acceptance through VisaNet with Visa or Mastercard
+    # Flag indicating the type of funding for the installment plan associated
+    # with the payment.
+    # Possible values:
+    # - 1 or 01: Merchant-funded installment plan
+    # - 2 or 02: Issuer-funded installment plan
+    # - 43: Crediario installment plan—only with Visa in Brazil
+    # For installment payments with Visa in Brazil, the value for this field
+    # corresponds to the following data in the TC 33 capture file5:
+    # - Record: CP07 TCR1
+    # - Position: 5-6
+    # - Field: Installment Type
+    # For all other kinds of installment payments, the value for this field
+    # corresponds to the following data in the TC 33 capture file5:
+    # - Record: CP01 TCR5
+    # - Position: 39-40
+    # - Field: Installment Plan Type (Issuer or Merchant)
+    # @return [String]
+    attr_accessor :plan_type
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['plan_type'] = 'planType'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        plan_type
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(plan_type = SKIP)
+      @plan_type = plan_type unless plan_type == 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.
+      plan_type = hash.key?('planType') ? hash['planType'] : SKIP
+
+      # Create object from extracted values.
+      InstallmentInformation3.new(plan_type)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_type: #{@plan_type}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} plan_type: #{@plan_type.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/installment_information4.rb

@@ -0,0 +1,213 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstallmentInformation4 Model.
+  class InstallmentInformation4 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Applicable only for SI. Required in case the authentication is initiated
+    # for SI registration.
+    # Valid Values:
+    # - `SMS`
+    # - `EMAIL`
+    # - `BOTH`
+    # @return [String]
+    attr_accessor :alert_preference
+
+    # Date of the first installment payment. Format: YYMMDD. When you do not
+    # include this field, Visa Acceptance sends a string of six zeros (000000)
+    # to the processor.
+    # This field is supported only for Crediario installment payments in Brazil
+    # on Visa Acceptance through VisaNet.
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file:
+    # - Record: CP01 TCR9
+    # - Position: 42-47
+    # - Field: Date of First Installment
+    # @return [String]
+    attr_accessor :first_installment_date
+
+    # Standing Instruction/Installment identifier.
+    # @return [String]
+    attr_accessor :identifier
+
+    # End date of the SI transactions.
+    # Cannot be later than card expiry date. Ideally this can be set to expiry
+    # date.
+    # Required in case the authentication is initiated for SI registration.
+    # @return [String]
+    attr_accessor :last_installment_date
+
+    # Maximum Amount for which SI can be initiated.
+    # Required in case the authentication is initiated for SI registration.
+    # @return [String]
+    attr_accessor :max_amount
+
+    # Minimum Amount for which SI can be initiated.
+    # Required in case the authentication is initiated for SI registration.
+    # @return [String]
+    attr_accessor :min_amount
+
+    # Payment plan for the installments.
+    # This field is supported only for installment payments on Visa Platform
+    # Connect, RuPay and SPG-KSA seamless flow.
+    # Possible values for a standing-instruction (SI) merchant-initiated
+    # transaction (MIT) with Diners Club or Mastercard in India or with an
+    # India-issued card:
+    # - 1: SI with a fixed amount.
+    # - 2: SI with a maximum amount.
+    # - 3: Other kind of SI.
+    # Possible values for a type of Installment transaction for on-soil
+    # transaction in Kingdom of Saudi Arabia
+    # - 1: Registration or first transaction.
+    # - 2: Subsequent transaction.
+    # Possible values for other kinds of installment payments:
+    # - 0 (default): Regular installment. This value is not allowed for airline
+    # transactions.
+    # - 1: Installment payment with down payment.
+    # - 2: Installment payment without down payment. This value is supported
+    # only for airline transactions.
+    # - 3: Installment payment; down payment and boarding fee will follow. This
+    # value is supported only for airline transactions.
+    # - 4: Down payment only; regular installment payment will follow.
+    # - 5: Boarding fee only. This value is supported only for airline
+    # transactions.
+    # - 6: SI de-registration on RuPay for the payer authentication seamless
+    # flow.
+    # @return [String]
+    attr_accessor :payment_type
+
+    # Preferred date for initiating the SI transaction every month.
+    # This field need not be sent in case the SI has to be initiated as and when
+    # required, e.g., topping up the wallet, etc.
+    # @return [String]
+    attr_accessor :preferred_day
+
+    # Installment number when making payments in installments. Used along with
+    # `totalCount` to track which payment is being processed.
+    # For example, the second of 5 payments would be passed to Visa Acceptance
+    # as `sequence` = 2 and `totalCount` = 5.
+    # #### Chase Paymentech Solutions and FDC Compass
+    # This field is optional because this value is required in the merchant
+    # descriptors.
+    # #### Visa Acceptance through VisaNet
+    # When you do not include this field in a request for a Crediario
+    # installment payment, Visa Acceptance sends a value of 0 to the processor.
+    # For Crediario installment payments, the value for this field corresponds
+    # to the following data in the TC 33 capture file*:
+    # - Record: CP01 TCR9
+    # - Position: 38-40
+    # - Field: Installment Payment Number
+    # * The TC 33 Capture file contains information about the purchases and
+    # refunds that a merchant submits to Visa Acceptance. Visa Acceptance
+    # through VisaNet creates the TC 33 Capture file at the end of the day and
+    # sends it to the merchant’s acquirer, who uses this information to
+    # facilitate end-of-day clearing processing with payment card companies.
+    # @return [Integer]
+    attr_accessor :sequence
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['alert_preference'] = 'alertPreference'
+      @_hash['first_installment_date'] = 'firstInstallmentDate'
+      @_hash['identifier'] = 'identifier'
+      @_hash['last_installment_date'] = 'lastInstallmentDate'
+      @_hash['max_amount'] = 'maxAmount'
+      @_hash['min_amount'] = 'minAmount'
+      @_hash['payment_type'] = 'paymentType'
+      @_hash['preferred_day'] = 'preferredDay'
+      @_hash['sequence'] = 'sequence'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        alert_preference
+        first_installment_date
+        identifier
+        last_installment_date
+        max_amount
+        min_amount
+        payment_type
+        preferred_day
+        sequence
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(alert_preference = SKIP, first_installment_date = SKIP,
+                   identifier = SKIP, last_installment_date = SKIP,
+                   max_amount = SKIP, min_amount = SKIP, payment_type = SKIP,
+                   preferred_day = SKIP, sequence = SKIP)
+      @alert_preference = alert_preference unless alert_preference == SKIP
+      @first_installment_date = first_installment_date unless first_installment_date == SKIP
+      @identifier = identifier unless identifier == SKIP
+      @last_installment_date = last_installment_date unless last_installment_date == SKIP
+      @max_amount = max_amount unless max_amount == SKIP
+      @min_amount = min_amount unless min_amount == SKIP
+      @payment_type = payment_type unless payment_type == SKIP
+      @preferred_day = preferred_day unless preferred_day == SKIP
+      @sequence = sequence unless sequence == 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.
+      alert_preference =
+        hash.key?('alertPreference') ? hash['alertPreference'] : SKIP
+      first_installment_date =
+        hash.key?('firstInstallmentDate') ? hash['firstInstallmentDate'] : SKIP
+      identifier = hash.key?('identifier') ? hash['identifier'] : SKIP
+      last_installment_date =
+        hash.key?('lastInstallmentDate') ? hash['lastInstallmentDate'] : SKIP
+      max_amount = hash.key?('maxAmount') ? hash['maxAmount'] : SKIP
+      min_amount = hash.key?('minAmount') ? hash['minAmount'] : SKIP
+      payment_type = hash.key?('paymentType') ? hash['paymentType'] : SKIP
+      preferred_day = hash.key?('preferredDay') ? hash['preferredDay'] : SKIP
+      sequence = hash.key?('sequence') ? hash['sequence'] : SKIP
+
+      # Create object from extracted values.
+      InstallmentInformation4.new(alert_preference,
+                                  first_installment_date,
+                                  identifier,
+                                  last_installment_date,
+                                  max_amount,
+                                  min_amount,
+                                  payment_type,
+                                  preferred_day,
+                                  sequence)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alert_preference: #{@alert_preference}, first_installment_date:"\
+      " #{@first_installment_date}, identifier: #{@identifier}, last_installment_date:"\
+      " #{@last_installment_date}, max_amount: #{@max_amount}, min_amount: #{@min_amount},"\
+      " payment_type: #{@payment_type}, preferred_day: #{@preferred_day}, sequence: #{@sequence}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} alert_preference: #{@alert_preference.inspect}, first_installment_date:"\
+      " #{@first_installment_date.inspect}, identifier: #{@identifier.inspect},"\
+      " last_installment_date: #{@last_installment_date.inspect}, max_amount:"\
+      " #{@max_amount.inspect}, min_amount: #{@min_amount.inspect}, payment_type:"\
+      " #{@payment_type.inspect}, preferred_day: #{@preferred_day.inspect}, sequence:"\
+      " #{@sequence.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/installment_information5.rb

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

data/lib/visa_acceptance_merged_spec/models/instrument_identifier.rb

@@ -0,0 +1,66 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstrumentIdentifier Model.
+  class InstrumentIdentifier < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the Instrument Identifier token used in the
+    # transaction.
+    # When you include this value in your request, many of the fields that can
+    # be supplied 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['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      InstrumentIdentifier.new(id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/instrument_identifier1.rb

@@ -0,0 +1,73 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstrumentIdentifier1 Model.
+  class InstrumentIdentifier1 < 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.
+      InstrumentIdentifier1.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/instrument_identifier10.rb

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

data/lib/visa_acceptance_merged_spec/models/instrument_identifier2.rb

@@ -0,0 +1,78 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # InstrumentIdentifier2 Model.
+  class InstrumentIdentifier2 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the Instrument Identifier token used in the
+    # transaction.
+    # When you include this value in your request, many of the fields that can
+    # be supplied for an authorization or credit
+    # become optional.
+    # @return [String]
+    attr_accessor :id
+
+    # Issuers state for the card number.
+    # Valid values:
+    # - ACTIVE
+    # - CLOSED : The account has been closed.
+    # @return [String]
+    attr_accessor :state
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['state'] = 'state'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        state
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, state = SKIP)
+      @id = id unless id == SKIP
+      @state = state unless state == 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.
+      id = hash.key?('id') ? hash['id'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+
+      # Create object from extracted values.
+      InstrumentIdentifier2.new(id,
+                                state)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, state: #{@state}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, state: #{@state.inspect}>"
+    end
+  end
+end