lithic 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37d9177dabd71343c3ba0be9ae82c47b899ac8c61b839359e72b13f35bb9a682
-  data.tar.gz: ea676fad5f242c817a9921928107da0be0612b88f7d4271d3b4c8a2d09685188
+  metadata.gz: 67af32ffcf50a40837eca3e3fe0eeb991c5c9cd5d61ddd545d5476157870fd32
+  data.tar.gz: dbae341ad40f2b8e70fbe6dae7ec8cb50ed4a6d7948a32f280cc5c848a79463c
 SHA512:
-  metadata.gz: 30978d9d1a737b508380fac34fd692dceed11ec5e5990028f6446c2387181b4e25d3006ad43d536f7094999a2745a516219b6e27d638c63be937271bf23ab4c9
-  data.tar.gz: 39c3a61ae93bfffb325b76dd6765990d55c80d8193b39aa57ad49ba034cb6df60fb9ea64cb98a830b50e1d6ea104c80ccd5704400a39c5e3f2fb3256a443dcc4
+  metadata.gz: 76b19130e933adb9b63f78e25c80767906846288ac5db76273cf23a1afa1f0dd4eac650b0365acab561fa9a82cf83b71ebfe7505e349323cbe571e00ab080313
+  data.tar.gz: 2b7f407c0b9e9bbfe3ba928ed86ea046dd48766f1fdb6c8102a565c55af10e4b164e7a50de9d43401f810a5efb450f486001c76c638cb055b62615bf0477e620

data/CHANGELOG.md

@@ -1,5 +1,57 @@
 # Changelog
 
+## 0.8.0 (2026-03-16)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/lithic-com/lithic-ruby/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** add EARLY_DIRECT_DEPOSIT_FLOAT to financial account types ([3e0194f](https://github.com/lithic-com/lithic-ruby/commit/3e0194f79f315f44b8bc95c7e18452c99d91ce81))
+* **api:** Add event_subtype to statement line items ([3e9c63c](https://github.com/lithic-com/lithic-ruby/commit/3e9c63ca2f2c3ddf7cfebef2bbf603646f0c6e7d))
+* **api:** add excluded_account_tokens field to auth_rules ([df3f09b](https://github.com/lithic-com/lithic-ruby/commit/df3f09b0f5fe02307e747af719d5f4ab5a8ebf04))
+* **api:** add loan_tape_date field to statement line items ([9dd0f14](https://github.com/lithic-com/lithic-ruby/commit/9dd0f14b35ebd87561dda0a11da9b440d9a4f1cb))
+* **api:** add penalty_rates parameter to interest_tier_schedule ([d5d3ecb](https://github.com/lithic-com/lithic-ruby/commit/d5d3ecb2d87d8475aead81558b3152fd922cf267))
+* **api:** Add support for early direct deposit ([5b75c2f](https://github.com/lithic-com/lithic-ruby/commit/5b75c2fdb30131890b8ea83befd70c6f7cba804f))
+* **api:** add TypeScript code rules, draft version state tracking to auth_rules ([1dbdb68](https://github.com/lithic-com/lithic-ruby/commit/1dbdb688fffb5909af5c568bb16b2e3f899a6a42))
+* **api:** add versions field to auth_rules daily statistics ([827bf68](https://github.com/lithic-com/lithic-ruby/commit/827bf6825c3dae568720c02beceedb1cc0f357f8))
+* **api:** add WIRE category to account_activity/statements/payment, wire event types, remove field ([a9df6e3](https://github.com/lithic-com/lithic-ruby/commit/a9df6e398525050cf3cb0d7d1166a4fd27d5d182))
+* **client:** add webhook support ([e31938a](https://github.com/lithic-com/lithic-ruby/commit/e31938aed255ccf33ac8cafcde59f0b53334cd52))
+
+
+### Bug Fixes
+
+* **api:** [breaking] unify webhook schemas for digital_wallet.tokenization_approval_request webhooks ([46555c1](https://github.com/lithic-com/lithic-ruby/commit/46555c112e45b4aa389e3d8f0a5231a0a7c3ce19))
+* **api:** Disable MCP server to fix TypeScript SDK package publishing ([b977c80](https://github.com/lithic-com/lithic-ruby/commit/b977c80b191364666f305fc9527d161c653a43f7))
+* **types:** require start/end_, remove auth_rule_token in auth_rules v2 backtest ([7307a40](https://github.com/lithic-com/lithic-ruby/commit/7307a40c8d1c7e50bc79ef302b1563da333ccb53))
+
+
+### Chores
+
+* **internal:** codegen related update ([489f19b](https://github.com/lithic-com/lithic-ruby/commit/489f19b1c8c76d08aed0a313d45bed73406025b5))
+* **internal:** regenerate SDK with no functional changes ([13a1d1b](https://github.com/lithic-com/lithic-ruby/commit/13a1d1bd178d109ca6d5c8d3f3199f471b643cfa))
+
+
+### Documentation
+
+* **api:** update disputes terminology to chargeback request ([94dadbc](https://github.com/lithic-com/lithic-ruby/commit/94dadbcaa0c7f98b6a7e8b66fcdf5bfdc0e8fa5d))
+* **client:** add MCP Server section to README ([fbf0234](https://github.com/lithic-com/lithic-ruby/commit/fbf0234627af6b16c0844a258c3133f2d671613c))
+
+## 0.7.0 (2026-03-05)
+
+Full Changelog: [v0.6.0...v0.7.0](https://github.com/lithic-com/lithic-ruby/compare/v0.6.0...v0.7.0)
+
+### Features
+
+* **api:** add action_counts to rule performance reports and code to authorization actions ([bd02001](https://github.com/lithic-com/lithic-ruby/commit/bd02001603d5893f1095ed7d89f9f019c780fff8))
+* **api:** Add Hold API for financial account fund reservations ([6b16d86](https://github.com/lithic-com/lithic-ruby/commit/6b16d86f054b238b7d2b91c9e0e62df67e88fbd7))
+* **api:** Remove deprecated beneficial owner entities field ([7c54dcf](https://github.com/lithic-com/lithic-ruby/commit/7c54dcf052f9c13b7ab73862f80e279d1184e8ee))
+
+
+### Chores
+
+* **internal:** codegen related update ([199e518](https://github.com/lithic-com/lithic-ruby/commit/199e518f942530266541eef7343ff626dfbf7c10))
+* **internal:** codegen related update ([412e84f](https://github.com/lithic-com/lithic-ruby/commit/412e84f1d1e0b574fd791ea420fbf88707a6985a))
+
 ## 0.6.0 (2026-02-27)
 
 Full Changelog: [v0.5.0...v0.6.0](https://github.com/lithic-com/lithic-ruby/compare/v0.5.0...v0.6.0)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.6.0"
+gem "lithic", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->
@@ -102,10 +102,10 @@ event = lithic.webhooks.parse_unsafe(request.body.read)
 
 #### Installing standardwebhooks (optional)
 
-To use signature verification, install from GitHub:
+To use signature verification, add the gem to your Gemfile:
 
 ```ruby
-gem "standardwebhooks", "~> 1.0", github: "standard-webhooks/standard-webhooks", glob: "libraries/ruby/*.gemspec"
+gem "standardwebhooks", "~> 1.0"
 ```
 
 ### Handling errors

data/lib/lithic/client.rb

@@ -23,6 +23,9 @@ module Lithic
     # @return [String]
     attr_reader :api_key
 
+    # @return [String, nil]
+    attr_reader :webhook_secret
+
     # @return [Lithic::Resources::Accounts]
     attr_reader :accounts
 
@@ -113,6 +116,9 @@ module Lithic
     # @return [Lithic::Resources::NetworkPrograms]
     attr_reader :network_programs
 
+    # @return [Lithic::Resources::Holds]
+    attr_reader :holds
+
     # @return [Lithic::Resources::AccountActivity]
     attr_reader :account_activity
 
@@ -146,6 +152,8 @@ module Lithic
     #
     # @param api_key [String, nil] Defaults to `ENV["LITHIC_API_KEY"]`
     #
+    # @param webhook_secret [String, nil] Defaults to `ENV["LITHIC_WEBHOOK_SECRET"]`
+    #
     # @param environment [:production, :sandbox, nil] Specifies the environment to use for the API.
     #
     # Each environment maps to a different base URL:
@@ -165,6 +173,7 @@ module Lithic
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["LITHIC_API_KEY"],
+      webhook_secret: ENV["LITHIC_WEBHOOK_SECRET"],
       environment: nil,
       base_url: ENV["LITHIC_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
@@ -182,6 +191,7 @@ module Lithic
       end
 
       @api_key = api_key.to_s
+      @webhook_secret = webhook_secret&.to_s
 
       super(
         base_url: base_url,
@@ -221,6 +231,7 @@ module Lithic
       @funding_events = Lithic::Resources::FundingEvents.new(client: self)
       @fraud = Lithic::Resources::Fraud.new(client: self)
       @network_programs = Lithic::Resources::NetworkPrograms.new(client: self)
+      @holds = Lithic::Resources::Holds.new(client: self)
       @account_activity = Lithic::Resources::AccountActivity.new(client: self)
       @transfer_limits = Lithic::Resources::TransferLimits.new(client: self)
       @webhooks = Lithic::Resources::Webhooks.new(client: self)

data/lib/lithic/internal/util.rb

@@ -490,6 +490,37 @@ module Lithic
       JSONL_CONTENT = %r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}
 
       class << self
+        # @api private
+        #
+        # @param query [Hash{Symbol=>Object}]
+        #
+        # @return [Hash{Symbol=>Object}]
+        def encode_query_params(query)
+          out = {}
+          query.each { write_query_param_element!(out, _1, _2) }
+          out
+        end
+
+        # @api private
+        #
+        # @param collection [Hash{Symbol=>Object}]
+        # @param key [String]
+        # @param element [Object]
+        #
+        # @return [nil]
+        private def write_query_param_element!(collection, key, element)
+          case element
+          in Hash
+            element.each do |name, value|
+              write_query_param_element!(collection, "#{key}[#{name}]", value)
+            end
+          in Array
+            collection[key] = element.map(&:to_s).join(",")
+          else
+            collection[key] = element.to_s
+          end
+        end
+
         # @api private
         #
         # @param y [Enumerator::Yielder]

data/lib/lithic/models/account_activity_list_params.rb

@@ -110,6 +110,7 @@ module Lithic
         extend Lithic::Internal::Type::Enum
 
         ACH = :ACH
+        WIRE = :WIRE
         BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
         FEE = :FEE
         REWARD = :REWARD
@@ -128,6 +129,7 @@ module Lithic
         MANAGEMENT_FEE = :MANAGEMENT_FEE
         MANAGEMENT_REWARD = :MANAGEMENT_REWARD
         MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
+        HOLD = :HOLD
         PROGRAM_FUNDING = :PROGRAM_FUNDING
 
         # @!method self.values

data/lib/lithic/models/account_activity_list_response.rb

@@ -6,7 +6,8 @@ module Lithic
     # which transaction type is returned: INTERNAL returns FinancialTransaction,
     # TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT
     # returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse,
-    # and MANAGEMENT_OPERATION returns ManagementOperationTransaction
+    # MANAGEMENT_OPERATION returns ManagementOperationTransaction, and HOLD returns
+    # HoldTransaction
     #
     # @see Lithic::Resources::AccountActivity#list
     module AccountActivityListResponse
@@ -30,6 +31,9 @@ module Lithic
 
       variant :MANAGEMENT_OPERATION, -> { Lithic::ManagementOperationTransaction }
 
+      # A hold transaction representing reserved funds on a financial account. Holds move funds from available to pending balance in anticipation of future payments. They can be resolved via settlement (linked to payment), manual release, or expiration.
+      variant :HOLD, -> { Lithic::Hold }
+
       class Internal < Lithic::Internal::Type::BaseModel
         # @!attribute token
         #   Unique identifier for the transaction
@@ -145,6 +149,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           ACH = :ACH
+          WIRE = :WIRE
           BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
           FEE = :FEE
           REWARD = :REWARD
@@ -163,6 +168,7 @@ module Lithic
           MANAGEMENT_FEE = :MANAGEMENT_FEE
           MANAGEMENT_REWARD = :MANAGEMENT_REWARD
           MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
+          HOLD = :HOLD
           PROGRAM_FUNDING = :PROGRAM_FUNDING
 
           # @!method self.values
@@ -261,7 +267,7 @@ module Lithic
       end
 
       # @!method self.variants
-      #   @return [Array(Lithic::Models::AccountActivityListResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityListResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction)]
+      #   @return [Array(Lithic::Models::AccountActivityListResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityListResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction, Lithic::Models::Hold)]
     end
   end
 end

data/lib/lithic/models/account_activity_retrieve_transaction_params.rb

@@ -7,7 +7,13 @@ module Lithic
       extend Lithic::Internal::Type::RequestParameters::Converter
       include Lithic::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute transaction_token
+      #
+      #   @return [String]
+      required :transaction_token, String
+
+      # @!method initialize(transaction_token:, request_options: {})
+      #   @param transaction_token [String]
       #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/lithic/models/account_activity_retrieve_transaction_response.rb

@@ -6,7 +6,8 @@ module Lithic
     # which transaction type is returned: INTERNAL returns FinancialTransaction,
     # TRANSFER returns BookTransferTransaction, CARD returns CardTransaction, PAYMENT
     # returns PaymentTransaction, EXTERNAL_PAYMENT returns ExternalPaymentResponse,
-    # and MANAGEMENT_OPERATION returns ManagementOperationTransaction
+    # MANAGEMENT_OPERATION returns ManagementOperationTransaction, and HOLD returns
+    # HoldTransaction
     #
     # @see Lithic::Resources::AccountActivity#retrieve_transaction
     module AccountActivityRetrieveTransactionResponse
@@ -30,6 +31,9 @@ module Lithic
 
       variant :MANAGEMENT_OPERATION, -> { Lithic::ManagementOperationTransaction }
 
+      # A hold transaction representing reserved funds on a financial account. Holds move funds from available to pending balance in anticipation of future payments. They can be resolved via settlement (linked to payment), manual release, or expiration.
+      variant :HOLD, -> { Lithic::Hold }
+
       class Internal < Lithic::Internal::Type::BaseModel
         # @!attribute token
         #   Unique identifier for the transaction
@@ -148,6 +152,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           ACH = :ACH
+          WIRE = :WIRE
           BALANCE_OR_FUNDING = :BALANCE_OR_FUNDING
           FEE = :FEE
           REWARD = :REWARD
@@ -166,6 +171,7 @@ module Lithic
           MANAGEMENT_FEE = :MANAGEMENT_FEE
           MANAGEMENT_REWARD = :MANAGEMENT_REWARD
           MANAGEMENT_DISBURSEMENT = :MANAGEMENT_DISBURSEMENT
+          HOLD = :HOLD
           PROGRAM_FUNDING = :PROGRAM_FUNDING
 
           # @!method self.values
@@ -264,7 +270,7 @@ module Lithic
       end
 
       # @!method self.variants
-      #   @return [Array(Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction)]
+      #   @return [Array(Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal, Lithic::Models::BookTransferResponse, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card, Lithic::Models::Payment, Lithic::Models::ExternalPayment, Lithic::Models::ManagementOperationTransaction, Lithic::Models::Hold)]
     end
   end
 end

data/lib/lithic/models/account_holder.rb

@@ -22,15 +22,6 @@ module Lithic
       #   @return [String, nil]
       optional :account_token, String
 
-      # @!attribute beneficial_owner_entities
-      #   @deprecated
-      #
-      #   Deprecated.
-      #
-      #   @return [Array<Lithic::Models::AccountHolder::BeneficialOwnerEntity>, nil]
-      optional :beneficial_owner_entities,
-               -> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolder::BeneficialOwnerEntity] }
-
       # @!attribute beneficial_owner_individuals
       #   Only present when user_type == "BUSINESS". You must submit a list of all direct
       #   and indirect individuals with 25% or more ownership in the company. A maximum of
@@ -168,7 +159,7 @@ module Lithic
       #   @return [String, nil]
       optional :website_url, String
 
-      # @!method initialize(token:, created:, account_token: nil, beneficial_owner_entities: nil, beneficial_owner_individuals: nil, business_account_token: nil, business_entity: nil, control_person: nil, email: nil, exemption_type: nil, external_id: nil, individual: nil, naics_code: nil, nature_of_business: nil, phone_number: nil, required_documents: nil, status: nil, status_reasons: nil, user_type: nil, verification_application: nil, website_url: nil)
+      # @!method initialize(token:, created:, account_token: nil, beneficial_owner_individuals: nil, business_account_token: nil, business_entity: nil, control_person: nil, email: nil, exemption_type: nil, external_id: nil, individual: nil, naics_code: nil, nature_of_business: nil, phone_number: nil, required_documents: nil, status: nil, status_reasons: nil, user_type: nil, verification_application: nil, website_url: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::AccountHolder} for more details.
       #
@@ -178,8 +169,6 @@ module Lithic
       #
       #   @param account_token [String] Globally unique identifier for the account.
       #
-      #   @param beneficial_owner_entities [Array<Lithic::Models::AccountHolder::BeneficialOwnerEntity>] Deprecated.
-      #
       #   @param beneficial_owner_individuals [Array<Lithic::Models::AccountHolder::BeneficialOwnerIndividual>] Only present when user_type == "BUSINESS".
       #
       #   @param business_account_token [String] Only applicable for customers using the KYC-Exempt workflow to enroll authorized
@@ -214,73 +203,6 @@ module Lithic
       #
       #   @param website_url [String] Only present when user_type == "BUSINESS". Business's primary website.
 
-      class BeneficialOwnerEntity < Lithic::Internal::Type::BaseModel
-        # @!attribute address
-        #   Business's physical address - PO boxes, UPS drops, and FedEx drops are not
-        #   acceptable; APO/FPO are acceptable.
-        #
-        #   @return [Lithic::Models::Address]
-        required :address, -> { Lithic::Address }
-
-        # @!attribute dba_business_name
-        #   Any name that the business operates under that is not its legal business name
-        #   (if applicable).
-        #
-        #   @return [String]
-        required :dba_business_name, String
-
-        # @!attribute entity_token
-        #   Globally unique identifier for the entity.
-        #
-        #   @return [String]
-        required :entity_token, String
-
-        # @!attribute government_id
-        #   Government-issued identification number. US Federal Employer Identification
-        #   Numbers (EIN) are currently supported, entered as full nine-digits, with or
-        #   without hyphens.
-        #
-        #   @return [String]
-        required :government_id, String
-
-        # @!attribute legal_business_name
-        #   Legal (formal) business name.
-        #
-        #   @return [String]
-        required :legal_business_name, String
-
-        # @!attribute phone_numbers
-        #   One or more of the business's phone number(s), entered as a list in E.164
-        #   format.
-        #
-        #   @return [Array<String>]
-        required :phone_numbers, Lithic::Internal::Type::ArrayOf[String]
-
-        # @!attribute parent_company
-        #   Parent company name (if applicable).
-        #
-        #   @return [String, nil]
-        optional :parent_company, String
-
-        # @!method initialize(address:, dba_business_name:, entity_token:, government_id:, legal_business_name:, phone_numbers:, parent_company: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Lithic::Models::AccountHolder::BeneficialOwnerEntity} for more details.
-        #
-        #   @param address [Lithic::Models::Address] Business's physical address - PO boxes, UPS drops, and FedEx drops are not accep
-        #
-        #   @param dba_business_name [String] Any name that the business operates under that is not its legal business name (i
-        #
-        #   @param entity_token [String] Globally unique identifier for the entity.
-        #
-        #   @param government_id [String] Government-issued identification number. US Federal Employer Identification Numb
-        #
-        #   @param legal_business_name [String] Legal (formal) business name.
-        #
-        #   @param phone_numbers [Array<String>] One or more of the business's phone number(s), entered as a list in E.164 format
-        #
-        #   @param parent_company [String] Parent company name (if applicable).
-      end
-
       class BeneficialOwnerIndividual < Lithic::Internal::Type::BaseModel
         # @!attribute address
         #   Individual's current address