visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/mandate1.rb

@@ -0,0 +1,100 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Mandate1 Model.
+  class Mandate1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique value generated by Visa Acceptance that identifies the transaction.
+    # Use this value to identify transactions in the Collections Report, which
+    # provides settlement
+    # information.
+    # For details, see the `direct_debit_reconciliation_reference_number` reply
+    # field description in [Ingenico ePayments Developer Guide For Direct
+    # Debits.](
+    # @return [String]
+    attr_accessor :reference_number
+
+    # Whether the direct debit is the first or last direct debit associated with
+    # the mandate, or one in between.
+    # Required only for the United Kingdom.
+    # Possible values:
+    # - `001`: First direct debit associated with this mandate. Use this value
+    # if a one-time direct debit).
+    # - `002`: Subsequent direct debits associated with this mandate.
+    # - `003`: Last direct debit associated with this mandate.
+    # For details, see the `direct_debit_recurring_type` request field
+    # description in [Ingenico ePayments Developer Guide For Direct Debits.](
+    # @return [String]
+    attr_accessor :recurring_type
+
+    # The mandate ID. Required only for the United Kingdom.
+    # For details, see the `mandate_id` request field description in [Ingenico
+    # ePayments Developer Guide For Direct Debits.](
+    # @return [String]
+    attr_accessor :id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['reference_number'] = 'referenceNumber'
+      @_hash['recurring_type'] = 'recurringType'
+      @_hash['id'] = 'id'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        reference_number
+        recurring_type
+        id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(reference_number = SKIP, recurring_type = SKIP, id = SKIP)
+      @reference_number = reference_number unless reference_number == SKIP
+      @recurring_type = recurring_type unless recurring_type == 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.
+      reference_number =
+        hash.key?('referenceNumber') ? hash['referenceNumber'] : SKIP
+      recurring_type = hash.key?('recurringType') ? hash['recurringType'] : SKIP
+      id = hash.key?('id') ? hash['id'] : SKIP
+
+      # Create object from extracted values.
+      Mandate1.new(reference_number,
+                   recurring_type,
+                   id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_number: #{@reference_number}, recurring_type: #{@recurring_type},"\
+      " id: #{@id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} reference_number: #{@reference_number.inspect}, recurring_type:"\
+      " #{@recurring_type.inspect}, id: #{@id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/match.rb

@@ -0,0 +1,96 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Match Model.
+  class Match < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Address found on the list specified in export_matchN_list
+    # for the entity (name and address) in the request.
+    # @return [Array[String]]
+    attr_accessor :addresses
+
+    # List on which the first Denied Parties List check match appears.
+    # For a list of codes, see "Denied Parties List Check Codes," page 56.
+    # @return [String]
+    attr_accessor :sanction_list
+
+    # Name found on the list specified in export_matchN_list for the entity
+    # (name and address) in the request.
+    # @return [Array[String]]
+    attr_accessor :aliases
+
+    # Sub-lists matched by the order data. List members are separated by carets
+    # (^).
+    # @return [Array[String]]
+    attr_accessor :programs
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['addresses'] = 'addresses'
+      @_hash['sanction_list'] = 'sanctionList'
+      @_hash['aliases'] = 'aliases'
+      @_hash['programs'] = 'programs'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        addresses
+        sanction_list
+        aliases
+        programs
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(addresses = SKIP, sanction_list = SKIP, aliases = SKIP,
+                   programs = SKIP)
+      @addresses = addresses unless addresses == SKIP
+      @sanction_list = sanction_list unless sanction_list == SKIP
+      @aliases = aliases unless aliases == SKIP
+      @programs = programs unless programs == 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.
+      addresses = hash.key?('addresses') ? hash['addresses'] : SKIP
+      sanction_list = hash.key?('sanctionList') ? hash['sanctionList'] : SKIP
+      aliases = hash.key?('aliases') ? hash['aliases'] : SKIP
+      programs = hash.key?('programs') ? hash['programs'] : SKIP
+
+      # Create object from extracted values.
+      Match.new(addresses,
+                sanction_list,
+                aliases,
+                programs)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} addresses: #{@addresses}, sanction_list: #{@sanction_list}, aliases:"\
+      " #{@aliases}, programs: #{@programs}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} addresses: #{@addresses.inspect}, sanction_list: #{@sanction_list.inspect},"\
+      " aliases: #{@aliases.inspect}, programs: #{@programs.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_advice.rb

@@ -0,0 +1,156 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantAdvice Model.
+  class MerchantAdvice < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # - Merchant should update their retry logic to ensure retry is not
+    # attempted for the cards for which Issuer won’t approve the transactions
+    # and where the retry is allowed.
+    # - Card Processing Associations provides this data which is being passed
+    # through in the following data element irrespective of the Card
+    # Associations.   Usage of this data must be always associated with the Card
+    # Associations card types for merchant processing retry logic.
+    # - In additions to the Merchant Advice code, Associations also provides the
+    # decline response codes which provides the reason for decline.  Association
+    # response code will be a pass-through value.
+    # #### Processors supported:
+    #   - HSBC
+    #   - Barclays
+    #   - FDC Nash
+    #   - FDI Global
+    #   - Elavon America
+    #   - VPC
+    #   - Rede
+    #   - Payment tech Salem
+    # #### Possible values:
+    # | Card Type   | Advice Code   |  Description
+    #  |
+    # | ----------- | ------------- |
+    # ------------------------------------------- |
+    # | VISA        | 1             | Issuer never approves
+    #  |
+    # | VISA        | 2             | Issuer cannot approve at this time
+    #  |
+    # | VISA        | 3             | Data quality/revalidate payment
+    # information |
+    # | MasterCard  | 01            | New account information available
+    #  |
+    # | MasterCard  | 02            | Try Again Later
+    #  |
+    # | MasterCard  | 03            | Do Not Try Again
+    #  |
+    # | MasterCard  | 04            | Token not supported
+    #  |
+    # | MasterCard  | 21            | Do not honor
+    #  |
+    # | MasterCard  | 22            | Merchant does not qualify for product code
+    #  |
+    # | MasterCard  | 24            | Retry after 1 hour
+    #  |
+    # | MasterCard  | 25            | Retry after 24 hours
+    #  |
+    # | MasterCard  | 26            | Retry after 2 days
+    #  |
+    # | MasterCard  | 27            | Retry after 4 days
+    #  |
+    # | MasterCard  | 28            | Retry after 6 days
+    #  |
+    # | MasterCard  | 29            | Retry after 8 days
+    #  |
+    # | MasterCard  | 30            | Retry after 10 days
+    #  |
+    # | MasterCard  | 40            | Consumer non-reloadable prepaid card
+    #  |
+    # | MasterCard  | 41            | Consumer single-use virtual card number
+    #  |
+    # | MasterCard  | 42            | Sanctions score exceeds threshold value
+    #  |
+    # | MasterCard  | 99            | Do Not Try Again
+    #  |
+    # @return [String]
+    attr_accessor :code
+
+    # Raw merchant advice code sent directly from the processor. This field is
+    # used only for Mastercard.
+    # #### Visa Acceptance through VisaNet
+    # The value for this field corresponds to the following data in the TC 33
+    # capture file1:
+    # - Record: CP01 TCR7
+    # - Position: 96-99
+    # - Field: Response Data-Merchant Advice Code
+    # @return [String]
+    attr_accessor :code_raw
+
+    # #### Visa Platform Connect
+    # The field contains will contain the Account Name Request Result for zero
+    # amount Authorization request. Valid values are:
+    # 00 = Name Match Performed
+    # 01 = Name Match not Performed
+    # 02 = Name Match not supported
+    # @return [String]
+    attr_accessor :name_match
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['code'] = 'code'
+      @_hash['code_raw'] = 'codeRaw'
+      @_hash['name_match'] = 'nameMatch'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        code
+        code_raw
+        name_match
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(code = SKIP, code_raw = SKIP, name_match = SKIP)
+      @code = code unless code == SKIP
+      @code_raw = code_raw unless code_raw == SKIP
+      @name_match = name_match unless name_match == 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.
+      code = hash.key?('code') ? hash['code'] : SKIP
+      code_raw = hash.key?('codeRaw') ? hash['codeRaw'] : SKIP
+      name_match = hash.key?('nameMatch') ? hash['nameMatch'] : SKIP
+
+      # Create object from extracted values.
+      MerchantAdvice.new(code,
+                         code_raw,
+                         name_match)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code}, code_raw: #{@code_raw}, name_match: #{@name_match}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} code: #{@code.inspect}, code_raw: #{@code_raw.inspect}, name_match:"\
+      " #{@name_match.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_defined_information.rb

@@ -0,0 +1,112 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDefinedInformation Model.
+  class MerchantDefinedInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number you assign for as the key for your merchant-defined data field.
+    # Valid values are 0 to 100.
+    # For example, to set or access the key for the 2nd merchant-defined data
+    # field in the array, you would reference
+    # `merchantDefinedInformation[1].key`.
+    # #### Visa Acceptance through VisaNet
+    # For installment payments with Mastercard in Brazil, use
+    # `merchantDefinedInformation[0].key` and
+    # `merchantDefinedInformation[1].key` for data that you want to provide to
+    # the issuer to identify the
+    # transaction.
+    # @return [String]
+    attr_accessor :key
+
+    # The value you assign for your merchant-defined data field.
+    # **Warning** Merchant-defined data fields are not intended to and must not
+    # be used to capture personally identifying information. Accordingly,
+    # merchants are prohibited from capturing, obtaining, and/or transmitting
+    # any personally identifying information in or via the merchant-defined data
+    # fields. Personally identifying information includes, but is not
+    # limited to, address, credit card number, social security number, driver's
+    # license number, state-issued identification number, passport number, and
+    # card verification numbers (CVV,
+    # CVC2, CVV2, CID, CVN). In the event Visa Acceptance discovers that a
+    # merchant is capturing and/or transmitting personally identifying
+    # information via the merchant-defined data fields, whether or not
+    # intentionally, Visa Acceptance will immediately suspend the merchant's
+    # account, which will result in a rejection of any and all transaction
+    # requests submitted by the merchant after the point of suspension.
+    # #### Visa Acceptance through VisaNet
+    # For installment payments with Mastercard in Brazil, use
+    # `merchantDefinedInformation[0].value` and
+    # `merchantDefinedInformation[1].value` for data that you want to provide to
+    # the issuer to identify the
+    # transaction. 
+    # For installment payments with Mastercard in Brazil:
+    # - The value for merchantDefinedInformation[0].value corresponds to the
+    # following data in the TC 33 capture file5:
+    #   - Record: CP07 TCR5
+    #   - Position: 25-44
+    #   - Field: Reference Field 2
+    # - The value for merchantDefinedInformation[1].value corresponds to the
+    # following data in the TC 33 capture file5:
+    #   - Record: CP07 TCR5
+    #   - Position: 45-64
+    #   - Field: Reference Field 3
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['key'] = 'key'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        key
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(key = SKIP, value = SKIP)
+      @key = key unless key == SKIP
+      @value = value unless value == 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.
+      key = hash.key?('key') ? hash['key'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDefinedInformation.new(key,
+                                     value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} key: #{@key.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_defined_information7.rb

@@ -0,0 +1,97 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # MerchantDefinedInformation7 Model.
+  class MerchantDefinedInformation7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number you assign as the name for your merchant-defined data or secure
+    # field. Possible Values are data1 to data4 and sensitive1 to sensitive4
+    # For example, to set the name for merchant-defined data 2 field, you would
+    # reference merchantDefinedInformation[x].name as data2
+    # Possible Values:
+    # - data1
+    # - data2
+    # - data3
+    # - data4
+    # - sensitive1
+    # - sensitive2
+    # - sensitive3
+    # - sensitive4
+    # @return [String]
+    attr_accessor :name
+
+    # The value you assign for your merchant-defined data field.
+    # **Warning** Merchant-defined data fields are not intended to and must not
+    # be used to capture personally identifying information. Accordingly,
+    # merchants are prohibited from capturing, obtaining, and/or transmitting
+    # any personally identifying information in or via the merchant-defined data
+    # fields. Personally identifying information includes, but is not
+    # limited to, address, credit card number, social security number, driver's
+    # license number, state-issued identification number, passport number, and
+    # card verification numbers (CVV,
+    # CVC2, CVV2, CID, CVN). In the event it is discovered a merchant is
+    # capturing and/or transmitting personally identifying information via the
+    # merchant-defined data fields, whether or not intentionally, the merchant's
+    # account will immediately be suspended, which will result in a rejection of
+    # any and all transaction requests submitted by the merchant after the point
+    # of suspension.
+    # @return [String]
+    attr_accessor :value
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['name'] = 'name'
+      @_hash['value'] = 'value'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        name
+        value
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(name = SKIP, value = SKIP)
+      @name = name unless name == SKIP
+      @value = value unless value == 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.
+      name = hash.key?('name') ? hash['name'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDefinedInformation7.new(name,
+                                      value)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name}, value: #{@value}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} name: #{@name.inspect}, value: #{@value.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/merchant_defined_secure_information.rb

@@ -0,0 +1,92 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # The object containing the secure data that the merchant defines.
+  class MerchantDefinedSecureInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The value you assign for your merchant-secure data field 1.
+    # @return [String]
+    attr_accessor :secure1
+
+    # The value you assign for your merchant-secure data field 2.
+    # @return [String]
+    attr_accessor :secure2
+
+    # The value you assign for your merchant-secure data field 3.
+    # @return [String]
+    attr_accessor :secure3
+
+    # The value you assign for your merchant-secure data field 4.
+    # @return [String]
+    attr_accessor :secure4
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['secure1'] = 'secure1'
+      @_hash['secure2'] = 'secure2'
+      @_hash['secure3'] = 'secure3'
+      @_hash['secure4'] = 'secure4'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        secure1
+        secure2
+        secure3
+        secure4
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(secure1 = SKIP, secure2 = SKIP, secure3 = SKIP,
+                   secure4 = SKIP)
+      @secure1 = secure1 unless secure1 == SKIP
+      @secure2 = secure2 unless secure2 == SKIP
+      @secure3 = secure3 unless secure3 == SKIP
+      @secure4 = secure4 unless secure4 == 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.
+      secure1 = hash.key?('secure1') ? hash['secure1'] : SKIP
+      secure2 = hash.key?('secure2') ? hash['secure2'] : SKIP
+      secure3 = hash.key?('secure3') ? hash['secure3'] : SKIP
+      secure4 = hash.key?('secure4') ? hash['secure4'] : SKIP
+
+      # Create object from extracted values.
+      MerchantDefinedSecureInformation.new(secure1,
+                                           secure2,
+                                           secure3,
+                                           secure4)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} secure1: #{@secure1}, secure2: #{@secure2}, secure3: #{@secure3}, secure4:"\
+      " #{@secure4}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} secure1: #{@secure1.inspect}, secure2: #{@secure2.inspect}, secure3:"\
+      " #{@secure3.inspect}, secure4: #{@secure4.inspect}>"
+    end
+  end
+end