lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/rbi/lib/lithic/models/auth_rules/v2_retrieve_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/v2_update_params.rbi

@@ -63,11 +63,21 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Account tokens to which the Auth Rule applies.
           account_tokens: nil,
+          # Auth Rule Name
           name: nil,
+          # The desired state of the Auth Rule.
+          #
+          # Note that only deactivating an Auth Rule through this endpoint is supported at
+          # this time. If you need to (re-)activate an Auth Rule the /promote endpoint
+          # should be used to promote a draft to the currently active version.
           state: nil,
+          # Card tokens to which the Auth Rule applies.
           card_tokens: nil,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level: nil,
           request_options: {}
         ); end

data/rbi/lib/lithic/models/auth_rules/v2_update_response.rbi

@@ -77,15 +77,23 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Auth Rule Token
           token:,
+          # Account tokens to which the Auth Rule applies.
           account_tokens:,
+          # Card tokens to which the Auth Rule applies.
           card_tokens:,
           current_version:,
           draft_version:,
+          # Auth Rule Name
           name:,
+          # Whether the Auth Rule applies to all authorizations on the card program.
           program_level:,
+          # The state of the Auth Rule
           state:,
+          # The type of Auth Rule
           type:,
+          # Card tokens to which the Auth Rule does not apply.
           excluded_card_tokens: nil
         ); end
         sig do
@@ -135,8 +143,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(
@@ -193,8 +206,13 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(parameters:, version:); end
-
+          def self.new(
+            # Parameters for the Auth Rule
+            parameters:,
+            # The version of the rule, this is incremented whenever the rule's parameters
+            # change.
+            version:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_rules/velocity_limit_params.rbi

@@ -45,8 +45,23 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(filters:, period:, scope:, limit_amount: nil, limit_count: nil); end
-
+        def self.new(
+          filters:,
+          # The size of the trailing window to calculate Spend Velocity over in seconds. The
+          # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
+          period:,
+          scope:,
+          # The maximum amount of spend velocity allowed in the period in minor units (the
+          # smallest unit of a currency, e.g. cents for USD). Transactions exceeding this
+          # limit will be declined.
+          limit_amount: nil,
+          # The number of spend velocity impacting transactions may not exceed this limit in
+          # the period. Transactions exceeding this limit will be declined. A spend velocity
+          # impacting transaction is a transaction that has been authorized, and optionally
+          # settled, or a force post (a transaction that settled without prior
+          # authorization).
+          limit_count: nil
+        ); end
         sig do
           override
             .returns(
@@ -93,9 +108,22 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(exclude_countries: nil, exclude_mccs: nil, include_countries: nil, include_mccs: nil)
-          end
-
+          def self.new(
+            # ISO-3166-1 alpha-3 Country Codes to exclude from the velocity calculation.
+            # Transactions matching any of the provided will be excluded from the calculated
+            # velocity.
+            exclude_countries: nil,
+            # Merchant Category Codes to exclude from the velocity calculation. Transactions
+            # matching this MCC will be excluded from the calculated velocity.
+            exclude_mccs: nil,
+            # ISO-3166-1 alpha-3 Country Codes to include in the velocity calculation.
+            # Transactions not matching any of the provided will not be included in the
+            # calculated velocity.
+            include_countries: nil,
+            # Merchant Category Codes to include in the velocity calculation. Transactions not
+            # matching this MCC will not be included in the calculated velocity.
+            include_mccs: nil
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/auth_stream_secret.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :secret
 
       sig { params(secret: String).returns(T.attached_class) }
-      def self.new(secret: nil); end
-
+      def self.new(
+        # The shared HMAC ASA secret
+        secret: nil
+      ); end
       sig { override.returns({secret: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/balance.rbi

@@ -64,15 +64,29 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Funds available for spend in the currency's smallest unit (e.g., cents for USD)
         available_amount:,
+        # Date and time for when the balance was first created.
         created:,
+        # 3-character alphabetic ISO 4217 code for the local currency of the balance.
         currency:,
+        # Globally unique identifier for the financial account that holds this balance.
         financial_account_token:,
+        # Type of financial account.
         financial_account_type:,
+        # Globally unique identifier for the last financial transaction event that
+        # impacted this balance.
         last_transaction_event_token:,
+        # Globally unique identifier for the last financial transaction that impacted this
+        # balance.
         last_transaction_token:,
+        # Funds not available for spend due to card authorizations or pending ACH release.
+        # Shown in the currency's smallest unit (e.g., cents for USD).
         pending_amount:,
+        # The sum of available and pending balance in the currency's smallest unit (e.g.,
+        # cents for USD).
         total_amount:,
+        # Date and time for when the balance was last updated.
         updated:
       ); end
       sig do

data/rbi/lib/lithic/models/balance_list_params.rbi

@@ -46,9 +46,14 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # List balances for all financial accounts of a given account_token.
         account_token: nil,
+        # UTC date and time of the balances to retrieve. Defaults to latest available
+        # balances
         balance_date: nil,
+        # List balances for all financial accounts of a given business_account_token.
         business_account_token: nil,
+        # List balances for a given Financial Account type.
         financial_account_type: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/book_transfer_create_params.rbi

@@ -63,13 +63,25 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+        # This should always be a positive value.
         amount:,
+        # Category of the book transfer
         category:,
+        # Globally unique identifier for the financial account or card that will send the
+        # funds. Accepted type dependent on the program's use case.
         from_financial_account_token:,
+        # The program specific subtype code for the specified category/type.
         subtype:,
+        # Globally unique identifier for the financial account or card that will receive
+        # the funds. Accepted type dependent on the program's use case.
         to_financial_account_token:,
+        # Type of book_transfer
         type:,
+        # Customer-provided token that will serve as an idempotency token. This token will
+        # become the transaction token.
         token: nil,
+        # Optional descriptor for the transfer.
         memo: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/book_transfer_list_params.rbi

@@ -105,15 +105,29 @@ module Lithic
       end
       def self.new(
         account_token: nil,
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
         begin_: nil,
         business_account_token: nil,
+        # Book Transfer category to be returned.
         category: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
         end_: nil,
+        # 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.
         ending_before: nil,
+        # Globally unique identifier for the financial account or card that will send the
+        # funds. Accepted type dependent on the program's use case.
         financial_account_token: nil,
+        # Page size (for pagination).
         page_size: nil,
+        # Book transfer result to be returned.
         result: nil,
+        # 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.
         starting_after: nil,
+        # Book transfer status to be returned.
         status: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/book_transfer_response.rbi

@@ -78,17 +78,38 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Customer-provided token that will serve as an idempotency token. This token will
+        # become the transaction token.
         token:,
+        # Category of the book transfer
         category:,
+        # Date and time when the transfer occurred. UTC time zone.
         created:,
+        # 3-character alphabetic ISO 4217 code for the settling currency of the
+        # transaction.
         currency:,
+        # A list of all financial events that have modified this transfer.
         events:,
+        # Globally unique identifier for the financial account or card that will send the
+        # funds. Accepted type dependent on the program's use case.
         from_financial_account_token:,
+        # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
+        # including any acquirer fees. The value of this field will go to zero over time
+        # once the financial transaction is settled.
         pending_amount:,
+        # APPROVED transactions were successful while DECLINED transactions were declined
+        # by user, Lithic, or the network.
         result:,
+        # Amount of the transaction that has been settled in the currency's smallest unit
+        # (e.g., cents).
         settled_amount:,
+        # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
+        # transfer was reversed \* `SETTLED` - The transfer is completed.
         status:,
+        # Globally unique identifier for the financial account or card that will receive
+        # the funds. Accepted type dependent on the program's use case.
         to_financial_account_token:,
+        # Date and time when the financial transaction was last updated. UTC time zone.
         updated:
       ); end
       sig do
@@ -180,8 +201,26 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(token:, amount:, created:, detailed_results:, memo:, result:, subtype:, type:); end
-
+        def self.new(
+          # Globally unique identifier.
+          token:,
+          # Amount of the financial event that has been settled in the currency's smallest
+          # unit (e.g., cents).
+          amount:,
+          # Date and time when the financial event occurred. UTC time zone.
+          created:,
+          # Detailed Results
+          detailed_results:,
+          # Memo for the transfer.
+          memo:,
+          # APPROVED financial events were successful while DECLINED financial events were
+          # declined by user, Lithic, or the network.
+          result:,
+          # The program specific subtype code for the specified category/type.
+          subtype:,
+          # Type of the book transfer
+          type:
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/book_transfer_reverse_params.rbi

@@ -17,8 +17,11 @@ module Lithic
         params(memo: String, request_options: T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash))
           .returns(T.attached_class)
       end
-      def self.new(memo: nil, request_options: {}); end
-
+      def self.new(
+        # Optional descriptor for the reversal.
+        memo: nil,
+        request_options: {}
+      ); end
       sig { override.returns({memo: String, request_options: Lithic::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/card.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class Card < Lithic::Models::NonPCICard
+      # Three digit cvv printed on the back of the card.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cvv
+
+      sig { params(cvv: String).void }
+      attr_writer :cvv
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :pan
+
+      sig { params(pan: String).void }
+      attr_writer :pan
+
+      # Card details with potentially PCI sensitive information for Enterprise customers
+      sig { params(cvv: String, pan: String).returns(T.attached_class) }
+      def self.new(
+        # Three digit cvv printed on the back of the card.
+        cvv: nil,
+        # 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.
+        pan: nil
+      ); end
+      sig { override.returns({cvv: String, pan: String}) }
+      def to_hash; end
+    end
+  end
+end

data/rbi/lib/lithic/models/card_convert_physical_params.rbi

@@ -58,14 +58,29 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # The shipping address this card will be sent to.
         shipping_address:,
+        # If omitted, the previous carrier will be used.
         carrier: nil,
+        # 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.
         product_id: nil,
+        # 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
         shipping_method: nil,
         request_options: {}
-      )
-      end
-
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/card_create_params.rbi

@@ -213,22 +213,106 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # 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.
         type:,
+        # 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.
         account_token: nil,
+        # 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.
         card_program_token: nil,
         carrier: nil,
+        # 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).
         digital_card_art_token: nil,
+        # Two digit (MM) expiry month. If neither `exp_month` nor `exp_year` is provided,
+        # an expiration date will be generated.
         exp_month: nil,
+        # Four digit (yyyy) expiry year. If neither `exp_month` nor `exp_year` is
+        # provided, an expiration date will be generated.
         exp_year: nil,
+        # Friendly name to identify the card.
         memo: nil,
+        # 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).
         pin: nil,
+        # 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.
         product_id: nil,
+        # 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.
         replacement_account_token: nil,
+        # 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.
         replacement_for: nil,
         shipping_address: nil,
+        # 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
         shipping_method: nil,
+        # 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.
         spend_limit: nil,
+        # 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.
         spend_limit_duration: nil,
+        # 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.
         state: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/card_embed_params.rbi

@@ -22,8 +22,13 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(embed_request:, hmac:, request_options: {}); end
-
+      def self.new(
+        # A base64 encoded JSON string of an EmbedRequest to specify which card to load.
+        embed_request:,
+        # SHA256 HMAC of the embed_request JSON string with base64 digest.
+        hmac:,
+        request_options: {}
+      ); end
       sig { override.returns({embed_request: String, hmac: String, request_options: Lithic::RequestOptions}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/card_list_params.rbi

@@ -73,12 +73,23 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Returns cards associated with the specified account.
         account_token: nil,
+        # Date string in RFC 3339 format. Only entries created after the specified time
+        # will be included. UTC time zone.
         begin_: nil,
+        # Date string in RFC 3339 format. Only entries created before the specified time
+        # will be included. UTC time zone.
         end_: nil,
+        # 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.
         ending_before: nil,
+        # Page size (for pagination).
         page_size: nil,
+        # 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.
         starting_after: nil,
+        # Returns cards with the specified state.
         state: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/card_program.rbi

@@ -51,12 +51,20 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier.
         token:,
+        # Timestamp of when the card program was created.
         created:,
+        # The name of the card program.
         name:,
+        # The first digits of the card number that this card program ends with.
         pan_range_end:,
+        # The first digits of the card number that this card program starts with.
         pan_range_start:,
+        # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
         cardholder_currency: nil,
+        # List of 3-character alphabetic ISO 4217 codes for the currencies that the card
+        # program supports for settlement.
         settlement_currencies: nil
       ); end
       sig do

data/rbi/lib/lithic/models/card_program_list_params.rbi

@@ -38,8 +38,17 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(ending_before: nil, page_size: nil, starting_after: nil, request_options: {}); end
-
+      def self.new(
+        # 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.
+        ending_before: nil,
+        # Page size (for pagination).
+        page_size: nil,
+        # 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.
+        starting_after: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(