lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/card_create_params.rb

@@ -0,0 +1,371 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardCreateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!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::CardCreateParams::Type]
+      required :type, enum: -> { Lithic::Models::CardCreateParams::Type }
+
+      # @!attribute [r] account_token
+      #   Globally unique identifier for the account that the card will be associated
+      #     with. Required for programs enrolling users using the
+      #     [/account_holders endpoint](https://docs.lithic.com/docs/account-holders-kyc).
+      #     See [Managing Your Program](doc:managing-your-program) for more information.
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :account_token
+
+      # @!attribute [r] card_program_token
+      #   For card programs with more than one BIN range. This must be configured with
+      #     Lithic before use. Identifies the card program/BIN range under which to create
+      #     the card. If omitted, will utilize the program's default `card_program_token`.
+      #     In Sandbox, use 00000000-0000-0000-1000-000000000000 and
+      #     00000000-0000-0000-2000-000000000000 to test creating cards on specific card
+      #     programs.
+      #
+      #   @return [String, nil]
+      optional :card_program_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :card_program_token
+
+      # @!attribute [r] carrier
+      #
+      #   @return [Lithic::Models::Carrier, nil]
+      optional :carrier, -> { Lithic::Models::Carrier }
+
+      # @!parse
+      #   # @return [Lithic::Models::Carrier]
+      #   attr_writer :carrier
+
+      # @!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. If neither `exp_month` nor `exp_year` is provided,
+      #     an expiration date will be generated.
+      #
+      #   @return [String, nil]
+      optional :exp_month, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_month
+
+      # @!attribute [r] exp_year
+      #   Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
+      #     provided, an expiration date will be generated.
+      #
+      #   @return [String, nil]
+      optional :exp_year, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :exp_year
+
+      # @!attribute [r] memo
+      #   Friendly name to identify the card.
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!attribute [r] pin
+      #   Encrypted PIN block (in base64). Applies to cards of type `PHYSICAL` and
+      #     `VIRTUAL`. See
+      #     [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
+      #
+      #   @return [String, nil]
+      optional :pin, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :pin
+
+      # @!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 [r] replacement_account_token
+      #   Restricted field limited to select use cases. Lithic will reach out directly if
+      #     this field should be used. Globally unique identifier for the replacement card's
+      #     account. If this field is specified, `replacement_for` must also be specified.
+      #     If `replacement_for` is specified and this field is omitted, the replacement
+      #     card's account will be inferred from the card being replaced.
+      #
+      #   @return [String, nil]
+      optional :replacement_account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :replacement_account_token
+
+      # @!attribute [r] replacement_for
+      #   Globally unique identifier for the card that this card will replace. If the card
+      #     type is `PHYSICAL` it will be replaced by a `PHYSICAL` card. If the card type is
+      #     `VIRTUAL` it will be replaced by a `VIRTUAL` card.
+      #
+      #   @return [String, nil]
+      optional :replacement_for, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :replacement_for
+
+      # @!attribute [r] shipping_address
+      #
+      #   @return [Lithic::Models::ShippingAddress, nil]
+      optional :shipping_address, -> { Lithic::Models::ShippingAddress }
+
+      # @!parse
+      #   # @return [Lithic::Models::ShippingAddress]
+      #   attr_writer :shipping_address
+
+      # @!attribute [r] shipping_method
+      #   Shipping method for the card. Only applies to cards of type PHYSICAL. 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::CardCreateParams::ShippingMethod, nil]
+      optional :shipping_method, enum: -> { Lithic::Models::CardCreateParams::ShippingMethod }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardCreateParams::ShippingMethod]
+      #   attr_writer :shipping_method
+
+      # @!attribute [r] 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. Note
+      #     that a spend limit of 0 is effectively no limit, and should only be used to
+      #     reset or remove a prior limit. Only a limit of 1 or above will result in
+      #     declined transactions due to checks against the card limit.
+      #
+      #   @return [Integer, nil]
+      optional :spend_limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :spend_limit
+
+      # @!attribute [r] 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, nil]
+      optional :spend_limit_duration, enum: -> { Lithic::Models::SpendLimitDuration }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::SpendLimitDuration]
+      #   attr_writer :spend_limit_duration
+
+      # @!attribute [r] state
+      #   Card state values:
+      #
+      #     - `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.
+      #
+      #   @return [Symbol, Lithic::Models::CardCreateParams::State, nil]
+      optional :state, enum: -> { Lithic::Models::CardCreateParams::State }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardCreateParams::State]
+      #   attr_writer :state
+
+      # @!parse
+      #   # @param type [Symbol, Lithic::Models::CardCreateParams::Type]
+      #   # @param account_token [String]
+      #   # @param card_program_token [String]
+      #   # @param carrier [Lithic::Models::Carrier]
+      #   # @param digital_card_art_token [String]
+      #   # @param exp_month [String]
+      #   # @param exp_year [String]
+      #   # @param memo [String]
+      #   # @param pin [String]
+      #   # @param product_id [String]
+      #   # @param replacement_account_token [String]
+      #   # @param replacement_for [String]
+      #   # @param shipping_address [Lithic::Models::ShippingAddress]
+      #   # @param shipping_method [Symbol, Lithic::Models::CardCreateParams::ShippingMethod]
+      #   # @param spend_limit [Integer]
+      #   # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
+      #   # @param state [Symbol, Lithic::Models::CardCreateParams::State]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     type:,
+      #     account_token: nil,
+      #     card_program_token: nil,
+      #     carrier: nil,
+      #     digital_card_art_token: nil,
+      #     exp_month: nil,
+      #     exp_year: nil,
+      #     memo: nil,
+      #     pin: nil,
+      #     product_id: nil,
+      #     replacement_account_token: nil,
+      #     replacement_for: nil,
+      #     shipping_address: nil,
+      #     shipping_method: nil,
+      #     spend_limit: nil,
+      #     spend_limit_duration: nil,
+      #     state: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # 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
+
+      # Shipping method for the card. Only applies to cards of type PHYSICAL. 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
+
+      # Card state values:
+      #
+      #   - `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.
+      module State
+        extend Lithic::Enum
+
+        OPEN = :OPEN
+        PAUSED = :PAUSED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/card_embed_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardEmbedParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute embed_request
+      #   A base64 encoded JSON string of an EmbedRequest to specify which card to load.
+      #
+      #   @return [String]
+      required :embed_request, String
+
+      # @!attribute hmac
+      #   SHA256 HMAC of the embed_request JSON string with base64 digest.
+      #
+      #   @return [String]
+      required :hmac, String
+
+      # @!parse
+      #   # @param embed_request [String]
+      #   # @param hmac [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(embed_request:, hmac:, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_list_params.rb

@@ -0,0 +1,128 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardListParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] account_token
+      #   Returns cards associated with the specified account.
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :account_token
+
+      # @!attribute [r] begin_
+      #   Date string in RFC 3339 format. Only entries created after the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :begin_, Time, api_name: :begin
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :begin_
+
+      # @!attribute [r] end_
+      #   Date string in RFC 3339 format. Only entries created before the specified time
+      #     will be included. UTC time zone.
+      #
+      #   @return [Time, nil]
+      optional :end_, Time, api_name: :end
+
+      # @!parse
+      #   # @return [Time]
+      #   attr_writer :end_
+
+      # @!attribute [r] ending_before
+      #   A cursor representing an item's token before which a page of results should end.
+      #     Used to retrieve the previous page of results before this item.
+      #
+      #   @return [String, nil]
+      optional :ending_before, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ending_before
+
+      # @!attribute [r] page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :page_size
+
+      # @!attribute [r] starting_after
+      #   A cursor representing an item's token after which a page of results should
+      #     begin. Used to retrieve the next page of results after this item.
+      #
+      #   @return [String, nil]
+      optional :starting_after, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :starting_after
+
+      # @!attribute [r] state
+      #   Returns cards with the specified state.
+      #
+      #   @return [Symbol, Lithic::Models::CardListParams::State, nil]
+      optional :state, enum: -> { Lithic::Models::CardListParams::State }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardListParams::State]
+      #   attr_writer :state
+
+      # @!parse
+      #   # @param account_token [String]
+      #   # @param begin_ [Time]
+      #   # @param end_ [Time]
+      #   # @param ending_before [String]
+      #   # @param page_size [Integer]
+      #   # @param starting_after [String]
+      #   # @param state [Symbol, Lithic::Models::CardListParams::State]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     account_token: nil,
+      #     begin_: nil,
+      #     end_: nil,
+      #     ending_before: nil,
+      #     page_size: nil,
+      #     starting_after: nil,
+      #     state: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Returns cards with the specified state.
+      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
+    end
+  end
+end

data/lib/lithic/models/card_program.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardProgram < Lithic::BaseModel
+      # @!attribute token
+      #   Globally unique identifier.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute created
+      #   Timestamp of when the card program was created.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute name
+      #   The name of the card program.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute pan_range_end
+      #   The first digits of the card number that this card program ends with.
+      #
+      #   @return [String]
+      required :pan_range_end, String
+
+      # @!attribute pan_range_start
+      #   The first digits of the card number that this card program starts with.
+      #
+      #   @return [String]
+      required :pan_range_start, String
+
+      # @!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] settlement_currencies
+      #   List of 3-character alphabetic ISO 4217 codes for the currencies that the card
+      #     program supports for settlement.
+      #
+      #   @return [Array<String>, nil]
+      optional :settlement_currencies, Lithic::ArrayOf[String]
+
+      # @!parse
+      #   # @return [Array<String>]
+      #   attr_writer :settlement_currencies
+
+      # @!parse
+      #   # @param token [String]
+      #   # @param created [Time]
+      #   # @param name [String]
+      #   # @param pan_range_end [String]
+      #   # @param pan_range_start [String]
+      #   # @param cardholder_currency [String]
+      #   # @param settlement_currencies [Array<String>]
+      #   #
+      #   def initialize(
+      #     token:,
+      #     created:,
+      #     name:,
+      #     pan_range_end:,
+      #     pan_range_start:,
+      #     cardholder_currency: nil,
+      #     settlement_currencies: nil,
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_program_list_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardProgramListParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] ending_before
+      #   A cursor representing an item's token before which a page of results should end.
+      #     Used to retrieve the previous page of results before this item.
+      #
+      #   @return [String, nil]
+      optional :ending_before, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :ending_before
+
+      # @!attribute [r] page_size
+      #   Page size (for pagination).
+      #
+      #   @return [Integer, nil]
+      optional :page_size, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :page_size
+
+      # @!attribute [r] starting_after
+      #   A cursor representing an item's token after which a page of results should
+      #     begin. Used to retrieve the next page of results after this item.
+      #
+      #   @return [String, nil]
+      optional :starting_after, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :starting_after
+
+      # @!parse
+      #   # @param ending_before [String]
+      #   # @param page_size [Integer]
+      #   # @param starting_after [String]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end

data/lib/lithic/models/card_program_retrieve_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardProgramRetrieveParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end