visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/card13.rb

@@ -0,0 +1,104 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # The expirationMonth, expirationYear and securityCode is sent to the issuer
+  # as part of network token enrollment and is not stored under the Instrument
+  # Identifier.
+  class Card13 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer’s payment card number, also known as the Primary Account
+    # Number (PAN). You can also use this field
+    # for encoded account numbers.
+    # @return [String]
+    attr_accessor :number
+
+    # Two-digit month in which the payment card expires.
+    # Format: `MM`.
+    # Possible Values: `01` through `12`.
+    # @return [String]
+    attr_accessor :expiration_month
+
+    # Four-digit year in which the credit card expires.
+    # Format: `YYYY`.
+    # @return [String]
+    attr_accessor :expiration_year
+
+    # Card Verification Code. 
+    # This value is sent to the issuer to support the approval of a network
+    # token provision.
+    # It is not persisted against the Instrument Identifier.
+    # @return [String]
+    attr_accessor :security_code
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiration_month'] = 'expirationMonth'
+      @_hash['expiration_year'] = 'expirationYear'
+      @_hash['security_code'] = 'securityCode'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        expiration_month
+        expiration_year
+        security_code
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, expiration_month = SKIP,
+                   expiration_year = SKIP, security_code = SKIP)
+      @number = number unless number == SKIP
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @security_code = security_code unless security_code == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiration_month =
+        hash.key?('expirationMonth') ? hash['expirationMonth'] : SKIP
+      expiration_year =
+        hash.key?('expirationYear') ? hash['expirationYear'] : SKIP
+      security_code = hash.key?('securityCode') ? hash['securityCode'] : SKIP
+
+      # Create object from extracted values.
+      Card13.new(number,
+                 expiration_month,
+                 expiration_year,
+                 security_code)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, expiration_month: #{@expiration_month},"\
+      " expiration_year: #{@expiration_year}, security_code: #{@security_code}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, expiration_month: #{@expiration_month.inspect},"\
+      " expiration_year: #{@expiration_year.inspect}, security_code: #{@security_code.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/card14.rb

@@ -0,0 +1,110 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Card object used to create a network token
+  class Card14 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The customer’s payment card number, also known as the Primary Account
+    # Number (PAN).
+    # @return [String]
+    attr_accessor :number
+
+    # Two-digit month in which the payment card expires.
+    # Format: `MM`.
+    # Possible Values: `01` through `12`.
+    # @return [String]
+    attr_accessor :expiration_month
+
+    # Four-digit year in which the credit card expires.
+    # Format: `YYYY`.
+    # @return [String]
+    attr_accessor :expiration_year
+
+    # The type of card (Card Network).
+    # Possible Values:
+    # - 001: visa
+    # @return [String]
+    attr_accessor :type
+
+    # The customer’s latest payment card number suffix.
+    # @return [String]
+    attr_accessor :suffix
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['number'] = 'number'
+      @_hash['expiration_month'] = 'expirationMonth'
+      @_hash['expiration_year'] = 'expirationYear'
+      @_hash['type'] = 'type'
+      @_hash['suffix'] = 'suffix'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        number
+        expiration_month
+        expiration_year
+        type
+        suffix
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(number = SKIP, expiration_month = SKIP,
+                   expiration_year = SKIP, type = SKIP, suffix = SKIP)
+      @number = number unless number == SKIP
+      @expiration_month = expiration_month unless expiration_month == SKIP
+      @expiration_year = expiration_year unless expiration_year == SKIP
+      @type = type unless type == SKIP
+      @suffix = suffix unless suffix == 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.
+      number = hash.key?('number') ? hash['number'] : SKIP
+      expiration_month =
+        hash.key?('expirationMonth') ? hash['expirationMonth'] : SKIP
+      expiration_year =
+        hash.key?('expirationYear') ? hash['expirationYear'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      suffix = hash.key?('suffix') ? hash['suffix'] : SKIP
+
+      # Create object from extracted values.
+      Card14.new(number,
+                 expiration_month,
+                 expiration_year,
+                 type,
+                 suffix)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number}, expiration_month: #{@expiration_month},"\
+      " expiration_year: #{@expiration_year}, type: #{@type}, suffix: #{@suffix}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} number: #{@number.inspect}, expiration_month: #{@expiration_month.inspect},"\
+      " expiration_year: #{@expiration_year.inspect}, type: #{@type.inspect}, suffix:"\
+      " #{@suffix.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/card15.rb

@@ -0,0 +1,287 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Card15 Model.
+  class Card15 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # This field contains a 3-digit numeric value that indicates the card type
+    # within Visa Acceptance eco-system.
+    # Possible values from BIN Lookup Service (based on availability and
+    # enablement):
+    # - `000`: Unsupported Card Type
+    # - `001`: Visa
+    # - `002`: Mastercard
+    # - `003`: American Express
+    # - `004`: Discover
+    # - `005`: Diners Club
+    # - `007`: JCB
+    # - `036`: Cartes Bancaire
+    # - `042`: Maestro
+    # - `054`: Elo
+    # - `058`: Carnet
+    # - `060`: MADA
+    # - `061`: RuPay
+    # - `062`: China UnionPay
+    # - `064`: Prompt Card
+    # - `067`: Meeza
+    # - `068`: PayPak
+    # - `070`: EFTPOS
+    # - `081`: Jaywan
+    # - `082`: TPN
+    # Glossary of possible values in the payments ecosystem:
+    # - `001`: Visa
+    # - `002`: Mastercard
+    # - `003`: American Express
+    # - `004`: Discover
+    # - `005`: Diners Club
+    # - `006`: Carte Blanche
+    # - `007`: JCB
+    # - `008`: Optima
+    # - `009`: GE Private Label
+    # - `010`: Beneficial Private Label
+    # - `011`: Twinpay Credit Card
+    # - `012`: Twinpay Debit Card
+    # - `013`: Walmart
+    # - `014`: EnRoute
+    # - `015`: Lowe's Consumer
+    # - `016`: Home Depot Consumer
+    # - `017`: MBNA
+    # - `018`: Dick's Sportwear
+    # - `019`: Casual Corner
+    # - `020`: Sears
+    # - `021`: JAL
+    # - `023`: Disney Card
+    # - `024`: Switch/Solo
+    # - `025`: Sam's Club Consumer
+    # - `026`: Sam's Club Business
+    # - `027`: Nico's
+    # - `028`: Paymentech Bill Me Later
+    # - `029`: Bebe
+    # - `030`: Restoration Hardware
+    # - `031`: Delta Online
+    # - `032`: Solo
+    # - `033`: Visa Electron
+    # - `034`: Dankort
+    # - `035`: Laser
+    # - `036`: Cartes Bancaire
+    # - `037`: Carta Si
+    # - `040`: UATP
+    # - `041`: HOUSEHOLD
+    # - `042`: Maestro
+    # - `043`: GE MONEY
+    # - `044`: Korean Cards
+    # - `045`: Style Cards
+    # - `046`: J.Crew
+    # - `047`: Payeasecn eWallet
+    # - `048`: Payeasecn Bank Transfer
+    # - `049`: Meijer
+    # - `050`: Hipercard
+    # - `051`: Aura
+    # - `052`: Redecard
+    # - `053`: Orico Card
+    # - `054`: Elo
+    # - `055`: Capital One Private Label
+    # - `057`: Costco Private Label
+    # - `058`: Carnet
+    # - `059`: ValueLink
+    # - `060`: MADA
+    # - `061`: RuPay
+    # - `062`: China UnionPay
+    # - `063`: Falabella Private Label
+    # - `064`: Prompt Card
+    # - `065`: Korean Domestic
+    # - `066`: Banricompras
+    # - `067`: Meeza
+    # - `068`: PayPak
+    # - `070`: EFTPOS
+    # - `071`: Codensa
+    # - `072`: Olimpica
+    # - `073`: Colsubsidio
+    # - `074`: Tuya
+    # - `075`: Sodexo
+    # - `076`: Naranja
+    # - `077`: Cabal
+    # - `078`: DINELCO
+    # - `079`: PANAL
+    # - `080`: EPM
+    # - `081`: Jaywan
+    # - `082`: TPN
+    # @return [String]
+    attr_accessor :type
+
+    # This field contains the card brand name. 
+    # Some of the possible values (not an exhaustive list) are -
+    #   - VISA
+    #   - MASTERCARD
+    #   - AMERICAN EXPRESS
+    #   - DISCOVER
+    #   - DINERS CLUB
+    #   - CARTE BLANCHE
+    #   - JCB
+    #   - OPTIMA
+    #   - TWINPAY CREDIT CARD
+    #   - TWINPAY DEBIT CARD
+    #   - WALMART
+    #   - ENROUTE
+    #   - LOWES CONSUMER
+    #   - HOME DEPOT CONSUMER
+    #   - MBNA
+    #   - DICKS SPORTWEAR
+    #   - CASUAL CORNER
+    #   - SEARS
+    #   - JAL
+    #   - DISNEY CARD
+    #   - SWITCH/SOLO
+    #   - SAMS CLUB CONSUMER
+    #   - SAMS CLUB BUSINESS
+    #   - NICOS HOUSE CARD
+    #   - BEBE
+    #   - RESTORATION HARDWARE
+    #   - DELTA ONLINE
+    #   - SOLO
+    #   - VISA ELECTRON
+    #   - DANKORT
+    #   - LASER
+    #   - CARTE BANCAIRE
+    #   - CARTA SI
+    #   - ENCODED ACCOUNT
+    #   - UATP
+    #   - HOUSEHOLD
+    #   - MAESTRO
+    #   - GE CAPITAL
+    #   - KOREAN CARDS
+    #   - STYLE CARDS
+    #   - JCREW
+    #   - MEIJER
+    #   - HIPERCARD
+    #   - AURA
+    #   - REDECARD
+    #   - ORICO HOUSE CARD
+    #   - MADA
+    #   - ELO
+    #   - CAPITAL ONE PRIVATE LABEL
+    #   - CARNET
+    #   - RUPAY
+    #   - CHINA UNION PAY
+    #   - FALABELLA PRIVATE LABEL
+    #   - PROMPTCARD
+    #   - KOREAN DOMESTIC
+    #   - BANRICOMPRAS
+    #   - MEEZA
+    #   - PAYPAK
+    #   - JAYWAN
+    #   - TPN
+    # @return [String]
+    attr_accessor :brand_name
+
+    # This field indicates the 3-letter [ISO Standard Currency Codes]( for the
+    # card currency.
+    # @return [String]
+    attr_accessor :currency
+
+    # This field contains the max length of the card.
+    # @return [String]
+    attr_accessor :max_length
+
+    # This field contains the type of the payment credential.
+    # Possible values:
+    #   - PAN
+    #   - TOKEN
+    # @return [String]
+    attr_accessor :credential_type
+
+    # Array of brands
+    # @return [Array[Brand]]
+    attr_accessor :brands
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['brand_name'] = 'brandName'
+      @_hash['currency'] = 'currency'
+      @_hash['max_length'] = 'maxLength'
+      @_hash['credential_type'] = 'credentialType'
+      @_hash['brands'] = 'brands'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        brand_name
+        currency
+        max_length
+        credential_type
+        brands
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type = SKIP, brand_name = SKIP, currency = SKIP,
+                   max_length = SKIP, credential_type = SKIP, brands = SKIP)
+      @type = type unless type == SKIP
+      @brand_name = brand_name unless brand_name == SKIP
+      @currency = currency unless currency == SKIP
+      @max_length = max_length unless max_length == SKIP
+      @credential_type = credential_type unless credential_type == SKIP
+      @brands = brands unless brands == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      brand_name = hash.key?('brandName') ? hash['brandName'] : SKIP
+      currency = hash.key?('currency') ? hash['currency'] : SKIP
+      max_length = hash.key?('maxLength') ? hash['maxLength'] : SKIP
+      credential_type =
+        hash.key?('credentialType') ? hash['credentialType'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      brands = nil
+      unless hash['brands'].nil?
+        brands = []
+        hash['brands'].each do |structure|
+          brands << (Brand.from_hash(structure) if structure)
+        end
+      end
+
+      brands = SKIP unless hash.key?('brands')
+
+      # Create object from extracted values.
+      Card15.new(type,
+                 brand_name,
+                 currency,
+                 max_length,
+                 credential_type,
+                 brands)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, brand_name: #{@brand_name}, currency: #{@currency},"\
+      " max_length: #{@max_length}, credential_type: #{@credential_type}, brands: #{@brands}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, brand_name: #{@brand_name.inspect}, currency:"\
+      " #{@currency.inspect}, max_length: #{@max_length.inspect}, credential_type:"\
+      " #{@credential_type.inspect}, brands: #{@brands.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/card3.rb

@@ -0,0 +1,115 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Card3 Model.
+  class Card3 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Flag that specifies the type of account associated with the card. 
+    # The cardholder provides this information during the payment process.
+    # This field is required in the following cases:
+    #   - Debit transactions on Cielo and Comercio Latino.
+    #   - Transactions with Brazilian-issued cards on Visa Acceptance through
+    # VisaNet.
+    #   - Applicable only for Visa Acceptance through VisaNet (CtV).
+    # **Note** Combo cards in Brazil contain credit and debit functionality in a
+    # single card. Visa systems use a credit bank
+    # identification number (BIN) for this type of card. Using the BIN to
+    # determine whether a card is debit or
+    # credit can cause transactions with these cards to be processed
+    # incorrectly. Visa Acceptance strongly recommends
+    # that you include this field for combo card transactions.
+    # Possible values include the following.
+    #  - `CH`: Checking account
+    #  - `CR`: Credit card account
+    #  - `SA`: Saving account
+    #  - `LI`: Line of credit or credit portion of combo card
+    #  - `PP`: Prepaid card account or prepaid portion of combo card
+    #  - `UA`: Universal account
+    # If useAs is set to credit/debit and there is a value in SourceAccountType,
+    # the value in the SourceAccountType field will take precedence.
+    # If useAs is set to CR/DB and there is a value in SourceAccountType, the
+    # value in the useAs field will take precedence.
+    # @return [String]
+    attr_accessor :source_account_type
+
+    # Type of account that is being used when the value for the
+    # override_payment_method field is line of credit (LI) or prepaid card (PP).
+    # Possible values for line of credit:
+    # - `AGRC`: Visa Agro Custeio
+    # - `AGRE`: Visa Agro Electron
+    # - `AGRI`: Visa Agro Investimento
+    # - `AGRO`: Visa Agro
+    # Possible values for prepaid card:
+    # - `VVA`: Visa Vale Alimentacao
+    # - `VVF`: Visa Vale Flex
+    # - `VVR`: Visa Vale Refeicao
+    # This field is supported only for combo card transactions in Brazil on Visa
+    # Acceptance through VisaNet.
+    # @return [String]
+    attr_accessor :source_account_type_details
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['source_account_type'] = 'sourceAccountType'
+      @_hash['source_account_type_details'] = 'sourceAccountTypeDetails'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        source_account_type
+        source_account_type_details
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(source_account_type = SKIP,
+                   source_account_type_details = SKIP)
+      @source_account_type = source_account_type unless source_account_type == SKIP
+      unless source_account_type_details == SKIP
+        @source_account_type_details =
+          source_account_type_details
+      end
+    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_account_type =
+        hash.key?('sourceAccountType') ? hash['sourceAccountType'] : SKIP
+      source_account_type_details =
+        hash.key?('sourceAccountTypeDetails') ? hash['sourceAccountTypeDetails'] : SKIP
+
+      # Create object from extracted values.
+      Card3.new(source_account_type,
+                source_account_type_details)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_account_type: #{@source_account_type}, source_account_type_details:"\
+      " #{@source_account_type_details}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} source_account_type: #{@source_account_type.inspect},"\
+      " source_account_type_details: #{@source_account_type_details.inspect}>"
+    end
+  end
+end