lithic 0.7.0 → 0.8.0

data/lib/lithic/models/payment.rb

@@ -189,6 +189,7 @@ module Lithic
         extend Lithic::Internal::Type::Enum
 
         ACH = :ACH
+        WIRE = :WIRE
         BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
         FEE = :FEE
         REWARD = :REWARD
@@ -207,6 +208,7 @@ module Lithic
         MANAGEMENT_FEE = :MANAGEMENT_FEE
         MANAGEMENT_REWARD = :MANAGEMENT_REWARD
         MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
+        HOLD = :HOLD
         PROGRAM_FUNDING = :PROGRAM_FUNDING
 
         # @!method self.values
@@ -254,8 +256,14 @@ module Lithic
         required :result, enum: -> { Lithic::Payment::Event::Result }
 
         # @!attribute type
+        #   Note: Inbound wire transfers are coming soon (availability varies by partner
+        #   bank). Wire-related event types below are a preview. To learn more, contact your
+        #   customer success manager.
+        #
         #   Event types:
         #
+        #   ACH events:
+        #
         #   - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
         #     approval/release from an ACH hold.
         #   - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
@@ -271,6 +279,8 @@ module Lithic
         #   - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
         #   - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
         #     balance.
+        #   - `ACH_RECEIPT_RELEASED_EARLY` - ACH receipt released early from pending to
+        #     available balance.
         #   - `ACH_RETURN_INITIATED` - ACH initiated return for an ACH receipt.
         #   - `ACH_RETURN_PROCESSED` - ACH receipt returned by the Receiving Depository
         #     Financial Institution.
@@ -279,6 +289,26 @@ module Lithic
         #   - `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository
         #     Financial Institution.
         #
+        #   Wire transfer events:
+        #
+        #   - `WIRE_TRANSFER_INBOUND_RECEIVED` - Inbound wire transfer received from the
+        #     Federal Reserve and pending release to available balance.
+        #   - `WIRE_TRANSFER_INBOUND_SETTLED` - Inbound wire transfer funds released from
+        #     pending to available balance.
+        #   - `WIRE_TRANSFER_INBOUND_BLOCKED` - Inbound wire transfer blocked and funds
+        #     frozen for regulatory review.
+        #
+        #   Wire return events:
+        #
+        #   - `WIRE_RETURN_OUTBOUND_INITIATED` - Outbound wire return initiated to return
+        #     funds from an inbound wire transfer.
+        #   - `WIRE_RETURN_OUTBOUND_SENT` - Outbound wire return sent to the Federal Reserve
+        #     and pending acceptance.
+        #   - `WIRE_RETURN_OUTBOUND_SETTLED` - Outbound wire return accepted by the Federal
+        #     Reserve and funds returned to sender.
+        #   - `WIRE_RETURN_OUTBOUND_REJECTED` - Outbound wire return rejected by the Federal
+        #     Reserve.
+        #
         #   @return [Symbol, Lithic::Models::Payment::Event::Type]
         required :type, enum: -> { Lithic::Payment::Event::Type }
 
@@ -290,7 +320,9 @@ module Lithic
                  -> { Lithic::Internal::Type::ArrayOf[enum: Lithic::Payment::Event::DetailedResult] }
 
         # @!attribute external_id
-        #   Payment event external ID, for example, ACH trace number.
+        #   Payment event external ID. For ACH transactions, this is the ACH trace number.
+        #   For inbound wire transfers, this is the IMAD (Input Message Accountability
+        #   Data).
         #
         #   @return [String, nil]
         optional :external_id, String, nil?: true
@@ -299,6 +331,10 @@ module Lithic
         #   Some parameter documentations has been truncated, see
         #   {Lithic::Models::Payment::Event} for more details.
         #
+        #   Note: Inbound wire transfers are coming soon (availability varies by partner
+        #   bank). Wire-related fields below are a preview. To learn more, contact your
+        #   customer success manager.
+        #
         #   Payment Event
         #
         #   @param token [String] Globally unique identifier.
@@ -309,11 +345,11 @@ module Lithic
         #
         #   @param result [Symbol, Lithic::Models::Payment::Event::Result] APPROVED financial events were successful while DECLINED financial events were d
         #
-        #   @param type [Symbol, Lithic::Models::Payment::Event::Type] Event types:
+        #   @param type [Symbol, Lithic::Models::Payment::Event::Type] Note: Inbound wire transfers are coming soon (availability varies by partner ban
         #
         #   @param detailed_results [Array<Symbol, Lithic::Models::Payment::Event::DetailedResult>] More detailed reasons for the event
         #
-        #   @param external_id [String, nil] Payment event external ID, for example, ACH trace number.
+        #   @param external_id [String, nil] Payment event external ID. For ACH transactions, this is the ACH trace number.
 
         # APPROVED financial events were successful while DECLINED financial events were
         # declined by user, Lithic, or the network.
@@ -329,8 +365,14 @@ module Lithic
           #   @return [Array<Symbol>]
         end
 
+        # Note: Inbound wire transfers are coming soon (availability varies by partner
+        # bank). Wire-related event types below are a preview. To learn more, contact your
+        # customer success manager.
+        #
         # Event types:
         #
+        # ACH events:
+        #
         # - `ACH_ORIGINATION_INITIATED` - ACH origination received and pending
         #   approval/release from an ACH hold.
         # - `ACH_ORIGINATION_REVIEWED` - ACH origination has completed the review process.
@@ -346,6 +388,8 @@ module Lithic
         # - `ACH_RECEIPT_SETTLED` - ACH receipt funds have settled.
         # - `ACH_RECEIPT_RELEASED` - ACH receipt released from pending to available
         #   balance.
+        # - `ACH_RECEIPT_RELEASED_EARLY` - ACH receipt released early from pending to
+        #   available balance.
         # - `ACH_RETURN_INITIATED` - ACH initiated return for an ACH receipt.
         # - `ACH_RETURN_PROCESSED` - ACH receipt returned by the Receiving Depository
         #   Financial Institution.
@@ -354,6 +398,26 @@ module Lithic
         # - `ACH_RETURN_REJECTED` - ACH return was rejected by the Receiving Depository
         #   Financial Institution.
         #
+        # Wire transfer events:
+        #
+        # - `WIRE_TRANSFER_INBOUND_RECEIVED` - Inbound wire transfer received from the
+        #   Federal Reserve and pending release to available balance.
+        # - `WIRE_TRANSFER_INBOUND_SETTLED` - Inbound wire transfer funds released from
+        #   pending to available balance.
+        # - `WIRE_TRANSFER_INBOUND_BLOCKED` - Inbound wire transfer blocked and funds
+        #   frozen for regulatory review.
+        #
+        # Wire return events:
+        #
+        # - `WIRE_RETURN_OUTBOUND_INITIATED` - Outbound wire return initiated to return
+        #   funds from an inbound wire transfer.
+        # - `WIRE_RETURN_OUTBOUND_SENT` - Outbound wire return sent to the Federal Reserve
+        #   and pending acceptance.
+        # - `WIRE_RETURN_OUTBOUND_SETTLED` - Outbound wire return accepted by the Federal
+        #   Reserve and funds returned to sender.
+        # - `WIRE_RETURN_OUTBOUND_REJECTED` - Outbound wire return rejected by the Federal
+        #   Reserve.
+        #
         # @see Lithic::Models::Payment::Event#type
         module Type
           extend Lithic::Internal::Type::Enum
@@ -367,11 +431,19 @@ module Lithic
           ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
           ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED
           ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
+          ACH_RECEIPT_RELEASED_EARLY = :ACH_RECEIPT_RELEASED_EARLY
           ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
           ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
           ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
           ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED
           ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED
+          WIRE_TRANSFER_INBOUND_RECEIVED = :WIRE_TRANSFER_INBOUND_RECEIVED
+          WIRE_TRANSFER_INBOUND_SETTLED = :WIRE_TRANSFER_INBOUND_SETTLED
+          WIRE_TRANSFER_INBOUND_BLOCKED = :WIRE_TRANSFER_INBOUND_BLOCKED
+          WIRE_RETURN_OUTBOUND_INITIATED = :WIRE_RETURN_OUTBOUND_INITIATED
+          WIRE_RETURN_OUTBOUND_SENT = :WIRE_RETURN_OUTBOUND_SENT
+          WIRE_RETURN_OUTBOUND_SETTLED = :WIRE_RETURN_OUTBOUND_SETTLED
+          WIRE_RETURN_OUTBOUND_REJECTED = :WIRE_RETURN_OUTBOUND_REJECTED
 
           # @!method self.values
           #   @return [Array<Symbol>]
@@ -531,13 +603,7 @@ module Lithic
           #   @return [String, nil]
           optional :message_id, String, nil?: true
 
-          # @!attribute remittance_information
-          #   Payment details or invoice reference
-          #
-          #   @return [String, nil]
-          optional :remittance_information, String, nil?: true
-
-          # @!method initialize(wire_message_type:, wire_network:, creditor: nil, debtor: nil, message_id: nil, remittance_information: nil)
+          # @!method initialize(wire_message_type:, wire_network:, creditor: nil, debtor: nil, message_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {Lithic::Models::Payment::MethodAttributes::WireMethodAttributes} for more
           #   details.
@@ -551,8 +617,6 @@ module Lithic
           #   @param debtor [Lithic::Models::WirePartyDetails]
           #
           #   @param message_id [String, nil] Point to point reference identifier, as assigned by the instructing party, used
-          #
-          #   @param remittance_information [String, nil] Payment details or invoice reference
 
           # Type of wire transfer
           #

data/lib/lithic/models/payment_simulate_action_params.rb

@@ -67,6 +67,7 @@ module Lithic
         ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED
         ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED
         ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED
+        ACH_RECEIPT_RELEASED_EARLY = :ACH_RECEIPT_RELEASED_EARLY
         ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED
         ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED
         ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED

data/lib/lithic/models.rb

@@ -365,6 +365,18 @@ module Lithic
 
   FundingEventRetrieveParams = Lithic::Models::FundingEventRetrieveParams
 
+  Hold = Lithic::Models::Hold
+
+  HoldCreateParams = Lithic::Models::HoldCreateParams
+
+  HoldEvent = Lithic::Models::HoldEvent
+
+  HoldListParams = Lithic::Models::HoldListParams
+
+  HoldRetrieveParams = Lithic::Models::HoldRetrieveParams
+
+  HoldVoidParams = Lithic::Models::HoldVoidParams
+
   InstanceFinancialAccountType = Lithic::Models::InstanceFinancialAccountType
 
   InternalTransactionAPI = Lithic::Models::InternalTransactionAPI
@@ -498,8 +510,6 @@ module Lithic
 
   TokenizationDeactivateParams = Lithic::Models::TokenizationDeactivateParams
 
-  TokenizationDecisioningRequestWebhookEvent = Lithic::Models::TokenizationDecisioningRequestWebhookEvent
-
   TokenizationDecisioningRetrieveSecretParams = Lithic::Models::TokenizationDecisioningRetrieveSecretParams
 
   TokenizationDecisioningRotateSecretParams = Lithic::Models::TokenizationDecisioningRotateSecretParams

data/lib/lithic/resources/account_activity.rb

@@ -34,7 +34,7 @@ module Lithic
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Internal::CursorPage<Lithic::Models::AccountActivityListResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityListResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction>]
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::AccountActivityListResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityListResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction, Lithic::Models::Hold>]
       #
       # @see Lithic::Models::AccountActivityListParams
       def list(params = {})
@@ -58,7 +58,7 @@ module Lithic
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction]
+      # @return [Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction, Lithic::Models::Hold]
       #
       # @see Lithic::Models::AccountActivityRetrieveTransactionParams
       def retrieve_transaction(transaction_token, params = {})

data/lib/lithic/resources/auth_rules/v2.rb

@@ -49,9 +49,9 @@ module Lithic
 
         # Updates a V2 Auth rule's properties
         #
-        # If `account_tokens`, `card_tokens`, `program_level`, or `excluded_card_tokens`
-        # is provided, this will replace existing associations with the provided list of
-        # entities.
+        # If `account_tokens`, `card_tokens`, `program_level`, `excluded_card_tokens`,
+        # `excluded_account_tokens`, or `excluded_business_account_tokens` is provided,
+        # this will replace existing associations with the provided list of entities.
         #
         # @overload update(auth_rule_token, body:, request_options: {})
         #
@@ -144,7 +144,7 @@ module Lithic
         #
         # @param auth_rule_token [String]
         #
-        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, nil] Parameters for the Auth Rule
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, Lithic::Models::AuthRules::TypescriptCodeParameters, nil] Parameters for the Auth Rule
         #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -209,6 +209,26 @@ module Lithic
           )
         end
 
+        # Returns all versions of an auth rule, sorted by version number descending
+        # (newest first).
+        #
+        # @overload list_versions(auth_rule_token, request_options: {})
+        #
+        # @param auth_rule_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::AuthRules::V2ListVersionsResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2ListVersionsParams
+        def list_versions(auth_rule_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v2/auth_rules/%1$s/versions", auth_rule_token],
+            model: Lithic::Models::AuthRules::V2ListVersionsResponse,
+            options: params[:request_options]
+          )
+        end
+
         # Promotes the draft version of an Auth rule to the currently active version such
         # that it is enforced in the respective stream.
         #

data/lib/lithic/resources/disputes.rb

@@ -3,19 +3,19 @@
 module Lithic
   module Resources
     class Disputes
-      # Initiate a dispute.
+      # Request a chargeback.
       #
       # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
       #
-      # @param amount [Integer] Amount to dispute
+      # @param amount [Integer] Amount for chargeback
       #
-      # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
+      # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for chargeback
       #
-      # @param transaction_token [String] Transaction to dispute
+      # @param transaction_token [String] Transaction for chargeback
       #
-      # @param customer_filed_date [Time] Date the customer filed the dispute
+      # @param customer_filed_date [Time] Date the customer filed the chargeback request
       #
-      # @param customer_note [String] Customer description of dispute
+      # @param customer_note [String] Customer description
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -33,7 +33,7 @@ module Lithic
         )
       end
 
-      # Get dispute.
+      # Get chargeback request.
       #
       # @overload retrieve(dispute_token, request_options: {})
       #
@@ -52,19 +52,19 @@ module Lithic
         )
       end
 
-      # Update dispute. Can only be modified if status is `NEW`.
+      # Update chargeback request. Can only be modified if status is `NEW`.
       #
       # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
       #
       # @param dispute_token [String]
       #
-      # @param amount [Integer] Amount to dispute
+      # @param amount [Integer] Amount for chargeback
       #
-      # @param customer_filed_date [Time] Date the customer filed the dispute
+      # @param customer_filed_date [Time] Date the customer filed the chargeback request
       #
-      # @param customer_note [String] Customer description of dispute
+      # @param customer_note [String] Customer description
       #
-      # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
+      # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for chargeback
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -85,7 +85,7 @@ module Lithic
       # Some parameter documentations has been truncated, see
       # {Lithic::Models::DisputeListParams} for more details.
       #
-      # List disputes.
+      # List chargeback requests.
       #
       # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
       #
@@ -99,7 +99,7 @@ module Lithic
       #
       # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
       #
-      # @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
+      # @param status [Symbol, Lithic::Models::DisputeListParams::Status] Filter by status.
       #
       # @param transaction_tokens [Array<String>] Transaction tokens to filter by.
       #
@@ -121,7 +121,7 @@ module Lithic
         )
       end
 
-      # Withdraw dispute.
+      # Withdraw chargeback request.
       #
       # @overload delete(dispute_token, request_options: {})
       #
@@ -140,8 +140,8 @@ module Lithic
         )
       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.
       #
       # @overload delete_evidence(evidence_token, dispute_token:, request_options: {})
       #
@@ -166,8 +166,8 @@ module Lithic
         )
       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.
@@ -197,7 +197,7 @@ module Lithic
       # Some parameter documentations has been truncated, see
       # {Lithic::Models::DisputeListEvidencesParams} for more details.
       #
-      # List evidence metadata for a dispute.
+      # List evidence for a chargeback request.
       #
       # @overload list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
@@ -231,7 +231,7 @@ module Lithic
         )
       end
 
-      # Get a dispute's evidence metadata.
+      # Get evidence for a chargeback request.
       #
       # @overload retrieve_evidence(evidence_token, dispute_token:, request_options: {})
       #

data/lib/lithic/resources/financial_accounts/interest_tier_schedule.rb

@@ -10,7 +10,7 @@ module Lithic
         #
         # Create a new interest tier schedule entry for a supported financial account
         #
-        # @overload create(financial_account_token, credit_product_token:, effective_date:, tier_name: nil, tier_rates: nil, request_options: {})
+        # @overload create(financial_account_token, credit_product_token:, effective_date:, penalty_rates: nil, tier_name: nil, tier_rates: nil, request_options: {})
         #
         # @param financial_account_token [String] Globally unique identifier for financial account
         #
@@ -18,6 +18,8 @@ module Lithic
         #
         # @param effective_date [Date] Date the tier should be effective in YYYY-MM-DD format
         #
+        # @param penalty_rates [Object] Custom rates per category for penalties
+        #
         # @param tier_name [String] Name of a tier contained in the credit product. Mutually exclusive with tier_rat
         #
         # @param tier_rates [Object] Custom rates per category. Mutually exclusive with tier_name
@@ -75,12 +77,14 @@ module Lithic
         #
         # Update an existing interest tier schedule
         #
-        # @overload update(effective_date, financial_account_token:, tier_name: nil, tier_rates: nil, request_options: {})
+        # @overload update(effective_date, financial_account_token:, penalty_rates: nil, tier_name: nil, tier_rates: nil, request_options: {})
         #
         # @param effective_date [Date] Path param: Effective date in ISO format (YYYY-MM-DD)
         #
         # @param financial_account_token [String] Path param: Globally unique identifier for financial account
         #
+        # @param penalty_rates [Object] Body param: Custom rates per category for penalties
+        #
         # @param tier_name [String] Body param: Name of a tier contained in the credit product. Mutually exclusive w
         #
         # @param tier_rates [Object] Body param: Custom rates per category. Mutually exclusive with tier_name

data/lib/lithic/resources/holds.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+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.
+      #
+      # @overload create(financial_account_token, amount:, token: nil, expiration_datetime: nil, memo: nil, user_defined_id: nil, request_options: {})
+      #
+      # @param financial_account_token [String] Globally unique identifier for the financial account.
+      #
+      # @param amount [Integer] Amount to hold in cents
+      #
+      # @param token [String] Customer-provided token for idempotency. Becomes the hold token.
+      #
+      # @param expiration_datetime [Time] When the hold should auto-expire
+      #
+      # @param memo [String, nil] Reason for the hold
+      #
+      # @param user_defined_id [String] User-provided identifier for the hold
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::Hold]
+      #
+      # @see Lithic::Models::HoldCreateParams
+      def create(financial_account_token, params)
+        parsed, options = Lithic::HoldCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/financial_accounts/%1$s/holds", financial_account_token],
+          body: parsed,
+          model: Lithic::Hold,
+          options: options
+        )
+      end
+
+      # Get hold by token.
+      #
+      # @overload retrieve(hold_token, request_options: {})
+      #
+      # @param hold_token [String] Globally unique identifier for the hold.
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::Hold]
+      #
+      # @see Lithic::Models::HoldRetrieveParams
+      def retrieve(hold_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/holds/%1$s", hold_token],
+          model: Lithic::Hold,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::HoldListParams} for more details.
+      #
+      # List holds for a financial account.
+      #
+      # @overload list(financial_account_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
+      #
+      # @param financial_account_token [String] Globally unique identifier for the financial account.
+      #
+      # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      #
+      # @param status [Symbol, Lithic::Models::HoldListParams::Status] Hold status to filter by.
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::Hold>]
+      #
+      # @see Lithic::Models::HoldListParams
+      def list(financial_account_token, params = {})
+        parsed, options = Lithic::HoldListParams.dump_request(params)
+        query = Lithic::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["v1/financial_accounts/%1$s/holds", financial_account_token],
+          query: query.transform_keys(begin_: "begin", end_: "end"),
+          page: Lithic::Internal::CursorPage,
+          model: Lithic::Hold,
+          options: 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.
+      #
+      # @overload void(hold_token, memo: nil, request_options: {})
+      #
+      # @param hold_token [String] Globally unique identifier for the hold.
+      #
+      # @param memo [String, nil] Reason for voiding the hold
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::Hold]
+      #
+      # @see Lithic::Models::HoldVoidParams
+      def void(hold_token, params = {})
+        parsed, options = Lithic::HoldVoidParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["v1/holds/%1$s/void", hold_token],
+          body: parsed,
+          model: Lithic::Hold,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Lithic::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/lithic/resources/webhooks.rb

@@ -9,8 +9,7 @@ module Lithic
       # @param headers [Hash{String => String}] The webhook request headers
       # @param secret [String, nil] The webhook secret. If not provided, reads from LITHIC_WEBHOOK_SECRET environment variable.
       #
-      # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::AsaRequestWebhookEvent, Lithic::Models::TokenizationDecisioningRequestWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthentication, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent]
-      #
+      # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent]      #
       # @raise [ArgumentError] if secret is not provided and LITHIC_WEBHOOK_SECRET env var is not set
       # @raise [Lithic::Errors::MissingDependencyError] if the standardwebhooks gem is not installed
       # @raise [StandardWebhooks::WebhookVerificationError] if the signature is invalid
@@ -32,7 +31,7 @@ module Lithic
       #
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationDecisioningRequestWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent]
+      # @return [Lithic::ParsedWebhookEvent::Variants]
       def parse_unsafe(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         Lithic::Internal::Type::Converter.coerce(Lithic::Models::ParsedWebhookEvent, parsed)

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end