lithic 0.1.0.pre.alpha.39 → 0.1.0.pre.alpha.41

data/rbi/lithic/models/book_transfer_create_params.rbi

@@ -11,7 +11,7 @@ module Lithic
           T.any(Lithic::BookTransferCreateParams, Lithic::Internal::AnyHash)
         end
 
-      # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+      # Amount to be transferred in the currency's smallest unit (e.g., cents for USD).
       # This should always be a positive value.
       sig { returns(Integer) }
       attr_accessor :amount
@@ -34,7 +34,7 @@ module Lithic
       sig { returns(String) }
       attr_accessor :to_financial_account_token
 
-      # Type of book_transfer
+      # Type of the book transfer
       sig { returns(Lithic::BookTransferCreateParams::Type::OrSymbol) }
       attr_accessor :type
 
@@ -46,6 +46,13 @@ module Lithic
       sig { params(token: String).void }
       attr_writer :token
 
+      # External ID defined by the customer
+      sig { returns(T.nilable(String)) }
+      attr_reader :external_id
+
+      sig { params(external_id: String).void }
+      attr_writer :external_id
+
       # Optional descriptor for the transfer.
       sig { returns(T.nilable(String)) }
       attr_reader :memo
@@ -53,6 +60,22 @@ module Lithic
       sig { params(memo: String).void }
       attr_writer :memo
 
+      # What to do if the financial account is closed when posting an operation
+      sig do
+        returns(
+          T.nilable(Lithic::BookTransferCreateParams::OnClosedAccount::OrSymbol)
+        )
+      end
+      attr_reader :on_closed_account
+
+      sig do
+        params(
+          on_closed_account:
+            Lithic::BookTransferCreateParams::OnClosedAccount::OrSymbol
+        ).void
+      end
+      attr_writer :on_closed_account
+
       sig do
         params(
           amount: Integer,
@@ -62,12 +85,15 @@ module Lithic
           to_financial_account_token: String,
           type: Lithic::BookTransferCreateParams::Type::OrSymbol,
           token: String,
+          external_id: String,
           memo: String,
+          on_closed_account:
+            Lithic::BookTransferCreateParams::OnClosedAccount::OrSymbol,
           request_options: Lithic::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
+        # Amount to be transferred in the currency's smallest unit (e.g., cents for USD).
         # This should always be a positive value.
         amount:,
         # Category of the book transfer
@@ -80,13 +106,17 @@ module Lithic
         # Globally unique identifier for the financial account or card that will receive
         # the funds. Accepted type dependent on the program's use case.
         to_financial_account_token:,
-        # Type of book_transfer
+        # Type of the book transfer
         type:,
         # Customer-provided token that will serve as an idempotency token. This token will
         # become the transaction token.
         token: nil,
+        # External ID defined by the customer
+        external_id: nil,
         # Optional descriptor for the transfer.
         memo: nil,
+        # What to do if the financial account is closed when posting an operation
+        on_closed_account: nil,
         request_options: {}
       )
       end
@@ -101,7 +131,10 @@ module Lithic
             to_financial_account_token: String,
             type: Lithic::BookTransferCreateParams::Type::OrSymbol,
             token: String,
+            external_id: String,
             memo: String,
+            on_closed_account:
+              Lithic::BookTransferCreateParams::OnClosedAccount::OrSymbol,
             request_options: Lithic::RequestOptions
           }
         )
@@ -161,7 +194,7 @@ module Lithic
         end
       end
 
-      # Type of book_transfer
+      # Type of the book transfer
       module Type
         extend Lithic::Internal::Type::Enum
 
@@ -316,6 +349,11 @@ module Lithic
           T.let(:SERVICE, Lithic::BookTransferCreateParams::Type::TaggedSymbol)
         TRANSFER =
           T.let(:TRANSFER, Lithic::BookTransferCreateParams::Type::TaggedSymbol)
+        COLLECTION =
+          T.let(
+            :COLLECTION,
+            Lithic::BookTransferCreateParams::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -325,6 +363,38 @@ module Lithic
         def self.values
         end
       end
+
+      # What to do if the financial account is closed when posting an operation
+      module OnClosedAccount
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::BookTransferCreateParams::OnClosedAccount)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        FAIL =
+          T.let(
+            :FAIL,
+            Lithic::BookTransferCreateParams::OnClosedAccount::TaggedSymbol
+          )
+        USE_SUSPENSE =
+          T.let(
+            :USE_SUSPENSE,
+            Lithic::BookTransferCreateParams::OnClosedAccount::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::BookTransferCreateParams::OnClosedAccount::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/lithic/models/book_transfer_response.rbi

@@ -30,19 +30,34 @@ module Lithic
       sig { returns(T::Array[Lithic::BookTransferResponse::Event]) }
       attr_accessor :events
 
+      # External ID defined by the customer
+      sig { returns(T.nilable(String)) }
+      attr_accessor :external_id
+
+      # External resource associated with the management operation
+      sig { returns(T.nilable(Lithic::ExternalResource)) }
+      attr_reader :external_resource
+
+      sig do
+        params(
+          external_resource: T.nilable(Lithic::ExternalResource::OrHash)
+        ).void
+      end
+      attr_writer :external_resource
+
       # Globally unique identifier for the financial account or card that will send the
       # funds. Accepted type dependent on the program's use case.
       sig { returns(String) }
       attr_accessor :from_financial_account_token
 
       # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
-      # including any acquirer fees. The value of this field will go to zero over time
-      # once the financial transaction is settled.
+      # including any acquirer fees.
+      #
+      # The value of this field will go to zero over time once the financial transaction
+      # is settled.
       sig { returns(Integer) }
       attr_accessor :pending_amount
 
-      # APPROVED transactions were successful while DECLINED transactions were declined
-      # by user, Lithic, or the network.
       sig { returns(Lithic::BookTransferResponse::Result::TaggedSymbol) }
       attr_accessor :result
 
@@ -51,16 +66,33 @@ module Lithic
       sig { returns(Integer) }
       attr_accessor :settled_amount
 
-      # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
-      # transfer was reversed \* `SETTLED` - The transfer is completed.
+      # Status types:
+      #
+      # - `DECLINED` - The transfer was declined.
+      # - `REVERSED` - The transfer was reversed
+      # - `SETTLED` - The transfer is completed.
       sig { returns(Lithic::BookTransferResponse::Status::TaggedSymbol) }
       attr_accessor :status
 
       # Globally unique identifier for the financial account or card that will receive
       # the funds. Accepted type dependent on the program's use case.
-      sig { returns(T.anything) }
+      sig { returns(String) }
       attr_accessor :to_financial_account_token
 
+      # A series of transactions that are grouped together.
+      sig do
+        returns(T.nilable(Lithic::BookTransferResponse::TransactionSeries))
+      end
+      attr_reader :transaction_series
+
+      sig do
+        params(
+          transaction_series:
+            T.nilable(Lithic::BookTransferResponse::TransactionSeries::OrHash)
+        ).void
+      end
+      attr_writer :transaction_series
+
       # Date and time when the financial transaction was last updated. UTC time zone.
       sig { returns(Time) }
       attr_accessor :updated
@@ -72,12 +104,16 @@ module Lithic
           created: Time,
           currency: String,
           events: T::Array[Lithic::BookTransferResponse::Event::OrHash],
+          external_id: T.nilable(String),
+          external_resource: T.nilable(Lithic::ExternalResource::OrHash),
           from_financial_account_token: String,
           pending_amount: Integer,
           result: Lithic::BookTransferResponse::Result::OrSymbol,
           settled_amount: Integer,
           status: Lithic::BookTransferResponse::Status::OrSymbol,
-          to_financial_account_token: T.anything,
+          to_financial_account_token: String,
+          transaction_series:
+            T.nilable(Lithic::BookTransferResponse::TransactionSeries::OrHash),
           updated: Time
         ).returns(T.attached_class)
       end
@@ -94,25 +130,34 @@ module Lithic
         currency:,
         # A list of all financial events that have modified this transfer.
         events:,
+        # External ID defined by the customer
+        external_id:,
+        # External resource associated with the management operation
+        external_resource:,
         # Globally unique identifier for the financial account or card that will send the
         # funds. Accepted type dependent on the program's use case.
         from_financial_account_token:,
         # Pending amount of the transaction in the currency's smallest unit (e.g., cents),
-        # including any acquirer fees. The value of this field will go to zero over time
-        # once the financial transaction is settled.
+        # including any acquirer fees.
+        #
+        # The value of this field will go to zero over time once the financial transaction
+        # is settled.
         pending_amount:,
-        # APPROVED transactions were successful while DECLINED transactions were declined
-        # by user, Lithic, or the network.
         result:,
         # Amount of the transaction that has been settled in the currency's smallest unit
         # (e.g., cents).
         settled_amount:,
-        # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
-        # transfer was reversed \* `SETTLED` - The transfer is completed.
+        # Status types:
+        #
+        # - `DECLINED` - The transfer was declined.
+        # - `REVERSED` - The transfer was reversed
+        # - `SETTLED` - The transfer is completed.
         status:,
         # Globally unique identifier for the financial account or card that will receive
         # the funds. Accepted type dependent on the program's use case.
         to_financial_account_token:,
+        # A series of transactions that are grouped together.
+        transaction_series:,
         # Date and time when the financial transaction was last updated. UTC time zone.
         updated:
       )
@@ -126,12 +171,16 @@ module Lithic
             created: Time,
             currency: String,
             events: T::Array[Lithic::BookTransferResponse::Event],
+            external_id: T.nilable(String),
+            external_resource: T.nilable(Lithic::ExternalResource),
             from_financial_account_token: String,
             pending_amount: Integer,
             result: Lithic::BookTransferResponse::Result::TaggedSymbol,
             settled_amount: Integer,
             status: Lithic::BookTransferResponse::Status::TaggedSymbol,
-            to_financial_account_token: T.anything,
+            to_financial_account_token: String,
+            transaction_series:
+              T.nilable(Lithic::BookTransferResponse::TransactionSeries),
             updated: Time
           }
         )
@@ -201,12 +250,9 @@ module Lithic
         sig { returns(Time) }
         attr_accessor :created
 
-        # Detailed Results
         sig do
           returns(
-            T::Array[
-              Lithic::BookTransferResponse::Event::DetailedResult::TaggedSymbol
-            ]
+            Lithic::BookTransferResponse::Event::DetailedResults::TaggedSymbol
           )
         end
         attr_accessor :detailed_results
@@ -227,22 +273,21 @@ module Lithic
         attr_accessor :subtype
 
         # Type of the book transfer
-        sig { returns(String) }
+        sig { returns(Lithic::BookTransferResponse::Event::Type::TaggedSymbol) }
         attr_accessor :type
 
+        # Book transfer Event
         sig do
           params(
             token: String,
             amount: Integer,
             created: Time,
             detailed_results:
-              T::Array[
-                Lithic::BookTransferResponse::Event::DetailedResult::OrSymbol
-              ],
+              Lithic::BookTransferResponse::Event::DetailedResults::OrSymbol,
             memo: String,
             result: Lithic::BookTransferResponse::Event::Result::OrSymbol,
             subtype: String,
-            type: String
+            type: Lithic::BookTransferResponse::Event::Type::OrSymbol
           ).returns(T.attached_class)
         end
         def self.new(
@@ -253,7 +298,6 @@ module Lithic
           amount:,
           # Date and time when the financial event occurred. UTC time zone.
           created:,
-          # Detailed Results
           detailed_results:,
           # Memo for the transfer.
           memo:,
@@ -274,43 +318,44 @@ module Lithic
               amount: Integer,
               created: Time,
               detailed_results:
-                T::Array[
-                  Lithic::BookTransferResponse::Event::DetailedResult::TaggedSymbol
-                ],
+                Lithic::BookTransferResponse::Event::DetailedResults::TaggedSymbol,
               memo: String,
               result: Lithic::BookTransferResponse::Event::Result::TaggedSymbol,
               subtype: String,
-              type: String
+              type: Lithic::BookTransferResponse::Event::Type::TaggedSymbol
             }
           )
         end
         def to_hash
         end
 
-        module DetailedResult
+        module DetailedResults
           extend Lithic::Internal::Type::Enum
 
           TaggedSymbol =
             T.type_alias do
-              T.all(Symbol, Lithic::BookTransferResponse::Event::DetailedResult)
+              T.all(
+                Symbol,
+                Lithic::BookTransferResponse::Event::DetailedResults
+              )
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
           APPROVED =
             T.let(
               :APPROVED,
-              Lithic::BookTransferResponse::Event::DetailedResult::TaggedSymbol
+              Lithic::BookTransferResponse::Event::DetailedResults::TaggedSymbol
             )
           FUNDS_INSUFFICIENT =
             T.let(
               :FUNDS_INSUFFICIENT,
-              Lithic::BookTransferResponse::Event::DetailedResult::TaggedSymbol
+              Lithic::BookTransferResponse::Event::DetailedResults::TaggedSymbol
             )
 
           sig do
             override.returns(
               T::Array[
-                Lithic::BookTransferResponse::Event::DetailedResult::TaggedSymbol
+                Lithic::BookTransferResponse::Event::DetailedResults::TaggedSymbol
               ]
             )
           end
@@ -350,10 +395,198 @@ module Lithic
           def self.values
           end
         end
+
+        # Type of the book transfer
+        module Type
+          extend Lithic::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Lithic::BookTransferResponse::Event::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ATM_WITHDRAWAL =
+            T.let(
+              :ATM_WITHDRAWAL,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ATM_DECLINE =
+            T.let(
+              :ATM_DECLINE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          INTERNATIONAL_ATM_WITHDRAWAL =
+            T.let(
+              :INTERNATIONAL_ATM_WITHDRAWAL,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          INACTIVITY =
+            T.let(
+              :INACTIVITY,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          STATEMENT =
+            T.let(
+              :STATEMENT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          MONTHLY =
+            T.let(
+              :MONTHLY,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          QUARTERLY =
+            T.let(
+              :QUARTERLY,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ANNUAL =
+            T.let(
+              :ANNUAL,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CUSTOMER_SERVICE =
+            T.let(
+              :CUSTOMER_SERVICE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ACCOUNT_MAINTENANCE =
+            T.let(
+              :ACCOUNT_MAINTENANCE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ACCOUNT_ACTIVATION =
+            T.let(
+              :ACCOUNT_ACTIVATION,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ACCOUNT_CLOSURE =
+            T.let(
+              :ACCOUNT_CLOSURE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CARD_REPLACEMENT =
+            T.let(
+              :CARD_REPLACEMENT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CARD_DELIVERY =
+            T.let(
+              :CARD_DELIVERY,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CARD_CREATE =
+            T.let(
+              :CARD_CREATE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CURRENCY_CONVERSION =
+            T.let(
+              :CURRENCY_CONVERSION,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          INTEREST =
+            T.let(
+              :INTEREST,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          LATE_PAYMENT =
+            T.let(
+              :LATE_PAYMENT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          BILL_PAYMENT =
+            T.let(
+              :BILL_PAYMENT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CASH_BACK =
+            T.let(
+              :CASH_BACK,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ACCOUNT_TO_ACCOUNT =
+            T.let(
+              :ACCOUNT_TO_ACCOUNT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          CARD_TO_CARD =
+            T.let(
+              :CARD_TO_CARD,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          DISBURSE =
+            T.let(
+              :DISBURSE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          BILLING_ERROR =
+            T.let(
+              :BILLING_ERROR,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          LOSS_WRITE_OFF =
+            T.let(
+              :LOSS_WRITE_OFF,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          EXPIRED_CARD =
+            T.let(
+              :EXPIRED_CARD,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          EARLY_DERECOGNITION =
+            T.let(
+              :EARLY_DERECOGNITION,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          ESCHEATMENT =
+            T.let(
+              :ESCHEATMENT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          INACTIVITY_FEE_DOWN =
+            T.let(
+              :INACTIVITY_FEE_DOWN,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          PROVISIONAL_CREDIT =
+            T.let(
+              :PROVISIONAL_CREDIT,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          DISPUTE_WON =
+            T.let(
+              :DISPUTE_WON,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          SERVICE =
+            T.let(
+              :SERVICE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          TRANSFER =
+            T.let(
+              :TRANSFER,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          COLLECTION =
+            T.let(
+              :COLLECTION,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Lithic::BookTransferResponse::Event::Type::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
-      # APPROVED transactions were successful while DECLINED transactions were declined
-      # by user, Lithic, or the network.
       module Result
         extend Lithic::Internal::Type::Enum
 
@@ -375,8 +608,11 @@ module Lithic
         end
       end
 
-      # Status types: _ `DECLINED` - The transfer was declined. _ `REVERSED` - The
-      # transfer was reversed \* `SETTLED` - The transfer is completed.
+      # Status types:
+      #
+      # - `DECLINED` - The transfer was declined.
+      # - `REVERSED` - The transfer was reversed
+      # - `SETTLED` - The transfer is completed.
       module Status
         extend Lithic::Internal::Type::Enum
 
@@ -399,6 +635,52 @@ module Lithic
         def self.values
         end
       end
+
+      class TransactionSeries < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::BookTransferResponse::TransactionSeries,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :related_transaction_event_token
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :related_transaction_token
+
+        sig { returns(String) }
+        attr_accessor :type
+
+        # A series of transactions that are grouped together.
+        sig do
+          params(
+            related_transaction_event_token: T.nilable(String),
+            related_transaction_token: T.nilable(String),
+            type: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          related_transaction_event_token:,
+          related_transaction_token:,
+          type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              related_transaction_event_token: T.nilable(String),
+              related_transaction_token: T.nilable(String),
+              type: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end