lithic 0.6.0 → 0.8.0

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/payments.rbi

@@ -14,6 +14,7 @@ module Lithic
             Lithic::PaymentCreateParams::MethodAttributes::OrHash,
           type: Lithic::PaymentCreateParams::Type::OrSymbol,
           token: String,
+          hold: Lithic::PaymentCreateParams::Hold::OrHash,
           memo: String,
           user_defined_id: String,
           request_options: Lithic::RequestOptions::OrHash
@@ -29,6 +30,8 @@ module Lithic
         # Customer-provided token that will serve as an idempotency token. This token will
         # become the transaction token.
         token: nil,
+        # Optional hold to settle when this payment is initiated.
+        hold: nil,
         memo: nil,
         user_defined_id: nil,
         request_options: {}

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/internal/util.rbs

@@ -106,6 +106,16 @@ module Lithic
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

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_params.rbs

@@ -1,15 +1,23 @@
 module Lithic
   module Models
     type account_activity_retrieve_transaction_params =
-      {  } & Lithic::Internal::Type::request_parameters
+      { transaction_token: String } & Lithic::Internal::Type::request_parameters
 
     class AccountActivityRetrieveTransactionParams < Lithic::Internal::Type::BaseModel
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      def initialize: (?request_options: Lithic::request_opts) -> void
+      attr_accessor transaction_token: String
 
-      def to_hash: -> { request_options: Lithic::RequestOptions }
+      def initialize: (
+        transaction_token: String,
+        ?request_options: Lithic::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        transaction_token: String,
+        request_options: Lithic::RequestOptions
+      }
     end
   end
 end

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/account_holder.rbs

@@ -5,7 +5,6 @@ module Lithic
         token: String,
         created: Time,
         account_token: String,
-        beneficial_owner_entities: ::Array[Lithic::AccountHolder::BeneficialOwnerEntity],
         beneficial_owner_individuals: ::Array[Lithic::AccountHolder::BeneficialOwnerIndividual],
         business_account_token: String,
         business_entity: Lithic::AccountHolder::BusinessEntity,
@@ -34,12 +33,6 @@ module Lithic
 
       def account_token=: (String) -> String
 
-      attr_reader beneficial_owner_entities: ::Array[Lithic::AccountHolder::BeneficialOwnerEntity]?
-
-      def beneficial_owner_entities=: (
-        ::Array[Lithic::AccountHolder::BeneficialOwnerEntity]
-      ) -> ::Array[Lithic::AccountHolder::BeneficialOwnerEntity]
-
       attr_reader beneficial_owner_individuals: ::Array[Lithic::AccountHolder::BeneficialOwnerIndividual]?
 
       def beneficial_owner_individuals=: (
@@ -132,7 +125,6 @@ module Lithic
         token: String,
         created: Time,
         ?account_token: String,
-        ?beneficial_owner_entities: ::Array[Lithic::AccountHolder::BeneficialOwnerEntity],
         ?beneficial_owner_individuals: ::Array[Lithic::AccountHolder::BeneficialOwnerIndividual],
         ?business_account_token: String,
         ?business_entity: Lithic::AccountHolder::BusinessEntity,
@@ -156,7 +148,6 @@ module Lithic
         token: String,
         created: Time,
         account_token: String,
-        beneficial_owner_entities: ::Array[Lithic::AccountHolder::BeneficialOwnerEntity],
         beneficial_owner_individuals: ::Array[Lithic::AccountHolder::BeneficialOwnerIndividual],
         business_account_token: String,
         business_entity: Lithic::AccountHolder::BusinessEntity,
@@ -176,55 +167,6 @@ module Lithic
         website_url: String
       }
 
-      type beneficial_owner_entity =
-        {
-          address: Lithic::Address,
-          dba_business_name: String,
-          entity_token: String,
-          government_id: String,
-          legal_business_name: String,
-          phone_numbers: ::Array[String],
-          parent_company: String
-        }
-
-      class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
-        attr_accessor address: Lithic::Address
-
-        attr_accessor dba_business_name: String
-
-        attr_accessor entity_token: String
-
-        attr_accessor government_id: String
-
-        attr_accessor legal_business_name: String
-
-        attr_accessor phone_numbers: ::Array[String]
-
-        attr_reader parent_company: String?
-
-        def parent_company=: (String) -> String
-
-        def initialize: (
-          address: Lithic::Address,
-          dba_business_name: String,
-          entity_token: String,
-          government_id: String,
-          legal_business_name: String,
-          phone_numbers: ::Array[String],
-          ?parent_company: String
-        ) -> void
-
-        def to_hash: -> {
-          address: Lithic::Address,
-          dba_business_name: String,
-          entity_token: String,
-          government_id: String,
-          legal_business_name: String,
-          phone_numbers: ::Array[String],
-          parent_company: String
-        }
-      end
-
       type beneficial_owner_individual =
         {
           address: Lithic::Address,