lithic 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84dffb32640f09dd777742e8279eb660addc6b5783cf2787b133ec5247e50507
-  data.tar.gz: 75d175963aceb1d75c46f7d2022cba419f4a7df0bb2d01e98dabb21f4f004b98
+  metadata.gz: 607c23f73075c6665363abeb7aae1925309dc8e5bc76cd6f492889036f4f77cc
+  data.tar.gz: f0cf9f33257ee6a8eb3c846c4ddb666bd03fb48ef94ad3fb3e19578455cf4425
 SHA512:
-  metadata.gz: 982807e64981a671609612a7bb9381655301310165373e3d1bdb13387b89dfe6f1dec73099f436fe32d224a7b6417ee949a9b9cafe14869a3125c8ce957c3415
-  data.tar.gz: 9e2231d392a1eb813a3e6a797c1d7625720d84833720deddca711f76ea9316eec61e55c20248d1d6d3b06a746d86a6036a4f59840d8bbecbbe1b3ea222f8b85d
+  metadata.gz: ff94b4056b75ccf4e4edbe51d89ecf27efa049b4796a60896256546b85a21e9a82675acd5087e44812067137a83af10d702493d3c10cc73f151ff078ae85ff40
+  data.tar.gz: e83448bd2e8a575b45a2480ff492fe986abbb7e6175834333a305201c5e4ad8c5963f3a5186979b697131f60ab3b3069ba05a744285656b5503e79732dd7c51d

data/CHANGELOG.md

@@ -1,5 +1,56 @@
 # Changelog
 
+## 0.3.0 (2026-01-08)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/lithic-com/lithic-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** Add card state attribute to tokenization rules ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+* **api:** Add event_type to ASA request and 3DS decisioning request ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+* **api:** add external_id to payment_event ([0bad1d9](https://github.com/lithic-com/lithic-ruby/commit/0bad1d9ef7b439a1be19b68af67abb6e66e5c53f))
+* **api:** add get /v1/transfer_limits endpoint ([0bad1d9](https://github.com/lithic-com/lithic-ruby/commit/0bad1d9ef7b439a1be19b68af67abb6e66e5c53f))
+* **api:** add post /v1/book_transfers/{book_transfer_token}/retry endpoint ([0bad1d9](https://github.com/lithic-com/lithic-ruby/commit/0bad1d9ef7b439a1be19b68af67abb6e66e5c53f))
+* **api:** Add user defined status to ledger accounts ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+* **api:** add WIRE_DRAWDOWN_REQUEST transfer type ([832895f](https://github.com/lithic-com/lithic-ruby/commit/832895fdf5d4e72f9fc1ce62e9acfb6bcbdfdc14))
+* **api:** Expose Payment Allocation Details ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+* **api:** remove unnecessary X-Lithic-Pagination header ([832895f](https://github.com/lithic-com/lithic-ruby/commit/832895fdf5d4e72f9fc1ce62e9acfb6bcbdfdc14))
+* **api:** remove v1/aggregate_balances and related models ([c66d75e](https://github.com/lithic-com/lithic-ruby/commit/c66d75ed7b10521d5f73efeafb9dbcd6ff7a7f0c))
+
+
+### Bug Fixes
+
+* calling `break` out of streams should be instantaneous ([86db080](https://github.com/lithic-com/lithic-ruby/commit/86db080240382ba1cd73af9a01c89379cfb8e330))
+* issue where json.parse errors when receiving HTTP 204 with nobody ([9c9d63b](https://github.com/lithic-com/lithic-ruby/commit/9c9d63b07badd9fdd107314ac0bd5c8c23ddd0c3))
+
+
+### Chores
+
+* formatting ([e736094](https://github.com/lithic-com/lithic-ruby/commit/e736094a8bcf11007a6ea2666cfc6a646aca6972))
+* **internal:** codegen related update ([6bacc68](https://github.com/lithic-com/lithic-ruby/commit/6bacc684b578951ece05155697ec0b68c2d8d4e0))
+* Simplify custom code ([67dc77a](https://github.com/lithic-com/lithic-ruby/commit/67dc77a78348d9d910cca58ffba483992b738f30))
+* Simplify custom code - same for rbs file ([3438ceb](https://github.com/lithic-com/lithic-ruby/commit/3438cebfd4899c87d06a2bc42d4a76af709ea21f))
+* update code formatting ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+
+
+### Documentation
+
+* **api:** clarify description of token /  retry_token when it serves as idempotency key ([832895f](https://github.com/lithic-com/lithic-ruby/commit/832895fdf5d4e72f9fc1ce62e9acfb6bcbdfdc14))
+* Update language for Google Web Push Provisioning docs ([24f042b](https://github.com/lithic-com/lithic-ruby/commit/24f042b70a1b3b6f30639fe6d04dbc7d566ea187))
+
+## 0.2.0 (2025-12-10)
+
+Full Changelog: [v0.1.0...v0.2.0](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0...v0.2.0)
+
+### Features
+
+* **api:** add webhook schemas to SDKs - add parse and parse_unsafe ([c40835b](https://github.com/lithic-com/lithic-ruby/commit/c40835b8afae6973e80baccab4017a99d15b4ac4))
+
+
+### Chores
+
+* replace custom webhook signature verification with standardwebhooks ([c40835b](https://github.com/lithic-com/lithic-ruby/commit/c40835b8afae6973e80baccab4017a99d15b4ac4))
+
 ## 0.1.0 (2025-12-09)
 
 Full Changelog: [v0.1.0-alpha.56...v0.1.0](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.56...v0.1.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "lithic", "~> 0.1.0"
+gem "lithic", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -64,6 +64,41 @@ if page.next_page?
 end
 ```
 
+### Webhooks
+
+Lithic uses webhooks to notify your application when events happen. The library provides signature verification via the optional `standardwebhooks` gem.
+
+#### Parsing and verifying webhooks
+
+```ruby
+# Verifies signature and returns typed event
+event = lithic.webhooks.parse(
+  request.body.read,
+  headers: request.headers,
+  secret: ENV["LITHIC_WEBHOOK_SECRET"] # optional, reads from env by default
+)
+
+case event
+when Lithic::Models::CardCreatedWebhookEvent
+  puts("Card created: #{event.data.token}")
+end
+```
+
+#### Parsing without verification
+
+```ruby
+# Parse only - skips signature verification (not recommended for production)
+event = lithic.webhooks.parse_unsafe(request.body.read)
+```
+
+#### Installing standardwebhooks (optional)
+
+To use signature verification, install from GitHub:
+
+```ruby
+gem "standardwebhooks", "~> 1.0", github: "standard-webhooks/standard-webhooks", glob: "libraries/ruby/*.gemspec"
+```
+
 ### Handling errors
 
 When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of `Lithic::Errors::APIError` will be thrown:

data/lib/lithic/client.rb

@@ -50,9 +50,6 @@ module Lithic
     # @return [Lithic::Resources::Balances]
     attr_reader :balances
 
-    # @return [Lithic::Resources::AggregateBalances]
-    attr_reader :aggregate_balances
-
     # @return [Lithic::Resources::Disputes]
     attr_reader :disputes
 
@@ -119,6 +116,12 @@ module Lithic
     # @return [Lithic::Resources::AccountActivity]
     attr_reader :account_activity
 
+    # @return [Lithic::Resources::TransferLimits]
+    attr_reader :transfer_limits
+
+    # @return [Lithic::Resources::Webhooks]
+    attr_reader :webhooks
+
     # Status of api
     #
     # @overload api_status(request_options: {})
@@ -178,10 +181,6 @@ module Lithic
         raise ArgumentError.new("api_key is required, and can be set via environ: \"LITHIC_API_KEY\"")
       end
 
-      headers = {
-        "x-lithic-pagination" => "cursor"
-      }
-
       @api_key = api_key.to_s
 
       super(
@@ -189,8 +188,7 @@ module Lithic
         timeout: timeout,
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
-        max_retry_delay: max_retry_delay,
-        headers: headers
+        max_retry_delay: max_retry_delay
       )
 
       @accounts = Lithic::Resources::Accounts.new(client: self)
@@ -202,7 +200,6 @@ module Lithic
       @cards = Lithic::Resources::Cards.new(client: self)
       @card_bulk_orders = Lithic::Resources::CardBulkOrders.new(client: self)
       @balances = Lithic::Resources::Balances.new(client: self)
-      @aggregate_balances = Lithic::Resources::AggregateBalances.new(client: self)
       @disputes = Lithic::Resources::Disputes.new(client: self)
       @disputes_v2 = Lithic::Resources::DisputesV2.new(client: self)
       @events = Lithic::Resources::Events.new(client: self)
@@ -225,6 +222,8 @@ module Lithic
       @fraud = Lithic::Resources::Fraud.new(client: self)
       @network_programs = Lithic::Resources::NetworkPrograms.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)
     end
   end
 end

data/lib/lithic/errors.rb

@@ -224,5 +224,20 @@ module Lithic
     class InternalServerError < Lithic::Errors::APIStatusError
       HTTP_STATUS = (500..)
     end
+
+    class MissingDependencyError < Lithic::Errors::Error
+      # @api private
+      #
+      # @param gem_name [String]
+      # @param feature [String]
+      def initialize(gem_name:, feature:)
+        message = [
+          "The '#{gem_name}' gem is required to use #{feature}.",
+          "Install it with: gem install #{gem_name}",
+          "Or add it to your Gemfile: gem '#{gem_name}'"
+        ].join("\n")
+        super(message)
+      end
+    end
   end
 end

data/lib/lithic/internal/transport/pooled_net_requester.rb

@@ -153,17 +153,19 @@ module Lithic
                   end
 
                   self.class.calibrate_socket_timeout(conn, deadline)
-                  conn.request(req) do |rsp|
-                    y << [req, rsp]
-                    break if finished
-
-                    rsp.read_body do |bytes|
-                      y << bytes.force_encoding(Encoding::BINARY)
-                      break if finished
-
-                      self.class.calibrate_socket_timeout(conn, deadline)
+                  ::Kernel.catch(:jump) do
+                    conn.request(req) do |rsp|
+                      y << [req, rsp]
+                      ::Kernel.throw(:jump) if finished
+
+                      rsp.read_body do |bytes|
+                        y << bytes.force_encoding(Encoding::BINARY)
+                        ::Kernel.throw(:jump) if finished
+
+                        self.class.calibrate_socket_timeout(conn, deadline)
+                      end
+                      eof = true
                     end
-                    eof = true
                   end
                 end
               ensure

data/lib/lithic/internal/util.rb

@@ -657,7 +657,8 @@ module Lithic
         def decode_content(headers, stream:, suppress_error: false)
           case (content_type = headers["content-type"])
           in Lithic::Internal::Util::JSON_CONTENT
-            json = stream.to_a.join
+            return nil if (json = stream.to_a.join).empty?
+
             begin
               JSON.parse(json, symbolize_names: true)
             rescue JSON::ParserError => e
@@ -667,7 +668,11 @@ module Lithic
           in Lithic::Internal::Util::JSONL_CONTENT
             lines = decode_lines(stream)
             chain_fused(lines) do |y|
-              lines.each { y << JSON.parse(_1, symbolize_names: true) }
+              lines.each do
+                next if _1.empty?
+
+                y << JSON.parse(_1, symbolize_names: true)
+              end
             end
           in %r{^text/event-stream}
             lines = decode_lines(stream)

data/lib/lithic/models/account_holder_created_webhook_event.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class AccountHolderCreatedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"account_holder.created"]
+      required :event_type, const: :"account_holder.created"
+
+      # @!attribute token
+      #   The token of the account_holder that was created.
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!attribute account_token
+      #   The token of the account that was created.
+      #
+      #   @return [String, nil]
+      optional :account_token, String
+
+      # @!attribute created
+      #   When the account_holder was created
+      #
+      #   @return [Time, nil]
+      optional :created, Time
+
+      # @!attribute required_documents
+      #
+      #   @return [Array<Lithic::Models::RequiredDocument>, nil]
+      optional :required_documents, -> { Lithic::Internal::Type::ArrayOf[Lithic::RequiredDocument] }
+
+      # @!attribute status
+      #   The status of the account_holder that was created.
+      #
+      #   @return [Symbol, Lithic::Models::AccountHolderCreatedWebhookEvent::Status, nil]
+      optional :status, enum: -> { Lithic::AccountHolderCreatedWebhookEvent::Status }
+
+      # @!attribute status_reason
+      #
+      #   @return [Array<String>, nil]
+      optional :status_reason, Lithic::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(token: nil, account_token: nil, created: nil, required_documents: nil, status: nil, status_reason: nil, event_type: :"account_holder.created")
+      #   @param token [String] The token of the account_holder that was created.
+      #
+      #   @param account_token [String] The token of the account that was created.
+      #
+      #   @param created [Time] When the account_holder was created
+      #
+      #   @param required_documents [Array<Lithic::Models::RequiredDocument>]
+      #
+      #   @param status [Symbol, Lithic::Models::AccountHolderCreatedWebhookEvent::Status] The status of the account_holder that was created.
+      #
+      #   @param status_reason [Array<String>]
+      #
+      #   @param event_type [Symbol, :"account_holder.created"] The type of event that occurred.
+
+      # The status of the account_holder that was created.
+      #
+      # @see Lithic::Models::AccountHolderCreatedWebhookEvent#status
+      module Status
+        extend Lithic::Internal::Type::Enum
+
+        ACCEPTED = :ACCEPTED
+        PENDING_REVIEW = :PENDING_REVIEW
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/account_holder_document_updated_webhook_event.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class AccountHolderDocumentUpdatedWebhookEvent < Lithic::Internal::Type::BaseModel
+      # @!attribute event_type
+      #   The type of event that occurred.
+      #
+      #   @return [Symbol, :"account_holder_document.updated"]
+      required :event_type, const: :"account_holder_document.updated"
+
+      # @!attribute token
+      #   The token of the account holder document
+      #
+      #   @return [String, nil]
+      optional :token, String
+
+      # @!attribute account_holder_token
+      #   The token of the account_holder that the document belongs to
+      #
+      #   @return [String, nil]
+      optional :account_holder_token, String
+
+      # @!attribute created
+      #   When the account_holder was created
+      #
+      #   @return [Time, nil]
+      optional :created, Time
+
+      # @!attribute document_type
+      #   Type of documentation to be submitted for verification of an account holder
+      #
+      #   @return [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::DocumentType, nil]
+      optional :document_type, enum: -> { Lithic::AccountHolderDocumentUpdatedWebhookEvent::DocumentType }
+
+      # @!attribute entity_token
+      #   The token of the entity that the document belongs to
+      #
+      #   @return [String, nil]
+      optional :entity_token, String
+
+      # @!attribute required_document_uploads
+      #
+      #   @return [Array<Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload>, nil]
+      optional :required_document_uploads,
+               -> { Lithic::Internal::Type::ArrayOf[Lithic::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload] }
+
+      # @!method initialize(token: nil, account_holder_token: nil, created: nil, document_type: nil, entity_token: nil, required_document_uploads: nil, event_type: :"account_holder_document.updated")
+      #   @param token [String] The token of the account holder document
+      #
+      #   @param account_holder_token [String] The token of the account_holder that the document belongs to
+      #
+      #   @param created [Time] When the account_holder was created
+      #
+      #   @param document_type [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::DocumentType] Type of documentation to be submitted for verification of an account holder
+      #
+      #   @param entity_token [String] The token of the entity that the document belongs to
+      #
+      #   @param required_document_uploads [Array<Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload>]
+      #
+      #   @param event_type [Symbol, :"account_holder_document.updated"] The type of event that occurred.
+
+      # Type of documentation to be submitted for verification of an account holder
+      #
+      # @see Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent#document_type
+      module DocumentType
+        extend Lithic::Internal::Type::Enum
+
+        DRIVERS_LICENSE = :DRIVERS_LICENSE
+        PASSPORT = :PASSPORT
+        PASSPORT_CARD = :PASSPORT_CARD
+        EIN_LETTER = :EIN_LETTER
+        TAX_RETURN = :TAX_RETURN
+        OPERATING_AGREEMENT = :OPERATING_AGREEMENT
+        CERTIFICATE_OF_FORMATION = :CERTIFICATE_OF_FORMATION
+        CERTIFICATE_OF_GOOD_STANDING = :CERTIFICATE_OF_GOOD_STANDING
+        ARTICLES_OF_INCORPORATION = :ARTICLES_OF_INCORPORATION
+        ARTICLES_OF_ORGANIZATION = :ARTICLES_OF_ORGANIZATION
+        BYLAWS = :BYLAWS
+        GOVERNMENT_BUSINESS_LICENSE = :GOVERNMENT_BUSINESS_LICENSE
+        PARTNERSHIP_AGREEMENT = :PARTNERSHIP_AGREEMENT
+        SS4_FORM = :SS4_FORM
+        BANK_STATEMENT = :BANK_STATEMENT
+        UTILITY_BILL_STATEMENT = :UTILITY_BILL_STATEMENT
+        SSN_CARD = :SSN_CARD
+        ITIN_LETTER = :ITIN_LETTER
+        FINCEN_BOI_REPORT = :FINCEN_BOI_REPORT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class RequiredDocumentUpload < Lithic::Internal::Type::BaseModel
+        # @!attribute token
+        #   The token of the document upload
+        #
+        #   @return [String, nil]
+        optional :token, String
+
+        # @!attribute accepted_entity_status_reasons
+        #
+        #   @return [Array<String>, nil]
+        optional :accepted_entity_status_reasons, Lithic::Internal::Type::ArrayOf[String]
+
+        # @!attribute created
+        #   When the document upload was created
+        #
+        #   @return [Time, nil]
+        optional :created, Time
+
+        # @!attribute image_type
+        #   The type of image that was uploaded
+        #
+        #   @return [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::ImageType, nil]
+        optional :image_type,
+                 enum: -> { Lithic::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::ImageType }
+
+        # @!attribute rejected_entity_status_reasons
+        #
+        #   @return [Array<String>, nil]
+        optional :rejected_entity_status_reasons, Lithic::Internal::Type::ArrayOf[String]
+
+        # @!attribute status
+        #   The status of the document upload
+        #
+        #   @return [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::Status, nil]
+        optional :status,
+                 enum: -> { Lithic::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::Status }
+
+        # @!attribute status_reasons
+        #
+        #   @return [Array<String>, nil]
+        optional :status_reasons, Lithic::Internal::Type::ArrayOf[String]
+
+        # @!attribute updated
+        #   When the document upload was last updated
+        #
+        #   @return [Time, nil]
+        optional :updated, Time
+
+        # @!method initialize(token: nil, accepted_entity_status_reasons: nil, created: nil, image_type: nil, rejected_entity_status_reasons: nil, status: nil, status_reasons: nil, updated: nil)
+        #   A document upload that belongs to the overall account holder document
+        #
+        #   @param token [String] The token of the document upload
+        #
+        #   @param accepted_entity_status_reasons [Array<String>]
+        #
+        #   @param created [Time] When the document upload was created
+        #
+        #   @param image_type [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::ImageType] The type of image that was uploaded
+        #
+        #   @param rejected_entity_status_reasons [Array<String>]
+        #
+        #   @param status [Symbol, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload::Status] The status of the document upload
+        #
+        #   @param status_reasons [Array<String>]
+        #
+        #   @param updated [Time] When the document upload was last updated
+
+        # The type of image that was uploaded
+        #
+        # @see Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload#image_type
+        module ImageType
+          extend Lithic::Internal::Type::Enum
+
+          FRONT = :FRONT
+          BACK = :BACK
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The status of the document upload
+        #
+        # @see Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent::RequiredDocumentUpload#status
+        module Status
+          extend Lithic::Internal::Type::Enum
+
+          ACCEPTED = :ACCEPTED
+          REJECTED = :REJECTED
+          PENDING_UPLOAD = :PENDING_UPLOAD
+          UPLOADED = :UPLOADED
+          PARTIAL_APPROVAL = :PARTIAL_APPROVAL
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end