lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/lithic/resources/transfers.rb

@@ -3,16 +3,28 @@
 module Lithic
   module Resources
     class Transfers
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::TransferCreateParams} for more details.
+      #
       # Transfer funds between two financial accounts or between a financial account and
       # card
       #
       # @overload create(amount:, from:, to:, token: nil, memo: nil, request_options: {})
       #
-      # @param amount [Integer]
-      # @param from [String]
-      # @param to [String]
-      # @param token [String]
-      # @param memo [String]
+      # @param amount [Integer] Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+      # ...
+      #
+      # @param from [String] Globally unique identifier for the financial account or card that will send the
+      # ...
+      #
+      # @param to [String] Globally unique identifier for the financial account or card that will receive t
+      # ...
+      #
+      # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      # ...
+      #
+      # @param memo [String] Optional descriptor for the transfer.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Transfer]

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0.pre.alpha.16"
+  VERSION = "0.1.0.pre.alpha.18"
 end

data/lib/lithic.rb

@@ -31,7 +31,7 @@ require_relative "lithic/internal/util"
 require_relative "lithic/internal/type/converter"
 require_relative "lithic/internal/type/unknown"
 require_relative "lithic/internal/type/boolean"
-require_relative "lithic/internal/type/io_like"
+require_relative "lithic/internal/type/file_input"
 require_relative "lithic/internal/type/enum"
 require_relative "lithic/internal/type/union"
 require_relative "lithic/internal/type/array_of"
@@ -41,12 +41,14 @@ require_relative "lithic/internal/type/base_page"
 require_relative "lithic/internal/type/request_parameters"
 require_relative "lithic/internal"
 require_relative "lithic/request_options"
+require_relative "lithic/file_part"
 require_relative "lithic/errors"
 require_relative "lithic/internal/transport/base_client"
 require_relative "lithic/internal/transport/pooled_net_requester"
 require_relative "lithic/client"
 require_relative "lithic/internal/cursor_page"
 require_relative "lithic/internal/single_page"
+require_relative "lithic/models/non_pci_card"
 require_relative "lithic/models/payment"
 require_relative "lithic/models/three_ds/challenge_response"
 require_relative "lithic/models/account"
@@ -112,24 +114,19 @@ require_relative "lithic/models/book_transfer_list_params"
 require_relative "lithic/models/book_transfer_response"
 require_relative "lithic/models/book_transfer_retrieve_params"
 require_relative "lithic/models/book_transfer_reverse_params"
+require_relative "lithic/models/card"
 require_relative "lithic/models/card_convert_physical_params"
-require_relative "lithic/models/card_convert_physical_response"
 require_relative "lithic/models/card_create_params"
-require_relative "lithic/models/card_create_response"
 require_relative "lithic/models/card_embed_params"
 require_relative "lithic/models/card_list_params"
-require_relative "lithic/models/card_list_response"
 require_relative "lithic/models/card_program"
 require_relative "lithic/models/card_program_list_params"
 require_relative "lithic/models/card_program_retrieve_params"
 require_relative "lithic/models/card_provision_params"
 require_relative "lithic/models/card_provision_response"
 require_relative "lithic/models/card_reissue_params"
-require_relative "lithic/models/card_reissue_response"
 require_relative "lithic/models/card_renew_params"
-require_relative "lithic/models/card_renew_response"
 require_relative "lithic/models/card_retrieve_params"
-require_relative "lithic/models/card_retrieve_response"
 require_relative "lithic/models/card_retrieve_spend_limits_params"
 require_relative "lithic/models/cards/aggregate_balance_list_params"
 require_relative "lithic/models/cards/aggregate_balance_list_response"
@@ -138,10 +135,8 @@ require_relative "lithic/models/cards/balance_list_response"
 require_relative "lithic/models/cards/financial_transaction_list_params"
 require_relative "lithic/models/cards/financial_transaction_retrieve_params"
 require_relative "lithic/models/card_search_by_pan_params"
-require_relative "lithic/models/card_search_by_pan_response"
 require_relative "lithic/models/card_spend_limits"
 require_relative "lithic/models/card_update_params"
-require_relative "lithic/models/card_update_response"
 require_relative "lithic/models/carrier"
 require_relative "lithic/models/client_api_status_params"
 require_relative "lithic/models/credit_products/extended_credit"

data/rbi/lib/lithic/file_part.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Lithic
+  class FilePart
+    sig { returns(T.any(Pathname, StringIO, IO, String)) }
+    attr_reader :content
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :content_type
+
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+
+    # @api private
+    sig { returns(String) }
+    private def read; end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_json(*a); end
+
+    sig { params(a: T.anything).returns(String) }
+    def to_yaml(*a); end
+
+    sig do
+      params(
+        content: T.any(Pathname, StringIO, IO, String),
+        filename: T.nilable(String),
+        content_type: T.nilable(String)
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil); end
+  end
+end

data/rbi/lib/lithic/internal/transport/base_client.rbi

@@ -24,7 +24,14 @@ module Lithic
                         )]
               ),
               body: T.nilable(T.anything),
-              unwrap: T.nilable(Symbol),
+              unwrap: T.nilable(
+                T.any(
+                  Symbol,
+                  Integer,
+                  T::Array[T.any(Symbol, Integer)],
+                  T.proc.params(arg0: T.anything).returns(T.anything)
+                )
+              ),
               page: T.nilable(T::Class[Lithic::Internal::Type::BasePage[Lithic::Internal::Type::BaseModel]]),
               stream: T.nilable(T::Class[T.anything]),
               model: T.nilable(Lithic::Internal::Type::Converter::Input),
@@ -90,7 +97,7 @@ module Lithic
 
         # @api private
         sig { returns(Lithic::Internal::Transport::PooledNetRequester) }
-        attr_accessor :requester
+        attr_reader :requester
 
         # @api private
         sig do
@@ -170,7 +177,14 @@ module Lithic
                       )]
             ),
             body: T.nilable(T.anything),
-            unwrap: T.nilable(Symbol),
+            unwrap: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             page: T.nilable(T::Class[Lithic::Internal::Type::BasePage[Lithic::Internal::Type::BaseModel]]),
             stream: T.nilable(T::Class[T.anything]),
             model: T.nilable(Lithic::Internal::Type::Converter::Input),

data/rbi/lib/lithic/internal/type/{io_like.rbi → file_input.rbi}

@@ -5,8 +5,12 @@ module Lithic
     module Type
       # @api private
       #
-      # Either `Pathname` or `StringIO`.
-      class IOLike
+      # Either `Pathname` or `StringIO`, or `IO`, or
+      # `Lithic::Internal::Type::FileInput`.
+      #
+      # Note: when `IO` is used, all retries are disabled, since many IO` streams are
+      # not rewindable.
+      class FileInput
         extend Lithic::Internal::Type::Converter
 
         abstract!

data/rbi/lib/lithic/internal/util.rbi

@@ -68,13 +68,19 @@ module Lithic
         sig do
           params(
             data: T.any(Lithic::Internal::AnyHash, T::Array[T.anything], T.anything),
-            pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
-            sentinel: T.nilable(T.anything),
+            pick: T.nilable(
+              T.any(
+                Symbol,
+                Integer,
+                T::Array[T.any(Symbol, Integer)],
+                T.proc.params(arg0: T.anything).returns(T.anything)
+              )
+            ),
             blk: T.nilable(T.proc.returns(T.anything))
           )
             .returns(T.nilable(T.anything))
         end
-        def dig(data, pick, sentinel = nil, &blk); end
+        def dig(data, pick, &blk); end
       end
 
       class << self
@@ -140,22 +146,6 @@ module Lithic
         def normalized_headers(*headers); end
       end
 
-      # @api private
-      class SerializationAdapter
-        sig { returns(T.any(Pathname, IO)) }
-        attr_reader :inner
-
-        sig { params(a: T.anything).returns(String) }
-        def to_json(*a); end
-
-        sig { params(a: T.anything).returns(String) }
-        def to_yaml(*a); end
-
-        # @api private
-        sig { params(inner: T.any(Pathname, IO)).returns(T.attached_class) }
-        def self.new(inner); end
-      end
-
       # @api private
       #
       # An adapter that satisfies the IO interface required by `::IO.copy_stream`
@@ -192,7 +182,22 @@ module Lithic
         def writable_enum(&blk); end
       end
 
+      JSON_CONTENT = T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+      JSONL_CONTENT = T.let(%r{^application/(?:x-)?jsonl}, Regexp)
+
       class << self
+        # @api private
+        sig do
+          params(
+            y: Enumerator::Yielder,
+            val: T.anything,
+            closing: T::Array[T.proc.void],
+            content_type: T.nilable(String)
+          )
+            .void
+        end
+        private def write_multipart_content(y, val:, closing:, content_type: nil); end
+
         # @api private
         sig do
           params(

data/rbi/lib/lithic/models/account.rbi

@@ -86,12 +86,37 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the account. This is the same as the
+        # account_token returned by the enroll endpoint. If using this parameter, do not
+        # include pagination.
         token:,
+        # Timestamp of when the account was created.
         created:,
+        # Spend limit information for the user containing the daily, monthly, and lifetime
+        # spend limit of the account. Any charges to a card owned by this account will be
+        # declined once their transaction volume has surpassed the value in the applicable
+        # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
+        # feature is disabled.
         spend_limit:,
+        # Account state:
+        #
+        # - `ACTIVE` - Account is able to transact and create new cards.
+        # - `PAUSED` - Account will not be able to transact or create new cards. It can be
+        #   set back to `ACTIVE`.
+        # - `CLOSED` - Account will not be able to transact or create new cards. `CLOSED`
+        #   accounts are also unable to be transitioned to `ACTIVE` or `PAUSED` states.
+        #   `CLOSED` accounts result from failing to pass KYB/KYC or Lithic closing for
+        #   risk/compliance reasons. Please contact
+        #   [support@lithic.com](mailto:support@lithic.com) if you believe this was in
+        #   error.
         state:,
         account_holder: nil,
+        # List of identifiers for the Auth Rule(s) that are applied on the account. This
+        # field is deprecated and will no longer be populated in the `account_holder`
+        # object. The key will be removed from the schema in a future release. Use the
+        # `/auth_rules` endpoints to fetch Auth Rule information instead.
         auth_rule_tokens: nil,
+        # 3-character alphabetic ISO 4217 code for the currency of the cardholder.
         cardholder_currency: nil,
         verification_address: nil
       ); end
@@ -131,8 +156,14 @@ module Lithic
         # time limit (rolling). A lifetime limit of 0 indicates that the lifetime limit
         # feature is disabled.
         sig { params(daily: Integer, lifetime: Integer, monthly: Integer).returns(T.attached_class) }
-        def self.new(daily:, lifetime:, monthly:); end
-
+        def self.new(
+          # Daily spend limit (in cents).
+          daily:,
+          # Total spend limit over account lifetime (in cents).
+          lifetime:,
+          # Monthly spend limit (in cents).
+          monthly:
+        ); end
         sig { override.returns({daily: Integer, lifetime: Integer, monthly: Integer}) }
         def to_hash; end
       end
@@ -185,8 +216,18 @@ module Lithic
           params(token: String, business_account_token: String, email: String, phone_number: String)
             .returns(T.attached_class)
         end
-        def self.new(token:, business_account_token:, email:, phone_number:); end
-
+        def self.new(
+          # Globally unique identifier for the account holder.
+          token:,
+          # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+          # users of businesses. Account_token of the enrolled business associated with an
+          # enrolled AUTHORIZED_USER individual.
+          business_account_token:,
+          # Email address.
+          email:,
+          # Phone number of the individual.
+          phone_number:
+        ); end
         sig do
           override.returns(
             {
@@ -242,8 +283,23 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address1:, city:, country:, postal_code:, state:, address2: nil); end
-
+        def self.new(
+          # Valid deliverable address (no PO boxes).
+          address1:,
+          # City name.
+          city:,
+          # Country name. Only USA is currently supported.
+          country:,
+          # Valid postal code. Only USA postal codes (ZIP codes) are currently supported,
+          # entered as a five-digit postal code or nine-digit postal code (ZIP+4) using the
+          # format 12345-1234.
+          postal_code:,
+          # Valid state code. Only USA state codes are currently supported, entered in
+          # uppercase ISO 3166-2 two-character format.
+          state:,
+          # Unit or apartment number (if applicable).
+          address2: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/account_holder.rbi

@@ -219,25 +219,78 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for the account holder.
         token:,
+        # Timestamp of when the account holder was created.
         created:,
+        # Globally unique identifier for the account.
         account_token: nil,
+        # Deprecated.
         beneficial_owner_entities: nil,
+        # 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
+        # 4 beneficial owners can be submitted. If no individual owns 25% of the company
+        # you do not need to send beneficial owner information. See
+        # [FinCEN requirements](https://www.fincen.gov/sites/default/files/shared/CDD_Rev6.7_Sept_2017_Certificate.pdf)
+        # (Section I) for more background on individuals that should be included.
         beneficial_owner_individuals: nil,
+        # Only applicable for customers using the KYC-Exempt workflow to enroll authorized
+        # users of businesses. Pass the account_token of the enrolled business associated
+        # with the AUTHORIZED_USER in this field.
         business_account_token: nil,
+        # Only present when user_type == "BUSINESS". Information about the business for
+        # which the account is being opened and KYB is being run.
         business_entity: nil,
+        # Only present when user_type == "BUSINESS". An individual with significant
+        # responsibility for managing the legal entity (e.g., a Chief Executive Officer,
+        # Chief Financial Officer, Chief Operating Officer, Managing Member, General
+        # Partner, President, Vice President, or Treasurer). This can be an executive, or
+        # someone who will have program-wide access to the cards that Lithic will provide.
+        # In some cases, this individual could also be a beneficial owner listed above.
         control_person: nil,
+        # < Deprecated. Use control_person.email when user_type == "BUSINESS". Use
+        # individual.phone_number when user_type == "INDIVIDUAL".
+        #
+        # > Primary email of Account Holder.
         email: nil,
+        # The type of KYC exemption for a KYC-Exempt Account Holder.
         exemption_type: nil,
+        # Customer-provided token that indicates a relationship with an object outside of
+        # the Lithic ecosystem.
         external_id: nil,
+        # Only present when user_type == "INDIVIDUAL". Information about the individual
+        # for which the account is being opened and KYC is being run.
         individual: nil,
+        # Only present when user_type == "BUSINESS". User-submitted description of the
+        # business.
         nature_of_business: nil,
+        # < Deprecated. Use control_person.phone_number when user_type == "BUSINESS". Use
+        # individual.phone_number when user_type == "INDIVIDUAL".
+        #
+        # > Primary phone of Account Holder, entered in E.164 format.
         phone_number: nil,
+        # Only present for "KYB_BASIC" workflow. A list of documents required for the
+        # account holder to be approved.
         required_documents: nil,
+        # <Deprecated. Use verification_application.status instead>
+        #
+        # KYC and KYB evaluation states.
+        #
+        # Note:
+        #
+        # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
         status: nil,
+        # <Deprecated. Use verification_application.status_reasons> Reason for the
+        # evaluation status.
         status_reasons: nil,
+        # The type of Account Holder. If the type is "INDIVIDUAL", the "individual"
+        # attribute will be present. If the type is "BUSINESS" then the "business_entity",
+        # "control_person", "beneficial_owner_individuals", "nature_of_business", and
+        # "website_url" attributes will be present.
         user_type: nil,
+        # Information about the most recent identity verification attempt
         verification_application: nil,
+        # Only present when user_type == "BUSINESS". Business's primary website.
         website_url: nil
       ); end
       sig do
@@ -322,12 +375,24 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name:,
+          # Globally unique identifier for the entity.
           entity_token:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do
@@ -394,8 +459,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
-
+        def self.new(
+          # Individual's current address
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address.
+          email:,
+          # Globally unique identifier for the entity.
+          entity_token:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:
+        ); end
         sig do
           override
             .returns(
@@ -468,12 +547,24 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Business's physical address - PO boxes, UPS drops, and FedEx drops are not
+          # acceptable; APO/FPO are acceptable.
           address:,
+          # Any name that the business operates under that is not its legal business name
+          # (if applicable).
           dba_business_name:,
+          # Globally unique identifier for the entity.
           entity_token:,
+          # Government-issued identification number. US Federal Employer Identification
+          # Numbers (EIN) are currently supported, entered as full nine-digits, with or
+          # without hyphens.
           government_id:,
+          # Legal (formal) business name.
           legal_business_name:,
+          # One or more of the business's phone number(s), entered as a list in E.164
+          # format.
           phone_numbers:,
+          # Parent company name (if applicable).
           parent_company: nil
         ); end
         sig do
@@ -543,8 +634,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
-
+        def self.new(
+          # Individual's current address
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address.
+          email:,
+          # Globally unique identifier for the entity.
+          entity_token:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:
+        ); end
         sig do
           override
             .returns(
@@ -622,8 +727,22 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(address:, dob:, email:, entity_token:, first_name:, last_name:, phone_number:); end
-
+        def self.new(
+          # Individual's current address
+          address:,
+          # Individual's date of birth, as an RFC 3339 date.
+          dob:,
+          # Individual's email address.
+          email:,
+          # Globally unique identifier for the entity.
+          entity_token:,
+          # Individual's first name, as it appears on government-issued identity documents.
+          first_name:,
+          # Individual's last name, as it appears on government-issued identity documents.
+          last_name:,
+          # Individual's phone number, entered in E.164 format.
+          phone_number:
+        ); end
         sig do
           override
             .returns(
@@ -766,8 +885,20 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(created: nil, status: nil, status_reasons: nil, updated: nil); end
-
+        def self.new(
+          # Timestamp of when the application was created.
+          created: nil,
+          # KYC and KYB evaluation states.
+          #
+          # Note:
+          #
+          # - `PENDING_REVIEW` is only applicable for the `KYB_BASIC` workflow.
+          status: nil,
+          # Reason for the evaluation status.
+          status_reasons: nil,
+          # Timestamp of when the application was last updated.
+          updated: nil
+        ); end
         sig do
           override
             .returns(