visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/buyer_information7.rb

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

data/lib/visa_acceptance_merged_spec/models/buyer_information8.rb

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

data/lib/visa_acceptance_merged_spec/models/buyer_information9.rb

@@ -0,0 +1,120 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # BuyerInformation9 Model.
+  class BuyerInformation9 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # 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 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
+
+    # Note to the recipient of the funds in this transaction
+    # @return [Array[PersonalIdentification2]]
+    attr_accessor :personal_identification
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['date_of_birth'] = 'dateOfBirth'
+      @_hash['gender'] = 'gender'
+      @_hash['language'] = 'language'
+      @_hash['note_to_seller'] = 'noteToSeller'
+      @_hash['personal_identification'] = 'personalIdentification'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        date_of_birth
+        gender
+        language
+        note_to_seller
+        personal_identification
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(date_of_birth = SKIP, gender = SKIP, language = SKIP,
+                   note_to_seller = SKIP, personal_identification = SKIP)
+      @date_of_birth = date_of_birth unless date_of_birth == SKIP
+      @gender = gender unless gender == SKIP
+      @language = language unless language == SKIP
+      @note_to_seller = note_to_seller unless note_to_seller == SKIP
+      @personal_identification = personal_identification unless personal_identification == 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.
+      date_of_birth = hash.key?('dateOfBirth') ? hash['dateOfBirth'] : SKIP
+      gender = hash.key?('gender') ? hash['gender'] : SKIP
+      language = hash.key?('language') ? hash['language'] : SKIP
+      note_to_seller = hash.key?('noteToSeller') ? hash['noteToSeller'] : 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 << (PersonalIdentification2.from_hash(structure) if structure)
+        end
+      end
+
+      personal_identification = SKIP unless hash.key?('personalIdentification')
+
+      # Create object from extracted values.
+      BuyerInformation9.new(date_of_birth,
+                            gender,
+                            language,
+                            note_to_seller,
+                            personal_identification)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date_of_birth: #{@date_of_birth}, gender: #{@gender}, language:"\
+      " #{@language}, note_to_seller: #{@note_to_seller}, personal_identification:"\
+      " #{@personal_identification}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} date_of_birth: #{@date_of_birth.inspect}, gender: #{@gender.inspect},"\
+      " language: #{@language.inspect}, note_to_seller: #{@note_to_seller.inspect},"\
+      " personal_identification: #{@personal_identification.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/capture.rb

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

@@ -0,0 +1,96 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CAPTURE1 Model.
+  class CAPTURE1 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The status of the submitted transaction.
+    # Possible values:
+    #  - PENDING
+    #  - TRANSMITTED (Only for Online Capture enabled merchants)
+    # @return [String]
+    attr_accessor :status
+
+    # The reason of the status.
+    # Possible values:
+    #  - MISSING_FIELD
+    #  - INVALID_DATA
+    #  - DUPLICATE_REQUEST
+    #  - INVALID_MERCHANT_CONFIGURATION
+    #  - EXCEEDS_AUTH_AMOUNT
+    #  - AUTH_ALREADY_REVERSED
+    #  - TRANSACTION_ALREADY_SETTLED
+    #  - INVALID_AMOUNT
+    #  - MISSING_AUTH
+    #  - TRANSACTION_ALREADY_REVERSED_OR_SETTLED
+    #  - NOT_SUPPORTED
+    # @return [String]
+    attr_accessor :reason
+
+    # The detail message related to the status and reason listed above.
+    # @return [String]
+    attr_accessor :message
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['status'] = 'status'
+      @_hash['reason'] = 'reason'
+      @_hash['message'] = 'message'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        status
+        reason
+        message
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(status = SKIP, reason = SKIP, message = SKIP)
+      @status = status unless status == SKIP
+      @reason = reason unless reason == SKIP
+      @message = message unless message == 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.
+      status = hash.key?('status') ? hash['status'] : SKIP
+      reason = hash.key?('reason') ? hash['reason'] : SKIP
+      message = hash.key?('message') ? hash['message'] : SKIP
+
+      # Create object from extracted values.
+      CAPTURE1.new(status,
+                   reason,
+                   message)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status}, reason: #{@reason}, message: #{@message}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} status: #{@status.inspect}, reason: #{@reason.inspect}, message:"\
+      " #{@message.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/capture_mandate.rb

@@ -0,0 +1,252 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # CaptureMandate Model.
+  class CaptureMandate < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Configure Unified Checkout to capture billing address information.
+    # Possible values:
+    # - FULL: Capture complete billing address information.
+    # - PARTIAL: Capture first name, last name, country and postal/zip code
+    # only.
+    # - NONE: Capture only first name and last name.
+    # @return [String]
+    attr_accessor :billing_type
+
+    # Configure Unified Checkout to capture customer email address.
+    # Possible values:
+    #  - True
+    #  - False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_email
+
+    # Configure Unified Checkout to capture customer phone number.
+    # Possible values:
+    # - True
+    # - False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_phone
+
+    # Configure Unified Checkout to capture customer shipping details.
+    # Possible values:
+    # - True
+    # - False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_shipping
+
+    # List of countries available to ship to.  
+    # Use the two-character ISO Standard Country Codes.
+    # @return [Array[String]]
+    attr_accessor :ship_to_countries
+
+    # Configure Unified Checkout to display the list of accepted card networks
+    # beneath the payment button
+    # Possible values:
+    # - True
+    # - False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_accepted_network_icons
+
+    # Configure Unified Checkout to display the final confirmation screen when
+    # using Click to Pay.<br>
+    # Where 'BillingType'= NONE and 'requestShipping'= FALSE and the customer is
+    # using an existing Click to Pay card as their chosen payment method, a
+    # final confirmation screen can be removed allowing the customer to check
+    # out as soon as they have selected their payment method from within their
+    # Click to Pay card tray.
+    # Possible values:
+    # - True
+    # - False
+    # @return [TrueClass | FalseClass]
+    attr_accessor :show_confirmation_step
+
+    # Configure Unified Checkout to display the "Save card for future use"
+    # checkbox.<br>
+    # Configurable check box that will show in a Manual card entry flow to allow
+    # a Cardholder to give consent to store their manually entered credential
+    # with the Merchant that they are paying.<br> 
+    # Applicable when manually entering the details and not enrolling in Click
+    # to Pay.
+    # Possible values:
+    #  - True 
+    #  - False<br><br>
+    # **Use Cases:**
+    # **Offer consumers option to save their card in Unified Checkout:** 
+    # - Include the captureMandate.requestSaveCard field in the capture context
+    # request and set it to true.
+    # - When set to true, this will show a checkbox with the message ‘Save card
+    # for future use’ in Unified Checkout.
+    # - When selected this provides a response in both the Transient Token and
+    # Get Credentials API response.<br><br>
+    # **Do not offer consumers the option to save their card in Unified
+    # Checkout:** 
+    # - Include the captureMandate.requestSaveCard field in the capture context
+    # request and set it to false OR omit the field from the capture context
+    # request.
+    # - When set to false, the save card option is not shown to consumers when
+    # manually entering card details.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :request_save_card
+
+    # Configure Unified Checkout to display combo card at checkout.<br>
+    # A combo debit/credit card is a single card that functions both as a
+    # Debit/Credit card. 
+    # Unified Checkout / Click to Pay Drop-in UI allows the Cardholder to choose
+    # whether they would like the transaction to be paid for using either debit
+    # or credit card.
+    # **Important:** This is applicable to Visa cards only.
+    # Possible values:
+    # - True 
+    # - False<br><br>
+    # **Use Cases:**
+    # **Offer Combo Card at Checkout:** 
+    # - Include the captureMandate.comboCard field in the capture context
+    # request and set it to true.
+    # - When set to true, Combo Card selection is shown at checkout <br><br>
+    # **Do not offer Combo Card at Checkout:** 
+    # - Include the captureMandate.comboCard field in the capture context
+    # request and set it to false OR omit the field from the capture context
+    # request.
+    # - The Combo Card selection is not shown at checkout.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :combo_card
+
+    # Configure Unified Checkout to display and capture the CPF number (Cadastro
+    # de Pessoas Físicas).  The CPF number is a unique 11-digit identifier
+    # issued to Brazilian citizens and residents for tax purposes.
+    # Possible values:
+    # - True
+    # - False<br><br>
+    # This field is optional.  
+    # If set to true the field is required.
+    # If set to false the field is optional.
+    # If the field is not included in the capture context then it is not
+    # captured.<br><br>
+    # **Important:**
+    #  - If PANENTRY is specified in the allowedPaymentTypes field, the CPF
+    # number will be displayed in Unified Checkout regardless of what card
+    # number is entered.
+    #  - If CLICKTOPAY is specified in the allowedPaymentTypes field, the CPF
+    # number will be displayed in Unified Checkout only when a Visa Click To Pay
+    # card is entered.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :cpf
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['billing_type'] = 'billingType'
+      @_hash['request_email'] = 'requestEmail'
+      @_hash['request_phone'] = 'requestPhone'
+      @_hash['request_shipping'] = 'requestShipping'
+      @_hash['ship_to_countries'] = 'shipToCountries'
+      @_hash['show_accepted_network_icons'] = 'showAcceptedNetworkIcons'
+      @_hash['show_confirmation_step'] = 'showConfirmationStep'
+      @_hash['request_save_card'] = 'requestSaveCard'
+      @_hash['combo_card'] = 'comboCard'
+      @_hash['cpf'] = 'CPF'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        billing_type
+        request_email
+        request_phone
+        request_shipping
+        ship_to_countries
+        show_accepted_network_icons
+        show_confirmation_step
+        request_save_card
+        combo_card
+        cpf
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(billing_type = SKIP, request_email = SKIP,
+                   request_phone = SKIP, request_shipping = SKIP,
+                   ship_to_countries = SKIP, show_accepted_network_icons = SKIP,
+                   show_confirmation_step = SKIP, request_save_card = SKIP,
+                   combo_card = SKIP, cpf = SKIP)
+      @billing_type = billing_type unless billing_type == SKIP
+      @request_email = request_email unless request_email == SKIP
+      @request_phone = request_phone unless request_phone == SKIP
+      @request_shipping = request_shipping unless request_shipping == SKIP
+      @ship_to_countries = ship_to_countries unless ship_to_countries == SKIP
+      unless show_accepted_network_icons == SKIP
+        @show_accepted_network_icons =
+          show_accepted_network_icons
+      end
+      @show_confirmation_step = show_confirmation_step unless show_confirmation_step == SKIP
+      @request_save_card = request_save_card unless request_save_card == SKIP
+      @combo_card = combo_card unless combo_card == SKIP
+      @cpf = cpf unless cpf == 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.
+      billing_type = hash.key?('billingType') ? hash['billingType'] : SKIP
+      request_email = hash.key?('requestEmail') ? hash['requestEmail'] : SKIP
+      request_phone = hash.key?('requestPhone') ? hash['requestPhone'] : SKIP
+      request_shipping =
+        hash.key?('requestShipping') ? hash['requestShipping'] : SKIP
+      ship_to_countries =
+        hash.key?('shipToCountries') ? hash['shipToCountries'] : SKIP
+      show_accepted_network_icons =
+        hash.key?('showAcceptedNetworkIcons') ? hash['showAcceptedNetworkIcons'] : SKIP
+      show_confirmation_step =
+        hash.key?('showConfirmationStep') ? hash['showConfirmationStep'] : SKIP
+      request_save_card =
+        hash.key?('requestSaveCard') ? hash['requestSaveCard'] : SKIP
+      combo_card = hash.key?('comboCard') ? hash['comboCard'] : SKIP
+      cpf = hash.key?('CPF') ? hash['CPF'] : SKIP
+
+      # Create object from extracted values.
+      CaptureMandate.new(billing_type,
+                         request_email,
+                         request_phone,
+                         request_shipping,
+                         ship_to_countries,
+                         show_accepted_network_icons,
+                         show_confirmation_step,
+                         request_save_card,
+                         combo_card,
+                         cpf)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_type: #{@billing_type}, request_email: #{@request_email},"\
+      " request_phone: #{@request_phone}, request_shipping: #{@request_shipping},"\
+      " ship_to_countries: #{@ship_to_countries}, show_accepted_network_icons:"\
+      " #{@show_accepted_network_icons}, show_confirmation_step: #{@show_confirmation_step},"\
+      " request_save_card: #{@request_save_card}, combo_card: #{@combo_card}, cpf: #{@cpf}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} billing_type: #{@billing_type.inspect}, request_email:"\
+      " #{@request_email.inspect}, request_phone: #{@request_phone.inspect}, request_shipping:"\
+      " #{@request_shipping.inspect}, ship_to_countries: #{@ship_to_countries.inspect},"\
+      " show_accepted_network_icons: #{@show_accepted_network_icons.inspect},"\
+      " show_confirmation_step: #{@show_confirmation_step.inspect}, request_save_card:"\
+      " #{@request_save_card.inspect}, combo_card: #{@combo_card.inspect}, cpf: #{@cpf.inspect}>"
+    end
+  end
+end