wp-sdk 1.0.0

data/lib/reporting_settlement_research_api/models/card_details.rb

@@ -0,0 +1,381 @@
+# reporting_settlement_research_api
+#
+# This file was automatically generated
+# by APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module ReportingSettlementResearchApi
+  # The details of card used for the transaction.
+  class CardDetails < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # The number found on the card used to make a purchase, also referred to as
+    # the bank or credit card number. <br>Searches can be done on the full card
+    # number, on the first six and last four digits, or on the last four
+    # digits."
+    # @return [String]
+    attr_accessor :card_number
+
+    # The category or classification of a payment card based on the issuing
+    # network. <br> Possible values are CREDIT, DEBIT, and GIFT.
+    # @return [String]
+    attr_accessor :card_type
+
+    # The set time when a card will need to be replaced.
+    # @return [Date]
+    attr_accessor :expiration_date
+
+    # The set time when a card will need to be replaced.
+    # @return [CardNetwork]
+    attr_accessor :card_network
+
+    # The set time when a card will need to be replaced.
+    # @return [Cvv2ResponseCode]
+    attr_accessor :cvv2_response_code
+
+    # The set time when a card will need to be replaced.
+    # @return [Cvv2PresenceIndicator]
+    attr_accessor :cvv2_presence_indicator
+
+    # The numeric value that is the same length as the card number and is used
+    # as a substitution with proxy data. Max length of the token is 19
+    # characters.
+    # @return [String]
+    attr_accessor :token
+
+    # The host-generated numeric value created during the tokenization process
+    # using a token key assigned to a merchant. This value is returned to the
+    # point-of-sale when tokenization is requested along with the token for
+    # utilization.
+    # @return [String]
+    attr_accessor :token_id
+
+    # A request and response field. The score or confidence level that
+    # determines the expected level of assurance associated with the approved
+    # token requestor and the identification and verification method performed
+    # at the time of token request.
+    # @return [String]
+    attr_accessor :token_assurance_level
+
+    # The expiration date of the token in the YYYY-MM format with a fixed length
+    # of 6.
+    # @return [Date]
+    attr_accessor :token_expiration_date
+
+    # The expiration date of the token in the YYYY-MM format with a fixed length
+    # of 6.
+    # @return [InternationalIndicator]
+    attr_accessor :international_indicator
+
+    # Possible values are true and false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :network_reject_indicator
+
+    # Indentifier for digital payment transactions.
+    # @return [String]
+    attr_accessor :network_payment_token_number
+
+    # Indentifier for digital payment transactions.
+    # @return [CardAccountTerm]
+    attr_accessor :card_account_term
+
+    # The acronym for the primary user of a payment card.
+    # @return [String]
+    attr_accessor :cardholder_bank_acro
+
+    # The unique identifier used to request network tokens from the card
+    # networks.
+    # @return [String]
+    attr_accessor :token_requestor_id
+
+    # The payments network operated by Mastercard. The value is present only if
+    # the transaction is Mastercard, otherwise it's null.
+    # @return [Date]
+    attr_accessor :bank_net_date
+
+    # The unique identifier for transactions processed through banknet systems.
+    # @return [String]
+    attr_accessor :bank_net_reference_number
+
+    # The unique identifier for transactions processed through banknet systems.
+    # @return [MarketSpecificDataIndicator]
+    attr_accessor :market_specific_data_indicator
+
+    # Provides dynamic currency conversion information to the merchant.
+    # Applicable for credit (master credit card).
+    # @return [String]
+    attr_accessor :dcc_mcp_indicator
+
+    # The last four digits of the PAN on the receipt.
+    # @return [String]
+    attr_accessor :last_four_of_pan
+
+    # Indicates funds without corresponding transaction records in accounts.
+    # Possible values are true or false.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :visa_reversed
+
+    # The Visa transaction's reversed authorization date.
+    # @return [Date]
+    attr_accessor :visa_reversed_date
+
+    # The Mastercard wallet identifier.
+    # @return [String]
+    attr_accessor :mastercard_wallet_id
+
+    # The Mastercard wallet identifier.
+    # @return [MastercardTicIndicator]
+    attr_accessor :mastercard_tic_indicator
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['card_number'] = 'cardNumber'
+      @_hash['card_type'] = 'cardType'
+      @_hash['expiration_date'] = 'expirationDate'
+      @_hash['card_network'] = 'cardNetwork'
+      @_hash['cvv2_response_code'] = 'cvv2ResponseCode'
+      @_hash['cvv2_presence_indicator'] = 'cvv2PresenceIndicator'
+      @_hash['token'] = 'token'
+      @_hash['token_id'] = 'tokenId'
+      @_hash['token_assurance_level'] = 'tokenAssuranceLevel'
+      @_hash['token_expiration_date'] = 'tokenExpirationDate'
+      @_hash['international_indicator'] = 'internationalIndicator'
+      @_hash['network_reject_indicator'] = 'networkRejectIndicator'
+      @_hash['network_payment_token_number'] = 'networkPaymentTokenNumber'
+      @_hash['card_account_term'] = 'cardAccountTerm'
+      @_hash['cardholder_bank_acro'] = 'cardholderBankAcro'
+      @_hash['token_requestor_id'] = 'tokenRequestorId'
+      @_hash['bank_net_date'] = 'bankNetDate'
+      @_hash['bank_net_reference_number'] = 'bankNetReferenceNumber'
+      @_hash['market_specific_data_indicator'] = 'marketSpecificDataIndicator'
+      @_hash['dcc_mcp_indicator'] = 'dccMcpIndicator'
+      @_hash['last_four_of_pan'] = 'lastFourOfPAN'
+      @_hash['visa_reversed'] = 'visaReversed'
+      @_hash['visa_reversed_date'] = 'visaReversedDate'
+      @_hash['mastercard_wallet_id'] = 'mastercardWalletId'
+      @_hash['mastercard_tic_indicator'] = 'mastercardTICIndicator'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        card_number
+        card_type
+        expiration_date
+        card_network
+        cvv2_response_code
+        cvv2_presence_indicator
+        token
+        token_id
+        token_assurance_level
+        token_expiration_date
+        international_indicator
+        network_reject_indicator
+        network_payment_token_number
+        card_account_term
+        cardholder_bank_acro
+        token_requestor_id
+        bank_net_date
+        bank_net_reference_number
+        market_specific_data_indicator
+        dcc_mcp_indicator
+        last_four_of_pan
+        visa_reversed
+        visa_reversed_date
+        mastercard_wallet_id
+        mastercard_tic_indicator
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(card_number: SKIP, card_type: SKIP, expiration_date: SKIP,
+                   card_network: SKIP, cvv2_response_code: SKIP,
+                   cvv2_presence_indicator: SKIP, token: SKIP, token_id: SKIP,
+                   token_assurance_level: SKIP, token_expiration_date: SKIP,
+                   international_indicator: SKIP,
+                   network_reject_indicator: SKIP,
+                   network_payment_token_number: SKIP, card_account_term: SKIP,
+                   cardholder_bank_acro: SKIP, token_requestor_id: SKIP,
+                   bank_net_date: SKIP, bank_net_reference_number: SKIP,
+                   market_specific_data_indicator: SKIP,
+                   dcc_mcp_indicator: SKIP, last_four_of_pan: SKIP,
+                   visa_reversed: SKIP, visa_reversed_date: SKIP,
+                   mastercard_wallet_id: SKIP, mastercard_tic_indicator: SKIP,
+                   additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @card_number = card_number unless card_number == SKIP
+      @card_type = card_type unless card_type == SKIP
+      @expiration_date = expiration_date unless expiration_date == SKIP
+      @card_network = card_network unless card_network == SKIP
+      @cvv2_response_code = cvv2_response_code unless cvv2_response_code == SKIP
+      @cvv2_presence_indicator = cvv2_presence_indicator unless cvv2_presence_indicator == SKIP
+      @token = token unless token == SKIP
+      @token_id = token_id unless token_id == SKIP
+      @token_assurance_level = token_assurance_level unless token_assurance_level == SKIP
+      @token_expiration_date = token_expiration_date unless token_expiration_date == SKIP
+      @international_indicator = international_indicator unless international_indicator == SKIP
+      @network_reject_indicator = network_reject_indicator unless network_reject_indicator == SKIP
+      unless network_payment_token_number == SKIP
+        @network_payment_token_number =
+          network_payment_token_number
+      end
+      @card_account_term = card_account_term unless card_account_term == SKIP
+      @cardholder_bank_acro = cardholder_bank_acro unless cardholder_bank_acro == SKIP
+      @token_requestor_id = token_requestor_id unless token_requestor_id == SKIP
+      @bank_net_date = bank_net_date unless bank_net_date == SKIP
+      unless bank_net_reference_number == SKIP
+        @bank_net_reference_number =
+          bank_net_reference_number
+      end
+      unless market_specific_data_indicator == SKIP
+        @market_specific_data_indicator =
+          market_specific_data_indicator
+      end
+      @dcc_mcp_indicator = dcc_mcp_indicator unless dcc_mcp_indicator == SKIP
+      @last_four_of_pan = last_four_of_pan unless last_four_of_pan == SKIP
+      @visa_reversed = visa_reversed unless visa_reversed == SKIP
+      @visa_reversed_date = visa_reversed_date unless visa_reversed_date == SKIP
+      @mastercard_wallet_id = mastercard_wallet_id unless mastercard_wallet_id == SKIP
+      @mastercard_tic_indicator = mastercard_tic_indicator unless mastercard_tic_indicator == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      card_number = hash.key?('cardNumber') ? hash['cardNumber'] : SKIP
+      card_type = hash.key?('cardType') ? hash['cardType'] : SKIP
+      expiration_date =
+        hash.key?('expirationDate') ? hash['expirationDate'] : SKIP
+      card_network = CardNetwork.from_hash(hash['cardNetwork']) if hash['cardNetwork']
+      cvv2_response_code = Cvv2ResponseCode.from_hash(hash['cvv2ResponseCode']) if
+        hash['cvv2ResponseCode']
+      cvv2_presence_indicator = Cvv2PresenceIndicator.from_hash(hash['cvv2PresenceIndicator']) if
+        hash['cvv2PresenceIndicator']
+      token = hash.key?('token') ? hash['token'] : SKIP
+      token_id = hash.key?('tokenId') ? hash['tokenId'] : SKIP
+      token_assurance_level =
+        hash.key?('tokenAssuranceLevel') ? hash['tokenAssuranceLevel'] : SKIP
+      token_expiration_date =
+        hash.key?('tokenExpirationDate') ? hash['tokenExpirationDate'] : SKIP
+      international_indicator = InternationalIndicator.from_hash(hash['internationalIndicator']) if
+        hash['internationalIndicator']
+      network_reject_indicator =
+        hash.key?('networkRejectIndicator') ? hash['networkRejectIndicator'] : SKIP
+      network_payment_token_number =
+        hash.key?('networkPaymentTokenNumber') ? hash['networkPaymentTokenNumber'] : SKIP
+      card_account_term = CardAccountTerm.from_hash(hash['cardAccountTerm']) if
+        hash['cardAccountTerm']
+      cardholder_bank_acro =
+        hash.key?('cardholderBankAcro') ? hash['cardholderBankAcro'] : SKIP
+      token_requestor_id =
+        hash.key?('tokenRequestorId') ? hash['tokenRequestorId'] : SKIP
+      bank_net_date = hash.key?('bankNetDate') ? hash['bankNetDate'] : SKIP
+      bank_net_reference_number =
+        hash.key?('bankNetReferenceNumber') ? hash['bankNetReferenceNumber'] : SKIP
+      if hash['marketSpecificDataIndicator']
+        market_specific_data_indicator = MarketSpecificDataIndicator.from_hash(hash['marketSpecificDataIndicator'])
+      end
+      dcc_mcp_indicator =
+        hash.key?('dccMcpIndicator') ? hash['dccMcpIndicator'] : SKIP
+      last_four_of_pan =
+        hash.key?('lastFourOfPAN') ? hash['lastFourOfPAN'] : SKIP
+      visa_reversed = hash.key?('visaReversed') ? hash['visaReversed'] : SKIP
+      visa_reversed_date =
+        hash.key?('visaReversedDate') ? hash['visaReversedDate'] : SKIP
+      mastercard_wallet_id =
+        hash.key?('mastercardWalletId') ? hash['mastercardWalletId'] : SKIP
+      mastercard_tic_indicator = MastercardTicIndicator.from_hash(hash['mastercardTICIndicator']) if
+        hash['mastercardTICIndicator']
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      CardDetails.new(card_number: card_number,
+                      card_type: card_type,
+                      expiration_date: expiration_date,
+                      card_network: card_network,
+                      cvv2_response_code: cvv2_response_code,
+                      cvv2_presence_indicator: cvv2_presence_indicator,
+                      token: token,
+                      token_id: token_id,
+                      token_assurance_level: token_assurance_level,
+                      token_expiration_date: token_expiration_date,
+                      international_indicator: international_indicator,
+                      network_reject_indicator: network_reject_indicator,
+                      network_payment_token_number: network_payment_token_number,
+                      card_account_term: card_account_term,
+                      cardholder_bank_acro: cardholder_bank_acro,
+                      token_requestor_id: token_requestor_id,
+                      bank_net_date: bank_net_date,
+                      bank_net_reference_number: bank_net_reference_number,
+                      market_specific_data_indicator: market_specific_data_indicator,
+                      dcc_mcp_indicator: dcc_mcp_indicator,
+                      last_four_of_pan: last_four_of_pan,
+                      visa_reversed: visa_reversed,
+                      visa_reversed_date: visa_reversed_date,
+                      mastercard_wallet_id: mastercard_wallet_id,
+                      mastercard_tic_indicator: mastercard_tic_indicator,
+                      additional_properties: additional_properties)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_number: #{@card_number}, card_type: #{@card_type}, expiration_date:"\
+      " #{@expiration_date}, card_network: #{@card_network}, cvv2_response_code:"\
+      " #{@cvv2_response_code}, cvv2_presence_indicator: #{@cvv2_presence_indicator}, token:"\
+      " #{@token}, token_id: #{@token_id}, token_assurance_level: #{@token_assurance_level},"\
+      " token_expiration_date: #{@token_expiration_date}, international_indicator:"\
+      " #{@international_indicator}, network_reject_indicator: #{@network_reject_indicator},"\
+      " network_payment_token_number: #{@network_payment_token_number}, card_account_term:"\
+      " #{@card_account_term}, cardholder_bank_acro: #{@cardholder_bank_acro}, token_requestor_id:"\
+      " #{@token_requestor_id}, bank_net_date: #{@bank_net_date}, bank_net_reference_number:"\
+      " #{@bank_net_reference_number}, market_specific_data_indicator:"\
+      " #{@market_specific_data_indicator}, dcc_mcp_indicator: #{@dcc_mcp_indicator},"\
+      " last_four_of_pan: #{@last_four_of_pan}, visa_reversed: #{@visa_reversed},"\
+      " visa_reversed_date: #{@visa_reversed_date}, mastercard_wallet_id:"\
+      " #{@mastercard_wallet_id}, mastercard_tic_indicator: #{@mastercard_tic_indicator},"\
+      " additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} card_number: #{@card_number.inspect}, card_type: #{@card_type.inspect},"\
+      " expiration_date: #{@expiration_date.inspect}, card_network: #{@card_network.inspect},"\
+      " cvv2_response_code: #{@cvv2_response_code.inspect}, cvv2_presence_indicator:"\
+      " #{@cvv2_presence_indicator.inspect}, token: #{@token.inspect}, token_id:"\
+      " #{@token_id.inspect}, token_assurance_level: #{@token_assurance_level.inspect},"\
+      " token_expiration_date: #{@token_expiration_date.inspect}, international_indicator:"\
+      " #{@international_indicator.inspect}, network_reject_indicator:"\
+      " #{@network_reject_indicator.inspect}, network_payment_token_number:"\
+      " #{@network_payment_token_number.inspect}, card_account_term:"\
+      " #{@card_account_term.inspect}, cardholder_bank_acro: #{@cardholder_bank_acro.inspect},"\
+      " token_requestor_id: #{@token_requestor_id.inspect}, bank_net_date:"\
+      " #{@bank_net_date.inspect}, bank_net_reference_number:"\
+      " #{@bank_net_reference_number.inspect}, market_specific_data_indicator:"\
+      " #{@market_specific_data_indicator.inspect}, dcc_mcp_indicator:"\
+      " #{@dcc_mcp_indicator.inspect}, last_four_of_pan: #{@last_four_of_pan.inspect},"\
+      " visa_reversed: #{@visa_reversed.inspect}, visa_reversed_date:"\
+      " #{@visa_reversed_date.inspect}, mastercard_wallet_id: #{@mastercard_wallet_id.inspect},"\
+      " mastercard_tic_indicator: #{@mastercard_tic_indicator.inspect}, additional_properties:"\
+      " #{@additional_properties}>"
+    end
+  end
+end