lithic 0.1.0.pre.alpha.1

data/rbi/lib/lithic/models/balance.rbi

@@ -0,0 +1,117 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class Balance < Lithic::BaseModel
+      # Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+      sig { returns(Integer) }
+      attr_accessor :available_amount
+
+      # Date and time for when the balance was first created.
+      sig { returns(Time) }
+      attr_accessor :created
+
+      # 3-character alphabetic ISO 4217 code for the local currency of the balance.
+      sig { returns(String) }
+      attr_accessor :currency
+
+      # Globally unique identifier for the financial account that holds this balance.
+      sig { returns(String) }
+      attr_accessor :financial_account_token
+
+      # Type of financial account.
+      sig { returns(Lithic::Models::Balance::FinancialAccountType::TaggedSymbol) }
+      attr_accessor :financial_account_type
+
+      # Globally unique identifier for the last financial transaction event that
+      #   impacted this balance.
+      sig { returns(String) }
+      attr_accessor :last_transaction_event_token
+
+      # Globally unique identifier for the last financial transaction that impacted this
+      #   balance.
+      sig { returns(String) }
+      attr_accessor :last_transaction_token
+
+      # Funds not available for spend due to card authorizations or pending ACH release.
+      #   Shown in the currency's smallest unit (e.g., cents for USD).
+      sig { returns(Integer) }
+      attr_accessor :pending_amount
+
+      # The sum of available and pending balance in the currency's smallest unit (e.g.,
+      #   cents for USD).
+      sig { returns(Integer) }
+      attr_accessor :total_amount
+
+      # Date and time for when the balance was last updated.
+      sig { returns(Time) }
+      attr_accessor :updated
+
+      # Balance
+      sig do
+        params(
+          available_amount: Integer,
+          created: Time,
+          currency: String,
+          financial_account_token: String,
+          financial_account_type: Lithic::Models::Balance::FinancialAccountType::OrSymbol,
+          last_transaction_event_token: String,
+          last_transaction_token: String,
+          pending_amount: Integer,
+          total_amount: Integer,
+          updated: Time
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        available_amount:,
+        created:,
+        currency:,
+        financial_account_token:,
+        financial_account_type:,
+        last_transaction_event_token:,
+        last_transaction_token:,
+        pending_amount:,
+        total_amount:,
+        updated:
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              available_amount: Integer,
+              created: Time,
+              currency: String,
+              financial_account_token: String,
+              financial_account_type: Lithic::Models::Balance::FinancialAccountType::TaggedSymbol,
+              last_transaction_event_token: String,
+              last_transaction_token: String,
+              pending_amount: Integer,
+              total_amount: Integer,
+              updated: Time
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Type of financial account.
+      module FinancialAccountType
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::Balance::FinancialAccountType) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::Balance::FinancialAccountType::TaggedSymbol) }
+
+        ISSUING = T.let(:ISSUING, Lithic::Models::Balance::FinancialAccountType::TaggedSymbol)
+        OPERATING = T.let(:OPERATING, Lithic::Models::Balance::FinancialAccountType::TaggedSymbol)
+        RESERVE = T.let(:RESERVE, Lithic::Models::Balance::FinancialAccountType::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::Balance::FinancialAccountType::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/balance_list_params.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class BalanceListParams < Lithic::BaseModel
+      extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # List balances for all financial accounts of a given account_token.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_token
+
+      sig { params(account_token: String).void }
+      attr_writer :account_token
+
+      # UTC date and time of the balances to retrieve. Defaults to latest available
+      #   balances
+      sig { returns(T.nilable(Time)) }
+      attr_reader :balance_date
+
+      sig { params(balance_date: Time).void }
+      attr_writer :balance_date
+
+      # List balances for all financial accounts of a given business_account_token.
+      sig { returns(T.nilable(String)) }
+      attr_reader :business_account_token
+
+      sig { params(business_account_token: String).void }
+      attr_writer :business_account_token
+
+      # List balances for a given Financial Account type.
+      sig { returns(T.nilable(Lithic::Models::BalanceListParams::FinancialAccountType::OrSymbol)) }
+      attr_reader :financial_account_type
+
+      sig { params(financial_account_type: Lithic::Models::BalanceListParams::FinancialAccountType::OrSymbol).void }
+      attr_writer :financial_account_type
+
+      sig do
+        params(
+          account_token: String,
+          balance_date: Time,
+          business_account_token: String,
+          financial_account_type: Lithic::Models::BalanceListParams::FinancialAccountType::OrSymbol,
+          request_options: T.any(Lithic::RequestOptions, Lithic::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        account_token: nil,
+        balance_date: nil,
+        business_account_token: nil,
+        financial_account_type: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              account_token: String,
+              balance_date: Time,
+              business_account_token: String,
+              financial_account_type: Lithic::Models::BalanceListParams::FinancialAccountType::OrSymbol,
+              request_options: Lithic::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # List balances for a given Financial Account type.
+      module FinancialAccountType
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BalanceListParams::FinancialAccountType) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, Lithic::Models::BalanceListParams::FinancialAccountType::TaggedSymbol) }
+
+        ISSUING = T.let(:ISSUING, Lithic::Models::BalanceListParams::FinancialAccountType::TaggedSymbol)
+        OPERATING = T.let(:OPERATING, Lithic::Models::BalanceListParams::FinancialAccountType::TaggedSymbol)
+        RESERVE = T.let(:RESERVE, Lithic::Models::BalanceListParams::FinancialAccountType::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BalanceListParams::FinancialAccountType::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/book_transfer_create_params.rbi

@@ -0,0 +1,173 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class BookTransferCreateParams < Lithic::BaseModel
+      extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # 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
+
+      # Category of the book transfer
+      sig { returns(Lithic::Models::BookTransferCreateParams::Category::OrSymbol) }
+      attr_accessor :category
+
+      # 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
+
+      # The program specific subtype code for the specified category/type.
+      sig { returns(String) }
+      attr_accessor :subtype
+
+      # 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(String) }
+      attr_accessor :to_financial_account_token
+
+      # Type of book_transfer
+      sig { returns(Lithic::Models::BookTransferCreateParams::Type::OrSymbol) }
+      attr_accessor :type
+
+      # Customer-provided token that will serve as an idempotency token. This token will
+      #   become the transaction token.
+      sig { returns(T.nilable(String)) }
+      attr_reader :token
+
+      sig { params(token: String).void }
+      attr_writer :token
+
+      # Optional descriptor for the transfer.
+      sig { returns(T.nilable(String)) }
+      attr_reader :memo
+
+      sig { params(memo: String).void }
+      attr_writer :memo
+
+      sig do
+        params(
+          amount: Integer,
+          category: Lithic::Models::BookTransferCreateParams::Category::OrSymbol,
+          from_financial_account_token: String,
+          subtype: String,
+          to_financial_account_token: String,
+          type: Lithic::Models::BookTransferCreateParams::Type::OrSymbol,
+          token: String,
+          memo: String,
+          request_options: T.any(Lithic::RequestOptions, Lithic::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        amount:,
+        category:,
+        from_financial_account_token:,
+        subtype:,
+        to_financial_account_token:,
+        type:,
+        token: nil,
+        memo: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              amount: Integer,
+              category: Lithic::Models::BookTransferCreateParams::Category::OrSymbol,
+              from_financial_account_token: String,
+              subtype: String,
+              to_financial_account_token: String,
+              type: Lithic::Models::BookTransferCreateParams::Type::OrSymbol,
+              token: String,
+              memo: String,
+              request_options: Lithic::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Category of the book transfer
+      module Category
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BookTransferCreateParams::Category) }
+        OrSymbol =
+          T.type_alias { T.any(Symbol, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol) }
+
+        ADJUSTMENT = T.let(:ADJUSTMENT, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        BALANCE_OR_FUNDING =
+          T.let(:BALANCE_OR_FUNDING, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        DERECOGNITION = T.let(:DERECOGNITION, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        DISPUTE = T.let(:DISPUTE, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        FEE = T.let(:FEE, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        REWARD = T.let(:REWARD, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+        TRANSFER = T.let(:TRANSFER, Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BookTransferCreateParams::Category::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      # Type of book_transfer
+      module Type
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BookTransferCreateParams::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol) }
+
+        ATM_WITHDRAWAL = T.let(:ATM_WITHDRAWAL, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ATM_DECLINE = T.let(:ATM_DECLINE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        INTERNATIONAL_ATM_WITHDRAWAL =
+          T.let(:INTERNATIONAL_ATM_WITHDRAWAL, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        INACTIVITY = T.let(:INACTIVITY, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        STATEMENT = T.let(:STATEMENT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        MONTHLY = T.let(:MONTHLY, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        QUARTERLY = T.let(:QUARTERLY, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ANNUAL = T.let(:ANNUAL, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CUSTOMER_SERVICE = T.let(:CUSTOMER_SERVICE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ACCOUNT_MAINTENANCE =
+          T.let(:ACCOUNT_MAINTENANCE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ACCOUNT_ACTIVATION =
+          T.let(:ACCOUNT_ACTIVATION, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ACCOUNT_CLOSURE = T.let(:ACCOUNT_CLOSURE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CARD_REPLACEMENT = T.let(:CARD_REPLACEMENT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CARD_DELIVERY = T.let(:CARD_DELIVERY, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CARD_CREATE = T.let(:CARD_CREATE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CURRENCY_CONVERSION =
+          T.let(:CURRENCY_CONVERSION, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        INTEREST = T.let(:INTEREST, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        LATE_PAYMENT = T.let(:LATE_PAYMENT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        BILL_PAYMENT = T.let(:BILL_PAYMENT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CASH_BACK = T.let(:CASH_BACK, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ACCOUNT_TO_ACCOUNT =
+          T.let(:ACCOUNT_TO_ACCOUNT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        CARD_TO_CARD = T.let(:CARD_TO_CARD, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        DISBURSE = T.let(:DISBURSE, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        BILLING_ERROR = T.let(:BILLING_ERROR, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        LOSS_WRITE_OFF = T.let(:LOSS_WRITE_OFF, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        EXPIRED_CARD = T.let(:EXPIRED_CARD, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        EARLY_DERECOGNITION =
+          T.let(:EARLY_DERECOGNITION, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        ESCHEATMENT = T.let(:ESCHEATMENT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        INACTIVITY_FEE_DOWN =
+          T.let(:INACTIVITY_FEE_DOWN, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        PROVISIONAL_CREDIT =
+          T.let(:PROVISIONAL_CREDIT, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        DISPUTE_WON = T.let(:DISPUTE_WON, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+        TRANSFER = T.let(:TRANSFER, Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BookTransferCreateParams::Type::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lib/lithic/models/book_transfer_list_params.rbi

@@ -0,0 +1,196 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class BookTransferListParams < Lithic::BaseModel
+      extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_token
+
+      sig { params(account_token: String).void }
+      attr_writer :account_token
+
+      # Date string in RFC 3339 format. Only entries created after the specified time
+      #   will be included. UTC time zone.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :begin_
+
+      sig { params(begin_: Time).void }
+      attr_writer :begin_
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :business_account_token
+
+      sig { params(business_account_token: String).void }
+      attr_writer :business_account_token
+
+      # Book Transfer category to be returned.
+      sig { returns(T.nilable(Lithic::Models::BookTransferListParams::Category::OrSymbol)) }
+      attr_reader :category
+
+      sig { params(category: Lithic::Models::BookTransferListParams::Category::OrSymbol).void }
+      attr_writer :category
+
+      # Date string in RFC 3339 format. Only entries created before the specified time
+      #   will be included. UTC time zone.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :end_
+
+      sig { params(end_: Time).void }
+      attr_writer :end_
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :ending_before
+
+      sig { params(ending_before: String).void }
+      attr_writer :ending_before
+
+      # 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(T.nilable(String)) }
+      attr_reader :financial_account_token
+
+      sig { params(financial_account_token: String).void }
+      attr_writer :financial_account_token
+
+      # Page size (for pagination).
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      # Book transfer result to be returned.
+      sig { returns(T.nilable(Lithic::Models::BookTransferListParams::Result::OrSymbol)) }
+      attr_reader :result
+
+      sig { params(result: Lithic::Models::BookTransferListParams::Result::OrSymbol).void }
+      attr_writer :result
+
+      # 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.
+      sig { returns(T.nilable(String)) }
+      attr_reader :starting_after
+
+      sig { params(starting_after: String).void }
+      attr_writer :starting_after
+
+      # Book transfer status to be returned.
+      sig { returns(T.nilable(Lithic::Models::BookTransferListParams::Status::OrSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Lithic::Models::BookTransferListParams::Status::OrSymbol).void }
+      attr_writer :status
+
+      sig do
+        params(
+          account_token: String,
+          begin_: Time,
+          business_account_token: String,
+          category: Lithic::Models::BookTransferListParams::Category::OrSymbol,
+          end_: Time,
+          ending_before: String,
+          financial_account_token: String,
+          page_size: Integer,
+          result: Lithic::Models::BookTransferListParams::Result::OrSymbol,
+          starting_after: String,
+          status: Lithic::Models::BookTransferListParams::Status::OrSymbol,
+          request_options: T.any(Lithic::RequestOptions, Lithic::Util::AnyHash)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        account_token: nil,
+        begin_: nil,
+        business_account_token: nil,
+        category: nil,
+        end_: nil,
+        ending_before: nil,
+        financial_account_token: nil,
+        page_size: nil,
+        result: nil,
+        starting_after: nil,
+        status: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override
+          .returns(
+            {
+              account_token: String,
+              begin_: Time,
+              business_account_token: String,
+              category: Lithic::Models::BookTransferListParams::Category::OrSymbol,
+              end_: Time,
+              ending_before: String,
+              financial_account_token: String,
+              page_size: Integer,
+              result: Lithic::Models::BookTransferListParams::Result::OrSymbol,
+              starting_after: String,
+              status: Lithic::Models::BookTransferListParams::Status::OrSymbol,
+              request_options: Lithic::RequestOptions
+            }
+          )
+      end
+      def to_hash
+      end
+
+      # Book Transfer category to be returned.
+      module Category
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BookTransferListParams::Category) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::BookTransferListParams::Category::TaggedSymbol) }
+
+        BALANCE_OR_FUNDING =
+          T.let(:BALANCE_OR_FUNDING, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        FEE = T.let(:FEE, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        REWARD = T.let(:REWARD, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        ADJUSTMENT = T.let(:ADJUSTMENT, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        DERECOGNITION = T.let(:DERECOGNITION, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        DISPUTE = T.let(:DISPUTE, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+        INTERNAL = T.let(:INTERNAL, Lithic::Models::BookTransferListParams::Category::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BookTransferListParams::Category::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      # Book transfer result to be returned.
+      module Result
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BookTransferListParams::Result) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::BookTransferListParams::Result::TaggedSymbol) }
+
+        APPROVED = T.let(:APPROVED, Lithic::Models::BookTransferListParams::Result::TaggedSymbol)
+        DECLINED = T.let(:DECLINED, Lithic::Models::BookTransferListParams::Result::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BookTransferListParams::Result::TaggedSymbol]) }
+        def self.values
+        end
+      end
+
+      # Book transfer status to be returned.
+      module Status
+        extend Lithic::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Models::BookTransferListParams::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, Lithic::Models::BookTransferListParams::Status::TaggedSymbol) }
+
+        DECLINED = T.let(:DECLINED, Lithic::Models::BookTransferListParams::Status::TaggedSymbol)
+        SETTLED = T.let(:SETTLED, Lithic::Models::BookTransferListParams::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[Lithic::Models::BookTransferListParams::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end