lithic 0.1.0.pre.alpha.1

data/lib/lithic/models/card_update_params.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class CardUpdateParams < Lithic::BaseModel
+      # @!parse
+      #   extend Lithic::RequestParameters::Converter
+      include Lithic::RequestParameters
+
+      # @!attribute [r] digital_card_art_token
+      #   Specifies the digital card art to be displayed in the user’s digital wallet
+      #     after tokenization. This artwork must be approved by Mastercard and configured
+      #     by Lithic to use. See
+      #     [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
+      #
+      #   @return [String, nil]
+      optional :digital_card_art_token, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :digital_card_art_token
+
+      # @!attribute [r] memo
+      #   Friendly name to identify the card.
+      #
+      #   @return [String, nil]
+      optional :memo, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :memo
+
+      # @!attribute [r] pin
+      #   Encrypted PIN block (in base64). Only applies to cards of type `PHYSICAL` and
+      #     `VIRTUAL`. Changing PIN also resets PIN status to `OK`. See
+      #     [Encrypted PIN Block](https://docs.lithic.com/docs/cards#encrypted-pin-block).
+      #
+      #   @return [String, nil]
+      optional :pin, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :pin
+
+      # @!attribute [r] pin_status
+      #   Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      #     attempts). Can only be set to `OK` to unblock a card.
+      #
+      #   @return [Symbol, Lithic::Models::CardUpdateParams::PinStatus, nil]
+      optional :pin_status, enum: -> { Lithic::Models::CardUpdateParams::PinStatus }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardUpdateParams::PinStatus]
+      #   attr_writer :pin_status
+
+      # @!attribute [r] spend_limit
+      #   Amount (in cents) to limit approved authorizations (e.g. 100000 would be a
+      #     $1,000 limit). Transaction requests above the spend limit will be declined. Note
+      #     that a spend limit of 0 is effectively no limit, and should only be used to
+      #     reset or remove a prior limit. Only a limit of 1 or above will result in
+      #     declined transactions due to checks against the card limit.
+      #
+      #   @return [Integer, nil]
+      optional :spend_limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :spend_limit
+
+      # @!attribute [r] spend_limit_duration
+      #   Spend limit duration values:
+      #
+      #     - `ANNUALLY` - Card will authorize transactions up to spend limit for the
+      #       trailing year.
+      #     - `FOREVER` - Card will authorize only up to spend limit for the entire lifetime
+      #       of the card.
+      #     - `MONTHLY` - Card will authorize transactions up to spend limit for the
+      #       trailing month. To support recurring monthly payments, which can occur on
+      #       different day every month, the time window we consider for monthly velocity
+      #       starts 6 days after the current calendar date one month prior.
+      #     - `TRANSACTION` - Card will authorize multiple transactions if each individual
+      #       transaction is under the spend limit.
+      #
+      #   @return [Symbol, Lithic::Models::SpendLimitDuration, nil]
+      optional :spend_limit_duration, enum: -> { Lithic::Models::SpendLimitDuration }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::SpendLimitDuration]
+      #   attr_writer :spend_limit_duration
+
+      # @!attribute [r] state
+      #   Card state values:
+      #
+      #     - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
+      #       be undone.
+      #     - `OPEN` - Card will approve authorizations (if they match card and account
+      #       parameters).
+      #     - `PAUSED` - Card will decline authorizations, but can be resumed at a later
+      #       time.
+      #
+      #   @return [Symbol, Lithic::Models::CardUpdateParams::State, nil]
+      optional :state, enum: -> { Lithic::Models::CardUpdateParams::State }
+
+      # @!parse
+      #   # @return [Symbol, Lithic::Models::CardUpdateParams::State]
+      #   attr_writer :state
+
+      # @!parse
+      #   # @param digital_card_art_token [String]
+      #   # @param memo [String]
+      #   # @param pin [String]
+      #   # @param pin_status [Symbol, Lithic::Models::CardUpdateParams::PinStatus]
+      #   # @param spend_limit [Integer]
+      #   # @param spend_limit_duration [Symbol, Lithic::Models::SpendLimitDuration]
+      #   # @param state [Symbol, Lithic::Models::CardUpdateParams::State]
+      #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     digital_card_art_token: nil,
+      #     memo: nil,
+      #     pin: nil,
+      #     pin_status: nil,
+      #     spend_limit: nil,
+      #     spend_limit_duration: nil,
+      #     state: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+
+      # Indicates if a card is blocked due a PIN status issue (e.g. excessive incorrect
+      #   attempts). Can only be set to `OK` to unblock a card.
+      module PinStatus
+        extend Lithic::Enum
+
+        OK = :OK
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Card state values:
+      #
+      #   - `CLOSED` - Card will no longer approve authorizations. Closing a card cannot
+      #     be undone.
+      #   - `OPEN` - Card will approve authorizations (if they match card and account
+      #     parameters).
+      #   - `PAUSED` - Card will decline authorizations, but can be resumed at a later
+      #     time.
+      module State
+        extend Lithic::Enum
+
+        CLOSED = :CLOSED
+        OPEN = :OPEN
+        PAUSED = :PAUSED
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/aggregate_balance_list_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class AggregateBalanceListParams < Lithic::BaseModel
+        # @!parse
+        #   extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        # @!attribute [r] account_token
+        #   Cardholder to retrieve aggregate balances for.
+        #
+        #   @return [String, nil]
+        optional :account_token, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :account_token
+
+        # @!attribute [r] business_account_token
+        #   Business to retrieve aggregate balances for.
+        #
+        #   @return [String, nil]
+        optional :business_account_token, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :business_account_token
+
+        # @!parse
+        #   # @param account_token [String]
+        #   # @param business_account_token [String]
+        #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(account_token: nil, business_account_token: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/aggregate_balance_list_response.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class AggregateBalanceListResponse < Lithic::BaseModel
+        # @!attribute available_amount
+        #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+        #
+        #   @return [Integer]
+        required :available_amount, Integer
+
+        # @!attribute created
+        #   Date and time for when the balance was first created.
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute currency
+        #   3-character alphabetic ISO 4217 code for the local currency of the balance.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute last_card_token
+        #   Globally unique identifier for the card that had its balance updated most
+        #     recently
+        #
+        #   @return [String]
+        required :last_card_token, String
+
+        # @!attribute last_transaction_event_token
+        #   Globally unique identifier for the last transaction event that impacted this
+        #     balance
+        #
+        #   @return [String]
+        required :last_transaction_event_token, String
+
+        # @!attribute last_transaction_token
+        #   Globally unique identifier for the last transaction that impacted this balance
+        #
+        #   @return [String]
+        required :last_transaction_token, String
+
+        # @!attribute pending_amount
+        #   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)
+        #
+        #   @return [Integer]
+        required :pending_amount, Integer
+
+        # @!attribute total_amount
+        #   The sum of available and pending balance in the currency's smallest unit (e.g.,
+        #     cents for USD)
+        #
+        #   @return [Integer]
+        required :total_amount, Integer
+
+        # @!attribute updated
+        #   Date and time for when the balance was last updated.
+        #
+        #   @return [Time]
+        required :updated, Time
+
+        # @!parse
+        #   # Card Aggregate Balance across all end-user accounts
+        #   #
+        #   # @param available_amount [Integer]
+        #   # @param created [Time]
+        #   # @param currency [String]
+        #   # @param last_card_token [String]
+        #   # @param last_transaction_event_token [String]
+        #   # @param last_transaction_token [String]
+        #   # @param pending_amount [Integer]
+        #   # @param total_amount [Integer]
+        #   # @param updated [Time]
+        #   #
+        #   def initialize(
+        #     available_amount:,
+        #     created:,
+        #     currency:,
+        #     last_card_token:,
+        #     last_transaction_event_token:,
+        #     last_transaction_token:,
+        #     pending_amount:,
+        #     total_amount:,
+        #     updated:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/balance_list_params.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class BalanceListParams < Lithic::BaseModel
+        # @!parse
+        #   extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        # @!attribute [r] balance_date
+        #   UTC date of the balance to retrieve. Defaults to latest available balance
+        #
+        #   @return [Time, nil]
+        optional :balance_date, Time
+
+        # @!parse
+        #   # @return [Time]
+        #   attr_writer :balance_date
+
+        # @!attribute [r] last_transaction_event_token
+        #   Balance after a given financial event occured. For example, passing the
+        #     event_token of a $5 CARD_CLEARING financial event will return a balance
+        #     decreased by $5
+        #
+        #   @return [String, nil]
+        optional :last_transaction_event_token, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :last_transaction_event_token
+
+        # @!parse
+        #   # @param balance_date [Time]
+        #   # @param last_transaction_event_token [String]
+        #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(balance_date: nil, last_transaction_event_token: nil, request_options: {}, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/balance_list_response.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class BalanceListResponse < Lithic::BaseModel
+        # @!attribute token
+        #   Globally unique identifier for the financial account that holds this balance.
+        #
+        #   @return [String]
+        required :token, String
+
+        # @!attribute available_amount
+        #   Funds available for spend in the currency's smallest unit (e.g., cents for USD)
+        #
+        #   @return [Integer]
+        required :available_amount, Integer
+
+        # @!attribute created
+        #   Date and time for when the balance was first created.
+        #
+        #   @return [Time]
+        required :created, Time
+
+        # @!attribute currency
+        #   3-character alphabetic ISO 4217 code for the local currency of the balance.
+        #
+        #   @return [String]
+        required :currency, String
+
+        # @!attribute last_transaction_event_token
+        #   Globally unique identifier for the last financial transaction event that
+        #     impacted this balance.
+        #
+        #   @return [String]
+        required :last_transaction_event_token, String
+
+        # @!attribute last_transaction_token
+        #   Globally unique identifier for the last financial transaction that impacted this
+        #     balance.
+        #
+        #   @return [String]
+        required :last_transaction_token, String
+
+        # @!attribute pending_amount
+        #   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).
+        #
+        #   @return [Integer]
+        required :pending_amount, Integer
+
+        # @!attribute total_amount
+        #   The sum of available and pending balance in the currency's smallest unit (e.g.,
+        #     cents for USD).
+        #
+        #   @return [Integer]
+        required :total_amount, Integer
+
+        # @!attribute type
+        #   Type of financial account.
+        #
+        #   @return [Symbol, Lithic::Models::Cards::BalanceListResponse::Type]
+        required :type, enum: -> { Lithic::Models::Cards::BalanceListResponse::Type }
+
+        # @!attribute updated
+        #   Date and time for when the balance was last updated.
+        #
+        #   @return [Time]
+        required :updated, Time
+
+        # @!parse
+        #   # Balance of a Financial Account
+        #   #
+        #   # @param token [String]
+        #   # @param available_amount [Integer]
+        #   # @param created [Time]
+        #   # @param currency [String]
+        #   # @param last_transaction_event_token [String]
+        #   # @param last_transaction_token [String]
+        #   # @param pending_amount [Integer]
+        #   # @param total_amount [Integer]
+        #   # @param type [Symbol, Lithic::Models::Cards::BalanceListResponse::Type]
+        #   # @param updated [Time]
+        #   #
+        #   def initialize(
+        #     token:,
+        #     available_amount:,
+        #     created:,
+        #     currency:,
+        #     last_transaction_event_token:,
+        #     last_transaction_token:,
+        #     pending_amount:,
+        #     total_amount:,
+        #     type:,
+        #     updated:,
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+
+        # Type of financial account.
+        module Type
+          extend Lithic::Enum
+
+          ISSUING = :ISSUING
+          OPERATING = :OPERATING
+          RESERVE = :RESERVE
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/financial_transaction_list_params.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class FinancialTransactionListParams < Lithic::BaseModel
+        # @!parse
+        #   extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        # @!attribute [r] begin_
+        #   Date string in RFC 3339 format. Only entries created after the specified time
+        #     will be included. UTC time zone.
+        #
+        #   @return [Time, nil]
+        optional :begin_, Time, api_name: :begin
+
+        # @!parse
+        #   # @return [Time]
+        #   attr_writer :begin_
+
+        # @!attribute [r] category
+        #   Financial Transaction category to be returned.
+        #
+        #   @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category, nil]
+        optional :category, enum: -> { Lithic::Models::Cards::FinancialTransactionListParams::Category }
+
+        # @!parse
+        #   # @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
+        #   attr_writer :category
+
+        # @!attribute [r] end_
+        #   Date string in RFC 3339 format. Only entries created before the specified time
+        #     will be included. UTC time zone.
+        #
+        #   @return [Time, nil]
+        optional :end_, Time, api_name: :end
+
+        # @!parse
+        #   # @return [Time]
+        #   attr_writer :end_
+
+        # @!attribute [r] ending_before
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :ending_before, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :ending_before
+
+        # @!attribute [r] result
+        #   Financial Transaction result to be returned.
+        #
+        #   @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result, nil]
+        optional :result, enum: -> { Lithic::Models::Cards::FinancialTransactionListParams::Result }
+
+        # @!parse
+        #   # @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
+        #   attr_writer :result
+
+        # @!attribute [r] starting_after
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :starting_after, String
+
+        # @!parse
+        #   # @return [String]
+        #   attr_writer :starting_after
+
+        # @!attribute [r] status
+        #   Financial Transaction status to be returned.
+        #
+        #   @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status, nil]
+        optional :status, enum: -> { Lithic::Models::Cards::FinancialTransactionListParams::Status }
+
+        # @!parse
+        #   # @return [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
+        #   attr_writer :status
+
+        # @!parse
+        #   # @param begin_ [Time]
+        #   # @param category [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Category]
+        #   # @param end_ [Time]
+        #   # @param ending_before [String]
+        #   # @param result [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Result]
+        #   # @param starting_after [String]
+        #   # @param status [Symbol, Lithic::Models::Cards::FinancialTransactionListParams::Status]
+        #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(
+        #     begin_: nil,
+        #     category: nil,
+        #     end_: nil,
+        #     ending_before: nil,
+        #     result: nil,
+        #     starting_after: nil,
+        #     status: nil,
+        #     request_options: {},
+        #     **
+        #   )
+        #     super
+        #   end
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+
+        # Financial Transaction category to be returned.
+        module Category
+          extend Lithic::Enum
+
+          CARD = :CARD
+          TRANSFER = :TRANSFER
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # Financial Transaction result to be returned.
+        module Result
+          extend Lithic::Enum
+
+          APPROVED = :APPROVED
+          DECLINED = :DECLINED
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+
+        # Financial Transaction status to be returned.
+        module Status
+          extend Lithic::Enum
+
+          DECLINED = :DECLINED
+          EXPIRED = :EXPIRED
+          PENDING = :PENDING
+          RETURNED = :RETURNED
+          SETTLED = :SETTLED
+          VOIDED = :VOIDED
+
+          finalize!
+
+          # @!parse
+          #   # @return [Array<Symbol>]
+          #   def self.values; end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/models/cards/financial_transaction_retrieve_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    module Cards
+      class FinancialTransactionRetrieveParams < Lithic::BaseModel
+        # @!parse
+        #   extend Lithic::RequestParameters::Converter
+        include Lithic::RequestParameters
+
+        # @!attribute card_token
+        #
+        #   @return [String]
+        required :card_token, String
+
+        # @!parse
+        #   # @param card_token [String]
+        #   # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+        #   #
+        #   def initialize(card_token:, request_options: {}, **) = super
+
+        # def initialize: (Hash | Lithic::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/lithic/models/carrier.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class Carrier < Lithic::BaseModel
+      # @!attribute [r] qr_code_url
+      #   QR code url to display on the card carrier
+      #
+      #   @return [String, nil]
+      optional :qr_code_url, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :qr_code_url
+
+      # @!parse
+      #   # @param qr_code_url [String]
+      #   #
+      #   def initialize(qr_code_url: nil, **) = super
+
+      # def initialize: (Hash | Lithic::BaseModel) -> void
+    end
+  end
+end