lithic 0.1.0.pre.alpha.14 → 0.1.0.pre.alpha.15

data/lib/lithic/models/card_search_by_pan_response.rb

@@ -0,0 +1,390 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Cards#search_by_pan
+    class CardSearchByPanResponse < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Globally unique identifier.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute account_token
+      #   Globally unique identifier for the account to which the card belongs.
+      #
+      #   @return [String]
+      required :account_token, String
+
+      # @!attribute card_program_token
+      #   Globally unique identifier for the card program on which the card exists.
+      #
+      #   @return [String]
+      required :card_program_token, String
+
+      # @!attribute created
+      #   An RFC 3339 timestamp for when the card was created. UTC time zone.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute funding
+      #   Deprecated: Funding account for the card.
+      #
+      #   @return [Lithic::Models::CardSearchByPanResponse::Funding]
+      required :funding, -> { Lithic::Models::CardSearchByPanResponse::Funding }
+
+      # @!attribute last_four
+      #   Last four digits of the card number.
+      #
+      #   @return [String]
+      required :last_four, String
+
+      # @!attribute pin_status
+      #   Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      #   attempts).
+      #
+      #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::PinStatus]
+      required :pin_status, enum: -> { Lithic::Models::CardSearchByPanResponse::PinStatus }
+
+      # @!attribute spend_limit
+      #   Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+      #   $1,000 limit). Transaction requests above the spend limit will be declined.
+      #
+      #   @return [Integer]
+      required :spend_limit, Integer
+
+      # @!attribute spend_limit_duration
+      #   Spend limit duration
+      #
+      #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::SpendLimitDuration]
+      required :spend_limit_duration, enum: -> { Lithic::Models::CardSearchByPanResponse::SpendLimitDuration }
+
+      # @!attribute state
+      #   Card state values: _ `CLOSED` - Card will no longer approve authorizations.
+      #   Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
+      #   they match card and account parameters). _ `PAUSED` - Card will decline
+      #   authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
+      #   The initial state for cards of type `PHYSICAL`. The card is provisioned pending
+      #   manufacturing and fulfillment. Cards in this state can accept authorizations for
+      #   e-commerce purchases, but not for "Card Present" purchases where the physical
+      #   card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
+      #   type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
+      #   warehouse and updated to state `PENDING_ACTIVATION`. Similar to
+      #   `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
+      #   transactions or can be added to mobile wallets. API clients should update the
+      #   card's state to `OPEN` only after the cardholder confirms receipt of the card.
+      #   In sandbox, the same daily batch fulfillment occurs, but no cards are actually
+      #   manufactured.
+      #
+      #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::State]
+      required :state, enum: -> { Lithic::Models::CardSearchByPanResponse::State }
+
+      # @!attribute type
+      #   Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
+      #   to a digital wallet like Apple Pay or Google Pay (if the card program is digital
+      #   wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
+      #   offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
+      #   functionality. _ `SINGLE_USE` - Card is closed upon first successful
+      #   authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
+      #   merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
+      #   Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
+      #   `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
+      #   VIRTUAL instead.
+      #
+      #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::Type]
+      required :type, enum: -> { Lithic::Models::CardSearchByPanResponse::Type }
+
+      # @!attribute auth_rule_tokens
+      #   List of identifiers for the Auth Rule(s) that are applied on the card. This
+      #   field is deprecated and will no longer be populated in the `Card` object. The
+      #   key will be removed from the schema in a future release. Use the `/auth_rules`
+      #   endpoints to fetch Auth Rule information instead.
+      #
+      #   @return [Array<String>, nil]
+      optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
+
+      # @!attribute cardholder_currency
+      #   3-character alphabetic ISO 4217 code for the currency of the cardholder.
+      #
+      #   @return [String, nil]
+      optional :cardholder_currency, String
+
+      # @!attribute cvv
+      #   Three digit cvv printed on the back of the card.
+      #
+      #   @return [String, nil]
+      optional :cvv, String
+
+      # @!attribute digital_card_art_token
+      #   Specifies the digital card art to be displayed in the user's digital wallet
+      #   after tokenization. This artwork must be approved by Mastercard and configured
+      #   by Lithic to use.
+      #
+      #   @return [String, nil]
+      optional :digital_card_art_token, String
+
+      # @!attribute exp_month
+      #   Two digit (MM) expiry month.
+      #
+      #   @return [String, nil]
+      optional :exp_month, String
+
+      # @!attribute exp_year
+      #   Four digit (yyyy) expiry year.
+      #
+      #   @return [String, nil]
+      optional :exp_year, String
+
+      # @!attribute hostname
+      #   Hostname of card's locked merchant (will be empty if not applicable).
+      #
+      #   @return [String, nil]
+      optional :hostname, String
+
+      # @!attribute memo
+      #   Friendly name to identify the card.
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!attribute pan
+      #   Primary Account Number (PAN) (i.e. the card number). Customers must be PCI
+      #   compliant to have PAN returned as a field in production. Please contact
+      #   support@lithic.com for questions.
+      #
+      #   @return [String, nil]
+      optional :pan, String
+
+      # @!attribute pending_commands
+      #   Indicates if there are offline PIN changes pending card interaction with an
+      #   offline PIN terminal. Possible commands are: CHANGE_PIN, UNBLOCK_PIN. Applicable
+      #   only to cards issued in markets supporting offline PINs.
+      #
+      #   @return [Array<String>, nil]
+      optional :pending_commands, Lithic::Internal::Type::ArrayOf[String]
+
+      # @!attribute product_id
+      #   Only applicable to cards of type `PHYSICAL`. This must be configured with Lithic
+      #   before use. Specifies the configuration (i.e., physical card art) that the card
+      #   should be manufactured with.
+      #
+      #   @return [String, nil]
+      optional :product_id, String
+
+      # @!attribute replacement_for
+      #   If the card is a replacement for another card, the globally unique identifier
+      #   for the card that was replaced.
+      #
+      #   @return [String, nil]
+      optional :replacement_for, String, nil?: true
+
+      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, cvv: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, pan: nil, pending_commands: nil, product_id: nil, replacement_for: nil)
+      #   Card details with potentially PCI sensitive information for Enterprise customers
+      #
+      #   @param token [String]
+      #   @param account_token [String]
+      #   @param card_program_token [String]
+      #   @param created [Time]
+      #   @param funding [Lithic::Models::CardSearchByPanResponse::Funding]
+      #   @param last_four [String]
+      #   @param pin_status [Symbol, Lithic::Models::CardSearchByPanResponse::PinStatus]
+      #   @param spend_limit [Integer]
+      #   @param spend_limit_duration [Symbol, Lithic::Models::CardSearchByPanResponse::SpendLimitDuration]
+      #   @param state [Symbol, Lithic::Models::CardSearchByPanResponse::State]
+      #   @param type [Symbol, Lithic::Models::CardSearchByPanResponse::Type]
+      #   @param auth_rule_tokens [Array<String>]
+      #   @param cardholder_currency [String]
+      #   @param cvv [String]
+      #   @param digital_card_art_token [String]
+      #   @param exp_month [String]
+      #   @param exp_year [String]
+      #   @param hostname [String]
+      #   @param memo [String]
+      #   @param pan [String]
+      #   @param pending_commands [Array<String>]
+      #   @param product_id [String]
+      #   @param replacement_for [String, nil]
+
+      # @see Lithic::Models::CardSearchByPanResponse#funding
+      class Funding < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   A globally unique identifier for this FundingAccount.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute created
+        #   An RFC 3339 string representing when this funding source was added to the Lithic
+        #   account. This may be `null`. UTC time zone.
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute last_four
+        #   The last 4 digits of the account (e.g. bank account, debit card) associated with
+        #   this FundingAccount. This may be null.
+        #
+        #   @return [String]
+        required :last_four, String
+
+        # @!attribute state
+        #   State of funding source. Funding source states: _ `ENABLED` - The funding
+        #   account is available to use for card creation and transactions. _ `PENDING` -
+        #   The funding account is still being verified e.g. bank micro-deposits
+        #   verification. \* `DELETED` - The founding account has been deleted.
+        #
+        #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::Funding::State]
+        required :state, enum: -> { Lithic::Models::CardSearchByPanResponse::Funding::State }
+
+        # @!attribute type
+        #   Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
+        #   `DEPOSITORY_SAVINGS` - Bank savings account.
+        #
+        #   @return [Symbol, Lithic::Models::CardSearchByPanResponse::Funding::Type]
+        required :type, enum: -> { Lithic::Models::CardSearchByPanResponse::Funding::Type }
+
+        # @!attribute account_name
+        #   Account name identifying the funding source. This may be `null`.
+        #
+        #   @return [String, nil]
+        optional :account_name, String
+
+        # @!attribute nickname
+        #   The nickname given to the `FundingAccount` or `null` if it has no nickname.
+        #
+        #   @return [String, nil]
+        optional :nickname, String
+
+        # @!method initialize(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil)
+        #   Deprecated: Funding account for the card.
+        #
+        #   @param token [String]
+        #   @param created [Time]
+        #   @param last_four [String]
+        #   @param state [Symbol, Lithic::Models::CardSearchByPanResponse::Funding::State]
+        #   @param type [Symbol, Lithic::Models::CardSearchByPanResponse::Funding::Type]
+        #   @param account_name [String]
+        #   @param nickname [String]
+
+        # State of funding source. Funding source states: _ `ENABLED` - The funding
+        # account is available to use for card creation and transactions. _ `PENDING` -
+        # The funding account is still being verified e.g. bank micro-deposits
+        # verification. \* `DELETED` - The founding account has been deleted.
+        #
+        # @see Lithic::Models::CardSearchByPanResponse::Funding#state
+        module State
+          extend Lithic::Internal::Type::Enum
+
+          DELETED = :DELETED
+          ENABLED = :ENABLED
+          PENDING = :PENDING
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Types of funding source: _ `DEPOSITORY_CHECKING` - Bank checking account. _
+        # `DEPOSITORY_SAVINGS` - Bank savings account.
+        #
+        # @see Lithic::Models::CardSearchByPanResponse::Funding#type
+        module Type
+          extend Lithic::Internal::Type::Enum
+
+          DEPOSITORY_CHECKING = :DEPOSITORY_CHECKING
+          DEPOSITORY_SAVINGS = :DEPOSITORY_SAVINGS
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      # attempts).
+      #
+      # @see Lithic::Models::CardSearchByPanResponse#pin_status
+      module PinStatus
+        extend Lithic::Internal::Type::Enum
+
+        OK = :OK
+        BLOCKED = :BLOCKED
+        NOT_SET = :NOT_SET
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Spend limit duration
+      #
+      # @see Lithic::Models::CardSearchByPanResponse#spend_limit_duration
+      module SpendLimitDuration
+        extend Lithic::Internal::Type::Enum
+
+        ANNUALLY = :ANNUALLY
+        FOREVER = :FOREVER
+        MONTHLY = :MONTHLY
+        TRANSACTION = :TRANSACTION
+        DAILY = :DAILY
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Card state values: _ `CLOSED` - Card will no longer approve authorizations.
+      # Closing a card cannot be undone. _ `OPEN` - Card will approve authorizations (if
+      # they match card and account parameters). _ `PAUSED` - Card will decline
+      # authorizations, but can be resumed at a later time. _ `PENDING_FULFILLMENT` -
+      # The initial state for cards of type `PHYSICAL`. The card is provisioned pending
+      # manufacturing and fulfillment. Cards in this state can accept authorizations for
+      # e-commerce purchases, but not for "Card Present" purchases where the physical
+      # card itself is present. \* `PENDING_ACTIVATION` - At regular intervals, cards of
+      # type `PHYSICAL` in state `PENDING_FULFILLMENT` are sent to the card production
+      # warehouse and updated to state `PENDING_ACTIVATION`. Similar to
+      # `PENDING_FULFILLMENT`, cards in this state can be used for e-commerce
+      # transactions or can be added to mobile wallets. API clients should update the
+      # card's state to `OPEN` only after the cardholder confirms receipt of the card.
+      # In sandbox, the same daily batch fulfillment occurs, but no cards are actually
+      # manufactured.
+      #
+      # @see Lithic::Models::CardSearchByPanResponse#state
+      module State
+        extend Lithic::Internal::Type::Enum
+
+        CLOSED = :CLOSED
+        OPEN = :OPEN
+        PAUSED = :PAUSED
+        PENDING_ACTIVATION = :PENDING_ACTIVATION
+        PENDING_FULFILLMENT = :PENDING_FULFILLMENT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Card types: _ `VIRTUAL` - Card will authorize at any merchant and can be added
+      # to a digital wallet like Apple Pay or Google Pay (if the card program is digital
+      # wallet-enabled). _ `PHYSICAL` - Manufactured and sent to the cardholder. We
+      # offer white label branding, credit, ATM, PIN debit, chip/EMV, NFC and magstripe
+      # functionality. _ `SINGLE_USE` - Card is closed upon first successful
+      # authorization. _ `MERCHANT_LOCKED` - _[Deprecated]_ Card is locked to the first
+      # merchant that successfully authorizes the card. _ `UNLOCKED` - _[Deprecated]_
+      # Similar behavior to VIRTUAL cards, please use VIRTUAL instead. _
+      # `DIGITAL_WALLET` - _[Deprecated]_ Similar behavior to VIRTUAL cards, please use
+      # VIRTUAL instead.
+      #
+      # @see Lithic::Models::CardSearchByPanResponse#type
+      module Type
+        extend Lithic::Internal::Type::Enum
+
+        MERCHANT_LOCKED = :MERCHANT_LOCKED
+        PHYSICAL = :PHYSICAL
+        SINGLE_USE = :SINGLE_USE
+        VIRTUAL = :VIRTUAL
+        UNLOCKED = :UNLOCKED
+        DIGITAL_WALLET = :DIGITAL_WALLET
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/card_spend_limits.rb

@@ -9,163 +9,103 @@ module Lithic
       #   @return [Lithic::Models::CardSpendLimits::AvailableSpendLimit]
       required :available_spend_limit, -> { Lithic::Models::CardSpendLimits::AvailableSpendLimit }
 
-      # @!attribute [r] spend_limit
+      # @!attribute spend_limit
       #
       #   @return [Lithic::Models::CardSpendLimits::SpendLimit, nil]
       optional :spend_limit, -> { Lithic::Models::CardSpendLimits::SpendLimit }
 
-      # @!parse
-      #   # @return [Lithic::Models::CardSpendLimits::SpendLimit]
-      #   attr_writer :spend_limit
-
-      # @!attribute [r] spend_velocity
+      # @!attribute spend_velocity
       #
       #   @return [Lithic::Models::CardSpendLimits::SpendVelocity, nil]
       optional :spend_velocity, -> { Lithic::Models::CardSpendLimits::SpendVelocity }
 
-      # @!parse
-      #   # @return [Lithic::Models::CardSpendLimits::SpendVelocity]
-      #   attr_writer :spend_velocity
-
-      # @!parse
-      #   # @param available_spend_limit [Lithic::Models::CardSpendLimits::AvailableSpendLimit]
-      #   # @param spend_limit [Lithic::Models::CardSpendLimits::SpendLimit]
-      #   # @param spend_velocity [Lithic::Models::CardSpendLimits::SpendVelocity]
-      #   #
-      #   def initialize(available_spend_limit:, spend_limit: nil, spend_velocity: nil, **) = super
-
-      # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+      # @!method initialize(available_spend_limit:, spend_limit: nil, spend_velocity: nil)
+      #   @param available_spend_limit [Lithic::Models::CardSpendLimits::AvailableSpendLimit]
+      #   @param spend_limit [Lithic::Models::CardSpendLimits::SpendLimit]
+      #   @param spend_velocity [Lithic::Models::CardSpendLimits::SpendVelocity]
 
       # @see Lithic::Models::CardSpendLimits#available_spend_limit
       class AvailableSpendLimit < Lithic::Internal::Type::BaseModel
-        # @!attribute [r] annually
+        # @!attribute annually
         #   The available spend limit (in cents) relative to the annual limit configured on
         #   the Card (e.g. 100000 would be a $1,000 limit).
         #
         #   @return [Integer, nil]
         optional :annually, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :annually
-
-        # @!attribute [r] forever
+        # @!attribute forever
         #   The available spend limit (in cents) relative to the forever limit configured on
         #   the Card.
         #
         #   @return [Integer, nil]
         optional :forever, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :forever
-
-        # @!attribute [r] monthly
+        # @!attribute monthly
         #   The available spend limit (in cents) relative to the monthly limit configured on
         #   the Card.
         #
         #   @return [Integer, nil]
         optional :monthly, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :monthly
-
-        # @!parse
-        #   # @param annually [Integer]
-        #   # @param forever [Integer]
-        #   # @param monthly [Integer]
-        #   #
-        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(annually: nil, forever: nil, monthly: nil)
+        #   @param annually [Integer]
+        #   @param forever [Integer]
+        #   @param monthly [Integer]
       end
 
       # @see Lithic::Models::CardSpendLimits#spend_limit
       class SpendLimit < Lithic::Internal::Type::BaseModel
-        # @!attribute [r] annually
+        # @!attribute annually
         #   The configured annual spend limit (in cents) on the Card.
         #
         #   @return [Integer, nil]
         optional :annually, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :annually
-
-        # @!attribute [r] forever
+        # @!attribute forever
         #   The configured forever spend limit (in cents) on the Card.
         #
         #   @return [Integer, nil]
         optional :forever, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :forever
-
-        # @!attribute [r] monthly
+        # @!attribute monthly
         #   The configured monthly spend limit (in cents) on the Card.
         #
         #   @return [Integer, nil]
         optional :monthly, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :monthly
-
-        # @!parse
-        #   # @param annually [Integer]
-        #   # @param forever [Integer]
-        #   # @param monthly [Integer]
-        #   #
-        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(annually: nil, forever: nil, monthly: nil)
+        #   @param annually [Integer]
+        #   @param forever [Integer]
+        #   @param monthly [Integer]
       end
 
       # @see Lithic::Models::CardSpendLimits#spend_velocity
       class SpendVelocity < Lithic::Internal::Type::BaseModel
-        # @!attribute [r] annually
+        # @!attribute annually
         #   Current annual spend velocity (in cents) on the Card. Present if annual spend
         #   limit is set.
         #
         #   @return [Integer, nil]
         optional :annually, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :annually
-
-        # @!attribute [r] forever
+        # @!attribute forever
         #   Current forever spend velocity (in cents) on the Card. Present if forever spend
         #   limit is set.
         #
         #   @return [Integer, nil]
         optional :forever, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :forever
-
-        # @!attribute [r] monthly
+        # @!attribute monthly
         #   Current monthly spend velocity (in cents) on the Card. Present if monthly spend
         #   limit is set.
         #
         #   @return [Integer, nil]
         optional :monthly, Integer
 
-        # @!parse
-        #   # @return [Integer]
-        #   attr_writer :monthly
-
-        # @!parse
-        #   # @param annually [Integer]
-        #   # @param forever [Integer]
-        #   # @param monthly [Integer]
-        #   #
-        #   def initialize(annually: nil, forever: nil, monthly: nil, **) = super
-
-        # def initialize: (Hash | Lithic::Internal::Type::BaseModel) -> void
+        # @!method initialize(annually: nil, forever: nil, monthly: nil)
+        #   @param annually [Integer]
+        #   @param forever [Integer]
+        #   @param monthly [Integer]
       end
     end
   end