lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/card.rb

@@ -0,0 +1,512 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class Card < Lithic::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::Card::Funding]
+      required :funding, -> { Lithic::Models::Card::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::Card::PinStatus]
+      required :pin_status, enum: -> { Lithic::Models::Card::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 values:
+      #
+      #     - `ANNUALLY` - Card will authorize transactions up to spend limit for the
+      #       trailing year.
+      #     - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
+      #       of the card.
+      #     - `MONTHLY` - Card will authorize transactions up to spend limit for the
+      #       trailing month. To support recurring monthly payments, which can occur on
+      #       different day every month, the time window we consider for monthly velocity
+      #       starts 6 days after the current calendar date one month prior.
+      #     - `TRANSACTION` - Card will authorize multiple transactions if each individual
+      #       transaction is under the spend limit.
+      #
+      #   @return [Symbol, Lithic::Models::SpendLimitDuration]
+      required :spend_limit_duration, enum: -> { Lithic::Models::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::Card::State]
+      required :state, enum: -> { Lithic::Models::Card::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.
+      #       Reach out at [lithic.com/contact](https://lithic.com/contact) for more
+      #       information.
+      #     - `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::Card::Type]
+      required :type, enum: -> { Lithic::Models::Card::Type }
+
+      # @!attribute [r] 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::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :auth_rule_tokens
+
+      # @!attribute [r] cardholder_currency
+      #   3-character alphabetic ISO 4217 code for the currency of the cardholder.
+      #
+      #   @return [String, nil]
+      optional :cardholder_currency, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :cardholder_currency
+
+      # @!attribute [r] cvv
+      #   Three digit cvv printed on the back of the card.
+      #
+      #   @return [String, nil]
+      optional :cvv, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :cvv
+
+      # @!attribute [r] 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. See
+      #     [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
+      #
+      #   @return [String, nil]
+      optional :digital_card_art_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :digital_card_art_token
+
+      # @!attribute [r] exp_month
+      #   Two digit (MM) expiry month.
+      #
+      #   @return [String, nil]
+      optional :exp_month, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_month
+
+      # @!attribute [r] exp_year
+      #   Four digit (yyyy) expiry year.
+      #
+      #   @return [String, nil]
+      optional :exp_year, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_year
+
+      # @!attribute [r] hostname
+      #   Hostname of card’s locked merchant (will be empty if not applicable).
+      #
+      #   @return [String, nil]
+      optional :hostname, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :hostname
+
+      # @!attribute [r] memo
+      #   Friendly name to identify the card.
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!attribute [r] 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](mailto:support@lithic.com) for questions.
+      #
+      #   @return [String, nil]
+      optional :pan, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :pan
+
+      # @!attribute [r] 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::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :pending_commands
+
+      # @!attribute [r] 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
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :product_id
+
+      # @!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
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param account_token [String]
+      #   # @param card_program_token [String]
+      #   # @param created [Time]
+      #   # @param funding [Lithic::Models::Card::Funding]
+      #   # @param last_four [String]
+      #   # @param pin_status [Symbol, Lithic::Models::Card::PinStatus]
+      #   # @param spend_limit [Integer]
+      #   # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
+      #   # @param state [Symbol, Lithic::Models::Card::State]
+      #   # @param type [Symbol, Lithic::Models::Card::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]
+      #   #
+      #   def 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,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      class Funding < Lithic::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::Card::Funding::State]
+        required :state, enum: -> { Lithic::Models::Card::Funding::State }
+
+        # @!attribute type
+        #   Types of funding source:
+        #
+        #     - `DEPOSITORY_CHECKING` - Bank checking account.
+        #     - `DEPOSITORY_SAVINGS` - Bank savings account.
+        #
+        #   @return [Symbol, Lithic::Models::Card::Funding::Type]
+        required :type, enum: -> { Lithic::Models::Card::Funding::Type }
+
+        # @!attribute [r] account_name
+        #   Account name identifying the funding source. This may be `null`.
+        #
+        #   @return [String, nil]
+        optional :account_name, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :account_name
+
+        # @!attribute [r] nickname
+        #   The nickname given to the `FundingAccount` or `null` if it has no nickname.
+        #
+        #   @return [String, nil]
+        optional :nickname, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :nickname
+
+        # @!parse
+        #   # Deprecated: Funding account for the card.
+        #   #
+        #   # @param token [String]
+        #   # @param created [Time]
+        #   # @param last_four [String]
+        #   # @param state [Symbol, Lithic::Models::Card::Funding::State]
+        #   # @param type [Symbol, Lithic::Models::Card::Funding::Type]
+        #   # @param account_name [String]
+        #   # @param nickname [String]
+        #   #
+        #   def initialize(token:, created:, last_four:, state:, type:, account_name: nil, nickname: nil, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+
+        # 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.
+        module State
+          extend Lithic::Enum
+
+          DELETED = :DELETED
+          ENABLED = :ENABLED
+          PENDING = :PENDING
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # Types of funding source:
+        #
+        #   - `DEPOSITORY_CHECKING` - Bank checking account.
+        #   - `DEPOSITORY_SAVINGS` - Bank savings account.
+        module Type
+          extend Lithic::Enum
+
+          DEPOSITORY_CHECKING = :DEPOSITORY_CHECKING
+          DEPOSITORY_SAVINGS = :DEPOSITORY_SAVINGS
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+
+      # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      #   attempts).
+      module PinStatus
+        extend Lithic::Enum
+
+        OK = :OK
+        BLOCKED = :BLOCKED
+        NOT_SET = :NOT_SET
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      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.
+      module State
+        extend Lithic::Enum
+
+        CLOSED = :CLOSED
+        OPEN = :OPEN
+        PAUSED = :PAUSED
+        PENDING_ACTIVATION = :PENDING_ACTIVATION
+        PENDING_FULFILLMENT = :PENDING_FULFILLMENT
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      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.
+      #     Reach out at [lithic.com/contact](https://lithic.com/contact) for more
+      #     information.
+      #   - `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.
+      module Type
+        extend Lithic::Enum
+
+        MERCHANT_LOCKED = :MERCHANT_LOCKED
+        PHYSICAL = :PHYSICAL
+        SINGLE_USE = :SINGLE_USE
+        VIRTUAL = :VIRTUAL
+        UNLOCKED = :UNLOCKED
+        DIGITAL_WALLET = :DIGITAL_WALLET
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/card_convert_physical_params.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardConvertPhysicalParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute shipping_address
+      #   The shipping address this card will be sent to.
+      #
+      #   @return [Lithic::Models::ShippingAddress]
+      required :shipping_address, -> { Lithic::Models::ShippingAddress }
+
+      # @!attribute [r] carrier
+      #   If omitted, the previous carrier will be used.
+      #
+      #   @return [Lithic::Models::Carrier, nil]
+      optional :carrier, -> { Lithic::Models::Carrier }
+
+      # @!parse
+      #   # @return [Lithic::Models::Carrier]
+      #   attr_writer :carrier
+
+      # @!attribute [r] product_id
+      #   Specifies the configuration (e.g. physical card art) that the card should be
+      #     manufactured with, and only applies to cards of type `PHYSICAL`. This must be
+      #     configured with Lithic before use.
+      #
+      #   @return [String, nil]
+      optional :product_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :product_id
+
+      # @!attribute [r] shipping_method
+      #   Shipping method for the card. Use of options besides `STANDARD` require
+      #     additional permissions.
+      #
+      #     - `STANDARD` - USPS regular mail or similar international option, with no
+      #       tracking
+      #     - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #       with tracking
+      #     - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #     - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #     - `2_DAY` - FedEx 2-day shipping, with tracking
+      #     - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #       tracking
+      #
+      #   @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod, nil]
+      optional :shipping_method, enum: -> { Lithic::Models::CardConvertPhysicalParams::ShippingMethod }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
+      #   attr_writer :shipping_method
+
+      # @!parse
+      #   # @param shipping_address [Lithic::Models::ShippingAddress]
+      #   # @param carrier [Lithic::Models::Carrier]
+      #   # @param product_id [String]
+      #   # @param shipping_method [Symbol, Lithic::Models::CardConvertPhysicalParams::ShippingMethod]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(shipping_address:, carrier: nil, product_id: nil, shipping_method: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Shipping method for the card. Use of options besides `STANDARD` require
+      #   additional permissions.
+      #
+      #   - `STANDARD` - USPS regular mail or similar international option, with no
+      #     tracking
+      #   - `STANDARD_WITH_TRACKING` - USPS regular mail or similar international option,
+      #     with tracking
+      #   - `PRIORITY` - USPS Priority, 1-3 day shipping, with tracking
+      #   - `EXPRESS` - FedEx Express, 3-day shipping, with tracking
+      #   - `2_DAY` - FedEx 2-day shipping, with tracking
+      #   - `EXPEDITED` - FedEx Standard Overnight or similar international option, with
+      #     tracking
+      module ShippingMethod
+        extend Lithic::Enum
+
+        NUMBER_2_DAY = :"2-DAY"
+        EXPEDITED = :EXPEDITED
+        EXPRESS = :EXPRESS
+        PRIORITY = :PRIORITY
+        STANDARD = :STANDARD
+        STANDARD_WITH_TRACKING = :STANDARD_WITH_TRACKING
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end