visa-acceptance-api-sdk 1.0.0

data/lib/visa_acceptance_merged_spec/models/generate_unified_checkout_capture_context_request.rb

@@ -0,0 +1,266 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # GenerateUnifiedCheckoutCaptureContextRequest Model.
+  class GenerateUnifiedCheckoutCaptureContextRequest < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Specify the version of Unified Checkout that you want to use.
+    # @return [String]
+    attr_accessor :client_version
+
+    # The [target origin]( of the website on which you will be launching Unified
+    # Checkout is defined by the scheme (protocol), hostname (domain) and port
+    # number (if used).  
+    # You must use  (unless you use 
+    # Wildcards are NOT supported.  Ensure that subdomains are included.
+    # Any valid top-level domain is supported (e.g. .com, .co.uk, .gov.br etc)
+    # Examples:
+    #   - 
+    #   - 
+    #   - 
+    # If you are embedding within multiple nested iframes you need to specify
+    # the origins of all the browser contexts used, for example:
+    #   targetOrigins: [
+    #     "
+    #     "
+    #     "
+    #   ]
+    # @return [Array[String]]
+    attr_accessor :target_origins
+
+    # The list of card networks you want to use for this Unified Checkout
+    # transaction.
+    # Unified Checkout currently supports the following card networks:
+    #     - VISA
+    #     - MASTERCARD
+    #     - AMEX
+    #     - CARNET
+    #     - CARTESBANCAIRES
+    #     - CUP
+    #     - DINERSCLUB
+    #     - DISCOVER
+    #     - EFTPOS
+    #     - ELO
+    #     - JCB
+    #     - JCREW
+    #     - MADA
+    #     - MAESTRO
+    #     - MEEZA
+    #     - PAYPAK
+    # @return [Array[String]]
+    attr_accessor :allowed_card_networks
+
+    # The payment types that are allowed for the merchant.  
+    # Possible values when launching Unified Checkout:
+    #   - APPLEPAY
+    #   - CHECK
+    #   - CLICKTOPAY
+    #   - GOOGLEPAY
+    #   - PANENTRY              
+    #   - PAZE <br><br>
+    # Unified Checkout also supports the following Alternative Payments:
+    #   - AFTERPAY<br><br>
+    # Possible values when launching Click To Pay Drop-In UI:
+    # - CLICKTOPAY <br><br>
+    # **Important:** 
+    #   - CLICKTOPAY only available for Visa, Mastercard and AMEX for saved
+    # cards.
+    #   - Visa and Mastercard will look to tokenize using network tokenization
+    # for all Click to Pay requests.  Click to Pay uses Click to Pay token
+    # requester IDs and not the merchant's existing token requester.
+    #   - Apple Pay, Google Pay, Check, and Paze can be used independently
+    # without requiring PAN entry in the allowedPaymentTypes field.<br><br>
+    # **Managing Google Pay Authentication Types**
+    # When you enable Google Pay on Unified Checkout you can specify optional
+    # parameters that define the types of card authentication you receive from
+    # Google Pay.<br><br>
+    # **Managing Google Pay Authentication Types**
+    # Where Click to Pay is the payment type selected by the customer and the
+    # customer manually enters their card, the option to enroll their card in
+    # Click to Pay will be auto-checked if this field is set to "true". 
+    # This is only available where the merchant and cardholder are based in the
+    # following countries and the billing type is set to "FULL" or "PARTIAL".
+    #   - UAE
+    #   - Argentina
+    #   - Brazil
+    #   - Chile
+    #   - Colombia
+    #   - Kuwait
+    #   - Mexico
+    #   - Peru
+    #   - Qatar
+    #   - Saudi Arabia
+    #   - Ukraine
+    #   - South Africa<br><br>
+    # If false, this is not present or not supported in the market.  Enrollment
+    # in Click to Pay is not checked for the customer when completing manual
+    # card entry.
+    # @return [Array[String]]
+    attr_accessor :allowed_payment_types
+
+    # Country the purchase is originating from (e.g. country of the merchant). 
+    # Use the two-character ISO Standard
+    # @return [String]
+    attr_accessor :country
+
+    # Localization of the User experience conforming to the ISO 639-1 language
+    # standards and two-character ISO Standard Country Code.
+    # Please refer to list of [supported locales through Unified Checkout](
+    # @return [String]
+    attr_accessor :locale
+
+    # Localization of the User experience conforming to the ISO 639-1 language
+    # standards and two-character ISO Standard Country Code.
+    # Please refer to list of [supported locales through Unified Checkout](
+    # @return [CaptureMandate]
+    attr_accessor :capture_mandate
+
+    # The completeMandate object is designed to provide instructions for
+    # orchestrating payment services.  Unified Checkout is capable of
+    # orchestrating a number of services on your behalf.<br><br>  
+    # By providing this field in the capture context Unified Checkout will
+    # initiate services on your behalf from the browser, simplifying your
+    # integration.
+    # @return [CompleteMandate]
+    attr_accessor :complete_mandate
+
+    # The completeMandate object is designed to provide instructions for
+    # orchestrating payment services.  Unified Checkout is capable of
+    # orchestrating a number of services on your behalf.<br><br>  
+    # By providing this field in the capture context Unified Checkout will
+    # initiate services on your behalf from the browser, simplifying your
+    # integration.
+    # @return [OrderInformation34]
+    attr_accessor :order_information
+
+    # The completeMandate object is designed to provide instructions for
+    # orchestrating payment services.  Unified Checkout is capable of
+    # orchestrating a number of services on your behalf.<br><br>  
+    # By providing this field in the capture context Unified Checkout will
+    # initiate services on your behalf from the browser, simplifying your
+    # integration.
+    # @return [TransientTokenResponseOptions]
+    attr_accessor :transient_token_response_options
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['client_version'] = 'clientVersion'
+      @_hash['target_origins'] = 'targetOrigins'
+      @_hash['allowed_card_networks'] = 'allowedCardNetworks'
+      @_hash['allowed_payment_types'] = 'allowedPaymentTypes'
+      @_hash['country'] = 'country'
+      @_hash['locale'] = 'locale'
+      @_hash['capture_mandate'] = 'captureMandate'
+      @_hash['complete_mandate'] = 'completeMandate'
+      @_hash['order_information'] = 'orderInformation'
+      @_hash['transient_token_response_options'] =
+        'transientTokenResponseOptions'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        client_version
+        target_origins
+        allowed_card_networks
+        allowed_payment_types
+        country
+        locale
+        capture_mandate
+        complete_mandate
+        order_information
+        transient_token_response_options
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(client_version = SKIP, target_origins = SKIP,
+                   allowed_card_networks = SKIP, allowed_payment_types = SKIP,
+                   country = SKIP, locale = SKIP, capture_mandate = SKIP,
+                   complete_mandate = SKIP, order_information = SKIP,
+                   transient_token_response_options = SKIP)
+      @client_version = client_version unless client_version == SKIP
+      @target_origins = target_origins unless target_origins == SKIP
+      @allowed_card_networks = allowed_card_networks unless allowed_card_networks == SKIP
+      @allowed_payment_types = allowed_payment_types unless allowed_payment_types == SKIP
+      @country = country unless country == SKIP
+      @locale = locale unless locale == SKIP
+      @capture_mandate = capture_mandate unless capture_mandate == SKIP
+      @complete_mandate = complete_mandate unless complete_mandate == SKIP
+      @order_information = order_information unless order_information == SKIP
+      unless transient_token_response_options == SKIP
+        @transient_token_response_options =
+          transient_token_response_options
+      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.
+      client_version = hash.key?('clientVersion') ? hash['clientVersion'] : SKIP
+      target_origins = hash.key?('targetOrigins') ? hash['targetOrigins'] : SKIP
+      allowed_card_networks =
+        hash.key?('allowedCardNetworks') ? hash['allowedCardNetworks'] : SKIP
+      allowed_payment_types =
+        hash.key?('allowedPaymentTypes') ? hash['allowedPaymentTypes'] : SKIP
+      country = hash.key?('country') ? hash['country'] : SKIP
+      locale = hash.key?('locale') ? hash['locale'] : SKIP
+      capture_mandate = CaptureMandate.from_hash(hash['captureMandate']) if hash['captureMandate']
+      complete_mandate = CompleteMandate.from_hash(hash['completeMandate']) if
+        hash['completeMandate']
+      order_information = OrderInformation34.from_hash(hash['orderInformation']) if
+        hash['orderInformation']
+      if hash['transientTokenResponseOptions']
+        transient_token_response_options = TransientTokenResponseOptions.from_hash(hash['transientTokenResponseOptions'])
+      end
+
+      # Create object from extracted values.
+      GenerateUnifiedCheckoutCaptureContextRequest.new(client_version,
+                                                       target_origins,
+                                                       allowed_card_networks,
+                                                       allowed_payment_types,
+                                                       country,
+                                                       locale,
+                                                       capture_mandate,
+                                                       complete_mandate,
+                                                       order_information,
+                                                       transient_token_response_options)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_version: #{@client_version}, target_origins: #{@target_origins},"\
+      " allowed_card_networks: #{@allowed_card_networks}, allowed_payment_types:"\
+      " #{@allowed_payment_types}, country: #{@country}, locale: #{@locale}, capture_mandate:"\
+      " #{@capture_mandate}, complete_mandate: #{@complete_mandate}, order_information:"\
+      " #{@order_information}, transient_token_response_options:"\
+      " #{@transient_token_response_options}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} client_version: #{@client_version.inspect}, target_origins:"\
+      " #{@target_origins.inspect}, allowed_card_networks: #{@allowed_card_networks.inspect},"\
+      " allowed_payment_types: #{@allowed_payment_types.inspect}, country: #{@country.inspect},"\
+      " locale: #{@locale.inspect}, capture_mandate: #{@capture_mandate.inspect},"\
+      " complete_mandate: #{@complete_mandate.inspect}, order_information:"\
+      " #{@order_information.inspect}, transient_token_response_options:"\
+      " #{@transient_token_response_options.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/get_card_art_asset_response.rb

@@ -0,0 +1,99 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # Represents the Card Art Asset associated to the Network Token.
+  class GetCardArtAssetResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # Unique identifier for the Card Art Asset.
+    # @return [String]
+    attr_accessor :id
+
+    # The type of Card Art Asset.
+    # @return [String]
+    attr_accessor :type
+
+    # The provider of the Card Art Asset.
+    # @return [String]
+    attr_accessor :provider
+
+    # Array of content objects representing the Card Art Asset.
+    # @return [Array[Content]]
+    attr_accessor :content
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['type'] = 'type'
+      @_hash['provider'] = 'provider'
+      @_hash['content'] = 'content'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        type
+        provider
+        content
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(id = SKIP, type = SKIP, provider = SKIP, content = SKIP)
+      @id = id unless id == SKIP
+      @type = type unless type == SKIP
+      @provider = provider unless provider == SKIP
+      @content = content unless content == 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
+      type = hash.key?('type') ? hash['type'] : SKIP
+      provider = hash.key?('provider') ? hash['provider'] : SKIP
+      # Parameter is an array, so we need to iterate through it
+      content = nil
+      unless hash['content'].nil?
+        content = []
+        hash['content'].each do |structure|
+          content << (Content.from_hash(structure) if structure)
+        end
+      end
+
+      content = SKIP unless hash.key?('content')
+
+      # Create object from extracted values.
+      GetCardArtAssetResponse.new(id,
+                                  type,
+                                  provider,
+                                  content)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, type: #{@type}, provider: #{@provider}, content: #{@content}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, type: #{@type.inspect}, provider: #{@provider.inspect},"\
+      " content: #{@content.inspect}>"
+    end
+  end
+end

data/lib/visa_acceptance_merged_spec/models/get_customer_payment_instrument_response.rb

@@ -0,0 +1,236 @@
+# visa_acceptance_merged_spec
+#
+# This file was automatically generated by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module VisaAcceptanceMergedSpec
+  # GetCustomerPaymentInstrumentResponse Model.
+  class GetCustomerPaymentInstrumentResponse < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Links20]
+    attr_accessor :links
+
+    # The Id of the Payment Instrument Token.
+    # @return [String]
+    attr_accessor :id
+
+    # The type.
+    # Possible Values:
+    # - paymentInstrument
+    # @return [String]
+    attr_accessor :object
+
+    # Flag that indicates whether customer payment instrument is the dafault.
+    # Possible Values:
+    #  - `true`: Payment instrument is customer's default.
+    #  - `false`: Payment instrument is not customer's default.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :default
+
+    # Issuers state for the card number.
+    # Possible Values:
+    # - ACTIVE
+    # - CLOSED : The account has been closed.
+    # @return [String]
+    attr_accessor :state
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [String]
+    attr_accessor :type
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [BankAccount]
+    attr_accessor :bank_account
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [Card12]
+    attr_accessor :card
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [BuyerInformation13]
+    attr_accessor :buyer_information
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [BillTo15]
+    attr_accessor :bill_to
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [TmsPaymentInstrumentProcessingInfo]
+    attr_accessor :processing_information
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [MerchantInformation18]
+    attr_accessor :merchant_information
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [InstrumentIdentifier10]
+    attr_accessor :instrument_identifier
+
+    # The type of Payment Instrument.
+    # Possible Values:
+    # - cardHash
+    # @return [Metadata1]
+    attr_accessor :metadata
+
+    # Additional resources for the Payment Instrument.
+    # @return [Embedded1]
+    attr_accessor :embedded
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['links'] = '_links'
+      @_hash['id'] = 'id'
+      @_hash['object'] = 'object'
+      @_hash['default'] = 'default'
+      @_hash['state'] = 'state'
+      @_hash['type'] = 'type'
+      @_hash['bank_account'] = 'bankAccount'
+      @_hash['card'] = 'card'
+      @_hash['buyer_information'] = 'buyerInformation'
+      @_hash['bill_to'] = 'billTo'
+      @_hash['processing_information'] = 'processingInformation'
+      @_hash['merchant_information'] = 'merchantInformation'
+      @_hash['instrument_identifier'] = 'instrumentIdentifier'
+      @_hash['metadata'] = 'metadata'
+      @_hash['embedded'] = '_embedded'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        links
+        id
+        object
+        default
+        state
+        type
+        bank_account
+        card
+        buyer_information
+        bill_to
+        processing_information
+        merchant_information
+        instrument_identifier
+        metadata
+        embedded
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(links = SKIP, id = SKIP, object = SKIP, default = SKIP,
+                   state = SKIP, type = SKIP, bank_account = SKIP, card = SKIP,
+                   buyer_information = SKIP, bill_to = SKIP,
+                   processing_information = SKIP, merchant_information = SKIP,
+                   instrument_identifier = SKIP, metadata = SKIP,
+                   embedded = SKIP)
+      @links = links unless links == SKIP
+      @id = id unless id == SKIP
+      @object = object unless object == SKIP
+      @default = default unless default == SKIP
+      @state = state unless state == SKIP
+      @type = type unless type == SKIP
+      @bank_account = bank_account unless bank_account == SKIP
+      @card = card unless card == SKIP
+      @buyer_information = buyer_information unless buyer_information == SKIP
+      @bill_to = bill_to unless bill_to == SKIP
+      @processing_information = processing_information unless processing_information == SKIP
+      @merchant_information = merchant_information unless merchant_information == SKIP
+      @instrument_identifier = instrument_identifier unless instrument_identifier == SKIP
+      @metadata = metadata unless metadata == SKIP
+      @embedded = embedded unless embedded == 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.
+      links = Links20.from_hash(hash['_links']) if hash['_links']
+      id = hash.key?('id') ? hash['id'] : SKIP
+      object = hash.key?('object') ? hash['object'] : SKIP
+      default = hash.key?('default') ? hash['default'] : SKIP
+      state = hash.key?('state') ? hash['state'] : SKIP
+      type = hash.key?('type') ? hash['type'] : SKIP
+      bank_account = BankAccount.from_hash(hash['bankAccount']) if hash['bankAccount']
+      card = Card12.from_hash(hash['card']) if hash['card']
+      buyer_information = BuyerInformation13.from_hash(hash['buyerInformation']) if
+        hash['buyerInformation']
+      bill_to = BillTo15.from_hash(hash['billTo']) if hash['billTo']
+      if hash['processingInformation']
+        processing_information = TmsPaymentInstrumentProcessingInfo.from_hash(hash['processingInformation'])
+      end
+      merchant_information = MerchantInformation18.from_hash(hash['merchantInformation']) if
+        hash['merchantInformation']
+      instrument_identifier = InstrumentIdentifier10.from_hash(hash['instrumentIdentifier']) if
+        hash['instrumentIdentifier']
+      metadata = Metadata1.from_hash(hash['metadata']) if hash['metadata']
+      embedded = Embedded1.from_hash(hash['_embedded']) if hash['_embedded']
+
+      # Create object from extracted values.
+      GetCustomerPaymentInstrumentResponse.new(links,
+                                               id,
+                                               object,
+                                               default,
+                                               state,
+                                               type,
+                                               bank_account,
+                                               card,
+                                               buyer_information,
+                                               bill_to,
+                                               processing_information,
+                                               merchant_information,
+                                               instrument_identifier,
+                                               metadata,
+                                               embedded)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links}, id: #{@id}, object: #{@object}, default: #{@default},"\
+      " state: #{@state}, type: #{@type}, bank_account: #{@bank_account}, card: #{@card},"\
+      " buyer_information: #{@buyer_information}, bill_to: #{@bill_to}, processing_information:"\
+      " #{@processing_information}, merchant_information: #{@merchant_information},"\
+      " instrument_identifier: #{@instrument_identifier}, metadata: #{@metadata}, embedded:"\
+      " #{@embedded}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} links: #{@links.inspect}, id: #{@id.inspect}, object: #{@object.inspect},"\
+      " default: #{@default.inspect}, state: #{@state.inspect}, type: #{@type.inspect},"\
+      " bank_account: #{@bank_account.inspect}, card: #{@card.inspect}, buyer_information:"\
+      " #{@buyer_information.inspect}, bill_to: #{@bill_to.inspect}, processing_information:"\
+      " #{@processing_information.inspect}, merchant_information:"\
+      " #{@merchant_information.inspect}, instrument_identifier:"\
+      " #{@instrument_identifier.inspect}, metadata: #{@metadata.inspect}, embedded:"\
+      " #{@embedded.inspect}>"
+    end
+  end
+end