visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/brand_logo_asset.rb

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

data/lib/visa_acceptance_merged_spec/models/buyer_history.rb

@@ -0,0 +1,173 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # BuyerHistory Model.
+  class BuyerHistory < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [CustomerAccount]
+    attr_accessor :customer_account
+
+    # TODO: Write general description for this method
+    # @return [AccountHistory]
+    attr_accessor :account_history
+
+    # Number of purchases with this cardholder account during the previous six
+    # months.
+    # Recommended for Discover ProtectBuy.
+    # @return [Integer]
+    attr_accessor :account_purchases
+
+    # Number of add card attempts in the last 24 hours.
+    # Recommended for Discover ProtectBuy.
+    # @return [Integer]
+    attr_accessor :add_card_attempts
+
+    # Indicates whether the merchant experienced suspicious activity (including
+    # previous fraud) on the account.
+    # Recommended for Discover ProtectBuy.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :prior_suspicious_activity
+
+    # This only applies for NEW_ACCOUNT and EXISTING_ACCOUNT in creationHistory.
+    # Possible values are:
+    # - PAYMENT_ACCOUNT_EXISTS
+    # - PAYMENT_ACCOUNT_ADDED_NOW
+    # @return [String]
+    attr_accessor :payment_account_history
+
+    # Date applicable only for PAYMENT_ACCOUNT_EXISTS in paymentAccountHistory
+    # @return [Integer]
+    attr_accessor :payment_account_date
+
+    # Number of transaction (successful or abandoned) for this cardholder
+    # account within the last 24 hours.
+    # Recommended for Discover ProtectBuy.
+    # @return [Integer]
+    attr_accessor :transaction_count_day
+
+    # Number of transaction (successful or abandoned) for this cardholder
+    # account within the last year.
+    # Recommended for Discover ProtectBuy.
+    # @return [Integer]
+    attr_accessor :transaction_count_year
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['customer_account'] = 'customerAccount'
+      @_hash['account_history'] = 'accountHistory'
+      @_hash['account_purchases'] = 'accountPurchases'
+      @_hash['add_card_attempts'] = 'addCardAttempts'
+      @_hash['prior_suspicious_activity'] = 'priorSuspiciousActivity'
+      @_hash['payment_account_history'] = 'paymentAccountHistory'
+      @_hash['payment_account_date'] = 'paymentAccountDate'
+      @_hash['transaction_count_day'] = 'transactionCountDay'
+      @_hash['transaction_count_year'] = 'transactionCountYear'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        customer_account
+        account_history
+        account_purchases
+        add_card_attempts
+        prior_suspicious_activity
+        payment_account_history
+        payment_account_date
+        transaction_count_day
+        transaction_count_year
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(customer_account = SKIP, account_history = SKIP,
+                   account_purchases = SKIP, add_card_attempts = SKIP,
+                   prior_suspicious_activity = SKIP,
+                   payment_account_history = SKIP, payment_account_date = SKIP,
+                   transaction_count_day = SKIP, transaction_count_year = SKIP)
+      @customer_account = customer_account unless customer_account == SKIP
+      @account_history = account_history unless account_history == SKIP
+      @account_purchases = account_purchases unless account_purchases == SKIP
+      @add_card_attempts = add_card_attempts unless add_card_attempts == SKIP
+      unless prior_suspicious_activity == SKIP
+        @prior_suspicious_activity =
+          prior_suspicious_activity
+      end
+      @payment_account_history = payment_account_history unless payment_account_history == SKIP
+      @payment_account_date = payment_account_date unless payment_account_date == SKIP
+      @transaction_count_day = transaction_count_day unless transaction_count_day == SKIP
+      @transaction_count_year = transaction_count_year unless transaction_count_year == 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_account = CustomerAccount.from_hash(hash['customerAccount']) if
+        hash['customerAccount']
+      account_history = AccountHistory.from_hash(hash['accountHistory']) if hash['accountHistory']
+      account_purchases =
+        hash.key?('accountPurchases') ? hash['accountPurchases'] : SKIP
+      add_card_attempts =
+        hash.key?('addCardAttempts') ? hash['addCardAttempts'] : SKIP
+      prior_suspicious_activity =
+        hash.key?('priorSuspiciousActivity') ? hash['priorSuspiciousActivity'] : SKIP
+      payment_account_history =
+        hash.key?('paymentAccountHistory') ? hash['paymentAccountHistory'] : SKIP
+      payment_account_date =
+        hash.key?('paymentAccountDate') ? hash['paymentAccountDate'] : SKIP
+      transaction_count_day =
+        hash.key?('transactionCountDay') ? hash['transactionCountDay'] : SKIP
+      transaction_count_year =
+        hash.key?('transactionCountYear') ? hash['transactionCountYear'] : SKIP
+
+      # Create object from extracted values.
+      BuyerHistory.new(customer_account,
+                       account_history,
+                       account_purchases,
+                       add_card_attempts,
+                       prior_suspicious_activity,
+                       payment_account_history,
+                       payment_account_date,
+                       transaction_count_day,
+                       transaction_count_year)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_account: #{@customer_account}, account_history:"\
+      " #{@account_history}, account_purchases: #{@account_purchases}, add_card_attempts:"\
+      " #{@add_card_attempts}, prior_suspicious_activity: #{@prior_suspicious_activity},"\
+      " payment_account_history: #{@payment_account_history}, payment_account_date:"\
+      " #{@payment_account_date}, transaction_count_day: #{@transaction_count_day},"\
+      " transaction_count_year: #{@transaction_count_year}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} customer_account: #{@customer_account.inspect}, account_history:"\
+      " #{@account_history.inspect}, account_purchases: #{@account_purchases.inspect},"\
+      " add_card_attempts: #{@add_card_attempts.inspect}, prior_suspicious_activity:"\
+      " #{@prior_suspicious_activity.inspect}, payment_account_history:"\
+      " #{@payment_account_history.inspect}, payment_account_date:"\
+      " #{@payment_account_date.inspect}, transaction_count_day:"\
+      " #{@transaction_count_day.inspect}, transaction_count_year:"\
+      " #{@transaction_count_year.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/buyer_information.rb

@@ -0,0 +1,222 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # BuyerInformation Model.
+  class BuyerInformation < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your identifier for the customer.
+    # When a subscription or customer profile is being created, the maximum
+    # length for this field for most processors is 30. Otherwise, the maximum
+    # length is 100.
+    # #### Comercio Latino
+    # For recurring payments in Mexico, the value is the customer’s contract
+    # number.
+    # Note Before you request the authorization, you must inform the issuer of
+    # the customer contract numbers that will be used for recurring
+    # transactions.
+    # #### Worldpay VAP
+    # For a follow-on credit with Worldpay VAP, Visa Acceptance checks the
+    # following locations, in the order
+    # given, for a customer account ID value and uses the first value it finds:
+    # 1. `customer_account_id` value in the follow-on credit request
+    # 2. Customer account ID value that was used for the capture that is being
+    # credited
+    # 3. Customer account ID value that was used for the original authorization
+    # If a customer account ID value cannot be found in any of these locations,
+    # then no value is used.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # Recipient’s date of birth. **Format**: `YYYYMMDD`.
+    # This field is a `pass-through`, which means that Visa Acceptance ensures
+    # that the value is eight numeric characters
+    # but otherwise does not verify the value or modify it in any way before
+    # sending it to the processor. If the field
+    # is not required for the transaction, Visa Acceptance does not forward it
+    # to the processor.
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Customer’s government-assigned tax identification number.
+    # #### Tax Calculation
+    # Optional for international and value added taxes only. Not applicable to
+    # U.S. and Canadian taxes.
+    # @return [String]
+    attr_accessor :vat_registration_number
+
+    # Company’s tax identifier. This is only used for eCheck service.
+    # ** TeleCheck **
+    # Contact your TeleCheck representative to find out whether this field is
+    # required or optional.
+    # ** All Other Processors **
+    # Not used.
+    # @return [String]
+    attr_accessor :company_tax_id
+
+    # Company’s tax identifier. This is only used for eCheck service.
+    # ** TeleCheck **
+    # Contact your TeleCheck representative to find out whether this field is
+    # required or optional.
+    # ** All Other Processors **
+    # Not used.
+    # @return [Array[PersonalIdentification]]
+    attr_accessor :personal_identification
+
+    # The merchant's password that Visa Acceptance hashes and stores as a hashed
+    # password.
+    # @return [String]
+    attr_accessor :hashed_password
+
+    # Customer's gender. Possible values are F (female), M (male),O (other).
+    # @return [String]
+    attr_accessor :gender
+
+    # language setting of the user. 
+    # Supports 2-character language codes (e.g., en, fr) and 5-character locale
+    # values (e.g., en-US, fr-CA).
+    # @return [String]
+    attr_accessor :language
+
+    # Note to the recipient of the funds in this transaction
+    # @return [String]
+    attr_accessor :note_to_seller
+
+    # Cardholder’s mobile phone number.
+    # **Important** Required for Visa Secure transactions in Brazil.
+    # Do not use this request field for any other types of transactions.
+    # @return [Integer]
+    attr_accessor :mobile_phone
+
+    # The one-time identification code of the Alipay wallet user. 
+    # It is scanned from the barcode that is shown by the mobile application.
+    # @return [String]
+    attr_accessor :wallet_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_customer_id'] = 'merchantCustomerId'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['vat_registration_number'] = 'vatRegistrationNumber'
+      @_hash['company_tax_id'] = 'companyTaxId'
+      @_hash['personal_identification'] = 'personalIdentification'
+      @_hash['hashed_password'] = 'hashedPassword'
+      @_hash['gender'] = 'gender'
+      @_hash['language'] = 'language'
+      @_hash['note_to_seller'] = 'noteToSeller'
+      @_hash['mobile_phone'] = 'mobilePhone'
+      @_hash['wallet_id'] = 'walletId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_customer_id
+        date_of_birth
+        vat_registration_number
+        company_tax_id
+        personal_identification
+        hashed_password
+        gender
+        language
+        note_to_seller
+        mobile_phone
+        wallet_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_customer_id = SKIP, date_of_birth = SKIP,
+                   vat_registration_number = SKIP, company_tax_id = SKIP,
+                   personal_identification = SKIP, hashed_password = SKIP,
+                   gender = SKIP, language = SKIP, note_to_seller = SKIP,
+                   mobile_phone = SKIP, wallet_id = SKIP)
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @vat_registration_number = vat_registration_number unless vat_registration_number == SKIP
+      @company_tax_id = company_tax_id unless company_tax_id == SKIP
+      @personal_identification = personal_identification unless personal_identification == SKIP
+      @hashed_password = hashed_password unless hashed_password == SKIP
+      @gender = gender unless gender == SKIP
+      @language = language unless language == SKIP
+      @note_to_seller = note_to_seller unless note_to_seller == SKIP
+      @mobile_phone = mobile_phone unless mobile_phone == SKIP
+      @wallet_id = wallet_id unless wallet_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_customer_id =
+        hash.key?('merchantCustomerId') ? hash['merchantCustomerId'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      vat_registration_number =
+        hash.key?('vatRegistrationNumber') ? hash['vatRegistrationNumber'] : SKIP
+      company_tax_id = hash.key?('companyTaxId') ? hash['companyTaxId'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      personal_identification = nil
+      unless hash['personalIdentification'].nil?
+        personal_identification = []
+        hash['personalIdentification'].each do |structure|
+          personal_identification << (PersonalIdentification.from_hash(structure) if structure)
+        end
+      end
+
+      personal_identification = SKIP unless hash.key?('personalIdentification')
+      hashed_password =
+        hash.key?('hashedPassword') ? hash['hashedPassword'] : SKIP
+      gender = hash.key?('gender') ? hash['gender'] : SKIP
+      language = hash.key?('language') ? hash['language'] : SKIP
+      note_to_seller = hash.key?('noteToSeller') ? hash['noteToSeller'] : SKIP
+      mobile_phone = hash.key?('mobilePhone') ? hash['mobilePhone'] : SKIP
+      wallet_id = hash.key?('walletId') ? hash['walletId'] : SKIP
+
+      # Create object from extracted values.
+      BuyerInformation.new(merchant_customer_id,
+                           date_of_birth,
+                           vat_registration_number,
+                           company_tax_id,
+                           personal_identification,
+                           hashed_password,
+                           gender,
+                           language,
+                           note_to_seller,
+                           mobile_phone,
+                           wallet_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_customer_id: #{@merchant_customer_id}, date_of_birth:"\
+      " #{@date_of_birth}, vat_registration_number: #{@vat_registration_number}, company_tax_id:"\
+      " #{@company_tax_id}, personal_identification: #{@personal_identification}, hashed_password:"\
+      " #{@hashed_password}, gender: #{@gender}, language: #{@language}, note_to_seller:"\
+      " #{@note_to_seller}, mobile_phone: #{@mobile_phone}, wallet_id: #{@wallet_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_customer_id: #{@merchant_customer_id.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, vat_registration_number: #{@vat_registration_number.inspect},"\
+      " company_tax_id: #{@company_tax_id.inspect}, personal_identification:"\
+      " #{@personal_identification.inspect}, hashed_password: #{@hashed_password.inspect}, gender:"\
+      " #{@gender.inspect}, language: #{@language.inspect}, note_to_seller:"\
+      " #{@note_to_seller.inspect}, mobile_phone: #{@mobile_phone.inspect}, wallet_id:"\
+      " #{@wallet_id.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/buyer_information1.rb

@@ -0,0 +1,159 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # BuyerInformation1 Model.
+  class BuyerInformation1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Your identifier for the customer.
+    # When a subscription or customer profile is being created, the maximum
+    # length for this field for most processors is 30. Otherwise, the maximum
+    # length is 100.
+    # #### Comercio Latino
+    # For recurring payments in Mexico, the value is the customer’s contract
+    # number.
+    # Note Before you request the authorization, you must inform the issuer of
+    # the customer contract numbers that will be used for recurring
+    # transactions.
+    # #### Worldpay VAP
+    # For a follow-on credit with Worldpay VAP, Visa Acceptance checks the
+    # following locations, in the order
+    # given, for a customer account ID value and uses the first value it finds:
+    # 1. `customer_account_id` value in the follow-on credit request
+    # 2. Customer account ID value that was used for the capture that is being
+    # credited
+    # 3. Customer account ID value that was used for the original authorization
+    # If a customer account ID value cannot be found in any of these locations,
+    # then no value is used.
+    # @return [String]
+    attr_accessor :merchant_customer_id
+
+    # Recipient’s date of birth. **Format**: `YYYYMMDD`.
+    # This field is a `pass-through`, which means that Visa Acceptance ensures
+    # that the value is eight numeric characters
+    # but otherwise does not verify the value or modify it in any way before
+    # sending it to the processor. If the field
+    # is not required for the transaction, Visa Acceptance does not forward it
+    # to the processor.
+    # @return [String]
+    attr_accessor :date_of_birth
+
+    # Customer’s government-assigned tax identification number.
+    # #### Tax Calculation
+    # Optional for international and value added taxes only. Not applicable to
+    # U.S. and Canadian taxes.
+    # @return [String]
+    attr_accessor :vat_registration_number
+
+    # Customer’s government-assigned tax identification number.
+    # #### Tax Calculation
+    # Optional for international and value added taxes only. Not applicable to
+    # U.S. and Canadian taxes.
+    # @return [Array[PersonalIdentification]]
+    attr_accessor :personal_identification
+
+    # The description for this field is not available.
+    # @return [String]
+    attr_accessor :tax_id
+
+    # The buyer’s Alipay login Id, the id might be an email or mobile number.
+    # The id is partially masked for privacy. cao***@126.com  or 186***22156
+    # @return [String]
+    attr_accessor :login_id
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['merchant_customer_id'] = 'merchantCustomerId'
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['vat_registration_number'] = 'vatRegistrationNumber'
+      @_hash['personal_identification'] = 'personalIdentification'
+      @_hash['tax_id'] = 'taxId'
+      @_hash['login_id'] = 'loginId'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        merchant_customer_id
+        date_of_birth
+        vat_registration_number
+        personal_identification
+        tax_id
+        login_id
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(merchant_customer_id = SKIP, date_of_birth = SKIP,
+                   vat_registration_number = SKIP,
+                   personal_identification = SKIP, tax_id = SKIP,
+                   login_id = SKIP)
+      @merchant_customer_id = merchant_customer_id unless merchant_customer_id == SKIP
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @vat_registration_number = vat_registration_number unless vat_registration_number == SKIP
+      @personal_identification = personal_identification unless personal_identification == SKIP
+      @tax_id = tax_id unless tax_id == SKIP
+      @login_id = login_id unless login_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_customer_id =
+        hash.key?('merchantCustomerId') ? hash['merchantCustomerId'] : SKIP
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      vat_registration_number =
+        hash.key?('vatRegistrationNumber') ? hash['vatRegistrationNumber'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      personal_identification = nil
+      unless hash['personalIdentification'].nil?
+        personal_identification = []
+        hash['personalIdentification'].each do |structure|
+          personal_identification << (PersonalIdentification.from_hash(structure) if structure)
+        end
+      end
+
+      personal_identification = SKIP unless hash.key?('personalIdentification')
+      tax_id = hash.key?('taxId') ? hash['taxId'] : SKIP
+      login_id = hash.key?('loginId') ? hash['loginId'] : SKIP
+
+      # Create object from extracted values.
+      BuyerInformation1.new(merchant_customer_id,
+                            date_of_birth,
+                            vat_registration_number,
+                            personal_identification,
+                            tax_id,
+                            login_id)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_customer_id: #{@merchant_customer_id}, date_of_birth:"\
+      " #{@date_of_birth}, vat_registration_number: #{@vat_registration_number},"\
+      " personal_identification: #{@personal_identification}, tax_id: #{@tax_id}, login_id:"\
+      " #{@login_id}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} merchant_customer_id: #{@merchant_customer_id.inspect}, date_of_birth:"\
+      " #{@date_of_birth.inspect}, vat_registration_number: #{@vat_registration_number.inspect},"\
+      " personal_identification: #{@personal_identification.inspect}, tax_id: #{@tax_id.inspect},"\
+      " login_id: #{@login_id.inspect}>"
+    end
+  end
+end