lithic 0.7.0 → 0.8.0

data/rbi/lithic/resources/disputes.rbi

@@ -3,7 +3,7 @@
 module Lithic
   module Resources
     class Disputes
-      # Initiate a dispute.
+      # Request a chargeback.
       sig do
         params(
           amount: Integer,
@@ -15,21 +15,21 @@ module Lithic
         ).returns(Lithic::Dispute)
       end
       def create(
-        # Amount to dispute
+        # Amount for chargeback
         amount:,
-        # Reason for dispute
+        # Reason for chargeback
         reason:,
-        # Transaction to dispute
+        # Transaction for chargeback
         transaction_token:,
-        # Date the customer filed the dispute
+        # Date the customer filed the chargeback request
         customer_filed_date: nil,
-        # Customer description of dispute
+        # Customer description
         customer_note: nil,
         request_options: {}
       )
       end
 
-      # Get dispute.
+      # Get chargeback request.
       sig do
         params(
           dispute_token: String,
@@ -39,7 +39,7 @@ module Lithic
       def retrieve(dispute_token, request_options: {})
       end
 
-      # Update dispute. Can only be modified if status is `NEW`.
+      # Update chargeback request. Can only be modified if status is `NEW`.
       sig do
         params(
           dispute_token: String,
@@ -52,19 +52,19 @@ module Lithic
       end
       def update(
         dispute_token,
-        # Amount to dispute
+        # Amount for chargeback
         amount: nil,
-        # Date the customer filed the dispute
+        # Date the customer filed the chargeback request
         customer_filed_date: nil,
-        # Customer description of dispute
+        # Customer description
         customer_note: nil,
-        # Reason for dispute
+        # Reason for chargeback
         reason: nil,
         request_options: {}
       )
       end
 
-      # List disputes.
+      # List chargeback requests.
       sig do
         params(
           begin_: Time,
@@ -92,7 +92,7 @@ module Lithic
         # 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,
-        # List disputes of a specific status.
+        # Filter by status.
         status: nil,
         # Transaction tokens to filter by.
         transaction_tokens: nil,
@@ -100,7 +100,7 @@ module Lithic
       )
       end
 
-      # Withdraw dispute.
+      # Withdraw chargeback request.
       sig do
         params(
           dispute_token: String,
@@ -110,8 +110,8 @@ module Lithic
       def delete(dispute_token, request_options: {})
       end
 
-      # Soft delete evidence for a dispute. Evidence will not be reviewed or submitted
-      # by Lithic after it is withdrawn.
+      # Soft delete evidence for a chargeback request. Evidence will not be reviewed or
+      # submitted by Lithic after it is withdrawn.
       sig do
         params(
           evidence_token: String,
@@ -122,8 +122,8 @@ module Lithic
       def delete_evidence(evidence_token, dispute_token:, request_options: {})
       end
 
-      # Use this endpoint to upload evidences for the dispute. It will return a URL to
-      # upload your documents to. The URL will expire in 30 minutes.
+      # Use this endpoint to upload evidence for a chargeback request. It will return a
+      # URL to upload your documents to. The URL will expire in 30 minutes.
       #
       # Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
       # less than 5 GiB.
@@ -142,7 +142,7 @@ module Lithic
       )
       end
 
-      # List evidence metadata for a dispute.
+      # List evidence for a chargeback request.
       sig do
         params(
           dispute_token: String,
@@ -174,7 +174,7 @@ module Lithic
       )
       end
 
-      # Get a dispute's evidence metadata.
+      # Get evidence for a chargeback request.
       sig do
         params(
           evidence_token: String,

data/rbi/lithic/resources/financial_accounts/interest_tier_schedule.rbi

@@ -10,6 +10,7 @@ module Lithic
             financial_account_token: String,
             credit_product_token: String,
             effective_date: Date,
+            penalty_rates: T.anything,
             tier_name: String,
             tier_rates: T.anything,
             request_options: Lithic::RequestOptions::OrHash
@@ -24,6 +25,8 @@ module Lithic
           credit_product_token:,
           # Date the tier should be effective in YYYY-MM-DD format
           effective_date:,
+          # Custom rates per category for penalties
+          penalty_rates: nil,
           # Name of a tier contained in the credit product. Mutually exclusive with
           # tier_rates
           tier_name: nil,
@@ -57,6 +60,7 @@ module Lithic
           params(
             effective_date: Date,
             financial_account_token: String,
+            penalty_rates: T.anything,
             tier_name: String,
             tier_rates: T.anything,
             request_options: Lithic::RequestOptions::OrHash
@@ -69,6 +73,8 @@ module Lithic
           effective_date,
           # Path param: Globally unique identifier for financial account
           financial_account_token:,
+          # Body param: Custom rates per category for penalties
+          penalty_rates: nil,
           # Body param: Name of a tier contained in the credit product. Mutually exclusive
           # with tier_rates
           tier_name: nil,

data/rbi/lithic/resources/holds.rbi

@@ -0,0 +1,111 @@
+# typed: strong
+
+module Lithic
+  module Resources
+    class Holds
+      # Create a hold on a financial account. Holds reserve funds by moving them from
+      # available to pending balance. They can be resolved via settlement (linked to a
+      # payment or book transfer), voiding, or expiration.
+      sig do
+        params(
+          financial_account_token: String,
+          amount: Integer,
+          token: String,
+          expiration_datetime: Time,
+          memo: T.nilable(String),
+          user_defined_id: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Hold)
+      end
+      def create(
+        # Globally unique identifier for the financial account.
+        financial_account_token,
+        # Amount to hold in cents
+        amount:,
+        # Customer-provided token for idempotency. Becomes the hold token.
+        token: nil,
+        # When the hold should auto-expire
+        expiration_datetime: nil,
+        # Reason for the hold
+        memo: nil,
+        # User-provided identifier for the hold
+        user_defined_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Get hold by token.
+      sig do
+        params(
+          hold_token: String,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Hold)
+      end
+      def retrieve(
+        # Globally unique identifier for the hold.
+        hold_token,
+        request_options: {}
+      )
+      end
+
+      # List holds for a financial account.
+      sig do
+        params(
+          financial_account_token: String,
+          begin_: Time,
+          end_: Time,
+          ending_before: String,
+          page_size: Integer,
+          starting_after: String,
+          status: Lithic::HoldListParams::Status::OrSymbol,
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Internal::CursorPage[Lithic::Hold])
+      end
+      def list(
+        # Globally unique identifier for the financial account.
+        financial_account_token,
+        # 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,
+        # Hold status to filter by.
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      # Void an active hold. This returns the held funds from pending back to available
+      # balance. Only holds in PENDING status can be voided.
+      sig do
+        params(
+          hold_token: String,
+          memo: T.nilable(String),
+          request_options: Lithic::RequestOptions::OrHash
+        ).returns(Lithic::Hold)
+      end
+      def void(
+        # Globally unique identifier for the hold.
+        hold_token,
+        # Reason for voiding the hold
+        memo: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Lithic::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/lithic/resources/webhooks.rbi

@@ -17,7 +17,6 @@ module Lithic
             Lithic::AccountHolderVerificationWebhookEvent,
             Lithic::AccountHolderDocumentUpdatedWebhookEvent,
             Lithic::CardAuthorizationApprovalRequestWebhookEvent,
-            Lithic::TokenizationDecisioningRequestWebhookEvent,
             Lithic::AuthRulesBacktestReportCreatedWebhookEvent,
             Lithic::BalanceUpdatedWebhookEvent,
             Lithic::BookTransferTransactionCreatedWebhookEvent,
@@ -71,7 +70,14 @@ module Lithic
           )
         )
       end
-      def parse(payload, headers:, secret: nil)
+      def parse(
+        # The raw webhook payload as a string
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing secret
+        secret: nil
+      )
       end
 
       sig { params(payload: String).returns(Lithic::ParsedWebhookEvent::Variants) }

data/sig/lithic/client.rbs

@@ -15,6 +15,8 @@ module Lithic
 
     attr_reader api_key: String
 
+    attr_reader webhook_secret: String?
+
     attr_reader accounts: Lithic::Resources::Accounts
 
     attr_reader account_holders: Lithic::Resources::AccountHolders
@@ -75,6 +77,8 @@ module Lithic
 
     attr_reader network_programs: Lithic::Resources::NetworkPrograms
 
+    attr_reader holds: Lithic::Resources::Holds
+
     attr_reader account_activity: Lithic::Resources::AccountActivity
 
     attr_reader transfer_limits: Lithic::Resources::TransferLimits
@@ -89,6 +93,7 @@ module Lithic
 
     def initialize: (
       ?api_key: String?,
+      ?webhook_secret: String?,
       ?environment: :production | :sandbox | nil,
       ?base_url: String?,
       ?max_retries: Integer,

data/sig/lithic/models/account_activity_list_params.rbs

@@ -102,6 +102,7 @@ module Lithic
 
       type category =
         :ACH
+        | :WIRE
         | :BALANCE_OR_FUNDING
         | :FEE
         | :REWARD
@@ -120,12 +121,14 @@ module Lithic
         | :MANAGEMENT_FEE
         | :MANAGEMENT_REWARD
         | :MANAGEMENT_DISBURSEMENT
+        | :HOLD
         | :PROGRAM_FUNDING
 
       module Category
         extend Lithic::Internal::Type::Enum
 
         ACH: :ACH
+        WIRE: :WIRE
         BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
         FEE: :FEE
         REWARD: :REWARD
@@ -144,6 +147,7 @@ module Lithic
         MANAGEMENT_FEE: :MANAGEMENT_FEE
         MANAGEMENT_REWARD: :MANAGEMENT_REWARD
         MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
+        HOLD: :HOLD
         PROGRAM_FUNDING: :PROGRAM_FUNDING
 
         def self?.values: -> ::Array[Lithic::Models::AccountActivityListParams::category]

data/sig/lithic/models/account_activity_list_response.rbs

@@ -7,6 +7,7 @@ module Lithic
       | Lithic::Payment
       | Lithic::ExternalPayment
       | Lithic::ManagementOperationTransaction
+      | Lithic::Hold
 
     module AccountActivityListResponse
       extend Lithic::Internal::Type::Union
@@ -89,6 +90,7 @@ module Lithic
 
         type category =
           :ACH
+          | :WIRE
           | :BALANCE_OR_FUNDING
           | :FEE
           | :REWARD
@@ -107,12 +109,14 @@ module Lithic
           | :MANAGEMENT_FEE
           | :MANAGEMENT_REWARD
           | :MANAGEMENT_DISBURSEMENT
+          | :HOLD
           | :PROGRAM_FUNDING
 
         module Category
           extend Lithic::Internal::Type::Enum
 
           ACH: :ACH
+          WIRE: :WIRE
           BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
           FEE: :FEE
           REWARD: :REWARD
@@ -131,6 +135,7 @@ module Lithic
           MANAGEMENT_FEE: :MANAGEMENT_FEE
           MANAGEMENT_REWARD: :MANAGEMENT_REWARD
           MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
+          HOLD: :HOLD
           PROGRAM_FUNDING: :PROGRAM_FUNDING
 
           def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::category]

data/sig/lithic/models/account_activity_retrieve_transaction_response.rbs

@@ -7,6 +7,7 @@ module Lithic
       | Lithic::Payment
       | Lithic::ExternalPayment
       | Lithic::ManagementOperationTransaction
+      | Lithic::Hold
 
     module AccountActivityRetrieveTransactionResponse
       extend Lithic::Internal::Type::Union
@@ -89,6 +90,7 @@ module Lithic
 
         type category =
           :ACH
+          | :WIRE
           | :BALANCE_OR_FUNDING
           | :FEE
           | :REWARD
@@ -107,12 +109,14 @@ module Lithic
           | :MANAGEMENT_FEE
           | :MANAGEMENT_REWARD
           | :MANAGEMENT_DISBURSEMENT
+          | :HOLD
           | :PROGRAM_FUNDING
 
         module Category
           extend Lithic::Internal::Type::Enum
 
           ACH: :ACH
+          WIRE: :WIRE
           BALANCE_OR_FUNDING: :BALANCE_OR_FUNDING
           FEE: :FEE
           REWARD: :REWARD
@@ -131,6 +135,7 @@ module Lithic
           MANAGEMENT_FEE: :MANAGEMENT_FEE
           MANAGEMENT_REWARD: :MANAGEMENT_REWARD
           MANAGEMENT_DISBURSEMENT: :MANAGEMENT_DISBURSEMENT
+          HOLD: :HOLD
           PROGRAM_FUNDING: :PROGRAM_FUNDING
 
           def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::category]

data/sig/lithic/models/auth_rules/auth_rule.rbs

@@ -17,6 +17,8 @@ module Lithic
           program_level: bool,
           state: Lithic::Models::AuthRules::AuthRule::state,
           type: Lithic::Models::AuthRules::AuthRule::type_,
+          excluded_account_tokens: ::Array[String],
+          excluded_business_account_tokens: ::Array[String],
           excluded_card_tokens: ::Array[String]
         }
 
@@ -45,6 +47,16 @@ module Lithic
 
         attr_accessor type: Lithic::Models::AuthRules::AuthRule::type_
 
+        attr_reader excluded_account_tokens: ::Array[String]?
+
+        def excluded_account_tokens=: (::Array[String]) -> ::Array[String]
+
+        attr_reader excluded_business_account_tokens: ::Array[String]?
+
+        def excluded_business_account_tokens=: (
+          ::Array[String]
+        ) -> ::Array[String]
+
         attr_reader excluded_card_tokens: ::Array[String]?
 
         def excluded_card_tokens=: (::Array[String]) -> ::Array[String]
@@ -62,6 +74,8 @@ module Lithic
           program_level: bool,
           state: Lithic::Models::AuthRules::AuthRule::state,
           type: Lithic::Models::AuthRules::AuthRule::type_,
+          ?excluded_account_tokens: ::Array[String],
+          ?excluded_business_account_tokens: ::Array[String],
           ?excluded_card_tokens: ::Array[String]
         ) -> void
 
@@ -78,6 +92,8 @@ module Lithic
           program_level: bool,
           state: Lithic::Models::AuthRules::AuthRule::state,
           type: Lithic::Models::AuthRules::AuthRule::type_,
+          excluded_account_tokens: ::Array[String],
+          excluded_business_account_tokens: ::Array[String],
           excluded_card_tokens: ::Array[String]
         }
 
@@ -110,6 +126,7 @@ module Lithic
             | Lithic::AuthRules::ConditionalAuthorizationActionParameters
             | Lithic::AuthRules::ConditionalACHActionParameters
             | Lithic::AuthRules::ConditionalTokenizationActionParameters
+            | Lithic::AuthRules::TypescriptCodeParameters
 
           module Parameters
             extend Lithic::Internal::Type::Union
@@ -120,22 +137,32 @@ module Lithic
 
         type draft_version =
           {
+            error: String?,
             parameters: Lithic::Models::AuthRules::AuthRule::DraftVersion::parameters,
+            state: Lithic::Models::AuthRules::AuthRule::DraftVersion::state,
             version: Integer
           }
 
         class DraftVersion < Lithic::Internal::Type::BaseModel
+          attr_accessor error: String?
+
           attr_accessor parameters: Lithic::Models::AuthRules::AuthRule::DraftVersion::parameters
 
+          attr_accessor state: Lithic::Models::AuthRules::AuthRule::DraftVersion::state
+
           attr_accessor version: Integer
 
           def initialize: (
+            error: String?,
             parameters: Lithic::Models::AuthRules::AuthRule::DraftVersion::parameters,
+            state: Lithic::Models::AuthRules::AuthRule::DraftVersion::state,
             version: Integer
           ) -> void
 
           def to_hash: -> {
+            error: String?,
             parameters: Lithic::Models::AuthRules::AuthRule::DraftVersion::parameters,
+            state: Lithic::Models::AuthRules::AuthRule::DraftVersion::state,
             version: Integer
           }
 
@@ -147,12 +174,25 @@ module Lithic
             | Lithic::AuthRules::ConditionalAuthorizationActionParameters
             | Lithic::AuthRules::ConditionalACHActionParameters
             | Lithic::AuthRules::ConditionalTokenizationActionParameters
+            | Lithic::AuthRules::TypescriptCodeParameters
 
           module Parameters
             extend Lithic::Internal::Type::Union
 
             def self?.variants: -> ::Array[Lithic::Models::AuthRules::AuthRule::DraftVersion::parameters]
           end
+
+          type state = :PENDING | :SHADOWING | :ERROR
+
+          module State
+            extend Lithic::Internal::Type::Enum
+
+            PENDING: :PENDING
+            SHADOWING: :SHADOWING
+            ERROR: :ERROR
+
+            def self?.values: -> ::Array[Lithic::Models::AuthRules::AuthRule::DraftVersion::state]
+          end
         end
 
         type state = :ACTIVE | :INACTIVE
@@ -171,6 +211,7 @@ module Lithic
           | :VELOCITY_LIMIT
           | :MERCHANT_LOCK
           | :CONDITIONAL_ACTION
+          | :TYPESCRIPT_CODE
 
         module Type
           extend Lithic::Internal::Type::Enum
@@ -179,6 +220,7 @@ module Lithic
           VELOCITY_LIMIT: :VELOCITY_LIMIT
           MERCHANT_LOCK: :MERCHANT_LOCK
           CONDITIONAL_ACTION: :CONDITIONAL_ACTION
+          TYPESCRIPT_CODE: :TYPESCRIPT_CODE
 
           def self?.values: -> ::Array[Lithic::Models::AuthRules::AuthRule::type_]
         end

data/sig/lithic/models/auth_rules/auth_rule_version.rbs

@@ -0,0 +1,67 @@
+module Lithic
+  module Models
+    class AuthRuleVersion = AuthRules::AuthRuleVersion
+
+    module AuthRules
+      type auth_rule_version =
+        {
+          created: Time,
+          parameters: Lithic::Models::AuthRules::AuthRuleVersion::parameters,
+          state: Lithic::Models::AuthRules::AuthRuleVersion::state,
+          version: Integer
+        }
+
+      class AuthRuleVersion < Lithic::Internal::Type::BaseModel
+        attr_accessor created: Time
+
+        attr_accessor parameters: Lithic::Models::AuthRules::AuthRuleVersion::parameters
+
+        attr_accessor state: Lithic::Models::AuthRules::AuthRuleVersion::state
+
+        attr_accessor version: Integer
+
+        def initialize: (
+          created: Time,
+          parameters: Lithic::Models::AuthRules::AuthRuleVersion::parameters,
+          state: Lithic::Models::AuthRules::AuthRuleVersion::state,
+          version: Integer
+        ) -> void
+
+        def to_hash: -> {
+          created: Time,
+          parameters: Lithic::Models::AuthRules::AuthRuleVersion::parameters,
+          state: Lithic::Models::AuthRules::AuthRuleVersion::state,
+          version: Integer
+        }
+
+        type parameters =
+          Lithic::AuthRules::ConditionalBlockParameters
+          | Lithic::AuthRules::VelocityLimitParams
+          | Lithic::AuthRules::MerchantLockParameters
+          | Lithic::AuthRules::Conditional3DSActionParameters
+          | Lithic::AuthRules::ConditionalAuthorizationActionParameters
+          | Lithic::AuthRules::ConditionalACHActionParameters
+          | Lithic::AuthRules::ConditionalTokenizationActionParameters
+          | Lithic::AuthRules::TypescriptCodeParameters
+
+        module Parameters
+          extend Lithic::Internal::Type::Union
+
+          def self?.variants: -> ::Array[Lithic::Models::AuthRules::AuthRuleVersion::parameters]
+        end
+
+        type state = :ACTIVE | :SHADOW | :INACTIVE
+
+        module State
+          extend Lithic::Internal::Type::Enum
+
+          ACTIVE: :ACTIVE
+          SHADOW: :SHADOW
+          INACTIVE: :INACTIVE
+
+          def self?.values: -> ::Array[Lithic::Models::AuthRules::AuthRuleVersion::state]
+        end
+      end
+    end
+  end
+end