lithic 0.1.0.pre.alpha.55 → 0.1.0

data/lib/lithic/models/network_total.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class NetworkTotal < Lithic::Internal::Type::BaseModel
+      # @!attribute token
+      #   Globally unique identifier.
+      #
+      #   @return [String]
+      required :token, String
+
+      # @!attribute amounts
+      #
+      #   @return [Lithic::Models::NetworkTotal::Amounts]
+      required :amounts, -> { Lithic::NetworkTotal::Amounts }
+
+      # @!attribute created
+      #   RFC 3339 timestamp for when the record was created. UTC time zone.
+      #
+      #   @return [Time]
+      required :created, Time
+
+      # @!attribute currency
+      #   3-character alphabetic ISO 4217 code.
+      #
+      #   @return [String]
+      required :currency, String
+
+      # @!attribute institution_id
+      #   The institution that activity occurred on. For Mastercard: ICA (Interbank Card
+      #   Association). For Maestro: institution ID. For Visa: lowest level SRE
+      #   (Settlement Reporting Entity).
+      #
+      #   @return [String]
+      required :institution_id, String
+
+      # @!attribute is_complete
+      #   Indicates that all settlement records related to this Network Total are
+      #   available in the details endpoint.
+      #
+      #   @return [Boolean]
+      required :is_complete, Lithic::Internal::Type::Boolean
+
+      # @!attribute network
+      #   Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      #   or INTERLINK.
+      #
+      #   @return [Symbol, Lithic::Models::NetworkTotal::Network]
+      required :network, enum: -> { Lithic::NetworkTotal::Network }
+
+      # @!attribute report_date
+      #   Date that the network total record applies to. YYYY-MM-DD format.
+      #
+      #   @return [Date]
+      required :report_date, Date
+
+      # @!attribute settlement_institution_id
+      #   The institution responsible for settlement. For Mastercard: same as
+      #   `institution_id`. For Maestro: billing ICA. For Visa: Funds Transfer SRE
+      #   (FTSRE).
+      #
+      #   @return [String]
+      required :settlement_institution_id, String
+
+      # @!attribute settlement_service
+      #   Settlement service.
+      #
+      #   @return [String]
+      required :settlement_service, String
+
+      # @!attribute updated
+      #   RFC 3339 timestamp for when the record was last updated. UTC time zone.
+      #
+      #   @return [Time]
+      required :updated, Time
+
+      # @!attribute cycle
+      #   The clearing cycle that the network total record applies to. Mastercard only.
+      #
+      #   @return [Integer, nil]
+      optional :cycle, Integer
+
+      # @!method initialize(token:, amounts:, created:, currency:, institution_id:, is_complete:, network:, report_date:, settlement_institution_id:, settlement_service:, updated:, cycle: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::NetworkTotal} for more details.
+      #
+      #   @param token [String] Globally unique identifier.
+      #
+      #   @param amounts [Lithic::Models::NetworkTotal::Amounts]
+      #
+      #   @param created [Time] RFC 3339 timestamp for when the record was created. UTC time zone.
+      #
+      #   @param currency [String] 3-character alphabetic ISO 4217 code.
+      #
+      #   @param institution_id [String] The institution that activity occurred on. For Mastercard: ICA (Interbank Card A
+      #
+      #   @param is_complete [Boolean] Indicates that all settlement records related to this Network Total are availabl
+      #
+      #   @param network [Symbol, Lithic::Models::NetworkTotal::Network] Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      #
+      #   @param report_date [Date] Date that the network total record applies to. YYYY-MM-DD format.
+      #
+      #   @param settlement_institution_id [String] The institution responsible for settlement. For Mastercard: same as `institution
+      #
+      #   @param settlement_service [String] Settlement service.
+      #
+      #   @param updated [Time] RFC 3339 timestamp for when the record was last updated. UTC time zone.
+      #
+      #   @param cycle [Integer] The clearing cycle that the network total record applies to. Mastercard only.
+
+      # @see Lithic::Models::NetworkTotal#amounts
+      class Amounts < Lithic::Internal::Type::BaseModel
+        # @!attribute gross_settlement
+        #   Total settlement amount excluding interchange, in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :gross_settlement, Integer
+
+        # @!attribute interchange_fees
+        #   Interchange amount, in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :interchange_fees, Integer
+
+        # @!attribute net_settlement
+        #   `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+        #   in currency's smallest unit.
+        #
+        #   @return [Integer]
+        required :net_settlement, Integer
+
+        # @!attribute visa_charges
+        #   Charges specific to Visa/Interlink, in currency's smallest unit.
+        #
+        #   @return [Integer, nil]
+        optional :visa_charges, Integer
+
+        # @!method initialize(gross_settlement:, interchange_fees:, net_settlement:, visa_charges: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Lithic::Models::NetworkTotal::Amounts} for more details.
+        #
+        #   @param gross_settlement [Integer] Total settlement amount excluding interchange, in currency's smallest unit.
+        #
+        #   @param interchange_fees [Integer] Interchange amount, in currency's smallest unit.
+        #
+        #   @param net_settlement [Integer] `gross_settlement` net of `interchange_fees` and `visa_charges` (if applicable),
+        #
+        #   @param visa_charges [Integer] Charges specific to Visa/Interlink, in currency's smallest unit.
+      end
+
+      # Card network where the transaction took place. AMEX, VISA, MASTERCARD, MAESTRO,
+      # or INTERLINK.
+      #
+      # @see Lithic::Models::NetworkTotal#network
+      module Network
+        extend Lithic::Internal::Type::Enum
+
+        AMEX = :AMEX
+        VISA = :VISA
+        MASTERCARD = :MASTERCARD
+        MAESTRO = :MAESTRO
+        INTERLINK = :INTERLINK
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/lithic/models/non_pci_card.rb

@@ -117,6 +117,13 @@ module Lithic
       #   @return [Array<String>, nil]
       optional :auth_rule_tokens, Lithic::Internal::Type::ArrayOf[String]
 
+      # @!attribute bulk_order_token
+      #   Globally unique identifier for the bulk order associated with this card. Only
+      #   applicable to physical cards that are part of a bulk shipment
+      #
+      #   @return [String, nil]
+      optional :bulk_order_token, String, nil?: true
+
       # @!attribute cardholder_currency
       #   3-character alphabetic ISO 4217 code for the currency of the cardholder.
       #
@@ -217,7 +224,7 @@ module Lithic
       #   @return [Symbol, Lithic::Models::NonPCICard::Substatus, nil]
       optional :substatus, enum: -> { Lithic::NonPCICard::Substatus }
 
-      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
+      # @!method initialize(token:, account_token:, card_program_token:, created:, funding:, last_four:, pin_status:, spend_limit:, spend_limit_duration:, state:, type:, auth_rule_tokens: nil, bulk_order_token: nil, cardholder_currency: nil, comment: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, hostname: nil, memo: nil, network_program_token: nil, pending_commands: nil, product_id: nil, replacement_for: nil, substatus: nil)
       #   Some parameter documentations has been truncated, see
       #   {Lithic::Models::NonPCICard} for more details.
       #
@@ -249,6 +256,8 @@ module Lithic
       #
       #   @param auth_rule_tokens [Array<String>] List of identifiers for the Auth Rule(s) that are applied on the card. This fiel
       #
+      #   @param bulk_order_token [String, nil] Globally unique identifier for the bulk order associated with this card. Only ap
+      #
       #   @param cardholder_currency [String] 3-character alphabetic ISO 4217 code for the currency of the cardholder.
       #
       #   @param comment [String] Additional context or information related to the card.

data/lib/lithic/models/payment.rb

@@ -71,10 +71,10 @@ module Lithic
       required :pending_amount, Integer
 
       # @!attribute related_account_tokens
-      #   Related account tokens for the transaction
+      #   Account tokens related to a payment transaction
       #
-      #   @return [Lithic::Models::Payment::RelatedAccountTokens]
-      required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }
+      #   @return [Lithic::Models::Payment::RelatedAccountTokens, nil]
+      required :related_account_tokens, -> { Lithic::Payment::RelatedAccountTokens }, nil?: true
 
       # @!attribute result
       #   Transaction result
@@ -158,7 +158,7 @@ module Lithic
       #
       #   @param pending_amount [Integer] Pending amount in cents
       #
-      #   @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens] Related account tokens for the transaction
+      #   @param related_account_tokens [Lithic::Models::Payment::RelatedAccountTokens, nil] Account tokens related to a payment transaction
       #
       #   @param result [Symbol, Lithic::Models::Payment::Result] Transaction result
       #
@@ -198,6 +198,8 @@ module Lithic
         CARD = :CARD
         EXTERNAL_ACH = :EXTERNAL_ACH
         EXTERNAL_CHECK = :EXTERNAL_CHECK
+        EXTERNAL_FEDNOW = :EXTERNAL_FEDNOW
+        EXTERNAL_RTP = :EXTERNAL_RTP
         EXTERNAL_TRANSFER = :EXTERNAL_TRANSFER
         EXTERNAL_WIRE = :EXTERNAL_WIRE
         MANAGEMENT_ADJUSTMENT = :MANAGEMENT_ADJUSTMENT
@@ -371,6 +373,7 @@ module Lithic
           extend Lithic::Internal::Type::Enum
 
           APPROVED = :APPROVED
+          DECLINED = :DECLINED
           FUNDS_INSUFFICIENT = :FUNDS_INSUFFICIENT
           ACCOUNT_INVALID = :ACCOUNT_INVALID
           PROGRAM_TRANSACTION_LIMIT_EXCEEDED = :PROGRAM_TRANSACTION_LIMIT_EXCEEDED
@@ -413,6 +416,12 @@ module Lithic
           #   @return [Symbol, Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes::SecCode]
           required :sec_code, enum: -> { Lithic::Payment::MethodAttributes::ACHMethodAttributes::SecCode }
 
+          # @!attribute ach_hold_period
+          #   Number of days the ACH transaction is on hold
+          #
+          #   @return [Integer, nil]
+          optional :ach_hold_period, Integer, nil?: true
+
           # @!attribute addenda
           #   Addenda information
           #
@@ -449,9 +458,11 @@ module Lithic
           #   @return [Array<String>, nil]
           optional :trace_numbers, Lithic::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(sec_code:, addenda: nil, company_id: nil, receipt_routing_number: nil, retries: nil, return_reason_code: nil, trace_numbers: nil)
+          # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil, company_id: nil, receipt_routing_number: nil, retries: nil, return_reason_code: nil, trace_numbers: nil)
           #   @param sec_code [Symbol, Lithic::Models::Payment::MethodAttributes::ACHMethodAttributes::SecCode] SEC code for ACH transaction
           #
+          #   @param ach_hold_period [Integer, nil] Number of days the ACH transaction is on hold
+          #
           #   @param addenda [String, nil] Addenda information
           #
           #   @param company_id [String, nil] Company ID for the ACH transaction
@@ -568,7 +579,7 @@ module Lithic
         required :business_account_token, String, nil?: true
 
         # @!method initialize(account_token:, business_account_token:)
-        #   Related account tokens for the transaction
+        #   Account tokens related to a payment transaction
         #
         #   @param account_token [String, nil] Globally unique identifier for the account
         #
@@ -613,6 +624,7 @@ module Lithic
         DECLINED = :DECLINED
         REVERSED = :REVERSED
         CANCELED = :CANCELED
+        RETURNED = :RETURNED
 
         # @!method self.values
         #   @return [Array<Symbol>]

data/lib/lithic/models/payment_create_params.rb

@@ -94,13 +94,22 @@ module Lithic
         #   @return [Symbol, Lithic::Models::PaymentCreateParams::MethodAttributes::SecCode]
         required :sec_code, enum: -> { Lithic::PaymentCreateParams::MethodAttributes::SecCode }
 
+        # @!attribute ach_hold_period
+        #   Number of days to hold the ACH payment
+        #
+        #   @return [Integer, nil]
+        optional :ach_hold_period, Integer, api_name: :ach_hold__period
+
         # @!attribute addenda
         #
         #   @return [String, nil]
         optional :addenda, String, nil?: true
 
-        # @!method initialize(sec_code:, addenda: nil)
+        # @!method initialize(sec_code:, ach_hold_period: nil, addenda: nil)
         #   @param sec_code [Symbol, Lithic::Models::PaymentCreateParams::MethodAttributes::SecCode]
+        #
+        #   @param ach_hold_period [Integer] Number of days to hold the ACH payment
+        #
         #   @param addenda [String, nil]
 
         # @see Lithic::Models::PaymentCreateParams::MethodAttributes#sec_code

data/lib/lithic/models/payment_return_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    # @see Lithic::Resources::Payments#return_
+    class PaymentReturnParams < Lithic::Internal::Type::BaseModel
+      extend Lithic::Internal::Type::RequestParameters::Converter
+      include Lithic::Internal::Type::RequestParameters
+
+      # @!attribute financial_account_token
+      #   Globally unique identifier for the financial account
+      #
+      #   @return [String]
+      required :financial_account_token, String
+
+      # @!attribute return_reason_code
+      #   ACH return reason code indicating the reason for returning the payment.
+      #   Supported codes include R01-R53 and R80-R85. For a complete list of return codes
+      #   and their meanings, see
+      #   [ACH Return Reasons](https://docs.lithic.com/docs/ach-overview#ach-return-reasons)
+      #
+      #   @return [String]
+      required :return_reason_code, String
+
+      # @!attribute addenda
+      #   Optional additional information about the return. Limited to 44 characters
+      #
+      #   @return [String, nil]
+      optional :addenda, String, nil?: true
+
+      # @!attribute date_of_death
+      #   Date of death in YYYY-MM-DD format. Required when using return codes **R14**
+      #   (representative payee deceased) or **R15** (beneficiary or account holder
+      #   deceased)
+      #
+      #   @return [Date, nil]
+      optional :date_of_death, Date, nil?: true
+
+      # @!attribute memo
+      #   Optional memo for the return. Limited to 10 characters
+      #
+      #   @return [String, nil]
+      optional :memo, String, nil?: true
+
+      # @!method initialize(financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::PaymentReturnParams} for more details.
+      #
+      #   @param financial_account_token [String] Globally unique identifier for the financial account
+      #
+      #   @param return_reason_code [String] ACH return reason code indicating the reason for returning the payment. Supporte
+      #
+      #   @param addenda [String, nil] Optional additional information about the return. Limited to 44 characters
+      #
+      #   @param date_of_death [Date, nil] Date of death in YYYY-MM-DD format. Required when using return codes **R14** (re
+      #
+      #   @param memo [String, nil] Optional memo for the return. Limited to 10 characters
+      #
+      #   @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/lithic/models/statement_totals.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Models
+    class StatementTotals < Lithic::Internal::Type::BaseModel
+      # @!attribute balance_transfers
+      #   Opening balance transferred from previous account in cents
+      #
+      #   @return [Integer]
+      required :balance_transfers, Integer
+
+      # @!attribute cash_advances
+      #   ATM and cashback transactions in cents
+      #
+      #   @return [Integer]
+      required :cash_advances, Integer
+
+      # @!attribute credits
+      #   Volume of credit management operation transactions less any balance transfers in
+      #   cents
+      #
+      #   @return [Integer]
+      required :credits, Integer
+
+      # @!attribute debits
+      #   Volume of debit management operation transactions less any interest in cents
+      #
+      #   @return [Integer]
+      required :debits, Integer
+
+      # @!attribute fees
+      #   Volume of debit management operation transactions less any interest in cents
+      #
+      #   @return [Integer]
+      required :fees, Integer
+
+      # @!attribute interest
+      #   Interest accrued in cents
+      #
+      #   @return [Integer]
+      required :interest, Integer
+
+      # @!attribute payments
+      #   Any funds transfers which affective the balance in cents
+      #
+      #   @return [Integer]
+      required :payments, Integer
+
+      # @!attribute purchases
+      #   Net card transaction volume less any cash advances in cents
+      #
+      #   @return [Integer]
+      required :purchases, Integer
+
+      # @!attribute credit_details
+      #   Breakdown of credits
+      #
+      #   @return [Object, nil]
+      optional :credit_details, Lithic::Internal::Type::Unknown
+
+      # @!attribute debit_details
+      #   Breakdown of debits
+      #
+      #   @return [Object, nil]
+      optional :debit_details, Lithic::Internal::Type::Unknown
+
+      # @!attribute payment_details
+      #   Breakdown of payments
+      #
+      #   @return [Object, nil]
+      optional :payment_details, Lithic::Internal::Type::Unknown
+
+      # @!method initialize(balance_transfers:, cash_advances:, credits:, debits:, fees:, interest:, payments:, purchases:, credit_details: nil, debit_details: nil, payment_details: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Lithic::Models::StatementTotals} for more details.
+      #
+      #   @param balance_transfers [Integer] Opening balance transferred from previous account in cents
+      #
+      #   @param cash_advances [Integer] ATM and cashback transactions in cents
+      #
+      #   @param credits [Integer] Volume of credit management operation transactions less any balance transfers in
+      #
+      #   @param debits [Integer] Volume of debit management operation transactions less any interest in cents
+      #
+      #   @param fees [Integer] Volume of debit management operation transactions less any interest in cents
+      #
+      #   @param interest [Integer] Interest accrued in cents
+      #
+      #   @param payments [Integer] Any funds transfers which affective the balance in cents
+      #
+      #   @param purchases [Integer] Net card transaction volume less any cash advances in cents
+      #
+      #   @param credit_details [Object] Breakdown of credits
+      #
+      #   @param debit_details [Object] Breakdown of debits
+      #
+      #   @param payment_details [Object] Breakdown of payments
+    end
+  end
+end