diff --git a/.release-please-manifest.json b/.release-please-manifest.json index b3365ecb..0815771e 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "0.1.0-alpha.55" + ".": "0.1.0-alpha.56" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index a080bc22..d8bf6f02 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ -configured_endpoints: 168 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-c3f6c23018d70fd1b259b21cfd377b5d905872f0d3c5ce2cdb8013f4b6daa338.yml -openapi_spec_hash: b551344da9d29eb4c5374874ed84a9b0 -config_hash: 012f050e575d1bbfe8db56a9eeaa5fcd +configured_endpoints: 172 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/lithic%2Flithic-9791980619fc7ce8afb01f77dfe3c660a540975327378287cb666136ae4b0a99.yml +openapi_spec_hash: 0752074b2a7b0534329a1e3176c94a62 +config_hash: aab05d0cf41f1f6b9f4d5677273c1600 diff --git a/CHANGELOG.md b/CHANGELOG.md index 4381675f..183a5af0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,25 @@ # Changelog +## 0.1.0-alpha.56 (2025-11-20) + +Full Changelog: [v0.1.0-alpha.55...v0.1.0-alpha.56](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.55...v0.1.0-alpha.56) + +### Features + +* **api:** add disputes V2 endpoints ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** Add Payoff Details ([e21e546](https://github.com/lithic-com/lithic-ruby/commit/e21e5460240174de29a51d67c8206220e3cf19d1)) +* **api:** add return payment method ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** add Tokenization and ACH Rules ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** add unpause external_bank_accounts API method ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** extract some common schemas into models ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) + + +### Bug Fixes + +* **api:** change allowed phone number length from 18 to 16 ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** mark certain optional fields as nullable ([0730dce](https://github.com/lithic-com/lithic-ruby/commit/0730dcede8d11f0b56c0beb90c692552b229c6fb)) +* **api:** Modify return type of returns API to payment-transaction ([e21e546](https://github.com/lithic-com/lithic-ruby/commit/e21e5460240174de29a51d67c8206220e3cf19d1)) + ## 0.1.0-alpha.55 (2025-11-11) Full Changelog: [v0.1.0-alpha.54...v0.1.0-alpha.55](https://github.com/lithic-com/lithic-ruby/compare/v0.1.0-alpha.54...v0.1.0-alpha.55) diff --git a/Gemfile.lock b/Gemfile.lock index 7b9e0d5f..b2ad9b84 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - lithic (0.1.0.pre.alpha.55) + lithic (0.1.0.pre.alpha.56) connection_pool GEM diff --git a/README.md b/README.md index 78f595a3..bdec4529 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "lithic", "~> 0.1.0.pre.alpha.55" +gem "lithic", "~> 0.1.0.pre.alpha.56" ``` diff --git a/lib/lithic.rb b/lib/lithic.rb index 2bcc7730..7aa9e255 100644 --- a/lib/lithic.rb +++ b/lib/lithic.rb @@ -90,9 +90,13 @@ require_relative "lithic/models/auth_rules/auth_rule" require_relative "lithic/models/auth_rules/auth_rule_condition" require_relative "lithic/models/auth_rules/conditional_3ds_action_parameters" +require_relative "lithic/models/auth_rules/conditional_ach_action_parameters" require_relative "lithic/models/auth_rules/conditional_attribute" require_relative "lithic/models/auth_rules/conditional_authorization_action_parameters" require_relative "lithic/models/auth_rules/conditional_block_parameters" +require_relative "lithic/models/auth_rules/conditional_operation" +require_relative "lithic/models/auth_rules/conditional_tokenization_action_parameters" +require_relative "lithic/models/auth_rules/conditional_value" require_relative "lithic/models/auth_rules/merchant_lock_parameters" require_relative "lithic/models/auth_rules/rule_stats" require_relative "lithic/models/auth_rules/v2/backtest_create_params" @@ -155,6 +159,7 @@ require_relative "lithic/models/card_web_provision_params" require_relative "lithic/models/card_web_provision_response" require_relative "lithic/models/carrier" +require_relative "lithic/models/category_details" require_relative "lithic/models/client_api_status_params" require_relative "lithic/models/credit_products/extended_credit" require_relative "lithic/models/credit_products/extended_credit_retrieve_params" @@ -167,20 +172,18 @@ require_relative "lithic/models/digital_card_art_retrieve_params" require_relative "lithic/models/dispute" require_relative "lithic/models/dispute_create_params" -require_relative "lithic/models/dispute_create_response" require_relative "lithic/models/dispute_delete_evidence_params" require_relative "lithic/models/dispute_delete_params" -require_relative "lithic/models/dispute_delete_response" require_relative "lithic/models/dispute_evidence" require_relative "lithic/models/dispute_initiate_evidence_upload_params" require_relative "lithic/models/dispute_list_evidences_params" require_relative "lithic/models/dispute_list_params" -require_relative "lithic/models/dispute_list_response" require_relative "lithic/models/dispute_retrieve_evidence_params" require_relative "lithic/models/dispute_retrieve_params" -require_relative "lithic/models/dispute_retrieve_response" +require_relative "lithic/models/disputes_v2_list_params" +require_relative "lithic/models/disputes_v2_retrieve_params" require_relative "lithic/models/dispute_update_params" -require_relative "lithic/models/dispute_update_response" +require_relative "lithic/models/dispute_v2" require_relative "lithic/models/document" require_relative "lithic/models/event" require_relative "lithic/models/event_list_attempts_params" @@ -213,6 +216,8 @@ require_relative "lithic/models/external_bank_account_retry_prenote_response" require_relative "lithic/models/external_bank_accounts/micro_deposit_create_params" require_relative "lithic/models/external_bank_accounts/micro_deposit_create_response" +require_relative "lithic/models/external_bank_account_unpause_params" +require_relative "lithic/models/external_bank_account_unpause_response" require_relative "lithic/models/external_bank_account_update_params" require_relative "lithic/models/external_bank_account_update_response" require_relative "lithic/models/external_payment" @@ -232,6 +237,7 @@ require_relative "lithic/models/financial_account_retrieve_params" require_relative "lithic/models/financial_accounts/balance_list_params" require_relative "lithic/models/financial_accounts/balance_list_response" +require_relative "lithic/models/financial_accounts/category_balances" require_relative "lithic/models/financial_accounts/credit_configuration_retrieve_params" require_relative "lithic/models/financial_accounts/credit_configuration_update_params" require_relative "lithic/models/financial_accounts/financial_account_credit_config" @@ -248,6 +254,7 @@ require_relative "lithic/models/financial_accounts/statements/statement_line_items" require_relative "lithic/models/financial_account_update_params" require_relative "lithic/models/financial_account_update_status_params" +require_relative "lithic/models/financial_event" require_relative "lithic/models/financial_transaction" require_relative "lithic/models/fraud/transaction_report_params" require_relative "lithic/models/fraud/transaction_report_response" @@ -269,6 +276,7 @@ require_relative "lithic/models/management_operation_retrieve_params" require_relative "lithic/models/management_operation_reverse_params" require_relative "lithic/models/management_operation_transaction" +require_relative "lithic/models/merchant" require_relative "lithic/models/message_attempt" require_relative "lithic/models/network_program" require_relative "lithic/models/network_program_list_params" @@ -280,6 +288,7 @@ require_relative "lithic/models/payment_retrieve_params" require_relative "lithic/models/payment_retry_params" require_relative "lithic/models/payment_retry_response" +require_relative "lithic/models/payment_return_params" require_relative "lithic/models/payment_simulate_action_params" require_relative "lithic/models/payment_simulate_action_response" require_relative "lithic/models/payment_simulate_receipt_params" @@ -306,6 +315,7 @@ require_relative "lithic/models/settlement_summary_details" require_relative "lithic/models/shipping_address" require_relative "lithic/models/spend_limit_duration" +require_relative "lithic/models/statement_totals" require_relative "lithic/models/three_ds/authentication_retrieve_params" require_relative "lithic/models/three_ds/authentication_retrieve_response" require_relative "lithic/models/three_ds/authentication_simulate_otp_entry_params" @@ -378,6 +388,7 @@ require_relative "lithic/resources/credit_products/prime_rates" require_relative "lithic/resources/digital_card_art" require_relative "lithic/resources/disputes" +require_relative "lithic/resources/disputes_v2" require_relative "lithic/resources/events" require_relative "lithic/resources/events/event_subscriptions" require_relative "lithic/resources/events/subscriptions" diff --git a/lib/lithic/client.rb b/lib/lithic/client.rb index 779b1a85..98594cea 100644 --- a/lib/lithic/client.rb +++ b/lib/lithic/client.rb @@ -53,6 +53,9 @@ class Client < Lithic::Internal::Transport::BaseClient # @return [Lithic::Resources::Disputes] attr_reader :disputes + # @return [Lithic::Resources::DisputesV2] + attr_reader :disputes_v2 + # @return [Lithic::Resources::Events] attr_reader :events @@ -194,6 +197,7 @@ def initialize( @balances = Lithic::Resources::Balances.new(client: self) @aggregate_balances = Lithic::Resources::AggregateBalances.new(client: self) @disputes = Lithic::Resources::Disputes.new(client: self) + @disputes_v2 = Lithic::Resources::DisputesV2.new(client: self) @events = Lithic::Resources::Events.new(client: self) @transfers = Lithic::Resources::Transfers.new(client: self) @financial_accounts = Lithic::Resources::FinancialAccounts.new(client: self) diff --git a/lib/lithic/models.rb b/lib/lithic/models.rb index 8028fa19..761dfbed 100644 --- a/lib/lithic/models.rb +++ b/lib/lithic/models.rb @@ -148,6 +148,8 @@ module Lithic Carrier = Lithic::Models::Carrier + CategoryDetails = Lithic::Models::CategoryDetails + ClientAPIStatusParams = Lithic::Models::ClientAPIStatusParams CreditProducts = Lithic::Models::CreditProducts @@ -180,8 +182,14 @@ module Lithic DisputeRetrieveParams = Lithic::Models::DisputeRetrieveParams + DisputesV2ListParams = Lithic::Models::DisputesV2ListParams + + DisputesV2RetrieveParams = Lithic::Models::DisputesV2RetrieveParams + DisputeUpdateParams = Lithic::Models::DisputeUpdateParams + DisputeV2 = Lithic::Models::DisputeV2 + Document = Lithic::Models::Document Event = Lithic::Models::Event @@ -210,6 +218,8 @@ module Lithic ExternalBankAccounts = Lithic::Models::ExternalBankAccounts + ExternalBankAccountUnpauseParams = Lithic::Models::ExternalBankAccountUnpauseParams + ExternalBankAccountUpdateParams = Lithic::Models::ExternalBankAccountUpdateParams ExternalPayment = Lithic::Models::ExternalPayment @@ -248,6 +258,8 @@ module Lithic FinancialAccountUpdateStatusParams = Lithic::Models::FinancialAccountUpdateStatusParams + FinancialEvent = Lithic::Models::FinancialEvent + FinancialTransaction = Lithic::Models::FinancialTransaction Fraud = Lithic::Models::Fraud @@ -278,6 +290,8 @@ module Lithic ManagementOperationTransaction = Lithic::Models::ManagementOperationTransaction + Merchant = Lithic::Models::Merchant + MessageAttempt = Lithic::Models::MessageAttempt NetworkProgram = Lithic::Models::NetworkProgram @@ -300,6 +314,8 @@ module Lithic PaymentRetryParams = Lithic::Models::PaymentRetryParams + PaymentReturnParams = Lithic::Models::PaymentReturnParams + PaymentSimulateActionParams = Lithic::Models::PaymentSimulateActionParams PaymentSimulateReceiptParams = Lithic::Models::PaymentSimulateReceiptParams @@ -332,6 +348,8 @@ module Lithic SpendLimitDuration = Lithic::Models::SpendLimitDuration + StatementTotals = Lithic::Models::StatementTotals + ThreeDS = Lithic::Models::ThreeDS Tokenization = Lithic::Models::Tokenization diff --git a/lib/lithic/models/account_activity_list_response.rb b/lib/lithic/models/account_activity_list_response.rb index 2aa3b56c..de75bde8 100644 --- a/lib/lithic/models/account_activity_list_response.rb +++ b/lib/lithic/models/account_activity_list_response.rb @@ -64,9 +64,8 @@ class Internal < Lithic::Internal::Type::BaseModel # @!attribute events # List of transaction events # - # @return [Array] - required :events, - -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::Internal::Event] } + # @return [Array] + required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] } # @!attribute family # INTERNAL - Financial Transaction @@ -123,7 +122,7 @@ class Internal < Lithic::Internal::Type::BaseModel # # @param descriptor [String] Transaction descriptor # - # @param events [Array] List of transaction events + # @param events [Array] List of transaction events # # @param financial_account_token [String] Financial account token associated with the transaction # @@ -168,149 +167,6 @@ module Category # @return [Array] end - class Event < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String, nil] - optional :token, String - - # @!attribute amount - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - # - # @return [Integer, nil] - optional :amount, Integer - - # @!attribute created - # Date and time when the financial event occurred. UTC time zone. - # - # @return [Time, nil] - optional :created, Time - - # @!attribute result - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Result, nil] - optional :result, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Event::Result } - - # @!attribute type - # - # @return [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Type, nil] - optional :type, enum: -> { Lithic::Models::AccountActivityListResponse::Internal::Event::Type } - - # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil) - # Some parameter documentations has been truncated, see - # {Lithic::Models::AccountActivityListResponse::Internal::Event} for more details. - # - # Financial Event - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u - # - # @param created [Time] Date and time when the financial event occurred. UTC time zone. - # - # @param result [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Result] APPROVED financial events were successful while DECLINED financial events were d - # - # @param type [Symbol, Lithic::Models::AccountActivityListResponse::Internal::Event::Type] - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @see Lithic::Models::AccountActivityListResponse::Internal::Event#result - module Result - extend Lithic::Internal::Type::Enum - - APPROVED = :APPROVED - DECLINED = :DECLINED - - # @!method self.values - # @return [Array] - end - - # @see Lithic::Models::AccountActivityListResponse::Internal::Event#type - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED - AUTHORIZATION = :AUTHORIZATION - AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY = :BALANCE_INQUIRY - BILLING_ERROR = :BILLING_ERROR - BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL - CARD_TO_CARD = :CARD_TO_CARD - CASH_BACK = :CASH_BACK - CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL - CLEARING = :CLEARING - COLLECTION = :COLLECTION - CORRECTION_CREDIT = :CORRECTION_CREDIT - CORRECTION_DEBIT = :CORRECTION_DEBIT - CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION = :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON = :DISPUTE_WON - EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST = :INTEREST - INTEREST_REVERSAL = :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT - LATE_PAYMENT = :LATE_PAYMENT - LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF = :LOSS_WRITE_OFF - PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL - SERVICE = :SERVICE - RETURN = :RETURN - RETURN_REVERSAL = :RETURN_REVERSAL - TRANSFER = :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT = :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT - - # @!method self.values - # @return [Array] - end - end - # Transaction result # # @see Lithic::Models::AccountActivityListResponse::Internal#result @@ -335,6 +191,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] @@ -342,8 +199,63 @@ module Status end class Card < Lithic::Models::Transaction - # @!method initialize + # @!attribute token + # Unique identifier for the transaction + # + # @return [String] + required :token, String + + # @!attribute created + # ISO 8601 timestamp of when the transaction was created + # + # @return [Time] + required :created, Time + + # @!attribute family + # CARD - Card Transaction + # + # @return [Symbol, :CARD] + required :family, const: :CARD + + # @!attribute status + # The status of the transaction + # + # @return [Symbol, Lithic::Models::AccountActivityListResponse::Card::Status] + required :status, enum: -> { Lithic::Models::AccountActivityListResponse::Card::Status } + + # @!attribute updated + # ISO 8601 timestamp of when the transaction was last updated + # + # @return [Time] + required :updated, Time + + # @!method initialize(token:, created:, status:, updated:, family: :CARD) # Card transaction with ledger base properties + # + # @param token [String] Unique identifier for the transaction + # + # @param created [Time] ISO 8601 timestamp of when the transaction was created + # + # @param status [Symbol, Lithic::Models::AccountActivityListResponse::Card::Status] The status of the transaction + # + # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated + # + # @param family [Symbol, :CARD] CARD - Card Transaction + + # The status of the transaction + module Status + extend Lithic::Internal::Type::Enum + + PENDING = :PENDING + SETTLED = :SETTLED + DECLINED = :DECLINED + REVERSED = :REVERSED + CANCELED = :CANCELED + RETURNED = :RETURNED + + # @!method self.values + # @return [Array] + end end # @!method self.variants diff --git a/lib/lithic/models/account_activity_retrieve_transaction_response.rb b/lib/lithic/models/account_activity_retrieve_transaction_response.rb index 37508895..43ad17a5 100644 --- a/lib/lithic/models/account_activity_retrieve_transaction_response.rb +++ b/lib/lithic/models/account_activity_retrieve_transaction_response.rb @@ -65,9 +65,8 @@ class Internal < Lithic::Internal::Type::BaseModel # @!attribute events # List of transaction events # - # @return [Array] - required :events, - -> { Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event] } + # @return [Array] + required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] } # @!attribute family # INTERNAL - Financial Transaction @@ -126,7 +125,7 @@ class Internal < Lithic::Internal::Type::BaseModel # # @param descriptor [String] Transaction descriptor # - # @param events [Array] List of transaction events + # @param events [Array] List of transaction events # # @param financial_account_token [String] Financial account token associated with the transaction # @@ -171,152 +170,6 @@ module Category # @return [Array] end - class Event < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String, nil] - optional :token, String - - # @!attribute amount - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - # - # @return [Integer, nil] - optional :amount, Integer - - # @!attribute created - # Date and time when the financial event occurred. UTC time zone. - # - # @return [Time, nil] - optional :created, Time - - # @!attribute result - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @return [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result, nil] - optional :result, - enum: -> { Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result } - - # @!attribute type - # - # @return [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type, nil] - optional :type, - enum: -> { Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type } - - # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil) - # Some parameter documentations has been truncated, see - # {Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event} - # for more details. - # - # Financial Event - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u - # - # @param created [Time] Date and time when the financial event occurred. UTC time zone. - # - # @param result [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result] APPROVED financial events were successful while DECLINED financial events were d - # - # @param type [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type] - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @see Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event#result - module Result - extend Lithic::Internal::Type::Enum - - APPROVED = :APPROVED - DECLINED = :DECLINED - - # @!method self.values - # @return [Array] - end - - # @see Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event#type - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED - AUTHORIZATION = :AUTHORIZATION - AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY = :BALANCE_INQUIRY - BILLING_ERROR = :BILLING_ERROR - BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL - CARD_TO_CARD = :CARD_TO_CARD - CASH_BACK = :CASH_BACK - CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL - CLEARING = :CLEARING - COLLECTION = :COLLECTION - CORRECTION_CREDIT = :CORRECTION_CREDIT - CORRECTION_DEBIT = :CORRECTION_DEBIT - CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION = :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON = :DISPUTE_WON - EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST = :INTEREST - INTEREST_REVERSAL = :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT - LATE_PAYMENT = :LATE_PAYMENT - LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF = :LOSS_WRITE_OFF - PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL - SERVICE = :SERVICE - RETURN = :RETURN - RETURN_REVERSAL = :RETURN_REVERSAL - TRANSFER = :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT = :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT - - # @!method self.values - # @return [Array] - end - end - # Transaction result # # @see Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal#result @@ -341,6 +194,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] @@ -348,8 +202,63 @@ module Status end class Card < Lithic::Models::Transaction - # @!method initialize + # @!attribute token + # Unique identifier for the transaction + # + # @return [String] + required :token, String + + # @!attribute created + # ISO 8601 timestamp of when the transaction was created + # + # @return [Time] + required :created, Time + + # @!attribute family + # CARD - Card Transaction + # + # @return [Symbol, :CARD] + required :family, const: :CARD + + # @!attribute status + # The status of the transaction + # + # @return [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status] + required :status, enum: -> { Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status } + + # @!attribute updated + # ISO 8601 timestamp of when the transaction was last updated + # + # @return [Time] + required :updated, Time + + # @!method initialize(token:, created:, status:, updated:, family: :CARD) # Card transaction with ledger base properties + # + # @param token [String] Unique identifier for the transaction + # + # @param created [Time] ISO 8601 timestamp of when the transaction was created + # + # @param status [Symbol, Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status] The status of the transaction + # + # @param updated [Time] ISO 8601 timestamp of when the transaction was last updated + # + # @param family [Symbol, :CARD] CARD - Card Transaction + + # The status of the transaction + module Status + extend Lithic::Internal::Type::Enum + + PENDING = :PENDING + SETTLED = :SETTLED + DECLINED = :DECLINED + REVERSED = :REVERSED + CANCELED = :CANCELED + RETURNED = :RETURNED + + # @!method self.values + # @return [Array] + end end # @!method self.variants diff --git a/lib/lithic/models/auth_rules/auth_rule_condition.rb b/lib/lithic/models/auth_rules/auth_rule_condition.rb index 2af273fc..670524a7 100644 --- a/lib/lithic/models/auth_rules/auth_rule_condition.rb +++ b/lib/lithic/models/auth_rules/auth_rule_condition.rb @@ -56,73 +56,30 @@ class AuthRuleCondition < Lithic::Internal::Type::BaseModel # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. # - # @return [Symbol, Lithic::Models::AuthRules::ConditionalAttribute, nil] - optional :attribute, enum: -> { Lithic::AuthRules::ConditionalAttribute } + # @return [Symbol, Lithic::Models::AuthRules::ConditionalAttribute] + required :attribute, enum: -> { Lithic::AuthRules::ConditionalAttribute } # @!attribute operation # The operation to apply to the attribute # - # @return [Symbol, Lithic::Models::AuthRules::AuthRuleCondition::Operation, nil] - optional :operation, enum: -> { Lithic::AuthRules::AuthRuleCondition::Operation } + # @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation] + required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation } # @!attribute value # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` # - # @return [String, Integer, Array, nil] - optional :value, union: -> { Lithic::AuthRules::AuthRuleCondition::Value } + # @return [String, Integer, Array] + required :value, union: -> { Lithic::AuthRules::ConditionalValue } - # @!method initialize(attribute: nil, operation: nil, value: nil) + # @!method initialize(attribute:, operation:, value:) # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::AuthRuleCondition} for more details. # # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalAttribute] The attribute to target. # - # @param operation [Symbol, Lithic::Models::AuthRules::AuthRuleCondition::Operation] The operation to apply to the attribute + # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute # # @param value [String, Integer, Array] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - - # The operation to apply to the attribute - # - # @see Lithic::Models::AuthRules::AuthRuleCondition#operation - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF = :IS_ONE_OF - IS_NOT_ONE_OF = :IS_NOT_ONE_OF - MATCHES = :MATCHES - DOES_NOT_MATCH = :DOES_NOT_MATCH - IS_EQUAL_TO = :IS_EQUAL_TO - IS_NOT_EQUAL_TO = :IS_NOT_EQUAL_TO - IS_GREATER_THAN = :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO = :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN = :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO = :IS_LESS_THAN_OR_EQUAL_TO - - # @!method self.values - # @return [Array] - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - # - # @see Lithic::Models::AuthRules::AuthRuleCondition#value - module Value - extend Lithic::Internal::Type::Union - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - variant String - - # A number, to be used with `IS_GREATER_THAN`, `IS_GREATER_THAN_OR_EQUAL_TO`, `IS_LESS_THAN`, `IS_LESS_THAN_OR_EQUAL_TO`, `IS_EQUAL_TO`, or `IS_NOT_EQUAL_TO` - variant Integer - - # An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` - variant -> { Lithic::Models::AuthRules::AuthRuleCondition::Value::StringArray } - - # @!method self.variants - # @return [Array(String, Integer, Array)] - - # @type [Lithic::Internal::Type::Converter] - StringArray = Lithic::Internal::Type::ArrayOf[String] - end end end diff --git a/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb b/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb index 8b66acce..00da70d6 100644 --- a/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb +++ b/lib/lithic/models/auth_rules/conditional_3ds_action_parameters.rb @@ -61,29 +61,29 @@ class Condition < Lithic::Internal::Type::BaseModel # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. # - # @return [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Attribute, nil] - optional :attribute, enum: -> { Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute } + # @return [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Attribute] + required :attribute, enum: -> { Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute } # @!attribute operation # The operation to apply to the attribute # - # @return [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Operation, nil] - optional :operation, enum: -> { Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation } + # @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation] + required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation } # @!attribute value # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` # - # @return [String, Integer, Array, nil] - optional :value, union: -> { Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value } + # @return [String, Integer, Array] + required :value, union: -> { Lithic::AuthRules::ConditionalValue } - # @!method initialize(attribute: nil, operation: nil, value: nil) + # @!method initialize(attribute:, operation:, value:) # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition} for more # details. # # @param attribute [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Attribute] The attribute to target. # - # @param operation [Symbol, Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Operation] The operation to apply to the attribute + # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute # # @param value [String, Integer, Array] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` @@ -129,49 +129,6 @@ module Attribute # @!method self.values # @return [Array] end - - # The operation to apply to the attribute - # - # @see Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition#operation - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF = :IS_ONE_OF - IS_NOT_ONE_OF = :IS_NOT_ONE_OF - MATCHES = :MATCHES - DOES_NOT_MATCH = :DOES_NOT_MATCH - IS_EQUAL_TO = :IS_EQUAL_TO - IS_NOT_EQUAL_TO = :IS_NOT_EQUAL_TO - IS_GREATER_THAN = :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO = :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN = :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO = :IS_LESS_THAN_OR_EQUAL_TO - - # @!method self.values - # @return [Array] - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - # - # @see Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition#value - module Value - extend Lithic::Internal::Type::Union - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - variant String - - # A number, to be used with `IS_GREATER_THAN`, `IS_GREATER_THAN_OR_EQUAL_TO`, `IS_LESS_THAN`, `IS_LESS_THAN_OR_EQUAL_TO`, `IS_EQUAL_TO`, or `IS_NOT_EQUAL_TO` - variant Integer - - # An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` - variant -> { Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::Value::StringArray } - - # @!method self.variants - # @return [Array(String, Integer, Array)] - - # @type [Lithic::Internal::Type::Converter] - StringArray = Lithic::Internal::Type::ArrayOf[String] - end end end end diff --git a/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb b/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb new file mode 100644 index 00000000..9b22cd09 --- /dev/null +++ b/lib/lithic/models/auth_rules/conditional_ach_action_parameters.rb @@ -0,0 +1,260 @@ +# frozen_string_literal: true + +module Lithic + module Models + module AuthRules + class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel + # @!attribute action + # The action to take if the conditions are met + # + # @return [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction] + required :action, union: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action } + + # @!attribute conditions + # + # @return [Array] + required :conditions, + -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::ConditionalACHActionParameters::Condition] } + + # @!method initialize(action:, conditions:) + # @param action [Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction] The action to take if the conditions are met + # + # @param conditions [Array] + + # The action to take if the conditions are met + # + # @see Lithic::Models::AuthRules::ConditionalACHActionParameters#action + module Action + extend Lithic::Internal::Type::Union + + variant -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction } + + variant -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction } + + class ApproveAction < Lithic::Internal::Type::BaseModel + # @!attribute type + # Approve the ACH transaction + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type] + required :type, + enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type } + + # @!method initialize(type:) + # @param type [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type] Approve the ACH transaction + + # Approve the ACH transaction + # + # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction#type + module Type + extend Lithic::Internal::Type::Enum + + APPROVE = :APPROVE + + # @!method self.values + # @return [Array] + end + end + + class ReturnAction < Lithic::Internal::Type::BaseModel + # @!attribute code + # NACHA return code to use when returning the transaction. Note that the list of + # available return codes is subject to an allowlist configured at the program + # level + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code] + required :code, enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code } + + # @!attribute type + # Return the ACH transaction + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type] + required :type, enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type } + + # @!method initialize(code:, type:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction} + # for more details. + # + # @param code [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code] NACHA return code to use when returning the transaction. Note that the list of a + # + # @param type [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type] Return the ACH transaction + + # NACHA return code to use when returning the transaction. Note that the list of + # available return codes is subject to an allowlist configured at the program + # level + # + # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction#code + module Code + extend Lithic::Internal::Type::Enum + + R01 = :R01 + R02 = :R02 + R03 = :R03 + R04 = :R04 + R05 = :R05 + R06 = :R06 + R07 = :R07 + R08 = :R08 + R09 = :R09 + R10 = :R10 + R11 = :R11 + R12 = :R12 + R13 = :R13 + R14 = :R14 + R15 = :R15 + R16 = :R16 + R17 = :R17 + R18 = :R18 + R19 = :R19 + R20 = :R20 + R21 = :R21 + R22 = :R22 + R23 = :R23 + R24 = :R24 + R25 = :R25 + R26 = :R26 + R27 = :R27 + R28 = :R28 + R29 = :R29 + R30 = :R30 + R31 = :R31 + R32 = :R32 + R33 = :R33 + R34 = :R34 + R35 = :R35 + R36 = :R36 + R37 = :R37 + R38 = :R38 + R39 = :R39 + R40 = :R40 + R41 = :R41 + R42 = :R42 + R43 = :R43 + R44 = :R44 + R45 = :R45 + R46 = :R46 + R47 = :R47 + R50 = :R50 + R51 = :R51 + R52 = :R52 + R53 = :R53 + R61 = :R61 + R62 = :R62 + R67 = :R67 + R68 = :R68 + R69 = :R69 + R70 = :R70 + R71 = :R71 + R72 = :R72 + R73 = :R73 + R74 = :R74 + R75 = :R75 + R76 = :R76 + R77 = :R77 + R80 = :R80 + R81 = :R81 + R82 = :R82 + R83 = :R83 + R84 = :R84 + R85 = :R85 + + # @!method self.values + # @return [Array] + end + + # Return the ACH transaction + # + # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction#type + module Type + extend Lithic::Internal::Type::Enum + + RETURN = :RETURN + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction)] + end + + class Condition < Lithic::Internal::Type::BaseModel + # @!attribute attribute + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `COMPANY_NAME`: The name of the company initiating the ACH transaction. + # - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company + # ID) of the entity initiating the ACH transaction. + # - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format. + # - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units + # (cents). + # - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. + # Valid values include PPD (Prearranged Payment and Deposit Entry), CCD + # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL + # (Telephone-Initiated Entry), and others. + # - `MEMO`: Optional memo or description field included with the ACH transaction. + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::Attribute] + required :attribute, enum: -> { Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute } + + # @!attribute operation + # The operation to apply to the attribute + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation] + required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation } + + # @!attribute value + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + # + # @return [String, Integer, Array] + required :value, union: -> { Lithic::AuthRules::ConditionalValue } + + # @!method initialize(attribute:, operation:, value:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition} for more + # details. + # + # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::Attribute] The attribute to target. + # + # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute + # + # @param value [String, Integer, Array] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `COMPANY_NAME`: The name of the company initiating the ACH transaction. + # - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company + # ID) of the entity initiating the ACH transaction. + # - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format. + # - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units + # (cents). + # - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. + # Valid values include PPD (Prearranged Payment and Deposit Entry), CCD + # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL + # (Telephone-Initiated Entry), and others. + # - `MEMO`: Optional memo or description field included with the ACH transaction. + # + # @see Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition#attribute + module Attribute + extend Lithic::Internal::Type::Enum + + COMPANY_NAME = :COMPANY_NAME + COMPANY_ID = :COMPANY_ID + TIMESTAMP = :TIMESTAMP + TRANSACTION_AMOUNT = :TRANSACTION_AMOUNT + SEC_CODE = :SEC_CODE + MEMO = :MEMO + + # @!method self.values + # @return [Array] + end + end + end + end + end +end diff --git a/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb b/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb index ce941344..e512a3b3 100644 --- a/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb +++ b/lib/lithic/models/auth_rules/conditional_authorization_action_parameters.rb @@ -91,32 +91,30 @@ class Condition < Lithic::Internal::Type::BaseModel # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. # - # @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute, nil] - optional :attribute, + # @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute] + required :attribute, enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute } # @!attribute operation # The operation to apply to the attribute # - # @return [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation, nil] - optional :operation, - enum: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation } + # @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation] + required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation } # @!attribute value # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` # - # @return [String, Integer, Array, nil] - optional :value, - union: -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value } + # @return [String, Integer, Array] + required :value, union: -> { Lithic::AuthRules::ConditionalValue } - # @!method initialize(attribute: nil, operation: nil, value: nil) + # @!method initialize(attribute:, operation:, value:) # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition} # for more details. # # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute] The attribute to target. # - # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation] The operation to apply to the attribute + # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute # # @param value [String, Integer, Array] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` @@ -202,49 +200,6 @@ module Attribute # @!method self.values # @return [Array] end - - # The operation to apply to the attribute - # - # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition#operation - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF = :IS_ONE_OF - IS_NOT_ONE_OF = :IS_NOT_ONE_OF - MATCHES = :MATCHES - DOES_NOT_MATCH = :DOES_NOT_MATCH - IS_EQUAL_TO = :IS_EQUAL_TO - IS_NOT_EQUAL_TO = :IS_NOT_EQUAL_TO - IS_GREATER_THAN = :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO = :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN = :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO = :IS_LESS_THAN_OR_EQUAL_TO - - # @!method self.values - # @return [Array] - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - # - # @see Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition#value - module Value - extend Lithic::Internal::Type::Union - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - variant String - - # A number, to be used with `IS_GREATER_THAN`, `IS_GREATER_THAN_OR_EQUAL_TO`, `IS_LESS_THAN`, `IS_LESS_THAN_OR_EQUAL_TO`, `IS_EQUAL_TO`, or `IS_NOT_EQUAL_TO` - variant Integer - - # An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` - variant -> { Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::StringArray } - - # @!method self.variants - # @return [Array(String, Integer, Array)] - - # @type [Lithic::Internal::Type::Converter] - StringArray = Lithic::Internal::Type::ArrayOf[String] - end end end end diff --git a/lib/lithic/models/auth_rules/conditional_operation.rb b/lib/lithic/models/auth_rules/conditional_operation.rb new file mode 100644 index 00000000..954bf04d --- /dev/null +++ b/lib/lithic/models/auth_rules/conditional_operation.rb @@ -0,0 +1,26 @@ +# frozen_string_literal: true + +module Lithic + module Models + module AuthRules + # The operation to apply to the attribute + module ConditionalOperation + extend Lithic::Internal::Type::Enum + + IS_ONE_OF = :IS_ONE_OF + IS_NOT_ONE_OF = :IS_NOT_ONE_OF + MATCHES = :MATCHES + DOES_NOT_MATCH = :DOES_NOT_MATCH + IS_EQUAL_TO = :IS_EQUAL_TO + IS_NOT_EQUAL_TO = :IS_NOT_EQUAL_TO + IS_GREATER_THAN = :IS_GREATER_THAN + IS_GREATER_THAN_OR_EQUAL_TO = :IS_GREATER_THAN_OR_EQUAL_TO + IS_LESS_THAN = :IS_LESS_THAN + IS_LESS_THAN_OR_EQUAL_TO = :IS_LESS_THAN_OR_EQUAL_TO + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb b/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb new file mode 100644 index 00000000..48e45259 --- /dev/null +++ b/lib/lithic/models/auth_rules/conditional_tokenization_action_parameters.rb @@ -0,0 +1,254 @@ +# frozen_string_literal: true + +module Lithic + module Models + module AuthRules + class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseModel + # @!attribute action + # The action to take if the conditions are met + # + # @return [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction] + required :action, union: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action } + + # @!attribute conditions + # + # @return [Array] + required :conditions, + -> { Lithic::Internal::Type::ArrayOf[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] } + + # @!method initialize(action:, conditions:) + # @param action [Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction] The action to take if the conditions are met + # + # @param conditions [Array] + + # The action to take if the conditions are met + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters#action + module Action + extend Lithic::Internal::Type::Union + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction } + + class DeclineAction < Lithic::Internal::Type::BaseModel + # @!attribute type + # Decline the tokenization request + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type] + required :type, + enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type } + + # @!attribute reason + # Reason code for declining the tokenization request + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason, nil] + optional :reason, + enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason } + + # @!method initialize(type:, reason: nil) + # @param type [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type] Decline the tokenization request + # + # @param reason [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason] Reason code for declining the tokenization request + + # Decline the tokenization request + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction#type + module Type + extend Lithic::Internal::Type::Enum + + DECLINE = :DECLINE + + # @!method self.values + # @return [Array] + end + + # Reason code for declining the tokenization request + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction#reason + module Reason + extend Lithic::Internal::Type::Enum + + ACCOUNT_SCORE_1 = :ACCOUNT_SCORE_1 + DEVICE_SCORE_1 = :DEVICE_SCORE_1 + ALL_WALLET_DECLINE_REASONS_PRESENT = :ALL_WALLET_DECLINE_REASONS_PRESENT + WALLET_RECOMMENDED_DECISION_RED = :WALLET_RECOMMENDED_DECISION_RED + CVC_MISMATCH = :CVC_MISMATCH + CARD_EXPIRY_MONTH_MISMATCH = :CARD_EXPIRY_MONTH_MISMATCH + CARD_EXPIRY_YEAR_MISMATCH = :CARD_EXPIRY_YEAR_MISMATCH + CARD_INVALID_STATE = :CARD_INVALID_STATE + CUSTOMER_RED_PATH = :CUSTOMER_RED_PATH + INVALID_CUSTOMER_RESPONSE = :INVALID_CUSTOMER_RESPONSE + NETWORK_FAILURE = :NETWORK_FAILURE + GENERIC_DECLINE = :GENERIC_DECLINE + DIGITAL_CARD_ART_REQUIRED = :DIGITAL_CARD_ART_REQUIRED + + # @!method self.values + # @return [Array] + end + end + + class RequireTfaAction < Lithic::Internal::Type::BaseModel + # @!attribute type + # Require two-factor authentication for the tokenization request + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type] + required :type, + enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type } + + # @!attribute reason + # Reason code for requiring two-factor authentication + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason, nil] + optional :reason, + enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason } + + # @!method initialize(type:, reason: nil) + # @param type [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type] Require two-factor authentication for the tokenization request + # + # @param reason [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason] Reason code for requiring two-factor authentication + + # Require two-factor authentication for the tokenization request + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction#type + module Type + extend Lithic::Internal::Type::Enum + + REQUIRE_TFA = :REQUIRE_TFA + + # @!method self.values + # @return [Array] + end + + # Reason code for requiring two-factor authentication + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction#reason + module Reason + extend Lithic::Internal::Type::Enum + + WALLET_RECOMMENDED_TFA = :WALLET_RECOMMENDED_TFA + SUSPICIOUS_ACTIVITY = :SUSPICIOUS_ACTIVITY + DEVICE_RECENTLY_LOST = :DEVICE_RECENTLY_LOST + TOO_MANY_RECENT_ATTEMPTS = :TOO_MANY_RECENT_ATTEMPTS + TOO_MANY_RECENT_TOKENS = :TOO_MANY_RECENT_TOKENS + TOO_MANY_DIFFERENT_CARDHOLDERS = :TOO_MANY_DIFFERENT_CARDHOLDERS + OUTSIDE_HOME_TERRITORY = :OUTSIDE_HOME_TERRITORY + HAS_SUSPENDED_TOKENS = :HAS_SUSPENDED_TOKENS + HIGH_RISK = :HIGH_RISK + ACCOUNT_SCORE_LOW = :ACCOUNT_SCORE_LOW + DEVICE_SCORE_LOW = :DEVICE_SCORE_LOW + CARD_STATE_TFA = :CARD_STATE_TFA + HARDCODED_TFA = :HARDCODED_TFA + CUSTOMER_RULE_TFA = :CUSTOMER_RULE_TFA + DEVICE_HOST_CARD_EMULATION = :DEVICE_HOST_CARD_EMULATION + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction)] + end + + class Condition < Lithic::Internal::Type::BaseModel + # @!attribute attribute + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format. + # - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was + # initiated (e.g., DIGITAL_WALLET, ECOMMERCE). + # - `TOKENIZATION_SOURCE`: The source of the tokenization request. + # - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid + # values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, + # `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, + # `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, + # `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`. + # - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet + # provider. Valid values include APPROVE, DECLINE, + # REQUIRE_ADDITIONAL_AUTHENTICATION. + # - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token. + # - `WALLET_TOKEN_STATUS`: The current status of the wallet token. + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute] + required :attribute, + enum: -> { Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute } + + # @!attribute operation + # The operation to apply to the attribute + # + # @return [Symbol, Lithic::Models::AuthRules::ConditionalOperation] + required :operation, enum: -> { Lithic::AuthRules::ConditionalOperation } + + # @!attribute value + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + # + # @return [String, Integer, Array] + required :value, union: -> { Lithic::AuthRules::ConditionalValue } + + # @!method initialize(attribute:, operation:, value:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition} + # for more details. + # + # @param attribute [Symbol, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute] The attribute to target. + # + # @param operation [Symbol, Lithic::Models::AuthRules::ConditionalOperation] The operation to apply to the attribute + # + # @param value [String, Integer, Array] A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format. + # - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was + # initiated (e.g., DIGITAL_WALLET, ECOMMERCE). + # - `TOKENIZATION_SOURCE`: The source of the tokenization request. + # - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid + # values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, + # `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, + # `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, + # `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`. + # - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet + # provider. Valid values include APPROVE, DECLINE, + # REQUIRE_ADDITIONAL_AUTHENTICATION. + # - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token. + # - `WALLET_TOKEN_STATUS`: The current status of the wallet token. + # + # @see Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition#attribute + module Attribute + extend Lithic::Internal::Type::Enum + + TIMESTAMP = :TIMESTAMP + TOKENIZATION_CHANNEL = :TOKENIZATION_CHANNEL + TOKENIZATION_SOURCE = :TOKENIZATION_SOURCE + TOKEN_REQUESTOR_NAME = :TOKEN_REQUESTOR_NAME + WALLET_ACCOUNT_SCORE = :WALLET_ACCOUNT_SCORE + WALLET_DEVICE_SCORE = :WALLET_DEVICE_SCORE + WALLET_RECOMMENDED_DECISION = :WALLET_RECOMMENDED_DECISION + TOKEN_REQUESTOR_ID = :TOKEN_REQUESTOR_ID + WALLET_TOKEN_STATUS = :WALLET_TOKEN_STATUS + + # @!method self.values + # @return [Array] + end + end + end + end + end +end diff --git a/lib/lithic/models/auth_rules/conditional_value.rb b/lib/lithic/models/auth_rules/conditional_value.rb new file mode 100644 index 00000000..64a34fe2 --- /dev/null +++ b/lib/lithic/models/auth_rules/conditional_value.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Lithic + module Models + module AuthRules + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + module ConditionalValue + extend Lithic::Internal::Type::Union + + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + variant String + + # A number, to be used with `IS_GREATER_THAN`, `IS_GREATER_THAN_OR_EQUAL_TO`, `IS_LESS_THAN`, `IS_LESS_THAN_OR_EQUAL_TO`, `IS_EQUAL_TO`, or `IS_NOT_EQUAL_TO` + variant Integer + + # An array of strings, to be used with `IS_ONE_OF` or `IS_NOT_ONE_OF` + variant -> { Lithic::Models::AuthRules::ConditionalValue::StringArray } + + # @!method self.variants + # @return [Array(String, Integer, Array)] + + # @type [Lithic::Internal::Type::Converter] + StringArray = Lithic::Internal::Type::ArrayOf[String] + end + end + end +end diff --git a/lib/lithic/models/auth_rules/v2_create_params.rb b/lib/lithic/models/auth_rules/v2_create_params.rb index 25e88d3e..d15531c2 100644 --- a/lib/lithic/models/auth_rules/v2_create_params.rb +++ b/lib/lithic/models/auth_rules/v2_create_params.rb @@ -11,7 +11,7 @@ class V2CreateParams < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::AuthRules::V2CreateParams::Parameters } # @!attribute type @@ -23,7 +23,8 @@ class V2CreateParams < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] required :type, enum: -> { Lithic::AuthRules::V2CreateParams::Type } @@ -74,7 +75,7 @@ class V2CreateParams < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2CreateParams} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. For certain rule types, this determines the event stream # @@ -108,8 +109,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end # The type of Auth Rule. For certain rule types, this determines the event stream @@ -120,7 +125,8 @@ module Parameters # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum @@ -139,6 +145,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] diff --git a/lib/lithic/models/auth_rules/v2_create_response.rb b/lib/lithic/models/auth_rules/v2_create_response.rb index 1b2a2aed..c235810c 100644 --- a/lib/lithic/models/auth_rules/v2_create_response.rb +++ b/lib/lithic/models/auth_rules/v2_create_response.rb @@ -79,7 +79,8 @@ class V2CreateResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2CreateResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2CreateResponse::Type } @@ -125,7 +126,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2CreateResponse::CurrentVersion::Parameters } @@ -142,7 +143,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2CreateResponse::CurrentVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -162,8 +163,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -172,7 +177,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2CreateResponse::DraftVersion::Parameters } response_only do @@ -188,7 +193,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2CreateResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -208,8 +213,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -221,6 +230,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -247,7 +259,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2CreateResponse#type module Type diff --git a/lib/lithic/models/auth_rules/v2_draft_params.rb b/lib/lithic/models/auth_rules/v2_draft_params.rb index 6479f3e2..10e2d072 100644 --- a/lib/lithic/models/auth_rules/v2_draft_params.rb +++ b/lib/lithic/models/auth_rules/v2_draft_params.rb @@ -11,11 +11,11 @@ class V2DraftParams < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, nil] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, nil] optional :parameters, union: -> { Lithic::AuthRules::V2DraftParams::Parameters }, nil?: true # @!method initialize(parameters: nil, request_options: {}) - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, nil] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, nil] Parameters for the Auth Rule # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}] @@ -33,8 +33,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end end diff --git a/lib/lithic/models/auth_rules/v2_draft_response.rb b/lib/lithic/models/auth_rules/v2_draft_response.rb index 1ac7c880..b1cd473c 100644 --- a/lib/lithic/models/auth_rules/v2_draft_response.rb +++ b/lib/lithic/models/auth_rules/v2_draft_response.rb @@ -79,7 +79,8 @@ class V2DraftResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2DraftResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2DraftResponse::Type } @@ -125,7 +126,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2DraftResponse::CurrentVersion::Parameters } response_only do @@ -141,7 +142,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2DraftResponse::CurrentVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -161,8 +162,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -171,7 +176,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2DraftResponse::DraftVersion::Parameters } response_only do @@ -187,7 +192,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2DraftResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -207,8 +212,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -220,6 +229,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -246,7 +258,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2DraftResponse#type module Type diff --git a/lib/lithic/models/auth_rules/v2_list_params.rb b/lib/lithic/models/auth_rules/v2_list_params.rb index 0b5ee4fc..92a8e995 100644 --- a/lib/lithic/models/auth_rules/v2_list_params.rb +++ b/lib/lithic/models/auth_rules/v2_list_params.rb @@ -86,6 +86,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] diff --git a/lib/lithic/models/auth_rules/v2_list_response.rb b/lib/lithic/models/auth_rules/v2_list_response.rb index ff8d117d..8475ba03 100644 --- a/lib/lithic/models/auth_rules/v2_list_response.rb +++ b/lib/lithic/models/auth_rules/v2_list_response.rb @@ -79,7 +79,8 @@ class V2ListResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2ListResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2ListResponse::Type } @@ -125,7 +126,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2ListResponse::CurrentVersion::Parameters } response_only do @@ -141,7 +142,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2ListResponse::CurrentVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -161,8 +162,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -171,7 +176,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2ListResponse::DraftVersion::Parameters } response_only do @@ -187,7 +192,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2ListResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -207,8 +212,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -220,6 +229,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -246,7 +258,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2ListResponse#type module Type diff --git a/lib/lithic/models/auth_rules/v2_promote_response.rb b/lib/lithic/models/auth_rules/v2_promote_response.rb index 6d5e81bf..3d61bb7f 100644 --- a/lib/lithic/models/auth_rules/v2_promote_response.rb +++ b/lib/lithic/models/auth_rules/v2_promote_response.rb @@ -79,7 +79,8 @@ class V2PromoteResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2PromoteResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2PromoteResponse::Type } @@ -125,7 +126,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2PromoteResponse::CurrentVersion::Parameters } @@ -142,7 +143,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2PromoteResponse::CurrentVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -162,8 +163,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -172,7 +177,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2PromoteResponse::DraftVersion::Parameters } response_only do @@ -188,7 +193,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2PromoteResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -208,8 +213,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -221,6 +230,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -247,7 +259,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2PromoteResponse#type module Type diff --git a/lib/lithic/models/auth_rules/v2_retrieve_response.rb b/lib/lithic/models/auth_rules/v2_retrieve_response.rb index c76ccdc8..065eee00 100644 --- a/lib/lithic/models/auth_rules/v2_retrieve_response.rb +++ b/lib/lithic/models/auth_rules/v2_retrieve_response.rb @@ -81,7 +81,8 @@ class V2RetrieveResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2RetrieveResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2RetrieveResponse::Type } @@ -127,7 +128,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2RetrieveResponse::CurrentVersion::Parameters } @@ -145,7 +146,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # {Lithic::Models::AuthRules::V2RetrieveResponse::CurrentVersion} for more # details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -165,8 +166,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -175,7 +180,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2RetrieveResponse::DraftVersion::Parameters } @@ -192,7 +197,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2RetrieveResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -212,8 +217,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -225,6 +234,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -251,7 +263,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2RetrieveResponse#type module Type diff --git a/lib/lithic/models/auth_rules/v2_update_response.rb b/lib/lithic/models/auth_rules/v2_update_response.rb index c8414a38..6362b2cc 100644 --- a/lib/lithic/models/auth_rules/v2_update_response.rb +++ b/lib/lithic/models/auth_rules/v2_update_response.rb @@ -79,7 +79,8 @@ class V2UpdateResponse < Lithic::Internal::Type::BaseModel # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @return [Symbol, Lithic::Models::AuthRules::V2UpdateResponse::Type] required :type, enum: -> { Lithic::Models::AuthRules::V2UpdateResponse::Type } @@ -125,7 +126,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2UpdateResponse::CurrentVersion::Parameters } @@ -142,7 +143,7 @@ class CurrentVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2UpdateResponse::CurrentVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -162,8 +163,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -172,7 +177,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # @!attribute parameters # Parameters for the Auth Rule # - # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] + # @return [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] required :parameters, union: -> { Lithic::Models::AuthRules::V2UpdateResponse::DraftVersion::Parameters } response_only do @@ -188,7 +193,7 @@ class DraftVersion < Lithic::Internal::Type::BaseModel # Some parameter documentations has been truncated, see # {Lithic::Models::AuthRules::V2UpdateResponse::DraftVersion} for more details. # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param version [Integer] The version of the rule, this is incremented whenever the rule's parameters chan @@ -208,8 +213,12 @@ module Parameters variant -> { Lithic::AuthRules::ConditionalAuthorizationActionParameters } + variant -> { Lithic::AuthRules::ConditionalACHActionParameters } + + variant -> { Lithic::AuthRules::ConditionalTokenizationActionParameters } + # @!method self.variants - # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters)] + # @return [Array(Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters)] end end @@ -221,6 +230,9 @@ module EventStream AUTHORIZATION = :AUTHORIZATION THREE_DS_AUTHENTICATION = :THREE_DS_AUTHENTICATION + TOKENIZATION = :TOKENIZATION + ACH_CREDIT_RECEIPT = :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT = :ACH_DEBIT_RECEIPT # @!method self.values # @return [Array] @@ -247,7 +259,8 @@ module State # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. # # @see Lithic::Models::AuthRules::V2UpdateResponse#type module Type diff --git a/lib/lithic/models/book_transfer_response.rb b/lib/lithic/models/book_transfer_response.rb index 9561f649..3059d390 100644 --- a/lib/lithic/models/book_transfer_response.rb +++ b/lib/lithic/models/book_transfer_response.rb @@ -328,6 +328,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] diff --git a/lib/lithic/models/category_details.rb b/lib/lithic/models/category_details.rb new file mode 100644 index 00000000..a6e58dcb --- /dev/null +++ b/lib/lithic/models/category_details.rb @@ -0,0 +1,27 @@ +# frozen_string_literal: true + +module Lithic + module Models + class CategoryDetails < Lithic::Internal::Type::BaseModel + # @!attribute balance_transfers + # + # @return [String] + required :balance_transfers, String + + # @!attribute cash_advances + # + # @return [String] + required :cash_advances, String + + # @!attribute purchases + # + # @return [String] + required :purchases, String + + # @!method initialize(balance_transfers:, cash_advances:, purchases:) + # @param balance_transfers [String] + # @param cash_advances [String] + # @param purchases [String] + end + end +end diff --git a/lib/lithic/models/dispute.rb b/lib/lithic/models/dispute.rb index 41f79aa9..fb4d28fc 100644 --- a/lib/lithic/models/dispute.rb +++ b/lib/lithic/models/dispute.rb @@ -2,591 +2,323 @@ module Lithic module Models + # @see Lithic::Resources::Disputes#create class Dispute < Lithic::Internal::Type::BaseModel # @!attribute token - # Token assigned by Lithic for the dispute, in UUID format. + # Globally unique identifier. # # @return [String] required :token, String - # @!attribute account_token - # Token for the account associated with the dispute, in UUID format. + # @!attribute amount + # Amount under dispute. May be different from the original transaction amount. # - # @return [String] - required :account_token, String - - # @!attribute card_token - # Token for the card used in the dispute, in UUID format. - # - # @return [String] - required :card_token, String + # @return [Integer] + required :amount, Integer - # @!attribute case_id - # Identifier assigned by the network for this dispute. + # @!attribute arbitration_date + # Date dispute entered arbitration. # - # @return [String, nil] - required :case_id, String, nil?: true + # @return [Time, nil] + required :arbitration_date, Time, nil?: true # @!attribute created - # When the dispute was created. + # Timestamp of when first Dispute was reported. # # @return [Time] required :created, Time - # @!attribute currency - # Three-letter ISO 4217 currency code. + # @!attribute customer_filed_date + # Date that the dispute was filed by the customer making the dispute. # - # @return [String] - required :currency, String + # @return [Time, nil] + required :customer_filed_date, Time, nil?: true - # @!attribute disposition - # Dispute resolution outcome + # @!attribute customer_note + # End customer description of the reason for the dispute. # - # @return [Symbol, Lithic::Models::Dispute::Disposition, nil] - required :disposition, enum: -> { Lithic::Dispute::Disposition }, nil?: true + # @return [String, nil] + required :customer_note, String, nil?: true - # @!attribute events - # Chronological list of events that have occurred in the dispute lifecycle + # @!attribute network_claim_ids + # Unique identifiers for the dispute from the network. # - # @return [Array] - required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::Dispute::Event] } + # @return [Array, nil] + required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - # @!attribute liability_allocation - # Current breakdown of how liability is allocated for the disputed amount + # @!attribute network_filed_date + # Date that the dispute was submitted to the network. # - # @return [Lithic::Models::Dispute::LiabilityAllocation] - required :liability_allocation, -> { Lithic::Dispute::LiabilityAllocation } + # @return [Time, nil] + required :network_filed_date, Time, nil?: true - # @!attribute merchant + # @!attribute network_reason_code + # Network reason code used to file the dispute. # - # @return [Lithic::Models::Dispute::Merchant] - required :merchant, -> { Lithic::Dispute::Merchant } + # @return [String, nil] + required :network_reason_code, String, nil?: true - # @!attribute network - # Card network handling the dispute. + # @!attribute prearbitration_date + # Date dispute entered pre-arbitration. # - # @return [Symbol, Lithic::Models::Dispute::Network] - required :network, enum: -> { Lithic::Dispute::Network } + # @return [Time, nil] + required :prearbitration_date, Time, nil?: true - # @!attribute status - # Current status of the dispute. + # @!attribute primary_claim_id + # Unique identifier for the dispute from the network. If there are multiple, this + # will be the first claim id set by the network # - # @return [Symbol, Lithic::Models::Dispute::Status, nil] - required :status, enum: -> { Lithic::Dispute::Status }, nil?: true + # @return [String, nil] + required :primary_claim_id, String, nil?: true + + # @!attribute reason + # Dispute reason: + # + # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. + # - `CANCELLED`: Transaction was cancelled by the customer. + # - `DUPLICATED`: The transaction was a duplicate. + # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. + # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. + # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable + # merchant activity. + # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as + # described. + # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. + # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. + # - `MISSING_AUTH`: The transaction was missing authorization. + # - `OTHER`: Other reason. + # - `PROCESSING_ERROR`: Processing error. + # - `REFUND_NOT_PROCESSED`: The refund was not processed. + # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not + # cancelled. + # + # @return [Symbol, Lithic::Models::Dispute::Reason] + required :reason, enum: -> { Lithic::Dispute::Reason } + + # @!attribute representment_date + # Date the representment was received. + # + # @return [Time, nil] + required :representment_date, Time, nil?: true + + # @!attribute resolution_date + # Date that the dispute was resolved. + # + # @return [Time, nil] + required :resolution_date, Time, nil?: true + + # @!attribute resolution_note + # Note by Dispute team on the case resolution. + # + # @return [String, nil] + required :resolution_note, String, nil?: true + + # @!attribute resolution_reason + # Reason for the dispute resolution: + # + # - `CASE_LOST`: This case was lost at final arbitration. + # - `NETWORK_REJECTED`: Network rejected. + # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. + # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. + # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. + # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. + # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. + # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. + # - `PAST_FILING_DATE`: Past filing date. + # - `PREARBITRATION_REJECTED`: Prearbitration rejected. + # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. + # - `REFUNDED`: Refunded. + # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. + # - `WITHDRAWN`: Withdrawn. + # - `WON_ARBITRATION`: Won arbitration. + # - `WON_FIRST_CHARGEBACK`: Won first chargeback. + # - `WON_PREARBITRATION`: Won prearbitration. + # + # @return [Symbol, Lithic::Models::Dispute::ResolutionReason, nil] + required :resolution_reason, enum: -> { Lithic::Dispute::ResolutionReason }, nil?: true - # @!attribute transaction_series - # Contains identifiers for the transaction and specific event within being - # disputed; null if no transaction can be identified + # @!attribute status + # Status types: + # + # - `NEW` - New dispute case is opened. + # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more + # information. + # - `SUBMITTED` - Dispute is submitted to the card network. + # - `REPRESENTMENT` - Case has entered second presentment. + # - `PREARBITRATION` - Case has entered prearbitration. + # - `ARBITRATION` - Case has entered arbitration. + # - `CASE_WON` - Case was won and credit will be issued. + # - `CASE_CLOSED` - Case was lost or withdrawn. # - # @return [Lithic::Models::Dispute::TransactionSeries, nil] - required :transaction_series, -> { Lithic::Dispute::TransactionSeries }, nil?: true + # @return [Symbol, Lithic::Models::Dispute::Status] + required :status, enum: -> { Lithic::Dispute::Status } - # @!attribute updated - # When the dispute was last updated. + # @!attribute transaction_token + # The transaction that is being disputed. A transaction can only be disputed once + # but may have multiple dispute cases. # - # @return [Time] - required :updated, Time + # @return [String] + required :transaction_token, String - # @!method initialize(token:, account_token:, card_token:, case_id:, created:, currency:, disposition:, events:, liability_allocation:, merchant:, network:, status:, transaction_series:, updated:) + # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) # Some parameter documentations has been truncated, see {Lithic::Models::Dispute} # for more details. # - # The Dispute object tracks the progression of a dispute throughout its lifecycle. + # Dispute. + # + # @param token [String] Globally unique identifier. + # + # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. # - # @param token [String] Token assigned by Lithic for the dispute, in UUID format. + # @param arbitration_date [Time, nil] Date dispute entered arbitration. # - # @param account_token [String] Token for the account associated with the dispute, in UUID format. + # @param created [Time] Timestamp of when first Dispute was reported. # - # @param card_token [String] Token for the card used in the dispute, in UUID format. + # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. # - # @param case_id [String, nil] Identifier assigned by the network for this dispute. + # @param customer_note [String, nil] End customer description of the reason for the dispute. # - # @param created [Time] When the dispute was created. + # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. # - # @param currency [String] Three-letter ISO 4217 currency code. + # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. # - # @param disposition [Symbol, Lithic::Models::Dispute::Disposition, nil] Dispute resolution outcome + # @param network_reason_code [String, nil] Network reason code used to file the dispute. # - # @param events [Array] Chronological list of events that have occurred in the dispute lifecycle + # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. # - # @param liability_allocation [Lithic::Models::Dispute::LiabilityAllocation] Current breakdown of how liability is allocated for the disputed amount + # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this # - # @param merchant [Lithic::Models::Dispute::Merchant] + # @param reason [Symbol, Lithic::Models::Dispute::Reason] Dispute reason: # - # @param network [Symbol, Lithic::Models::Dispute::Network] Card network handling the dispute. + # @param representment_date [Time, nil] Date the representment was received. # - # @param status [Symbol, Lithic::Models::Dispute::Status, nil] Current status of the dispute. + # @param resolution_date [Time, nil] Date that the dispute was resolved. # - # @param transaction_series [Lithic::Models::Dispute::TransactionSeries, nil] Contains identifiers for the transaction and specific event within being dispute + # @param resolution_note [String, nil] Note by Dispute team on the case resolution. # - # @param updated [Time] When the dispute was last updated. + # @param resolution_reason [Symbol, Lithic::Models::Dispute::ResolutionReason, nil] Reason for the dispute resolution: + # + # @param status [Symbol, Lithic::Models::Dispute::Status] Status types: + # + # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - # Dispute resolution outcome + # Dispute reason: + # + # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. + # - `CANCELLED`: Transaction was cancelled by the customer. + # - `DUPLICATED`: The transaction was a duplicate. + # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. + # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. + # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable + # merchant activity. + # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as + # described. + # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. + # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. + # - `MISSING_AUTH`: The transaction was missing authorization. + # - `OTHER`: Other reason. + # - `PROCESSING_ERROR`: Processing error. + # - `REFUND_NOT_PROCESSED`: The refund was not processed. + # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not + # cancelled. # - # @see Lithic::Models::Dispute#disposition - module Disposition + # @see Lithic::Models::Dispute#reason + module Reason extend Lithic::Internal::Type::Enum - WON = :WON - LOST = :LOST - PARTIALLY_WON = :PARTIALLY_WON - WITHDRAWN = :WITHDRAWN - DENIED = :DENIED + ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE + CANCELLED = :CANCELLED + DUPLICATED = :DUPLICATED + FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT + FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT + FRAUD_OTHER = :FRAUD_OTHER + GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED + GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED + INCORRECT_AMOUNT = :INCORRECT_AMOUNT + MISSING_AUTH = :MISSING_AUTH + OTHER = :OTHER + PROCESSING_ERROR = :PROCESSING_ERROR + RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED + REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED # @!method self.values # @return [Array] end - class Event < Lithic::Internal::Type::BaseModel - # @!attribute token - # Unique identifier for the event, in UUID format - # - # @return [String] - required :token, String - - # @!attribute created - # When the event occurred - # - # @return [Time] - required :created, Time - - # @!attribute data - # Details specific to the event type - # - # @return [Lithic::Models::Dispute::Event::Data::WorkflowEventData, Lithic::Models::Dispute::Event::Data::FinancialEventData, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData] - required :data, union: -> { Lithic::Dispute::Event::Data } - - # @!attribute type - # Type of event - # - # @return [Symbol, Lithic::Models::Dispute::Event::Type] - required :type, enum: -> { Lithic::Dispute::Event::Type } - - # @!method initialize(token:, created:, data:, type:) - # Event that occurred in the dispute lifecycle - # - # @param token [String] Unique identifier for the event, in UUID format - # - # @param created [Time] When the event occurred - # - # @param data [Lithic::Models::Dispute::Event::Data::WorkflowEventData, Lithic::Models::Dispute::Event::Data::FinancialEventData, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData] Details specific to the event type - # - # @param type [Symbol, Lithic::Models::Dispute::Event::Type] Type of event - - # Details specific to the event type - # - # @see Lithic::Models::Dispute::Event#data - module Data - extend Lithic::Internal::Type::Union - - # Details specific to workflow events - variant -> { Lithic::Dispute::Event::Data::WorkflowEventData } - - # Details specific to financial events - variant -> { Lithic::Dispute::Event::Data::FinancialEventData } - - # Details specific to cardholder liability events - variant -> { Lithic::Dispute::Event::Data::CardholderLiabilityEventData } - - class WorkflowEventData < Lithic::Internal::Type::BaseModel - # @!attribute action - # Action taken in this stage - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Action] - required :action, enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Action } - - # @!attribute amount - # Amount in minor units - # - # @return [Integer, nil] - required :amount, Integer, nil?: true - - # @!attribute disposition - # Dispute resolution outcome - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Disposition, nil] - required :disposition, - enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Disposition }, - nil?: true - - # @!attribute reason - # Reason for the action - # - # @return [String, nil] - required :reason, String, nil?: true - - # @!attribute stage - # Current stage of the dispute workflow - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Stage] - required :stage, enum: -> { Lithic::Dispute::Event::Data::WorkflowEventData::Stage } - - # @!method initialize(action:, amount:, disposition:, reason:, stage:) - # Details specific to workflow events - # - # @param action [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Action] Action taken in this stage - # - # @param amount [Integer, nil] Amount in minor units - # - # @param disposition [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Disposition, nil] Dispute resolution outcome - # - # @param reason [String, nil] Reason for the action - # - # @param stage [Symbol, Lithic::Models::Dispute::Event::Data::WorkflowEventData::Stage] Current stage of the dispute workflow - - # Action taken in this stage - # - # @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#action - module Action - extend Lithic::Internal::Type::Enum - - OPENED = :OPENED - CLOSED = :CLOSED - REOPENED = :REOPENED - - # @!method self.values - # @return [Array] - end - - # Dispute resolution outcome - # - # @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#disposition - module Disposition - extend Lithic::Internal::Type::Enum - - WON = :WON - LOST = :LOST - PARTIALLY_WON = :PARTIALLY_WON - WITHDRAWN = :WITHDRAWN - DENIED = :DENIED - - # @!method self.values - # @return [Array] - end - - # Current stage of the dispute workflow - # - # @see Lithic::Models::Dispute::Event::Data::WorkflowEventData#stage - module Stage - extend Lithic::Internal::Type::Enum - - CLAIM = :CLAIM - - # @!method self.values - # @return [Array] - end - end - - class FinancialEventData < Lithic::Internal::Type::BaseModel - # @!attribute amount - # Amount in minor units - # - # @return [Integer] - required :amount, Integer - - # @!attribute polarity - # Direction of funds flow - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Polarity] - required :polarity, enum: -> { Lithic::Dispute::Event::Data::FinancialEventData::Polarity } - - # @!attribute stage - # Stage at which the financial event occurred - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Stage] - required :stage, enum: -> { Lithic::Dispute::Event::Data::FinancialEventData::Stage } - - # @!method initialize(amount:, polarity:, stage:) - # Details specific to financial events - # - # @param amount [Integer] Amount in minor units - # - # @param polarity [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Polarity] Direction of funds flow - # - # @param stage [Symbol, Lithic::Models::Dispute::Event::Data::FinancialEventData::Stage] Stage at which the financial event occurred - - # Direction of funds flow - # - # @see Lithic::Models::Dispute::Event::Data::FinancialEventData#polarity - module Polarity - extend Lithic::Internal::Type::Enum - - CREDIT = :CREDIT - DEBIT = :DEBIT - - # @!method self.values - # @return [Array] - end - - # Stage at which the financial event occurred - # - # @see Lithic::Models::Dispute::Event::Data::FinancialEventData#stage - module Stage - extend Lithic::Internal::Type::Enum - - CHARGEBACK = :CHARGEBACK - REPRESENTMENT = :REPRESENTMENT - PREARBITRATION = :PREARBITRATION - ARBITRATION = :ARBITRATION - COLLABORATION = :COLLABORATION - - # @!method self.values - # @return [Array] - end - end - - class CardholderLiabilityEventData < Lithic::Internal::Type::BaseModel - # @!attribute action - # Action taken regarding cardholder liability - # - # @return [Symbol, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::Action] - required :action, enum: -> { Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action } - - # @!attribute amount - # Amount in minor units - # - # @return [Integer] - required :amount, Integer - - # @!attribute reason - # Reason for the action - # - # @return [String] - required :reason, String - - # @!method initialize(action:, amount:, reason:) - # Details specific to cardholder liability events - # - # @param action [Symbol, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::Action] Action taken regarding cardholder liability - # - # @param amount [Integer] Amount in minor units - # - # @param reason [String] Reason for the action - - # Action taken regarding cardholder liability - # - # @see Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData#action - module Action - extend Lithic::Internal::Type::Enum - - PROVISIONAL_CREDIT_GRANTED = :PROVISIONAL_CREDIT_GRANTED - PROVISIONAL_CREDIT_REVERSED = :PROVISIONAL_CREDIT_REVERSED - WRITTEN_OFF = :WRITTEN_OFF - - # @!method self.values - # @return [Array] - end - end - - # @!method self.variants - # @return [Array(Lithic::Models::Dispute::Event::Data::WorkflowEventData, Lithic::Models::Dispute::Event::Data::FinancialEventData, Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData)] - end - - # Type of event - # - # @see Lithic::Models::Dispute::Event#type - module Type - extend Lithic::Internal::Type::Enum - - WORKFLOW = :WORKFLOW - FINANCIAL = :FINANCIAL - CARDHOLDER_LIABILITY = :CARDHOLDER_LIABILITY - - # @!method self.values - # @return [Array] - end - end - - # @see Lithic::Models::Dispute#liability_allocation - class LiabilityAllocation < Lithic::Internal::Type::BaseModel - # @!attribute denied_amount - # The amount that has been denied to the cardholder - # - # @return [Integer] - required :denied_amount, Integer - - # @!attribute original_amount - # The initial amount disputed - # - # @return [Integer] - required :original_amount, Integer - - # @!attribute recovered_amount - # The amount that has been recovered from the merchant through the dispute process - # - # @return [Integer] - required :recovered_amount, Integer - - # @!attribute remaining_amount - # Any disputed amount that is still outstanding, i.e. has not been recovered, - # written off, or denied - # - # @return [Integer] - required :remaining_amount, Integer - - # @!attribute written_off_amount - # The amount the issuer has chosen to write off - # - # @return [Integer] - required :written_off_amount, Integer - - # @!method initialize(denied_amount:, original_amount:, recovered_amount:, remaining_amount:, written_off_amount:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::Dispute::LiabilityAllocation} for more details. - # - # Current breakdown of how liability is allocated for the disputed amount - # - # @param denied_amount [Integer] The amount that has been denied to the cardholder - # - # @param original_amount [Integer] The initial amount disputed - # - # @param recovered_amount [Integer] The amount that has been recovered from the merchant through the dispute process - # - # @param remaining_amount [Integer] Any disputed amount that is still outstanding, i.e. has not been recovered, writ - # - # @param written_off_amount [Integer] The amount the issuer has chosen to write off - end - - # @see Lithic::Models::Dispute#merchant - class Merchant < Lithic::Internal::Type::BaseModel - # @!attribute acceptor_id - # Unique alphanumeric identifier for the payment card acceptor (merchant). - # - # @return [String] - required :acceptor_id, String - - # @!attribute acquiring_institution_id - # Unique numeric identifier of the acquiring institution. - # - # @return [String] - required :acquiring_institution_id, String - - # @!attribute city - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - # - # @return [String] - required :city, String - - # @!attribute country - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - # - # @return [String] - required :country, String - - # @!attribute descriptor - # Short description of card acceptor. - # - # @return [String] - required :descriptor, String - - # @!attribute mcc - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - # - # @return [String] - required :mcc, String - - # @!attribute state - # Geographic state of card acceptor. - # - # @return [String] - required :state, String - - # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::Dispute::Merchant} for more details. - # - # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). - # - # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution. - # - # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present - # - # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph - # - # @param descriptor [String] Short description of card acceptor. - # - # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # - # @param state [String] Geographic state of card acceptor. - end - - # Card network handling the dispute. - # - # @see Lithic::Models::Dispute#network - module Network + # Reason for the dispute resolution: + # + # - `CASE_LOST`: This case was lost at final arbitration. + # - `NETWORK_REJECTED`: Network rejected. + # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. + # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. + # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. + # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. + # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. + # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. + # - `PAST_FILING_DATE`: Past filing date. + # - `PREARBITRATION_REJECTED`: Prearbitration rejected. + # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. + # - `REFUNDED`: Refunded. + # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. + # - `WITHDRAWN`: Withdrawn. + # - `WON_ARBITRATION`: Won arbitration. + # - `WON_FIRST_CHARGEBACK`: Won first chargeback. + # - `WON_PREARBITRATION`: Won prearbitration. + # + # @see Lithic::Models::Dispute#resolution_reason + module ResolutionReason extend Lithic::Internal::Type::Enum - VISA = :VISA - MASTERCARD = :MASTERCARD + CASE_LOST = :CASE_LOST + NETWORK_REJECTED = :NETWORK_REJECTED + NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS + NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD + NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS + NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID + NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS + NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER + PAST_FILING_DATE = :PAST_FILING_DATE + PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED + PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER + REFUNDED = :REFUNDED + REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK + WITHDRAWN = :WITHDRAWN + WON_ARBITRATION = :WON_ARBITRATION + WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK + WON_PREARBITRATION = :WON_PREARBITRATION # @!method self.values # @return [Array] end - # Current status of the dispute. + # Status types: + # + # - `NEW` - New dispute case is opened. + # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more + # information. + # - `SUBMITTED` - Dispute is submitted to the card network. + # - `REPRESENTMENT` - Case has entered second presentment. + # - `PREARBITRATION` - Case has entered prearbitration. + # - `ARBITRATION` - Case has entered arbitration. + # - `CASE_WON` - Case was won and credit will be issued. + # - `CASE_CLOSED` - Case was lost or withdrawn. # # @see Lithic::Models::Dispute#status module Status extend Lithic::Internal::Type::Enum - OPEN = :OPEN - CLOSED = :CLOSED + ARBITRATION = :ARBITRATION + CASE_CLOSED = :CASE_CLOSED + CASE_WON = :CASE_WON + NEW = :NEW + PENDING_CUSTOMER = :PENDING_CUSTOMER + PREARBITRATION = :PREARBITRATION + REPRESENTMENT = :REPRESENTMENT + SUBMITTED = :SUBMITTED # @!method self.values # @return [Array] end - - # @see Lithic::Models::Dispute#transaction_series - class TransactionSeries < Lithic::Internal::Type::BaseModel - # @!attribute related_transaction_event_token - # Token of the specific event in the original transaction being disputed, in UUID - # format; null if no event can be identified - # - # @return [String, nil] - required :related_transaction_event_token, String, nil?: true - - # @!attribute related_transaction_token - # Token of the original transaction being disputed, in UUID format - # - # @return [String] - required :related_transaction_token, String - - # @!attribute type - # The type of transaction series associating the dispute and the original - # transaction. Always set to DISPUTE - # - # @return [Symbol, Lithic::Models::Dispute::TransactionSeries::Type] - required :type, enum: -> { Lithic::Dispute::TransactionSeries::Type } - - # @!method initialize(related_transaction_event_token:, related_transaction_token:, type:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::Dispute::TransactionSeries} for more details. - # - # Contains identifiers for the transaction and specific event within being - # disputed; null if no transaction can be identified - # - # @param related_transaction_event_token [String, nil] Token of the specific event in the original transaction being disputed, in UUID - # - # @param related_transaction_token [String] Token of the original transaction being disputed, in UUID format - # - # @param type [Symbol, Lithic::Models::Dispute::TransactionSeries::Type] The type of transaction series associating the dispute and the original transact - - # The type of transaction series associating the dispute and the original - # transaction. Always set to DISPUTE - # - # @see Lithic::Models::Dispute::TransactionSeries#type - module Type - extend Lithic::Internal::Type::Enum - - DISPUTE = :DISPUTE - - # @!method self.values - # @return [Array] - end - end end end end diff --git a/lib/lithic/models/dispute_create_response.rb b/lib/lithic/models/dispute_create_response.rb deleted file mode 100644 index 452c366b..00000000 --- a/lib/lithic/models/dispute_create_response.rb +++ /dev/null @@ -1,326 +0,0 @@ -# frozen_string_literal: true - -module Lithic - module Models - # @see Lithic::Resources::Disputes#create - class DisputeCreateResponse < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String] - required :token, String - - # @!attribute amount - # Amount under dispute. May be different from the original transaction amount. - # - # @return [Integer] - required :amount, Integer - - # @!attribute arbitration_date - # Date dispute entered arbitration. - # - # @return [Time, nil] - required :arbitration_date, Time, nil?: true - - # @!attribute created - # Timestamp of when first Dispute was reported. - # - # @return [Time] - required :created, Time - - # @!attribute customer_filed_date - # Date that the dispute was filed by the customer making the dispute. - # - # @return [Time, nil] - required :customer_filed_date, Time, nil?: true - - # @!attribute customer_note - # End customer description of the reason for the dispute. - # - # @return [String, nil] - required :customer_note, String, nil?: true - - # @!attribute network_claim_ids - # Unique identifiers for the dispute from the network. - # - # @return [Array, nil] - required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute network_filed_date - # Date that the dispute was submitted to the network. - # - # @return [Time, nil] - required :network_filed_date, Time, nil?: true - - # @!attribute network_reason_code - # Network reason code used to file the dispute. - # - # @return [String, nil] - required :network_reason_code, String, nil?: true - - # @!attribute prearbitration_date - # Date dispute entered pre-arbitration. - # - # @return [Time, nil] - required :prearbitration_date, Time, nil?: true - - # @!attribute primary_claim_id - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - # - # @return [String, nil] - required :primary_claim_id, String, nil?: true - - # @!attribute reason - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @return [Symbol, Lithic::Models::DisputeCreateResponse::Reason] - required :reason, enum: -> { Lithic::Models::DisputeCreateResponse::Reason } - - # @!attribute representment_date - # Date the representment was received. - # - # @return [Time, nil] - required :representment_date, Time, nil?: true - - # @!attribute resolution_date - # Date that the dispute was resolved. - # - # @return [Time, nil] - required :resolution_date, Time, nil?: true - - # @!attribute resolution_note - # Note by Dispute team on the case resolution. - # - # @return [String, nil] - required :resolution_note, String, nil?: true - - # @!attribute resolution_reason - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @return [Symbol, Lithic::Models::DisputeCreateResponse::ResolutionReason, nil] - required :resolution_reason, - enum: -> { Lithic::Models::DisputeCreateResponse::ResolutionReason }, - nil?: true - - # @!attribute status - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @return [Symbol, Lithic::Models::DisputeCreateResponse::Status] - required :status, enum: -> { Lithic::Models::DisputeCreateResponse::Status } - - # @!attribute transaction_token - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - # - # @return [String] - required :transaction_token, String - - # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::DisputeCreateResponse} for more details. - # - # Dispute. - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. - # - # @param arbitration_date [Time, nil] Date dispute entered arbitration. - # - # @param created [Time] Timestamp of when first Dispute was reported. - # - # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. - # - # @param customer_note [String, nil] End customer description of the reason for the dispute. - # - # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. - # - # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. - # - # @param network_reason_code [String, nil] Network reason code used to file the dispute. - # - # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. - # - # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this - # - # @param reason [Symbol, Lithic::Models::DisputeCreateResponse::Reason] Dispute reason: - # - # @param representment_date [Time, nil] Date the representment was received. - # - # @param resolution_date [Time, nil] Date that the dispute was resolved. - # - # @param resolution_note [String, nil] Note by Dispute team on the case resolution. - # - # @param resolution_reason [Symbol, Lithic::Models::DisputeCreateResponse::ResolutionReason, nil] Reason for the dispute resolution: - # - # @param status [Symbol, Lithic::Models::DisputeCreateResponse::Status] Status types: - # - # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @see Lithic::Models::DisputeCreateResponse#reason - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE - CANCELLED = :CANCELLED - DUPLICATED = :DUPLICATED - FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT - FRAUD_OTHER = :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT = :INCORRECT_AMOUNT - MISSING_AUTH = :MISSING_AUTH - OTHER = :OTHER - PROCESSING_ERROR = :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED - - # @!method self.values - # @return [Array] - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @see Lithic::Models::DisputeCreateResponse#resolution_reason - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST = :CASE_LOST - NETWORK_REJECTED = :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE = :PAST_FILING_DATE - PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER - REFUNDED = :REFUNDED - REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN = :WITHDRAWN - WON_ARBITRATION = :WON_ARBITRATION - WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK - WON_PREARBITRATION = :WON_PREARBITRATION - - # @!method self.values - # @return [Array] - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @see Lithic::Models::DisputeCreateResponse#status - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION = :ARBITRATION - CASE_CLOSED = :CASE_CLOSED - CASE_WON = :CASE_WON - NEW = :NEW - PENDING_CUSTOMER = :PENDING_CUSTOMER - PREARBITRATION = :PREARBITRATION - REPRESENTMENT = :REPRESENTMENT - SUBMITTED = :SUBMITTED - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/lithic/models/dispute_delete_response.rb b/lib/lithic/models/dispute_delete_response.rb deleted file mode 100644 index 2f53b878..00000000 --- a/lib/lithic/models/dispute_delete_response.rb +++ /dev/null @@ -1,326 +0,0 @@ -# frozen_string_literal: true - -module Lithic - module Models - # @see Lithic::Resources::Disputes#delete - class DisputeDeleteResponse < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String] - required :token, String - - # @!attribute amount - # Amount under dispute. May be different from the original transaction amount. - # - # @return [Integer] - required :amount, Integer - - # @!attribute arbitration_date - # Date dispute entered arbitration. - # - # @return [Time, nil] - required :arbitration_date, Time, nil?: true - - # @!attribute created - # Timestamp of when first Dispute was reported. - # - # @return [Time] - required :created, Time - - # @!attribute customer_filed_date - # Date that the dispute was filed by the customer making the dispute. - # - # @return [Time, nil] - required :customer_filed_date, Time, nil?: true - - # @!attribute customer_note - # End customer description of the reason for the dispute. - # - # @return [String, nil] - required :customer_note, String, nil?: true - - # @!attribute network_claim_ids - # Unique identifiers for the dispute from the network. - # - # @return [Array, nil] - required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute network_filed_date - # Date that the dispute was submitted to the network. - # - # @return [Time, nil] - required :network_filed_date, Time, nil?: true - - # @!attribute network_reason_code - # Network reason code used to file the dispute. - # - # @return [String, nil] - required :network_reason_code, String, nil?: true - - # @!attribute prearbitration_date - # Date dispute entered pre-arbitration. - # - # @return [Time, nil] - required :prearbitration_date, Time, nil?: true - - # @!attribute primary_claim_id - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - # - # @return [String, nil] - required :primary_claim_id, String, nil?: true - - # @!attribute reason - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @return [Symbol, Lithic::Models::DisputeDeleteResponse::Reason] - required :reason, enum: -> { Lithic::Models::DisputeDeleteResponse::Reason } - - # @!attribute representment_date - # Date the representment was received. - # - # @return [Time, nil] - required :representment_date, Time, nil?: true - - # @!attribute resolution_date - # Date that the dispute was resolved. - # - # @return [Time, nil] - required :resolution_date, Time, nil?: true - - # @!attribute resolution_note - # Note by Dispute team on the case resolution. - # - # @return [String, nil] - required :resolution_note, String, nil?: true - - # @!attribute resolution_reason - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @return [Symbol, Lithic::Models::DisputeDeleteResponse::ResolutionReason, nil] - required :resolution_reason, - enum: -> { Lithic::Models::DisputeDeleteResponse::ResolutionReason }, - nil?: true - - # @!attribute status - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @return [Symbol, Lithic::Models::DisputeDeleteResponse::Status] - required :status, enum: -> { Lithic::Models::DisputeDeleteResponse::Status } - - # @!attribute transaction_token - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - # - # @return [String] - required :transaction_token, String - - # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::DisputeDeleteResponse} for more details. - # - # Dispute. - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. - # - # @param arbitration_date [Time, nil] Date dispute entered arbitration. - # - # @param created [Time] Timestamp of when first Dispute was reported. - # - # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. - # - # @param customer_note [String, nil] End customer description of the reason for the dispute. - # - # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. - # - # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. - # - # @param network_reason_code [String, nil] Network reason code used to file the dispute. - # - # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. - # - # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this - # - # @param reason [Symbol, Lithic::Models::DisputeDeleteResponse::Reason] Dispute reason: - # - # @param representment_date [Time, nil] Date the representment was received. - # - # @param resolution_date [Time, nil] Date that the dispute was resolved. - # - # @param resolution_note [String, nil] Note by Dispute team on the case resolution. - # - # @param resolution_reason [Symbol, Lithic::Models::DisputeDeleteResponse::ResolutionReason, nil] Reason for the dispute resolution: - # - # @param status [Symbol, Lithic::Models::DisputeDeleteResponse::Status] Status types: - # - # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @see Lithic::Models::DisputeDeleteResponse#reason - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE - CANCELLED = :CANCELLED - DUPLICATED = :DUPLICATED - FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT - FRAUD_OTHER = :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT = :INCORRECT_AMOUNT - MISSING_AUTH = :MISSING_AUTH - OTHER = :OTHER - PROCESSING_ERROR = :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED - - # @!method self.values - # @return [Array] - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @see Lithic::Models::DisputeDeleteResponse#resolution_reason - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST = :CASE_LOST - NETWORK_REJECTED = :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE = :PAST_FILING_DATE - PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER - REFUNDED = :REFUNDED - REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN = :WITHDRAWN - WON_ARBITRATION = :WON_ARBITRATION - WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK - WON_PREARBITRATION = :WON_PREARBITRATION - - # @!method self.values - # @return [Array] - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @see Lithic::Models::DisputeDeleteResponse#status - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION = :ARBITRATION - CASE_CLOSED = :CASE_CLOSED - CASE_WON = :CASE_WON - NEW = :NEW - PENDING_CUSTOMER = :PENDING_CUSTOMER - PREARBITRATION = :PREARBITRATION - REPRESENTMENT = :REPRESENTMENT - SUBMITTED = :SUBMITTED - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/lithic/models/dispute_list_response.rb b/lib/lithic/models/dispute_list_response.rb deleted file mode 100644 index 3cb20040..00000000 --- a/lib/lithic/models/dispute_list_response.rb +++ /dev/null @@ -1,326 +0,0 @@ -# frozen_string_literal: true - -module Lithic - module Models - # @see Lithic::Resources::Disputes#list - class DisputeListResponse < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String] - required :token, String - - # @!attribute amount - # Amount under dispute. May be different from the original transaction amount. - # - # @return [Integer] - required :amount, Integer - - # @!attribute arbitration_date - # Date dispute entered arbitration. - # - # @return [Time, nil] - required :arbitration_date, Time, nil?: true - - # @!attribute created - # Timestamp of when first Dispute was reported. - # - # @return [Time] - required :created, Time - - # @!attribute customer_filed_date - # Date that the dispute was filed by the customer making the dispute. - # - # @return [Time, nil] - required :customer_filed_date, Time, nil?: true - - # @!attribute customer_note - # End customer description of the reason for the dispute. - # - # @return [String, nil] - required :customer_note, String, nil?: true - - # @!attribute network_claim_ids - # Unique identifiers for the dispute from the network. - # - # @return [Array, nil] - required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute network_filed_date - # Date that the dispute was submitted to the network. - # - # @return [Time, nil] - required :network_filed_date, Time, nil?: true - - # @!attribute network_reason_code - # Network reason code used to file the dispute. - # - # @return [String, nil] - required :network_reason_code, String, nil?: true - - # @!attribute prearbitration_date - # Date dispute entered pre-arbitration. - # - # @return [Time, nil] - required :prearbitration_date, Time, nil?: true - - # @!attribute primary_claim_id - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - # - # @return [String, nil] - required :primary_claim_id, String, nil?: true - - # @!attribute reason - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @return [Symbol, Lithic::Models::DisputeListResponse::Reason] - required :reason, enum: -> { Lithic::Models::DisputeListResponse::Reason } - - # @!attribute representment_date - # Date the representment was received. - # - # @return [Time, nil] - required :representment_date, Time, nil?: true - - # @!attribute resolution_date - # Date that the dispute was resolved. - # - # @return [Time, nil] - required :resolution_date, Time, nil?: true - - # @!attribute resolution_note - # Note by Dispute team on the case resolution. - # - # @return [String, nil] - required :resolution_note, String, nil?: true - - # @!attribute resolution_reason - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @return [Symbol, Lithic::Models::DisputeListResponse::ResolutionReason, nil] - required :resolution_reason, - enum: -> { Lithic::Models::DisputeListResponse::ResolutionReason }, - nil?: true - - # @!attribute status - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @return [Symbol, Lithic::Models::DisputeListResponse::Status] - required :status, enum: -> { Lithic::Models::DisputeListResponse::Status } - - # @!attribute transaction_token - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - # - # @return [String] - required :transaction_token, String - - # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::DisputeListResponse} for more details. - # - # Dispute. - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. - # - # @param arbitration_date [Time, nil] Date dispute entered arbitration. - # - # @param created [Time] Timestamp of when first Dispute was reported. - # - # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. - # - # @param customer_note [String, nil] End customer description of the reason for the dispute. - # - # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. - # - # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. - # - # @param network_reason_code [String, nil] Network reason code used to file the dispute. - # - # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. - # - # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this - # - # @param reason [Symbol, Lithic::Models::DisputeListResponse::Reason] Dispute reason: - # - # @param representment_date [Time, nil] Date the representment was received. - # - # @param resolution_date [Time, nil] Date that the dispute was resolved. - # - # @param resolution_note [String, nil] Note by Dispute team on the case resolution. - # - # @param resolution_reason [Symbol, Lithic::Models::DisputeListResponse::ResolutionReason, nil] Reason for the dispute resolution: - # - # @param status [Symbol, Lithic::Models::DisputeListResponse::Status] Status types: - # - # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @see Lithic::Models::DisputeListResponse#reason - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE - CANCELLED = :CANCELLED - DUPLICATED = :DUPLICATED - FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT - FRAUD_OTHER = :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT = :INCORRECT_AMOUNT - MISSING_AUTH = :MISSING_AUTH - OTHER = :OTHER - PROCESSING_ERROR = :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED - - # @!method self.values - # @return [Array] - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @see Lithic::Models::DisputeListResponse#resolution_reason - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST = :CASE_LOST - NETWORK_REJECTED = :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE = :PAST_FILING_DATE - PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER - REFUNDED = :REFUNDED - REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN = :WITHDRAWN - WON_ARBITRATION = :WON_ARBITRATION - WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK - WON_PREARBITRATION = :WON_PREARBITRATION - - # @!method self.values - # @return [Array] - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @see Lithic::Models::DisputeListResponse#status - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION = :ARBITRATION - CASE_CLOSED = :CASE_CLOSED - CASE_WON = :CASE_WON - NEW = :NEW - PENDING_CUSTOMER = :PENDING_CUSTOMER - PREARBITRATION = :PREARBITRATION - REPRESENTMENT = :REPRESENTMENT - SUBMITTED = :SUBMITTED - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/lithic/models/dispute_retrieve_response.rb b/lib/lithic/models/dispute_retrieve_response.rb deleted file mode 100644 index 82beb226..00000000 --- a/lib/lithic/models/dispute_retrieve_response.rb +++ /dev/null @@ -1,326 +0,0 @@ -# frozen_string_literal: true - -module Lithic - module Models - # @see Lithic::Resources::Disputes#retrieve - class DisputeRetrieveResponse < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String] - required :token, String - - # @!attribute amount - # Amount under dispute. May be different from the original transaction amount. - # - # @return [Integer] - required :amount, Integer - - # @!attribute arbitration_date - # Date dispute entered arbitration. - # - # @return [Time, nil] - required :arbitration_date, Time, nil?: true - - # @!attribute created - # Timestamp of when first Dispute was reported. - # - # @return [Time] - required :created, Time - - # @!attribute customer_filed_date - # Date that the dispute was filed by the customer making the dispute. - # - # @return [Time, nil] - required :customer_filed_date, Time, nil?: true - - # @!attribute customer_note - # End customer description of the reason for the dispute. - # - # @return [String, nil] - required :customer_note, String, nil?: true - - # @!attribute network_claim_ids - # Unique identifiers for the dispute from the network. - # - # @return [Array, nil] - required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute network_filed_date - # Date that the dispute was submitted to the network. - # - # @return [Time, nil] - required :network_filed_date, Time, nil?: true - - # @!attribute network_reason_code - # Network reason code used to file the dispute. - # - # @return [String, nil] - required :network_reason_code, String, nil?: true - - # @!attribute prearbitration_date - # Date dispute entered pre-arbitration. - # - # @return [Time, nil] - required :prearbitration_date, Time, nil?: true - - # @!attribute primary_claim_id - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - # - # @return [String, nil] - required :primary_claim_id, String, nil?: true - - # @!attribute reason - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @return [Symbol, Lithic::Models::DisputeRetrieveResponse::Reason] - required :reason, enum: -> { Lithic::Models::DisputeRetrieveResponse::Reason } - - # @!attribute representment_date - # Date the representment was received. - # - # @return [Time, nil] - required :representment_date, Time, nil?: true - - # @!attribute resolution_date - # Date that the dispute was resolved. - # - # @return [Time, nil] - required :resolution_date, Time, nil?: true - - # @!attribute resolution_note - # Note by Dispute team on the case resolution. - # - # @return [String, nil] - required :resolution_note, String, nil?: true - - # @!attribute resolution_reason - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @return [Symbol, Lithic::Models::DisputeRetrieveResponse::ResolutionReason, nil] - required :resolution_reason, - enum: -> { Lithic::Models::DisputeRetrieveResponse::ResolutionReason }, - nil?: true - - # @!attribute status - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @return [Symbol, Lithic::Models::DisputeRetrieveResponse::Status] - required :status, enum: -> { Lithic::Models::DisputeRetrieveResponse::Status } - - # @!attribute transaction_token - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - # - # @return [String] - required :transaction_token, String - - # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::DisputeRetrieveResponse} for more details. - # - # Dispute. - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. - # - # @param arbitration_date [Time, nil] Date dispute entered arbitration. - # - # @param created [Time] Timestamp of when first Dispute was reported. - # - # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. - # - # @param customer_note [String, nil] End customer description of the reason for the dispute. - # - # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. - # - # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. - # - # @param network_reason_code [String, nil] Network reason code used to file the dispute. - # - # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. - # - # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this - # - # @param reason [Symbol, Lithic::Models::DisputeRetrieveResponse::Reason] Dispute reason: - # - # @param representment_date [Time, nil] Date the representment was received. - # - # @param resolution_date [Time, nil] Date that the dispute was resolved. - # - # @param resolution_note [String, nil] Note by Dispute team on the case resolution. - # - # @param resolution_reason [Symbol, Lithic::Models::DisputeRetrieveResponse::ResolutionReason, nil] Reason for the dispute resolution: - # - # @param status [Symbol, Lithic::Models::DisputeRetrieveResponse::Status] Status types: - # - # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @see Lithic::Models::DisputeRetrieveResponse#reason - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE - CANCELLED = :CANCELLED - DUPLICATED = :DUPLICATED - FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT - FRAUD_OTHER = :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT = :INCORRECT_AMOUNT - MISSING_AUTH = :MISSING_AUTH - OTHER = :OTHER - PROCESSING_ERROR = :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED - - # @!method self.values - # @return [Array] - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @see Lithic::Models::DisputeRetrieveResponse#resolution_reason - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST = :CASE_LOST - NETWORK_REJECTED = :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE = :PAST_FILING_DATE - PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER - REFUNDED = :REFUNDED - REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN = :WITHDRAWN - WON_ARBITRATION = :WON_ARBITRATION - WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK - WON_PREARBITRATION = :WON_PREARBITRATION - - # @!method self.values - # @return [Array] - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @see Lithic::Models::DisputeRetrieveResponse#status - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION = :ARBITRATION - CASE_CLOSED = :CASE_CLOSED - CASE_WON = :CASE_WON - NEW = :NEW - PENDING_CUSTOMER = :PENDING_CUSTOMER - PREARBITRATION = :PREARBITRATION - REPRESENTMENT = :REPRESENTMENT - SUBMITTED = :SUBMITTED - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/lithic/models/dispute_update_response.rb b/lib/lithic/models/dispute_update_response.rb deleted file mode 100644 index 6bfa3acb..00000000 --- a/lib/lithic/models/dispute_update_response.rb +++ /dev/null @@ -1,326 +0,0 @@ -# frozen_string_literal: true - -module Lithic - module Models - # @see Lithic::Resources::Disputes#update - class DisputeUpdateResponse < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String] - required :token, String - - # @!attribute amount - # Amount under dispute. May be different from the original transaction amount. - # - # @return [Integer] - required :amount, Integer - - # @!attribute arbitration_date - # Date dispute entered arbitration. - # - # @return [Time, nil] - required :arbitration_date, Time, nil?: true - - # @!attribute created - # Timestamp of when first Dispute was reported. - # - # @return [Time] - required :created, Time - - # @!attribute customer_filed_date - # Date that the dispute was filed by the customer making the dispute. - # - # @return [Time, nil] - required :customer_filed_date, Time, nil?: true - - # @!attribute customer_note - # End customer description of the reason for the dispute. - # - # @return [String, nil] - required :customer_note, String, nil?: true - - # @!attribute network_claim_ids - # Unique identifiers for the dispute from the network. - # - # @return [Array, nil] - required :network_claim_ids, Lithic::Internal::Type::ArrayOf[String], nil?: true - - # @!attribute network_filed_date - # Date that the dispute was submitted to the network. - # - # @return [Time, nil] - required :network_filed_date, Time, nil?: true - - # @!attribute network_reason_code - # Network reason code used to file the dispute. - # - # @return [String, nil] - required :network_reason_code, String, nil?: true - - # @!attribute prearbitration_date - # Date dispute entered pre-arbitration. - # - # @return [Time, nil] - required :prearbitration_date, Time, nil?: true - - # @!attribute primary_claim_id - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - # - # @return [String, nil] - required :primary_claim_id, String, nil?: true - - # @!attribute reason - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @return [Symbol, Lithic::Models::DisputeUpdateResponse::Reason] - required :reason, enum: -> { Lithic::Models::DisputeUpdateResponse::Reason } - - # @!attribute representment_date - # Date the representment was received. - # - # @return [Time, nil] - required :representment_date, Time, nil?: true - - # @!attribute resolution_date - # Date that the dispute was resolved. - # - # @return [Time, nil] - required :resolution_date, Time, nil?: true - - # @!attribute resolution_note - # Note by Dispute team on the case resolution. - # - # @return [String, nil] - required :resolution_note, String, nil?: true - - # @!attribute resolution_reason - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @return [Symbol, Lithic::Models::DisputeUpdateResponse::ResolutionReason, nil] - required :resolution_reason, - enum: -> { Lithic::Models::DisputeUpdateResponse::ResolutionReason }, - nil?: true - - # @!attribute status - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @return [Symbol, Lithic::Models::DisputeUpdateResponse::Status] - required :status, enum: -> { Lithic::Models::DisputeUpdateResponse::Status } - - # @!attribute transaction_token - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - # - # @return [String] - required :transaction_token, String - - # @!method initialize(token:, amount:, arbitration_date:, created:, customer_filed_date:, customer_note:, network_claim_ids:, network_filed_date:, network_reason_code:, prearbitration_date:, primary_claim_id:, reason:, representment_date:, resolution_date:, resolution_note:, resolution_reason:, status:, transaction_token:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::DisputeUpdateResponse} for more details. - # - # Dispute. - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount under dispute. May be different from the original transaction amount. - # - # @param arbitration_date [Time, nil] Date dispute entered arbitration. - # - # @param created [Time] Timestamp of when first Dispute was reported. - # - # @param customer_filed_date [Time, nil] Date that the dispute was filed by the customer making the dispute. - # - # @param customer_note [String, nil] End customer description of the reason for the dispute. - # - # @param network_claim_ids [Array, nil] Unique identifiers for the dispute from the network. - # - # @param network_filed_date [Time, nil] Date that the dispute was submitted to the network. - # - # @param network_reason_code [String, nil] Network reason code used to file the dispute. - # - # @param prearbitration_date [Time, nil] Date dispute entered pre-arbitration. - # - # @param primary_claim_id [String, nil] Unique identifier for the dispute from the network. If there are multiple, this - # - # @param reason [Symbol, Lithic::Models::DisputeUpdateResponse::Reason] Dispute reason: - # - # @param representment_date [Time, nil] Date the representment was received. - # - # @param resolution_date [Time, nil] Date that the dispute was resolved. - # - # @param resolution_note [String, nil] Note by Dispute team on the case resolution. - # - # @param resolution_reason [Symbol, Lithic::Models::DisputeUpdateResponse::ResolutionReason, nil] Reason for the dispute resolution: - # - # @param status [Symbol, Lithic::Models::DisputeUpdateResponse::Status] Status types: - # - # @param transaction_token [String] The transaction that is being disputed. A transaction can only be disputed once - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - # - # @see Lithic::Models::DisputeUpdateResponse#reason - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE = :ATM_CASH_MISDISPENSE - CANCELLED = :CANCELLED - DUPLICATED = :DUPLICATED - FRAUD_CARD_NOT_PRESENT = :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT = :FRAUD_CARD_PRESENT - FRAUD_OTHER = :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED = :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED = :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT = :INCORRECT_AMOUNT - MISSING_AUTH = :MISSING_AUTH - OTHER = :OTHER - PROCESSING_ERROR = :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED = :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED = :REFUND_NOT_PROCESSED - - # @!method self.values - # @return [Array] - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - # - # @see Lithic::Models::DisputeUpdateResponse#resolution_reason - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST = :CASE_LOST - NETWORK_REJECTED = :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS = :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS = :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID = :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER = :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE = :PAST_FILING_DATE - PREARBITRATION_REJECTED = :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER = :PROCESSOR_REJECTED_OTHER - REFUNDED = :REFUNDED - REFUNDED_AFTER_CHARGEBACK = :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN = :WITHDRAWN - WON_ARBITRATION = :WON_ARBITRATION - WON_FIRST_CHARGEBACK = :WON_FIRST_CHARGEBACK - WON_PREARBITRATION = :WON_PREARBITRATION - - # @!method self.values - # @return [Array] - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - # - # @see Lithic::Models::DisputeUpdateResponse#status - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION = :ARBITRATION - CASE_CLOSED = :CASE_CLOSED - CASE_WON = :CASE_WON - NEW = :NEW - PENDING_CUSTOMER = :PENDING_CUSTOMER - PREARBITRATION = :PREARBITRATION - REPRESENTMENT = :REPRESENTMENT - SUBMITTED = :SUBMITTED - - # @!method self.values - # @return [Array] - end - end - end -end diff --git a/lib/lithic/models/dispute_v2.rb b/lib/lithic/models/dispute_v2.rb new file mode 100644 index 00000000..33775e17 --- /dev/null +++ b/lib/lithic/models/dispute_v2.rb @@ -0,0 +1,555 @@ +# frozen_string_literal: true + +module Lithic + module Models + # @see Lithic::Resources::DisputesV2#retrieve + class DisputeV2 < Lithic::Internal::Type::BaseModel + # @!attribute token + # Token assigned by Lithic for the dispute, in UUID format. + # + # @return [String] + required :token, String + + # @!attribute account_token + # Token for the account associated with the dispute, in UUID format. + # + # @return [String] + required :account_token, String + + # @!attribute card_token + # Token for the card used in the dispute, in UUID format. + # + # @return [String] + required :card_token, String + + # @!attribute case_id + # Identifier assigned by the network for this dispute. + # + # @return [String, nil] + required :case_id, String, nil?: true + + # @!attribute created + # When the dispute was created. + # + # @return [Time] + required :created, Time + + # @!attribute currency + # Three-letter ISO 4217 currency code. + # + # @return [String] + required :currency, String + + # @!attribute disposition + # Dispute resolution outcome + # + # @return [Symbol, Lithic::Models::DisputeV2::Disposition, nil] + required :disposition, enum: -> { Lithic::DisputeV2::Disposition }, nil?: true + + # @!attribute events + # Chronological list of events that have occurred in the dispute lifecycle + # + # @return [Array] + required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::DisputeV2::Event] } + + # @!attribute liability_allocation + # Current breakdown of how liability is allocated for the disputed amount + # + # @return [Lithic::Models::DisputeV2::LiabilityAllocation] + required :liability_allocation, -> { Lithic::DisputeV2::LiabilityAllocation } + + # @!attribute merchant + # + # @return [Lithic::Models::Merchant] + required :merchant, -> { Lithic::Merchant } + + # @!attribute network + # Card network handling the dispute. + # + # @return [Symbol, Lithic::Models::DisputeV2::Network] + required :network, enum: -> { Lithic::DisputeV2::Network } + + # @!attribute status + # Current status of the dispute. + # + # @return [Symbol, Lithic::Models::DisputeV2::Status, nil] + required :status, enum: -> { Lithic::DisputeV2::Status }, nil?: true + + # @!attribute transaction_series + # Contains identifiers for the transaction and specific event within being + # disputed; null if no transaction can be identified + # + # @return [Lithic::Models::DisputeV2::TransactionSeries, nil] + required :transaction_series, -> { Lithic::DisputeV2::TransactionSeries }, nil?: true + + # @!attribute updated + # When the dispute was last updated. + # + # @return [Time] + required :updated, Time + + # @!method initialize(token:, account_token:, card_token:, case_id:, created:, currency:, disposition:, events:, liability_allocation:, merchant:, network:, status:, transaction_series:, updated:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::DisputeV2} for more details. + # + # The Dispute object tracks the progression of a dispute throughout its lifecycle. + # + # @param token [String] Token assigned by Lithic for the dispute, in UUID format. + # + # @param account_token [String] Token for the account associated with the dispute, in UUID format. + # + # @param card_token [String] Token for the card used in the dispute, in UUID format. + # + # @param case_id [String, nil] Identifier assigned by the network for this dispute. + # + # @param created [Time] When the dispute was created. + # + # @param currency [String] Three-letter ISO 4217 currency code. + # + # @param disposition [Symbol, Lithic::Models::DisputeV2::Disposition, nil] Dispute resolution outcome + # + # @param events [Array] Chronological list of events that have occurred in the dispute lifecycle + # + # @param liability_allocation [Lithic::Models::DisputeV2::LiabilityAllocation] Current breakdown of how liability is allocated for the disputed amount + # + # @param merchant [Lithic::Models::Merchant] + # + # @param network [Symbol, Lithic::Models::DisputeV2::Network] Card network handling the dispute. + # + # @param status [Symbol, Lithic::Models::DisputeV2::Status, nil] Current status of the dispute. + # + # @param transaction_series [Lithic::Models::DisputeV2::TransactionSeries, nil] Contains identifiers for the transaction and specific event within being dispute + # + # @param updated [Time] When the dispute was last updated. + + # Dispute resolution outcome + # + # @see Lithic::Models::DisputeV2#disposition + module Disposition + extend Lithic::Internal::Type::Enum + + WON = :WON + LOST = :LOST + PARTIALLY_WON = :PARTIALLY_WON + WITHDRAWN = :WITHDRAWN + DENIED = :DENIED + + # @!method self.values + # @return [Array] + end + + class Event < Lithic::Internal::Type::BaseModel + # @!attribute token + # Unique identifier for the event, in UUID format + # + # @return [String] + required :token, String + + # @!attribute created + # When the event occurred + # + # @return [Time] + required :created, Time + + # @!attribute data + # Details specific to the event type + # + # @return [Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability] + required :data, union: -> { Lithic::DisputeV2::Event::Data } + + # @!attribute type + # Type of event + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Type] + required :type, enum: -> { Lithic::DisputeV2::Event::Type } + + # @!method initialize(token:, created:, data:, type:) + # Event that occurred in the dispute lifecycle + # + # @param token [String] Unique identifier for the event, in UUID format + # + # @param created [Time] When the event occurred + # + # @param data [Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability] Details specific to the event type + # + # @param type [Symbol, Lithic::Models::DisputeV2::Event::Type] Type of event + + # Details specific to the event type + # + # @see Lithic::Models::DisputeV2::Event#data + module Data + extend Lithic::Internal::Type::Union + + discriminator :type + + # Details specific to workflow events + variant :WORKFLOW, -> { Lithic::DisputeV2::Event::Data::Workflow } + + # Details specific to financial events + variant :FINANCIAL, -> { Lithic::DisputeV2::Event::Data::Financial } + + # Details specific to cardholder liability events + variant :CARDHOLDER_LIABILITY, -> { Lithic::DisputeV2::Event::Data::CardholderLiability } + + class Workflow < Lithic::Internal::Type::BaseModel + # @!attribute action + # Action taken in this stage + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Action] + required :action, enum: -> { Lithic::DisputeV2::Event::Data::Workflow::Action } + + # @!attribute amount + # Amount in minor units + # + # @return [Integer, nil] + required :amount, Integer, nil?: true + + # @!attribute disposition + # Dispute resolution outcome + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Disposition, nil] + required :disposition, + enum: -> { + Lithic::DisputeV2::Event::Data::Workflow::Disposition + }, + nil?: true + + # @!attribute reason + # Reason for the action + # + # @return [String, nil] + required :reason, String, nil?: true + + # @!attribute stage + # Current stage of the dispute workflow + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Stage] + required :stage, enum: -> { Lithic::DisputeV2::Event::Data::Workflow::Stage } + + # @!attribute type + # Event type discriminator + # + # @return [Symbol, :WORKFLOW] + required :type, const: :WORKFLOW + + # @!method initialize(action:, amount:, disposition:, reason:, stage:, type: :WORKFLOW) + # Details specific to workflow events + # + # @param action [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Action] Action taken in this stage + # + # @param amount [Integer, nil] Amount in minor units + # + # @param disposition [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Disposition, nil] Dispute resolution outcome + # + # @param reason [String, nil] Reason for the action + # + # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Data::Workflow::Stage] Current stage of the dispute workflow + # + # @param type [Symbol, :WORKFLOW] Event type discriminator + + # Action taken in this stage + # + # @see Lithic::Models::DisputeV2::Event::Data::Workflow#action + module Action + extend Lithic::Internal::Type::Enum + + OPENED = :OPENED + CLOSED = :CLOSED + REOPENED = :REOPENED + + # @!method self.values + # @return [Array] + end + + # Dispute resolution outcome + # + # @see Lithic::Models::DisputeV2::Event::Data::Workflow#disposition + module Disposition + extend Lithic::Internal::Type::Enum + + WON = :WON + LOST = :LOST + PARTIALLY_WON = :PARTIALLY_WON + WITHDRAWN = :WITHDRAWN + DENIED = :DENIED + + # @!method self.values + # @return [Array] + end + + # Current stage of the dispute workflow + # + # @see Lithic::Models::DisputeV2::Event::Data::Workflow#stage + module Stage + extend Lithic::Internal::Type::Enum + + CLAIM = :CLAIM + + # @!method self.values + # @return [Array] + end + end + + class Financial < Lithic::Internal::Type::BaseModel + # @!attribute amount + # Amount in minor units + # + # @return [Integer] + required :amount, Integer + + # @!attribute polarity + # Direction of funds flow + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Polarity] + required :polarity, enum: -> { Lithic::DisputeV2::Event::Data::Financial::Polarity } + + # @!attribute stage + # Stage at which the financial event occurred + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Stage] + required :stage, enum: -> { Lithic::DisputeV2::Event::Data::Financial::Stage } + + # @!attribute type + # Event type discriminator + # + # @return [Symbol, :FINANCIAL] + required :type, const: :FINANCIAL + + # @!method initialize(amount:, polarity:, stage:, type: :FINANCIAL) + # Details specific to financial events + # + # @param amount [Integer] Amount in minor units + # + # @param polarity [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Polarity] Direction of funds flow + # + # @param stage [Symbol, Lithic::Models::DisputeV2::Event::Data::Financial::Stage] Stage at which the financial event occurred + # + # @param type [Symbol, :FINANCIAL] Event type discriminator + + # Direction of funds flow + # + # @see Lithic::Models::DisputeV2::Event::Data::Financial#polarity + module Polarity + extend Lithic::Internal::Type::Enum + + CREDIT = :CREDIT + DEBIT = :DEBIT + + # @!method self.values + # @return [Array] + end + + # Stage at which the financial event occurred + # + # @see Lithic::Models::DisputeV2::Event::Data::Financial#stage + module Stage + extend Lithic::Internal::Type::Enum + + CHARGEBACK = :CHARGEBACK + REPRESENTMENT = :REPRESENTMENT + PREARBITRATION = :PREARBITRATION + ARBITRATION = :ARBITRATION + COLLABORATION = :COLLABORATION + + # @!method self.values + # @return [Array] + end + end + + class CardholderLiability < Lithic::Internal::Type::BaseModel + # @!attribute action + # Action taken regarding cardholder liability + # + # @return [Symbol, Lithic::Models::DisputeV2::Event::Data::CardholderLiability::Action] + required :action, enum: -> { Lithic::DisputeV2::Event::Data::CardholderLiability::Action } + + # @!attribute amount + # Amount in minor units + # + # @return [Integer] + required :amount, Integer + + # @!attribute reason + # Reason for the action + # + # @return [String] + required :reason, String + + # @!attribute type + # Event type discriminator + # + # @return [Symbol, :CARDHOLDER_LIABILITY] + required :type, const: :CARDHOLDER_LIABILITY + + # @!method initialize(action:, amount:, reason:, type: :CARDHOLDER_LIABILITY) + # Details specific to cardholder liability events + # + # @param action [Symbol, Lithic::Models::DisputeV2::Event::Data::CardholderLiability::Action] Action taken regarding cardholder liability + # + # @param amount [Integer] Amount in minor units + # + # @param reason [String] Reason for the action + # + # @param type [Symbol, :CARDHOLDER_LIABILITY] Event type discriminator + + # Action taken regarding cardholder liability + # + # @see Lithic::Models::DisputeV2::Event::Data::CardholderLiability#action + module Action + extend Lithic::Internal::Type::Enum + + PROVISIONAL_CREDIT_GRANTED = :PROVISIONAL_CREDIT_GRANTED + PROVISIONAL_CREDIT_REVERSED = :PROVISIONAL_CREDIT_REVERSED + WRITTEN_OFF = :WRITTEN_OFF + + # @!method self.values + # @return [Array] + end + end + + # @!method self.variants + # @return [Array(Lithic::Models::DisputeV2::Event::Data::Workflow, Lithic::Models::DisputeV2::Event::Data::Financial, Lithic::Models::DisputeV2::Event::Data::CardholderLiability)] + end + + # Type of event + # + # @see Lithic::Models::DisputeV2::Event#type + module Type + extend Lithic::Internal::Type::Enum + + WORKFLOW = :WORKFLOW + FINANCIAL = :FINANCIAL + CARDHOLDER_LIABILITY = :CARDHOLDER_LIABILITY + + # @!method self.values + # @return [Array] + end + end + + # @see Lithic::Models::DisputeV2#liability_allocation + class LiabilityAllocation < Lithic::Internal::Type::BaseModel + # @!attribute denied_amount + # The amount that has been denied to the cardholder + # + # @return [Integer] + required :denied_amount, Integer + + # @!attribute original_amount + # The initial amount disputed + # + # @return [Integer] + required :original_amount, Integer + + # @!attribute recovered_amount + # The amount that has been recovered from the merchant through the dispute process + # + # @return [Integer] + required :recovered_amount, Integer + + # @!attribute remaining_amount + # Any disputed amount that is still outstanding, i.e. has not been recovered, + # written off, or denied + # + # @return [Integer] + required :remaining_amount, Integer + + # @!attribute written_off_amount + # The amount the issuer has chosen to write off + # + # @return [Integer] + required :written_off_amount, Integer + + # @!method initialize(denied_amount:, original_amount:, recovered_amount:, remaining_amount:, written_off_amount:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::DisputeV2::LiabilityAllocation} for more details. + # + # Current breakdown of how liability is allocated for the disputed amount + # + # @param denied_amount [Integer] The amount that has been denied to the cardholder + # + # @param original_amount [Integer] The initial amount disputed + # + # @param recovered_amount [Integer] The amount that has been recovered from the merchant through the dispute process + # + # @param remaining_amount [Integer] Any disputed amount that is still outstanding, i.e. has not been recovered, writ + # + # @param written_off_amount [Integer] The amount the issuer has chosen to write off + end + + # Card network handling the dispute. + # + # @see Lithic::Models::DisputeV2#network + module Network + extend Lithic::Internal::Type::Enum + + VISA = :VISA + MASTERCARD = :MASTERCARD + + # @!method self.values + # @return [Array] + end + + # Current status of the dispute. + # + # @see Lithic::Models::DisputeV2#status + module Status + extend Lithic::Internal::Type::Enum + + OPEN = :OPEN + CLOSED = :CLOSED + + # @!method self.values + # @return [Array] + end + + # @see Lithic::Models::DisputeV2#transaction_series + class TransactionSeries < Lithic::Internal::Type::BaseModel + # @!attribute related_transaction_event_token + # Token of the specific event in the original transaction being disputed, in UUID + # format; null if no event can be identified + # + # @return [String, nil] + required :related_transaction_event_token, String, nil?: true + + # @!attribute related_transaction_token + # Token of the original transaction being disputed, in UUID format + # + # @return [String] + required :related_transaction_token, String + + # @!attribute type + # The type of transaction series associating the dispute and the original + # transaction. Always set to DISPUTE + # + # @return [Symbol, Lithic::Models::DisputeV2::TransactionSeries::Type] + required :type, enum: -> { Lithic::DisputeV2::TransactionSeries::Type } + + # @!method initialize(related_transaction_event_token:, related_transaction_token:, type:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::DisputeV2::TransactionSeries} for more details. + # + # Contains identifiers for the transaction and specific event within being + # disputed; null if no transaction can be identified + # + # @param related_transaction_event_token [String, nil] Token of the specific event in the original transaction being disputed, in UUID + # + # @param related_transaction_token [String] Token of the original transaction being disputed, in UUID format + # + # @param type [Symbol, Lithic::Models::DisputeV2::TransactionSeries::Type] The type of transaction series associating the dispute and the original transact + + # The type of transaction series associating the dispute and the original + # transaction. Always set to DISPUTE + # + # @see Lithic::Models::DisputeV2::TransactionSeries#type + module Type + extend Lithic::Internal::Type::Enum + + DISPUTE = :DISPUTE + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/lithic/models/disputes_v2_list_params.rb b/lib/lithic/models/disputes_v2_list_params.rb new file mode 100644 index 00000000..04be824a --- /dev/null +++ b/lib/lithic/models/disputes_v2_list_params.rb @@ -0,0 +1,84 @@ +# frozen_string_literal: true + +module Lithic + module Models + # @see Lithic::Resources::DisputesV2#list + class DisputesV2ListParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + # @!attribute account_token + # Filter by account token. + # + # @return [String, nil] + optional :account_token, String + + # @!attribute begin_ + # RFC 3339 timestamp for filtering by created date, inclusive. + # + # @return [Time, nil] + optional :begin_, Time + + # @!attribute card_token + # Filter by card token. + # + # @return [String, nil] + optional :card_token, String + + # @!attribute disputed_transaction_token + # Filter by the token of the transaction being disputed. Corresponds with + # transaction_series.related_transaction_token in the Dispute. + # + # @return [String, nil] + optional :disputed_transaction_token, String + + # @!attribute end_ + # RFC 3339 timestamp for filtering by created date, inclusive. + # + # @return [Time, nil] + optional :end_, Time + + # @!attribute 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 + + # @!attribute page_size + # Number of items to return. + # + # @return [Integer, nil] + optional :page_size, Integer + + # @!attribute 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 + + # @!method initialize(account_token: nil, begin_: nil, card_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {Lithic::Models::DisputesV2ListParams} for more details. + # + # @param account_token [String] Filter by account token. + # + # @param begin_ [Time] RFC 3339 timestamp for filtering by created date, inclusive. + # + # @param card_token [String] Filter by card token. + # + # @param disputed_transaction_token [String] Filter by the token of the transaction being disputed. Corresponds with transact + # + # @param end_ [Time] RFC 3339 timestamp for filtering by created date, inclusive. + # + # @param ending_before [String] A cursor representing an item's token before which a page of results should end. + # + # @param page_size [Integer] Number of items to return. + # + # @param starting_after [String] A cursor representing an item's token after which a page of results should begin + # + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/lithic/models/disputes_v2_retrieve_params.rb b/lib/lithic/models/disputes_v2_retrieve_params.rb new file mode 100644 index 00000000..73e78749 --- /dev/null +++ b/lib/lithic/models/disputes_v2_retrieve_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Lithic + module Models + # @see Lithic::Resources::DisputesV2#retrieve + class DisputesV2RetrieveParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/lithic/models/external_bank_account_address.rb b/lib/lithic/models/external_bank_account_address.rb index 257e47da..79bb3355 100644 --- a/lib/lithic/models/external_bank_account_address.rb +++ b/lib/lithic/models/external_bank_account_address.rb @@ -31,7 +31,7 @@ class ExternalBankAccountAddress < Lithic::Internal::Type::BaseModel # @!attribute address2 # # @return [String, nil] - optional :address2, String + optional :address2, String, nil?: true # @!method initialize(address1:, city:, country:, postal_code:, state:, address2: nil) # @param address1 [String] @@ -39,7 +39,7 @@ class ExternalBankAccountAddress < Lithic::Internal::Type::BaseModel # @param country [String] # @param postal_code [String] # @param state [String] - # @param address2 [String] + # @param address2 [String, nil] end end end diff --git a/lib/lithic/models/external_bank_account_create_response.rb b/lib/lithic/models/external_bank_account_create_response.rb index c625f742..88db5ccb 100644 --- a/lib/lithic/models/external_bank_account_create_response.rb +++ b/lib/lithic/models/external_bank_account_create_response.rb @@ -97,49 +97,49 @@ class ExternalBankAccountCreateResponse < Lithic::Internal::Type::BaseModel # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -147,7 +147,7 @@ class ExternalBankAccountCreateResponse < Lithic::Internal::Type::BaseModel # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -179,23 +179,23 @@ class ExternalBankAccountCreateResponse < Lithic::Internal::Type::BaseModel # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountCreateResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_bank_account_list_response.rb b/lib/lithic/models/external_bank_account_list_response.rb index 9fe538bf..fa2f6307 100644 --- a/lib/lithic/models/external_bank_account_list_response.rb +++ b/lib/lithic/models/external_bank_account_list_response.rb @@ -97,49 +97,49 @@ class ExternalBankAccountListResponse < Lithic::Internal::Type::BaseModel # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -147,7 +147,7 @@ class ExternalBankAccountListResponse < Lithic::Internal::Type::BaseModel # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -179,23 +179,23 @@ class ExternalBankAccountListResponse < Lithic::Internal::Type::BaseModel # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountListResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_bank_account_retrieve_response.rb b/lib/lithic/models/external_bank_account_retrieve_response.rb index bf29b95e..eea54399 100644 --- a/lib/lithic/models/external_bank_account_retrieve_response.rb +++ b/lib/lithic/models/external_bank_account_retrieve_response.rb @@ -97,49 +97,49 @@ class ExternalBankAccountRetrieveResponse < Lithic::Internal::Type::BaseModel # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -147,7 +147,7 @@ class ExternalBankAccountRetrieveResponse < Lithic::Internal::Type::BaseModel # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -179,23 +179,23 @@ class ExternalBankAccountRetrieveResponse < Lithic::Internal::Type::BaseModel # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountRetrieveResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb b/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb index 2c5b19f2..21b247bb 100644 --- a/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb +++ b/lib/lithic/models/external_bank_account_retry_micro_deposits_response.rb @@ -98,49 +98,49 @@ class ExternalBankAccountRetryMicroDepositsResponse < Lithic::Internal::Type::Ba # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -148,7 +148,7 @@ class ExternalBankAccountRetryMicroDepositsResponse < Lithic::Internal::Type::Ba # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -181,23 +181,23 @@ class ExternalBankAccountRetryMicroDepositsResponse < Lithic::Internal::Type::Ba # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_bank_account_retry_prenote_response.rb b/lib/lithic/models/external_bank_account_retry_prenote_response.rb index d546dfb8..932081b8 100644 --- a/lib/lithic/models/external_bank_account_retry_prenote_response.rb +++ b/lib/lithic/models/external_bank_account_retry_prenote_response.rb @@ -96,49 +96,49 @@ class ExternalBankAccountRetryPrenoteResponse < Lithic::Internal::Type::BaseMode # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -146,7 +146,7 @@ class ExternalBankAccountRetryPrenoteResponse < Lithic::Internal::Type::BaseMode # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -178,23 +178,23 @@ class ExternalBankAccountRetryPrenoteResponse < Lithic::Internal::Type::BaseMode # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountRetryPrenoteResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Account State # diff --git a/lib/lithic/models/external_bank_account_unpause_params.rb b/lib/lithic/models/external_bank_account_unpause_params.rb new file mode 100644 index 00000000..a3e3c3cf --- /dev/null +++ b/lib/lithic/models/external_bank_account_unpause_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module Lithic + module Models + # @see Lithic::Resources::ExternalBankAccounts#unpause + class ExternalBankAccountUnpauseParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + # @!method initialize(request_options: {}) + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/lithic/models/external_bank_account_unpause_response.rb b/lib/lithic/models/external_bank_account_unpause_response.rb new file mode 100644 index 00000000..076431aa --- /dev/null +++ b/lib/lithic/models/external_bank_account_unpause_response.rb @@ -0,0 +1,242 @@ +# frozen_string_literal: true + +module Lithic + module Models + # @see Lithic::Resources::ExternalBankAccounts#unpause + class ExternalBankAccountUnpauseResponse < Lithic::Internal::Type::BaseModel + # @!attribute token + # A globally unique identifier for this record of an external bank account + # association. If a program links an external bank account to more than one + # end-user or to both the program and the end-user, then Lithic will return each + # record of the association + # + # @return [String] + required :token, String + + # @!attribute country + # The country that the bank account is located in using ISO 3166-1. We will only + # accept USA bank accounts e.g., USA + # + # @return [String] + required :country, String + + # @!attribute created + # An ISO 8601 string representing when this funding source was added to the Lithic + # account. + # + # @return [Time] + required :created, Time + + # @!attribute currency + # currency of the external account 3-character alphabetic ISO 4217 code + # + # @return [String] + required :currency, String + + # @!attribute last_four + # The last 4 digits of the bank account. Derived by Lithic from the account number + # passed + # + # @return [String] + required :last_four, String + + # @!attribute owner + # Legal Name of the business or individual who owns the external account. This + # will appear in statements + # + # @return [String] + required :owner, String + + # @!attribute owner_type + # Owner Type + # + # @return [Symbol, Lithic::Models::OwnerType] + required :owner_type, enum: -> { Lithic::OwnerType } + + # @!attribute routing_number + # Routing Number + # + # @return [String] + required :routing_number, String + + # @!attribute state + # Account State + # + # @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::State] + required :state, enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::State } + + # @!attribute type + # Account Type + # + # @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::Type] + required :type, enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::Type } + + # @!attribute verification_attempts + # The number of attempts at verification + # + # @return [Integer] + required :verification_attempts, Integer + + # @!attribute verification_method + # Verification Method + # + # @return [Symbol, Lithic::Models::VerificationMethod] + required :verification_method, enum: -> { Lithic::VerificationMethod } + + # @!attribute verification_state + # Verification State + # + # @return [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState] + required :verification_state, + enum: -> { Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState } + + # @!attribute account_token + # Indicates which Lithic account the external account is associated with. For + # external accounts that are associated with the program, account_token field + # returned will be null + # + # @return [String, nil] + optional :account_token, String, nil?: true + + # @!attribute address + # Address + # + # @return [Lithic::Models::ExternalBankAccountAddress, nil] + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true + + # @!attribute company_id + # Optional field that helps identify bank accounts in receipts + # + # @return [String, nil] + optional :company_id, String, nil?: true + + # @!attribute dob + # Date of Birth of the Individual that owns the external bank account + # + # @return [Date, nil] + optional :dob, Date, nil?: true + + # @!attribute doing_business_as + # Doing Business As + # + # @return [String, nil] + optional :doing_business_as, String, nil?: true + + # @!attribute financial_account_token + # The financial account token of the operating account to fund the micro deposits + # + # @return [String, nil] + optional :financial_account_token, String, nil?: true + + # @!attribute name + # The nickname for this External Bank Account + # + # @return [String, nil] + optional :name, String, nil?: true + + # @!attribute user_defined_id + # User Defined ID + # + # @return [String, nil] + optional :user_defined_id, String, nil?: true + + # @!attribute verification_failed_reason + # Optional free text description of the reason for the failed verification. For + # ACH micro-deposits returned, this field will display the reason return code sent + # by the ACH network + # + # @return [String, nil] + optional :verification_failed_reason, String, nil?: true + + # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) + # Some parameter documentations has been truncated, see + # {Lithic::Models::ExternalBankAccountUnpauseResponse} for more details. + # + # @param token [String] A globally unique identifier for this record of an external bank account associa + # + # @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a + # + # @param created [Time] An ISO 8601 string representing when this funding source was added to the Lithic + # + # @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code + # + # @param last_four [String] The last 4 digits of the bank account. Derived by Lithic from the account number + # + # @param owner [String] Legal Name of the business or individual who owns the external account. This wil + # + # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type + # + # @param routing_number [String] Routing Number + # + # @param state [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::State] Account State + # + # @param type [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::Type] Account Type + # + # @param verification_attempts [Integer] The number of attempts at verification + # + # @param verification_method [Symbol, Lithic::Models::VerificationMethod] Verification Method + # + # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState] Verification State + # + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte + # + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address + # + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts + # + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account + # + # @param doing_business_as [String, nil] Doing Business As + # + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits + # + # @param name [String, nil] The nickname for this External Bank Account + # + # @param user_defined_id [String, nil] User Defined ID + # + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC + + # Account State + # + # @see Lithic::Models::ExternalBankAccountUnpauseResponse#state + module State + extend Lithic::Internal::Type::Enum + + ENABLED = :ENABLED + CLOSED = :CLOSED + PAUSED = :PAUSED + + # @!method self.values + # @return [Array] + end + + # Account Type + # + # @see Lithic::Models::ExternalBankAccountUnpauseResponse#type + module Type + extend Lithic::Internal::Type::Enum + + CHECKING = :CHECKING + SAVINGS = :SAVINGS + + # @!method self.values + # @return [Array] + end + + # Verification State + # + # @see Lithic::Models::ExternalBankAccountUnpauseResponse#verification_state + module VerificationState + extend Lithic::Internal::Type::Enum + + PENDING = :PENDING + ENABLED = :ENABLED + FAILED_VERIFICATION = :FAILED_VERIFICATION + INSUFFICIENT_FUNDS = :INSUFFICIENT_FUNDS + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/lithic/models/external_bank_account_update_response.rb b/lib/lithic/models/external_bank_account_update_response.rb index 5a824304..b13b825d 100644 --- a/lib/lithic/models/external_bank_account_update_response.rb +++ b/lib/lithic/models/external_bank_account_update_response.rb @@ -97,49 +97,49 @@ class ExternalBankAccountUpdateResponse < Lithic::Internal::Type::BaseModel # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -147,7 +147,7 @@ class ExternalBankAccountUpdateResponse < Lithic::Internal::Type::BaseModel # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -179,23 +179,23 @@ class ExternalBankAccountUpdateResponse < Lithic::Internal::Type::BaseModel # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb b/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb index 1e923d12..c3f82678 100644 --- a/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb +++ b/lib/lithic/models/external_bank_accounts/micro_deposit_create_response.rb @@ -99,49 +99,49 @@ class MicroDepositCreateResponse < Lithic::Internal::Type::BaseModel # returned will be null # # @return [String, nil] - optional :account_token, String + optional :account_token, String, nil?: true # @!attribute address # Address # # @return [Lithic::Models::ExternalBankAccountAddress, nil] - optional :address, -> { Lithic::ExternalBankAccountAddress } + optional :address, -> { Lithic::ExternalBankAccountAddress }, nil?: true # @!attribute company_id # Optional field that helps identify bank accounts in receipts # # @return [String, nil] - optional :company_id, String + optional :company_id, String, nil?: true # @!attribute dob # Date of Birth of the Individual that owns the external bank account # # @return [Date, nil] - optional :dob, Date + optional :dob, Date, nil?: true # @!attribute doing_business_as # Doing Business As # # @return [String, nil] - optional :doing_business_as, String + optional :doing_business_as, String, nil?: true # @!attribute financial_account_token # The financial account token of the operating account to fund the micro deposits # # @return [String, nil] - optional :financial_account_token, String + optional :financial_account_token, String, nil?: true # @!attribute name # The nickname for this External Bank Account # # @return [String, nil] - optional :name, String + optional :name, String, nil?: true # @!attribute user_defined_id # User Defined ID # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!attribute verification_failed_reason # Optional free text description of the reason for the failed verification. For @@ -149,7 +149,7 @@ class MicroDepositCreateResponse < Lithic::Internal::Type::BaseModel # by the ACH network # # @return [String, nil] - optional :verification_failed_reason, String + optional :verification_failed_reason, String, nil?: true # @!method initialize(token:, country:, created:, currency:, last_four:, owner:, owner_type:, routing_number:, state:, type:, verification_attempts:, verification_method:, verification_state:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, financial_account_token: nil, name: nil, user_defined_id: nil, verification_failed_reason: nil) # Some parameter documentations has been truncated, see @@ -182,23 +182,23 @@ class MicroDepositCreateResponse < Lithic::Internal::Type::BaseModel # # @param verification_state [Symbol, Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState] Verification State # - # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte + # @param account_token [String, nil] Indicates which Lithic account the external account is associated with. For exte # - # @param address [Lithic::Models::ExternalBankAccountAddress] Address + # @param address [Lithic::Models::ExternalBankAccountAddress, nil] Address # - # @param company_id [String] Optional field that helps identify bank accounts in receipts + # @param company_id [String, nil] Optional field that helps identify bank accounts in receipts # - # @param dob [Date] Date of Birth of the Individual that owns the external bank account + # @param dob [Date, nil] Date of Birth of the Individual that owns the external bank account # - # @param doing_business_as [String] Doing Business As + # @param doing_business_as [String, nil] Doing Business As # - # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits + # @param financial_account_token [String, nil] The financial account token of the operating account to fund the micro deposits # - # @param name [String] The nickname for this External Bank Account + # @param name [String, nil] The nickname for this External Bank Account # - # @param user_defined_id [String] User Defined ID + # @param user_defined_id [String, nil] User Defined ID # - # @param verification_failed_reason [String] Optional free text description of the reason for the failed verification. For AC + # @param verification_failed_reason [String, nil] Optional free text description of the reason for the failed verification. For AC # Owner Type # diff --git a/lib/lithic/models/external_payment.rb b/lib/lithic/models/external_payment.rb index 5ae10951..01015071 100644 --- a/lib/lithic/models/external_payment.rb +++ b/lib/lithic/models/external_payment.rb @@ -77,7 +77,7 @@ class ExternalPayment < Lithic::Internal::Type::BaseModel # @!attribute user_defined_id # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!method initialize(token:, created:, status:, updated:, category: nil, currency: nil, events: nil, family: nil, financial_account_token: nil, payment_type: nil, pending_amount: nil, result: nil, settled_amount: nil, user_defined_id: nil) # @param token [String] Unique identifier for the transaction @@ -106,7 +106,7 @@ class ExternalPayment < Lithic::Internal::Type::BaseModel # # @param settled_amount [Integer] # - # @param user_defined_id [String] + # @param user_defined_id [String, nil] # The status of the transaction # @@ -119,6 +119,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] diff --git a/lib/lithic/models/external_payment_list_params.rb b/lib/lithic/models/external_payment_list_params.rb index 6beea911..54496222 100644 --- a/lib/lithic/models/external_payment_list_params.rb +++ b/lib/lithic/models/external_payment_list_params.rb @@ -130,6 +130,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] diff --git a/lib/lithic/models/financial_account.rb b/lib/lithic/models/financial_account.rb index e1f4687a..1b6c45aa 100644 --- a/lib/lithic/models/financial_account.rb +++ b/lib/lithic/models/financial_account.rb @@ -97,9 +97,10 @@ class FinancialAccount < Lithic::Internal::Type::BaseModel class CreditConfiguration < Lithic::Internal::Type::BaseModel # @!attribute auto_collection_configuration # - # @return [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration] + # @return [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, nil] required :auto_collection_configuration, - -> { Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration } + -> { Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration }, + nil?: true # @!attribute credit_limit # @@ -124,7 +125,7 @@ class CreditConfiguration < Lithic::Internal::Type::BaseModel required :tier, String, nil?: true # @!method initialize(auto_collection_configuration:, credit_limit:, credit_product_token:, external_bank_account_token:, tier:) - # @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration] + # @param auto_collection_configuration [Lithic::Models::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, nil] # # @param credit_limit [Integer, nil] # diff --git a/lib/lithic/models/financial_accounts/category_balances.rb b/lib/lithic/models/financial_accounts/category_balances.rb new file mode 100644 index 00000000..2d1e5852 --- /dev/null +++ b/lib/lithic/models/financial_accounts/category_balances.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module Lithic + module Models + module FinancialAccounts + class CategoryBalances < Lithic::Internal::Type::BaseModel + # @!attribute fees + # + # @return [Integer] + required :fees, Integer + + # @!attribute interest + # + # @return [Integer] + required :interest, Integer + + # @!attribute principal + # + # @return [Integer] + required :principal, Integer + + # @!method initialize(fees:, interest:, principal:) + # @param fees [Integer] + # @param interest [Integer] + # @param principal [Integer] + end + end + end +end diff --git a/lib/lithic/models/financial_accounts/loan_tape.rb b/lib/lithic/models/financial_accounts/loan_tape.rb index bc10a225..99186714 100644 --- a/lib/lithic/models/financial_accounts/loan_tape.rb +++ b/lib/lithic/models/financial_accounts/loan_tape.rb @@ -55,8 +55,8 @@ class LoanTape < Lithic::Internal::Type::BaseModel # @!attribute day_totals # - # @return [Lithic::Models::FinancialAccounts::LoanTape::DayTotals] - required :day_totals, -> { Lithic::FinancialAccounts::LoanTape::DayTotals } + # @return [Lithic::Models::StatementTotals] + required :day_totals, -> { Lithic::StatementTotals } # @!attribute ending_balance # Balance at the end of the day @@ -90,13 +90,13 @@ class LoanTape < Lithic::Internal::Type::BaseModel # @!attribute payment_allocation # - # @return [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation] - required :payment_allocation, -> { Lithic::FinancialAccounts::LoanTape::PaymentAllocation } + # @return [Lithic::Models::FinancialAccounts::CategoryBalances] + required :payment_allocation, -> { Lithic::FinancialAccounts::CategoryBalances } # @!attribute period_totals # - # @return [Lithic::Models::FinancialAccounts::LoanTape::PeriodTotals] - required :period_totals, -> { Lithic::FinancialAccounts::LoanTape::PeriodTotals } + # @return [Lithic::Models::StatementTotals] + required :period_totals, -> { Lithic::StatementTotals } # @!attribute previous_statement_balance # @@ -123,14 +123,14 @@ class LoanTape < Lithic::Internal::Type::BaseModel # @!attribute ytd_totals # - # @return [Lithic::Models::FinancialAccounts::LoanTape::YtdTotals] - required :ytd_totals, -> { Lithic::FinancialAccounts::LoanTape::YtdTotals } + # @return [Lithic::Models::StatementTotals] + required :ytd_totals, -> { Lithic::StatementTotals } # @!attribute tier # Interest tier to which this account belongs to # # @return [String, nil] - optional :tier, String + optional :tier, String, nil?: true # @!method initialize(token:, account_standing:, available_credit:, balances:, created:, credit_limit:, credit_product_token:, date:, day_totals:, ending_balance:, excess_credits:, financial_account_token:, interest_details:, minimum_payment_balance:, payment_allocation:, period_totals:, previous_statement_balance:, starting_balance:, updated:, version:, ytd_totals:, tier: nil) # Some parameter documentations has been truncated, see @@ -152,7 +152,7 @@ class LoanTape < Lithic::Internal::Type::BaseModel # # @param date [Date] Date of transactions that this loan tape covers # - # @param day_totals [Lithic::Models::FinancialAccounts::LoanTape::DayTotals] + # @param day_totals [Lithic::Models::StatementTotals] # # @param ending_balance [Integer] Balance at the end of the day # @@ -164,9 +164,9 @@ class LoanTape < Lithic::Internal::Type::BaseModel # # @param minimum_payment_balance [Lithic::Models::FinancialAccounts::LoanTape::MinimumPaymentBalance] # - # @param payment_allocation [Lithic::Models::FinancialAccounts::LoanTape::PaymentAllocation] + # @param payment_allocation [Lithic::Models::FinancialAccounts::CategoryBalances] # - # @param period_totals [Lithic::Models::FinancialAccounts::LoanTape::PeriodTotals] + # @param period_totals [Lithic::Models::StatementTotals] # # @param previous_statement_balance [Lithic::Models::FinancialAccounts::LoanTape::PreviousStatementBalance] # @@ -176,9 +176,9 @@ class LoanTape < Lithic::Internal::Type::BaseModel # # @param version [Integer] Version number of the loan tape. This starts at 1 # - # @param ytd_totals [Lithic::Models::FinancialAccounts::LoanTape::YtdTotals] + # @param ytd_totals [Lithic::Models::StatementTotals] # - # @param tier [String] Interest tier to which this account belongs to + # @param tier [String, nil] Interest tier to which this account belongs to # @see Lithic::Models::FinancialAccounts::LoanTape#account_standing class AccountStanding < Lithic::Internal::Type::BaseModel @@ -324,239 +324,40 @@ class Balances < Lithic::Internal::Type::BaseModel # Amount due for the prior billing cycle. Any amounts not fully paid off on this # due date will be considered past due the next day # - # @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::Due] - required :due, -> { Lithic::FinancialAccounts::LoanTape::Balances::Due } + # @return [Lithic::Models::FinancialAccounts::CategoryBalances] + required :due, -> { Lithic::FinancialAccounts::CategoryBalances } # @!attribute next_statement_due # Amount due for the current billing cycle. Any amounts not paid off by early # payments or credits will be considered due at the end of the current billing # period # - # @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::NextStatementDue] - required :next_statement_due, -> { Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue } + # @return [Lithic::Models::FinancialAccounts::CategoryBalances] + required :next_statement_due, -> { Lithic::FinancialAccounts::CategoryBalances } # @!attribute past_due # Amount not paid off on previous due dates # - # @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::PastDue] - required :past_due, -> { Lithic::FinancialAccounts::LoanTape::Balances::PastDue } + # @return [Lithic::Models::FinancialAccounts::CategoryBalances] + required :past_due, -> { Lithic::FinancialAccounts::CategoryBalances } # @!attribute past_statements_due # Amount due for the past billing cycles. # - # @return [Lithic::Models::FinancialAccounts::LoanTape::Balances::PastStatementsDue] - required :past_statements_due, -> { Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue } + # @return [Lithic::Models::FinancialAccounts::CategoryBalances] + required :past_statements_due, -> { Lithic::FinancialAccounts::CategoryBalances } # @!method initialize(due:, next_statement_due:, past_due:, past_statements_due:) # Some parameter documentations has been truncated, see # {Lithic::Models::FinancialAccounts::LoanTape::Balances} for more details. # - # @param due [Lithic::Models::FinancialAccounts::LoanTape::Balances::Due] Amount due for the prior billing cycle. Any amounts not fully paid off on this d + # @param due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount due for the prior billing cycle. Any amounts not fully paid off on this d # - # @param next_statement_due [Lithic::Models::FinancialAccounts::LoanTape::Balances::NextStatementDue] Amount due for the current billing cycle. Any amounts not paid off by early paym + # @param next_statement_due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount due for the current billing cycle. Any amounts not paid off by early paym # - # @param past_due [Lithic::Models::FinancialAccounts::LoanTape::Balances::PastDue] Amount not paid off on previous due dates + # @param past_due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount not paid off on previous due dates # - # @param past_statements_due [Lithic::Models::FinancialAccounts::LoanTape::Balances::PastStatementsDue] Amount due for the past billing cycles. - - # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#due - class Due < Lithic::Internal::Type::BaseModel - # @!attribute fees - # - # @return [Integer] - required :fees, Integer - - # @!attribute interest - # - # @return [Integer] - required :interest, Integer - - # @!attribute principal - # - # @return [Integer] - required :principal, Integer - - # @!method initialize(fees:, interest:, principal:) - # Amount due for the prior billing cycle. Any amounts not fully paid off on this - # due date will be considered past due the next day - # - # @param fees [Integer] - # @param interest [Integer] - # @param principal [Integer] - end - - # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#next_statement_due - class NextStatementDue < Lithic::Internal::Type::BaseModel - # @!attribute fees - # - # @return [Integer] - required :fees, Integer - - # @!attribute interest - # - # @return [Integer] - required :interest, Integer - - # @!attribute principal - # - # @return [Integer] - required :principal, Integer - - # @!method initialize(fees:, interest:, principal:) - # Amount due for the current billing cycle. Any amounts not paid off by early - # payments or credits will be considered due at the end of the current billing - # period - # - # @param fees [Integer] - # @param interest [Integer] - # @param principal [Integer] - end - - # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#past_due - class PastDue < Lithic::Internal::Type::BaseModel - # @!attribute fees - # - # @return [Integer] - required :fees, Integer - - # @!attribute interest - # - # @return [Integer] - required :interest, Integer - - # @!attribute principal - # - # @return [Integer] - required :principal, Integer - - # @!method initialize(fees:, interest:, principal:) - # Amount not paid off on previous due dates - # - # @param fees [Integer] - # @param interest [Integer] - # @param principal [Integer] - end - - # @see Lithic::Models::FinancialAccounts::LoanTape::Balances#past_statements_due - class PastStatementsDue < Lithic::Internal::Type::BaseModel - # @!attribute fees - # - # @return [Integer] - required :fees, Integer - - # @!attribute interest - # - # @return [Integer] - required :interest, Integer - - # @!attribute principal - # - # @return [Integer] - required :principal, Integer - - # @!method initialize(fees:, interest:, principal:) - # Amount due for the past billing cycles. - # - # @param fees [Integer] - # @param interest [Integer] - # @param principal [Integer] - end - end - - # @see Lithic::Models::FinancialAccounts::LoanTape#day_totals - class DayTotals < 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::FinancialAccounts::LoanTape::DayTotals} 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 + # @param past_statements_due [Lithic::Models::FinancialAccounts::CategoryBalances] Amount due for the past billing cycles. end # @see Lithic::Models::FinancialAccounts::LoanTape#interest_details @@ -568,14 +369,13 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!attribute daily_balance_amounts # - # @return [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts] - required :daily_balance_amounts, - -> { Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts } + # @return [Lithic::Models::CategoryDetails] + required :daily_balance_amounts, -> { Lithic::CategoryDetails } # @!attribute effective_apr # - # @return [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr] - required :effective_apr, -> { Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr } + # @return [Lithic::Models::CategoryDetails] + required :effective_apr, -> { Lithic::CategoryDetails } # @!attribute interest_calculation_method # @@ -585,9 +385,8 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!attribute interest_for_period # - # @return [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod] - required :interest_for_period, - -> { Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod } + # @return [Lithic::Models::CategoryDetails] + required :interest_for_period, -> { Lithic::CategoryDetails } # @!attribute prime_rate # @@ -601,59 +400,13 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!method initialize(actual_interest_charged:, daily_balance_amounts:, effective_apr:, interest_calculation_method:, interest_for_period:, prime_rate:, minimum_interest_charged: nil) # @param actual_interest_charged [Integer, nil] - # @param daily_balance_amounts [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts] - # @param effective_apr [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr] + # @param daily_balance_amounts [Lithic::Models::CategoryDetails] + # @param effective_apr [Lithic::Models::CategoryDetails] # @param interest_calculation_method [Symbol, Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod] - # @param interest_for_period [Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod] + # @param interest_for_period [Lithic::Models::CategoryDetails] # @param prime_rate [String, nil] # @param minimum_interest_charged [Integer, nil] - # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#daily_balance_amounts - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String - - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String - - # @!attribute purchases - # - # @return [String] - required :purchases, String - - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end - - # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#effective_apr - class EffectiveApr < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String - - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String - - # @!attribute purchases - # - # @return [String] - required :purchases, String - - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end - # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#interest_calculation_method module InterestCalculationMethod extend Lithic::Internal::Type::Enum @@ -664,29 +417,6 @@ module InterestCalculationMethod # @!method self.values # @return [Array] end - - # @see Lithic::Models::FinancialAccounts::LoanTape::InterestDetails#interest_for_period - class InterestForPeriod < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String - - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String - - # @!attribute purchases - # - # @return [String] - required :purchases, String - - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end end # @see Lithic::Models::FinancialAccounts::LoanTape#minimum_payment_balance @@ -706,125 +436,6 @@ class MinimumPaymentBalance < Lithic::Internal::Type::BaseModel # @param remaining [Integer] end - # @see Lithic::Models::FinancialAccounts::LoanTape#payment_allocation - class PaymentAllocation < Lithic::Internal::Type::BaseModel - # @!attribute fees - # - # @return [Integer] - required :fees, Integer - - # @!attribute interest - # - # @return [Integer] - required :interest, Integer - - # @!attribute principal - # - # @return [Integer] - required :principal, Integer - - # @!method initialize(fees:, interest:, principal:) - # @param fees [Integer] - # @param interest [Integer] - # @param principal [Integer] - end - - # @see Lithic::Models::FinancialAccounts::LoanTape#period_totals - class PeriodTotals < 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::FinancialAccounts::LoanTape::PeriodTotals} 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 - # @see Lithic::Models::FinancialAccounts::LoanTape#previous_statement_balance class PreviousStatementBalance < Lithic::Internal::Type::BaseModel # @!attribute amount @@ -841,102 +452,6 @@ class PreviousStatementBalance < Lithic::Internal::Type::BaseModel # @param amount [Integer] # @param remaining [Integer] end - - # @see Lithic::Models::FinancialAccounts::LoanTape#ytd_totals - class YtdTotals < 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::FinancialAccounts::LoanTape::YtdTotals} 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 end diff --git a/lib/lithic/models/financial_accounts/statement.rb b/lib/lithic/models/financial_accounts/statement.rb index cdeb28dd..465ce6eb 100644 --- a/lib/lithic/models/financial_accounts/statement.rb +++ b/lib/lithic/models/financial_accounts/statement.rb @@ -72,8 +72,8 @@ class Statement < Lithic::Internal::Type::BaseModel # @!attribute period_totals # - # @return [Lithic::Models::FinancialAccounts::Statement::PeriodTotals] - required :period_totals, -> { Lithic::FinancialAccounts::Statement::PeriodTotals } + # @return [Lithic::Models::StatementTotals] + required :period_totals, -> { Lithic::StatementTotals } # @!attribute starting_balance # Balance at the start of the billing period @@ -106,8 +106,8 @@ class Statement < Lithic::Internal::Type::BaseModel # @!attribute ytd_totals # - # @return [Lithic::Models::FinancialAccounts::Statement::YtdTotals] - required :ytd_totals, -> { Lithic::FinancialAccounts::Statement::YtdTotals } + # @return [Lithic::Models::StatementTotals] + required :ytd_totals, -> { Lithic::StatementTotals } # @!attribute interest_details # @@ -126,7 +126,13 @@ class Statement < Lithic::Internal::Type::BaseModel # @return [Date, nil] optional :next_statement_end_date, Date - # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil) + # @!attribute payoff_details + # Details on number and size of payments to pay off balance + # + # @return [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] + optional :payoff_details, -> { Lithic::FinancialAccounts::Statement::PayoffDetails }, nil?: true + + # @!method initialize(token:, account_standing:, amount_due:, available_credit:, created:, credit_limit:, credit_product_token:, days_in_billing_cycle:, ending_balance:, financial_account_token:, payment_due_date:, period_totals:, starting_balance:, statement_end_date:, statement_start_date:, statement_type:, updated:, ytd_totals:, interest_details: nil, next_payment_due_date: nil, next_statement_end_date: nil, payoff_details: nil) # Some parameter documentations has been truncated, see # {Lithic::Models::FinancialAccounts::Statement} for more details. # @@ -152,7 +158,7 @@ class Statement < Lithic::Internal::Type::BaseModel # # @param payment_due_date [Date, nil] Date when the payment is due # - # @param period_totals [Lithic::Models::FinancialAccounts::Statement::PeriodTotals] + # @param period_totals [Lithic::Models::StatementTotals] # # @param starting_balance [Integer] Balance at the start of the billing period # @@ -164,13 +170,15 @@ class Statement < Lithic::Internal::Type::BaseModel # # @param updated [Time] Timestamp of when the statement was updated # - # @param ytd_totals [Lithic::Models::FinancialAccounts::Statement::YtdTotals] + # @param ytd_totals [Lithic::Models::StatementTotals] # # @param interest_details [Lithic::Models::FinancialAccounts::Statement::InterestDetails, nil] # # @param next_payment_due_date [Date] Date when the next payment is due # # @param next_statement_end_date [Date] Date when the next billing period will end + # + # @param payoff_details [Lithic::Models::FinancialAccounts::Statement::PayoffDetails, nil] Details on number and size of payments to pay off balance # @see Lithic::Models::FinancialAccounts::Statement#account_standing class AccountStanding < Lithic::Internal::Type::BaseModel @@ -336,102 +344,6 @@ class AmountDue < Lithic::Internal::Type::BaseModel # @param past_due [Integer] Amount past due for statement in cents end - # @see Lithic::Models::FinancialAccounts::Statement#period_totals - class PeriodTotals < 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::FinancialAccounts::Statement::PeriodTotals} 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 - # @see Lithic::Models::FinancialAccounts::Statement#statement_type module StatementType extend Lithic::Internal::Type::Enum @@ -444,102 +356,6 @@ module StatementType # @return [Array] end - # @see Lithic::Models::FinancialAccounts::Statement#ytd_totals - class YtdTotals < 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::FinancialAccounts::Statement::YtdTotals} 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 - # @see Lithic::Models::FinancialAccounts::Statement#interest_details class InterestDetails < Lithic::Internal::Type::BaseModel # @!attribute actual_interest_charged @@ -549,14 +365,13 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!attribute daily_balance_amounts # - # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts] - required :daily_balance_amounts, - -> { Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts } + # @return [Lithic::Models::CategoryDetails] + required :daily_balance_amounts, -> { Lithic::CategoryDetails } # @!attribute effective_apr # - # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr] - required :effective_apr, -> { Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr } + # @return [Lithic::Models::CategoryDetails] + required :effective_apr, -> { Lithic::CategoryDetails } # @!attribute interest_calculation_method # @@ -566,9 +381,8 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!attribute interest_for_period # - # @return [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod] - required :interest_for_period, - -> { Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod } + # @return [Lithic::Models::CategoryDetails] + required :interest_for_period, -> { Lithic::CategoryDetails } # @!attribute prime_rate # @@ -582,59 +396,13 @@ class InterestDetails < Lithic::Internal::Type::BaseModel # @!method initialize(actual_interest_charged:, daily_balance_amounts:, effective_apr:, interest_calculation_method:, interest_for_period:, prime_rate:, minimum_interest_charged: nil) # @param actual_interest_charged [Integer, nil] - # @param daily_balance_amounts [Lithic::Models::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts] - # @param effective_apr [Lithic::Models::FinancialAccounts::Statement::InterestDetails::EffectiveApr] + # @param daily_balance_amounts [Lithic::Models::CategoryDetails] + # @param effective_apr [Lithic::Models::CategoryDetails] # @param interest_calculation_method [Symbol, Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod] - # @param interest_for_period [Lithic::Models::FinancialAccounts::Statement::InterestDetails::InterestForPeriod] + # @param interest_for_period [Lithic::Models::CategoryDetails] # @param prime_rate [String, nil] # @param minimum_interest_charged [Integer, nil] - # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#daily_balance_amounts - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String - - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String - - # @!attribute purchases - # - # @return [String] - required :purchases, String - - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end - - # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#effective_apr - class EffectiveApr < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String - - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String - - # @!attribute purchases - # - # @return [String] - required :purchases, String - - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end - # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_calculation_method module InterestCalculationMethod extend Lithic::Internal::Type::Enum @@ -645,29 +413,59 @@ module InterestCalculationMethod # @!method self.values # @return [Array] end + end - # @see Lithic::Models::FinancialAccounts::Statement::InterestDetails#interest_for_period - class InterestForPeriod < Lithic::Internal::Type::BaseModel - # @!attribute balance_transfers - # - # @return [String] - required :balance_transfers, String + # @see Lithic::Models::FinancialAccounts::Statement#payoff_details + class PayoffDetails < Lithic::Internal::Type::BaseModel + # @!attribute minimum_payment_months + # The number of months it would take to pay off the balance in full by only paying + # the minimum payment. "NA" will signal negative or zero amortization + # + # @return [String] + required :minimum_payment_months, String - # @!attribute cash_advances - # - # @return [String] - required :cash_advances, String + # @!attribute minimum_payment_total + # The sum of all interest and principal paid, in cents, when only paying minimum + # monthly payment. "NA" will signal negative or zero amortization + # + # @return [String] + required :minimum_payment_total, String - # @!attribute purchases - # - # @return [String] - required :purchases, String + # @!attribute payoff_period_length_months + # Number of months to full pay off + # + # @return [Integer] + required :payoff_period_length_months, Integer - # @!method initialize(balance_transfers:, cash_advances:, purchases:) - # @param balance_transfers [String] - # @param cash_advances [String] - # @param purchases [String] - end + # @!attribute payoff_period_monthly_payment_amount + # The amount needed to be paid, in cents, each month in order to pay off current + # balance in the payoff period + # + # @return [Integer] + required :payoff_period_monthly_payment_amount, Integer + + # @!attribute payoff_period_payment_total + # The sum of all interest and principal paid, in cents, when paying off in the + # payoff period + # + # @return [Integer] + required :payoff_period_payment_total, Integer + + # @!method initialize(minimum_payment_months:, minimum_payment_total:, payoff_period_length_months:, payoff_period_monthly_payment_amount:, payoff_period_payment_total:) + # Some parameter documentations has been truncated, see + # {Lithic::Models::FinancialAccounts::Statement::PayoffDetails} for more details. + # + # Details on number and size of payments to pay off balance + # + # @param minimum_payment_months [String] The number of months it would take to pay off the balance in full by only paying + # + # @param minimum_payment_total [String] The sum of all interest and principal paid, in cents, when only paying minimum m + # + # @param payoff_period_length_months [Integer] Number of months to full pay off + # + # @param payoff_period_monthly_payment_amount [Integer] The amount needed to be paid, in cents, each month in order to pay off current b + # + # @param payoff_period_payment_total [Integer] The sum of all interest and principal paid, in cents, when paying off in the pay end end end diff --git a/lib/lithic/models/financial_event.rb b/lib/lithic/models/financial_event.rb new file mode 100644 index 00000000..09101055 --- /dev/null +++ b/lib/lithic/models/financial_event.rb @@ -0,0 +1,148 @@ +# frozen_string_literal: true + +module Lithic + module Models + class FinancialEvent < Lithic::Internal::Type::BaseModel + # @!attribute token + # Globally unique identifier. + # + # @return [String, nil] + optional :token, String + + # @!attribute amount + # Amount of the financial event that has been settled in the currency's smallest + # unit (e.g., cents). + # + # @return [Integer, nil] + optional :amount, Integer + + # @!attribute created + # Date and time when the financial event occurred. UTC time zone. + # + # @return [Time, nil] + optional :created, Time + + # @!attribute result + # APPROVED financial events were successful while DECLINED financial events were + # declined by user, Lithic, or the network. + # + # @return [Symbol, Lithic::Models::FinancialEvent::Result, nil] + optional :result, enum: -> { Lithic::FinancialEvent::Result } + + # @!attribute type + # + # @return [Symbol, Lithic::Models::FinancialEvent::Type, nil] + optional :type, enum: -> { Lithic::FinancialEvent::Type } + + # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil) + # Some parameter documentations has been truncated, see + # {Lithic::Models::FinancialEvent} for more details. + # + # Financial Event + # + # @param token [String] Globally unique identifier. + # + # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u + # + # @param created [Time] Date and time when the financial event occurred. UTC time zone. + # + # @param result [Symbol, Lithic::Models::FinancialEvent::Result] APPROVED financial events were successful while DECLINED financial events were d + # + # @param type [Symbol, Lithic::Models::FinancialEvent::Type] + + # APPROVED financial events were successful while DECLINED financial events were + # declined by user, Lithic, or the network. + # + # @see Lithic::Models::FinancialEvent#result + module Result + extend Lithic::Internal::Type::Enum + + APPROVED = :APPROVED + DECLINED = :DECLINED + + # @!method self.values + # @return [Array] + end + + # @see Lithic::Models::FinancialEvent#type + module Type + extend Lithic::Internal::Type::Enum + + ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED + ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED + ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED + ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED + ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED + ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED + ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED + ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED + ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED + ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED + ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED + ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED + ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED + ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED + AUTHORIZATION = :AUTHORIZATION + AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE + AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY + AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL + BALANCE_INQUIRY = :BALANCE_INQUIRY + BILLING_ERROR = :BILLING_ERROR + BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL + CARD_TO_CARD = :CARD_TO_CARD + CASH_BACK = :CASH_BACK + CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL + CLEARING = :CLEARING + COLLECTION = :COLLECTION + CORRECTION_CREDIT = :CORRECTION_CREDIT + CORRECTION_DEBIT = :CORRECTION_DEBIT + CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION + CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE + CURRENCY_CONVERSION = :CURRENCY_CONVERSION + CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL + DISPUTE_WON = :DISPUTE_WON + EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED + EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED + EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED + EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED + EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED + EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED + EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED + EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED + EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED + EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED + EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED + EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED + EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED + EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED + EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED + EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED + EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED + EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED + EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED + EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED + FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION + FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION + INTEREST = :INTEREST + INTEREST_REVERSAL = :INTEREST_REVERSAL + INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT + LATE_PAYMENT = :LATE_PAYMENT + LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL + LOSS_WRITE_OFF = :LOSS_WRITE_OFF + PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT + PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL + SERVICE = :SERVICE + RETURN = :RETURN + RETURN_REVERSAL = :RETURN_REVERSAL + TRANSFER = :TRANSFER + TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS + RETURNED_PAYMENT = :RETURNED_PAYMENT + RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL + LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/lithic/models/financial_transaction.rb b/lib/lithic/models/financial_transaction.rb index f7cc1df8..4a12ab1a 100644 --- a/lib/lithic/models/financial_transaction.rb +++ b/lib/lithic/models/financial_transaction.rb @@ -44,8 +44,8 @@ class FinancialTransaction < Lithic::Internal::Type::BaseModel # @!attribute events # A list of all financial events that have modified this financial transaction. # - # @return [Array] - required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event] } + # @return [Array] + required :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] } # @!attribute pending_amount # Pending amount of the transaction in the currency's smallest unit (e.g., cents), @@ -103,7 +103,7 @@ class FinancialTransaction < Lithic::Internal::Type::BaseModel # # @param descriptor [String] A string that provides a description of the financial transaction; may be useful # - # @param events [Array] A list of all financial events that have modified this financial transaction. + # @param events [Array] A list of all financial events that have modified this financial transaction. # # @param pending_amount [Integer] Pending amount of the transaction in the currency's smallest unit (e.g., cents), # @@ -136,149 +136,6 @@ module Category # @return [Array] end - class Event < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String, nil] - optional :token, String - - # @!attribute amount - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - # - # @return [Integer, nil] - optional :amount, Integer - - # @!attribute created - # Date and time when the financial event occurred. UTC time zone. - # - # @return [Time, nil] - optional :created, Time - - # @!attribute result - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @return [Symbol, Lithic::Models::FinancialTransaction::Event::Result, nil] - optional :result, enum: -> { Lithic::FinancialTransaction::Event::Result } - - # @!attribute type - # - # @return [Symbol, Lithic::Models::FinancialTransaction::Event::Type, nil] - optional :type, enum: -> { Lithic::FinancialTransaction::Event::Type } - - # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil) - # Some parameter documentations has been truncated, see - # {Lithic::Models::FinancialTransaction::Event} for more details. - # - # Financial Event - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u - # - # @param created [Time] Date and time when the financial event occurred. UTC time zone. - # - # @param result [Symbol, Lithic::Models::FinancialTransaction::Event::Result] APPROVED financial events were successful while DECLINED financial events were d - # - # @param type [Symbol, Lithic::Models::FinancialTransaction::Event::Type] - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @see Lithic::Models::FinancialTransaction::Event#result - module Result - extend Lithic::Internal::Type::Enum - - APPROVED = :APPROVED - DECLINED = :DECLINED - - # @!method self.values - # @return [Array] - end - - # @see Lithic::Models::FinancialTransaction::Event#type - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED - AUTHORIZATION = :AUTHORIZATION - AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY = :BALANCE_INQUIRY - BILLING_ERROR = :BILLING_ERROR - BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL - CARD_TO_CARD = :CARD_TO_CARD - CASH_BACK = :CASH_BACK - CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL - CLEARING = :CLEARING - COLLECTION = :COLLECTION - CORRECTION_CREDIT = :CORRECTION_CREDIT - CORRECTION_DEBIT = :CORRECTION_DEBIT - CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION = :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON = :DISPUTE_WON - EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST = :INTEREST - INTEREST_REVERSAL = :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT - LATE_PAYMENT = :LATE_PAYMENT - LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF = :LOSS_WRITE_OFF - PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL - SERVICE = :SERVICE - RETURN = :RETURN - RETURN_REVERSAL = :RETURN_REVERSAL - TRANSFER = :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT = :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT - - # @!method self.values - # @return [Array] - end - end - # APPROVED transactions were successful while DECLINED transactions were declined # by user, Lithic, or the network. # diff --git a/lib/lithic/models/management_operation_list_params.rb b/lib/lithic/models/management_operation_list_params.rb index 6a1ec911..3b83c201 100644 --- a/lib/lithic/models/management_operation_list_params.rb +++ b/lib/lithic/models/management_operation_list_params.rb @@ -112,6 +112,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] diff --git a/lib/lithic/models/management_operation_transaction.rb b/lib/lithic/models/management_operation_transaction.rb index 837ceade..35d9b204 100644 --- a/lib/lithic/models/management_operation_transaction.rb +++ b/lib/lithic/models/management_operation_transaction.rb @@ -92,7 +92,7 @@ class ManagementOperationTransaction < Lithic::Internal::Type::BaseModel # @!attribute user_defined_id # # @return [String, nil] - optional :user_defined_id, String + optional :user_defined_id, String, nil?: true # @!method initialize(token:, created:, status:, updated:, category: nil, currency: nil, direction: nil, events: nil, external_resource: nil, family: nil, financial_account_token: nil, pending_amount: nil, result: nil, settled_amount: nil, transaction_series: nil, user_defined_id: nil) # @param token [String] Unique identifier for the transaction @@ -125,7 +125,7 @@ class ManagementOperationTransaction < Lithic::Internal::Type::BaseModel # # @param transaction_series [Lithic::Models::ManagementOperationTransaction::TransactionSeries, nil] # - # @param user_defined_id [String] + # @param user_defined_id [String, nil] # The status of the transaction # @@ -138,6 +138,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] @@ -213,7 +214,7 @@ class Event < Lithic::Internal::Type::BaseModel # @!attribute subtype # # @return [String, nil] - optional :subtype, String + optional :subtype, String, nil?: true # @!method initialize(token:, amount:, created:, detailed_results:, effective_date:, memo:, result:, type:, subtype: nil) # @param token [String] @@ -224,7 +225,7 @@ class Event < Lithic::Internal::Type::BaseModel # @param memo [String] # @param result [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Result] # @param type [Symbol, Lithic::Models::ManagementOperationTransaction::Event::Type] - # @param subtype [String] + # @param subtype [String, nil] module DetailedResult extend Lithic::Internal::Type::Enum diff --git a/lib/lithic/models/merchant.rb b/lib/lithic/models/merchant.rb new file mode 100644 index 00000000..2bb506cb --- /dev/null +++ b/lib/lithic/models/merchant.rb @@ -0,0 +1,70 @@ +# frozen_string_literal: true + +module Lithic + module Models + class Merchant < Lithic::Internal::Type::BaseModel + # @!attribute acceptor_id + # Unique alphanumeric identifier for the payment card acceptor (merchant). + # + # @return [String] + required :acceptor_id, String + + # @!attribute acquiring_institution_id + # Unique numeric identifier of the acquiring institution. + # + # @return [String] + required :acquiring_institution_id, String + + # @!attribute city + # City of card acceptor. Note that in many cases, particularly in card-not-present + # transactions, merchants may send through a phone number or URL in this field. + # + # @return [String] + required :city, String + + # @!attribute country + # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 + # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. + # + # @return [String] + required :country, String + + # @!attribute descriptor + # Short description of card acceptor. + # + # @return [String] + required :descriptor, String + + # @!attribute mcc + # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is + # used to classify a business by the types of goods or services it provides. + # + # @return [String] + required :mcc, String + + # @!attribute state + # Geographic state of card acceptor. + # + # @return [String] + required :state, String + + # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:) + # Some parameter documentations has been truncated, see {Lithic::Models::Merchant} + # for more details. + # + # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). + # + # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution. + # + # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present + # + # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph + # + # @param descriptor [String] Short description of card acceptor. + # + # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is + # + # @param state [String] Geographic state of card acceptor. + end + end +end diff --git a/lib/lithic/models/payment.rb b/lib/lithic/models/payment.rb index 14c74cde..71f861b4 100644 --- a/lib/lithic/models/payment.rb +++ b/lib/lithic/models/payment.rb @@ -71,10 +71,10 @@ class Payment < Lithic::Internal::Type::BaseModel 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 @@ class Payment < Lithic::Internal::Type::BaseModel # # @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 # @@ -371,6 +371,7 @@ module DetailedResult 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 @@ -568,7 +569,7 @@ class RelatedAccountTokens < Lithic::Internal::Type::BaseModel 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 +614,7 @@ module Status DECLINED = :DECLINED REVERSED = :REVERSED CANCELED = :CANCELED + RETURNED = :RETURNED # @!method self.values # @return [Array] diff --git a/lib/lithic/models/payment_return_params.rb b/lib/lithic/models/payment_return_params.rb new file mode 100644 index 00000000..4d89c243 --- /dev/null +++ b/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 diff --git a/lib/lithic/models/statement_totals.rb b/lib/lithic/models/statement_totals.rb new file mode 100644 index 00000000..e53aec64 --- /dev/null +++ b/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 diff --git a/lib/lithic/models/three_ds/authentication_retrieve_response.rb b/lib/lithic/models/three_ds/authentication_retrieve_response.rb index d5a31152..483765d3 100644 --- a/lib/lithic/models/three_ds/authentication_retrieve_response.rb +++ b/lib/lithic/models/three_ds/authentication_retrieve_response.rb @@ -312,22 +312,22 @@ class Cardholder < Lithic::Internal::Type::BaseModel optional :name, String, nil?: true # @!attribute phone_number_home - # Home phone number provided by the cardholder. Maps to EMV 3DS fields - # `homePhone.cc` and `homePhone.subscriber`. + # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `homePhone.cc` and `homePhone.subscriber`. # # @return [String, nil] optional :phone_number_home, String, nil?: true # @!attribute phone_number_mobile - # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields - # `mobilePhone.cc` and `mobilePhone.subscriber`. + # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV + # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`. # # @return [String, nil] optional :phone_number_mobile, String, nil?: true # @!attribute phone_number_work - # Work phone number provided by the cardholder. Maps to EMV 3DS fields - # `workPhone.cc` and `workPhone.subscriber`. + # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `workPhone.cc` and `workPhone.subscriber`. # # @return [String, nil] optional :phone_number_work, String, nil?: true @@ -356,11 +356,11 @@ class Cardholder < Lithic::Internal::Type::BaseModel # # @param name [String, nil] Name of the cardholder. Maps to EMV 3DS field `cardholderName`. # - # @param phone_number_home [String, nil] Home phone number provided by the cardholder. Maps to EMV 3DS fields `homePhone. + # @param phone_number_home [String, nil] Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi # - # @param phone_number_mobile [String, nil] Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields `mob + # @param phone_number_mobile [String, nil] Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV # - # @param phone_number_work [String, nil] Work phone number provided by the cardholder. Maps to EMV 3DS fields `workPhone. + # @param phone_number_work [String, nil] Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS fi # # @param shipping_address [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse::Cardholder::ShippingAddress] Object containing data on the shipping address provided during the transaction. diff --git a/lib/lithic/models/transaction.rb b/lib/lithic/models/transaction.rb index 5f10d6f9..65243f62 100644 --- a/lib/lithic/models/transaction.rb +++ b/lib/lithic/models/transaction.rb @@ -94,8 +94,8 @@ class Transaction < Lithic::Internal::Type::BaseModel # @!attribute merchant # - # @return [Lithic::Models::Transaction::Merchant] - required :merchant, -> { Lithic::Transaction::Merchant } + # @return [Lithic::Models::Merchant] + required :merchant, -> { Lithic::Merchant } # @!attribute merchant_amount # @deprecated @@ -208,7 +208,7 @@ class Transaction < Lithic::Internal::Type::BaseModel # # @param financial_account_token [String, nil] # - # @param merchant [Lithic::Models::Transaction::Merchant] + # @param merchant [Lithic::Models::Merchant] # # @param merchant_amount [Integer, nil] Analogous to the 'amount', but in the merchant currency. # @@ -506,72 +506,6 @@ module LiabilityShift end end - # @see Lithic::Models::Transaction#merchant - class Merchant < Lithic::Internal::Type::BaseModel - # @!attribute acceptor_id - # Unique alphanumeric identifier for the payment card acceptor (merchant). - # - # @return [String] - required :acceptor_id, String - - # @!attribute acquiring_institution_id - # Unique numeric identifier of the acquiring institution. - # - # @return [String] - required :acquiring_institution_id, String - - # @!attribute city - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - # - # @return [String] - required :city, String - - # @!attribute country - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - # - # @return [String] - required :country, String - - # @!attribute descriptor - # Short description of card acceptor. - # - # @return [String] - required :descriptor, String - - # @!attribute mcc - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - # - # @return [String] - required :mcc, String - - # @!attribute state - # Geographic state of card acceptor. - # - # @return [String] - required :state, String - - # @!method initialize(acceptor_id:, acquiring_institution_id:, city:, country:, descriptor:, mcc:, state:) - # Some parameter documentations has been truncated, see - # {Lithic::Models::Transaction::Merchant} for more details. - # - # @param acceptor_id [String] Unique alphanumeric identifier for the payment card acceptor (merchant). - # - # @param acquiring_institution_id [String] Unique numeric identifier of the acquiring institution. - # - # @param city [String] City of card acceptor. Note that in many cases, particularly in card-not-present - # - # @param country [String] Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 alph - # - # @param descriptor [String] Short description of card acceptor. - # - # @param mcc [String] Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # - # @param state [String] Geographic state of card acceptor. - end - # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot # determine the network code from the upstream provider. # diff --git a/lib/lithic/models/transactions/events/enhanced_data.rb b/lib/lithic/models/transactions/events/enhanced_data.rb index 91f6424f..c65da11d 100644 --- a/lib/lithic/models/transactions/events/enhanced_data.rb +++ b/lib/lithic/models/transactions/events/enhanced_data.rb @@ -62,66 +62,66 @@ class Common < Lithic::Internal::Type::BaseModel # A customer identifier. # # @return [String, nil] - optional :customer_reference_number, String + optional :customer_reference_number, String, nil?: true # @!attribute merchant_reference_number # A merchant identifier. # # @return [String, nil] - optional :merchant_reference_number, String + optional :merchant_reference_number, String, nil?: true # @!attribute order_date # The date of the order. # # @return [Date, nil] - optional :order_date, Date + optional :order_date, Date, nil?: true # @!method initialize(line_items:, tax:, customer_reference_number: nil, merchant_reference_number: nil, order_date: nil) # @param line_items [Array] # # @param tax [Lithic::Models::Transactions::Events::EnhancedData::Common::Tax] # - # @param customer_reference_number [String] A customer identifier. + # @param customer_reference_number [String, nil] A customer identifier. # - # @param merchant_reference_number [String] A merchant identifier. + # @param merchant_reference_number [String, nil] A merchant identifier. # - # @param order_date [Date] The date of the order. + # @param order_date [Date, nil] The date of the order. class LineItem < Lithic::Internal::Type::BaseModel # @!attribute amount # The price of the item purchased in merchant currency. # # @return [String, nil] - optional :amount, String + optional :amount, String, nil?: true # @!attribute description # A human-readable description of the item. # # @return [String, nil] - optional :description, String + optional :description, String, nil?: true # @!attribute product_code # An identifier for the item purchased. # # @return [String, nil] - optional :product_code, String + optional :product_code, String, nil?: true # @!attribute quantity # The quantity of the item purchased. # # @return [String, nil] - optional :quantity, String + optional :quantity, String, nil?: true # @!method initialize(amount: nil, description: nil, product_code: nil, quantity: nil) # An L2/L3 enhanced commercial data line item. # - # @param amount [String] The price of the item purchased in merchant currency. + # @param amount [String, nil] The price of the item purchased in merchant currency. # - # @param description [String] A human-readable description of the item. + # @param description [String, nil] A human-readable description of the item. # - # @param product_code [String] An identifier for the item purchased. + # @param product_code [String, nil] An identifier for the item purchased. # - # @param quantity [String] The quantity of the item purchased. + # @param quantity [String, nil] The quantity of the item purchased. end # @see Lithic::Models::Transactions::Events::EnhancedData::Common#tax @@ -130,26 +130,30 @@ class Tax < Lithic::Internal::Type::BaseModel # The amount of tax collected. # # @return [Integer, nil] - optional :amount, Integer + optional :amount, Integer, nil?: true # @!attribute exempt # A flag indicating whether the transaction is tax exempt or not. # # @return [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::Exempt, nil] - optional :exempt, enum: -> { Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt } + optional :exempt, + enum: -> { + Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt + }, + nil?: true # @!attribute merchant_tax_id # The tax ID of the merchant. # # @return [String, nil] - optional :merchant_tax_id, String + optional :merchant_tax_id, String, nil?: true # @!method initialize(amount: nil, exempt: nil, merchant_tax_id: nil) - # @param amount [Integer] The amount of tax collected. + # @param amount [Integer, nil] The amount of tax collected. # - # @param exempt [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::Exempt] A flag indicating whether the transaction is tax exempt or not. + # @param exempt [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::Exempt, nil] A flag indicating whether the transaction is tax exempt or not. # - # @param merchant_tax_id [String] The tax ID of the merchant. + # @param merchant_tax_id [String, nil] The tax ID of the merchant. # A flag indicating whether the transaction is tax exempt or not. # @@ -183,13 +187,13 @@ class Fleet < Lithic::Internal::Type::BaseModel # zeros stripped. # # @return [String, nil] - optional :driver_number, String + optional :driver_number, String, nil?: true # @!attribute odometer # The odometer reading entered into the terminal at the time of sale. # # @return [Integer, nil] - optional :odometer, Integer + optional :odometer, Integer, nil?: true # @!attribute service_type # The type of fuel service. @@ -202,7 +206,7 @@ class Fleet < Lithic::Internal::Type::BaseModel # zeros stripped. # # @return [String, nil] - optional :vehicle_number, String + optional :vehicle_number, String, nil?: true # @!method initialize(amount_totals:, fuel:, driver_number: nil, odometer: nil, service_type: nil, vehicle_number: nil) # Some parameter documentations has been truncated, see @@ -212,13 +216,13 @@ class Fleet < Lithic::Internal::Type::BaseModel # # @param fuel [Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel] # - # @param driver_number [String] The driver number entered into the terminal at the time of sale, with leading ze + # @param driver_number [String, nil] The driver number entered into the terminal at the time of sale, with leading ze # - # @param odometer [Integer] The odometer reading entered into the terminal at the time of sale. + # @param odometer [Integer, nil] The odometer reading entered into the terminal at the time of sale. # # @param service_type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::ServiceType] The type of fuel service. # - # @param vehicle_number [String] The vehicle number entered into the terminal at the time of sale, with leading z + # @param vehicle_number [String, nil] The vehicle number entered into the terminal at the time of sale, with leading z # @see Lithic::Models::Transactions::Events::EnhancedData::Fleet#amount_totals class AmountTotals < Lithic::Internal::Type::BaseModel @@ -226,26 +230,26 @@ class AmountTotals < Lithic::Internal::Type::BaseModel # The discount applied to the gross sale amount. # # @return [Integer, nil] - optional :discount, Integer + optional :discount, Integer, nil?: true # @!attribute gross_sale # The gross sale amount. # # @return [Integer, nil] - optional :gross_sale, Integer + optional :gross_sale, Integer, nil?: true # @!attribute net_sale # The amount after discount. # # @return [Integer, nil] - optional :net_sale, Integer + optional :net_sale, Integer, nil?: true # @!method initialize(discount: nil, gross_sale: nil, net_sale: nil) - # @param discount [Integer] The discount applied to the gross sale amount. + # @param discount [Integer, nil] The discount applied to the gross sale amount. # - # @param gross_sale [Integer] The gross sale amount. + # @param gross_sale [Integer, nil] The gross sale amount. # - # @param net_sale [Integer] The amount after discount. + # @param net_sale [Integer, nil] The amount after discount. end # @see Lithic::Models::Transactions::Events::EnhancedData::Fleet#fuel @@ -254,35 +258,40 @@ class Fuel < Lithic::Internal::Type::BaseModel # The quantity of fuel purchased. # # @return [String, nil] - optional :quantity, String + optional :quantity, String, nil?: true # @!attribute type # The type of fuel purchased. # # @return [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::Type, nil] - optional :type, enum: -> { Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type } + optional :type, + enum: -> { + Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type + }, + nil?: true # @!attribute unit_of_measure # Unit of measure for fuel disbursement. # # @return [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure, nil] optional :unit_of_measure, - enum: -> { Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure } + enum: -> { Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure }, + nil?: true # @!attribute unit_price # The price per unit of fuel. # # @return [Integer, nil] - optional :unit_price, Integer + optional :unit_price, Integer, nil?: true # @!method initialize(quantity: nil, type: nil, unit_of_measure: nil, unit_price: nil) - # @param quantity [String] The quantity of fuel purchased. + # @param quantity [String, nil] The quantity of fuel purchased. # - # @param type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::Type] The type of fuel purchased. + # @param type [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::Type, nil] The type of fuel purchased. # - # @param unit_of_measure [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure] Unit of measure for fuel disbursement. + # @param unit_of_measure [Symbol, Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure, nil] Unit of measure for fuel disbursement. # - # @param unit_price [Integer] The price per unit of fuel. + # @param unit_price [Integer, nil] The price per unit of fuel. # The type of fuel purchased. # diff --git a/lib/lithic/models/transfer.rb b/lib/lithic/models/transfer.rb index 0dc22227..524a1c53 100644 --- a/lib/lithic/models/transfer.rb +++ b/lib/lithic/models/transfer.rb @@ -42,8 +42,8 @@ class Transfer < Lithic::Internal::Type::BaseModel # @!attribute events # A list of all financial events that have modified this trasnfer. # - # @return [Array, nil] - optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::Transfer::Event] } + # @return [Array, nil] + optional :events, -> { Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent] } # @!attribute from_balance # The updated balance of the sending financial account. @@ -111,7 +111,7 @@ class Transfer < Lithic::Internal::Type::BaseModel # # @param descriptor [String] A string that provides a description of the transfer; may be useful to display t # - # @param events [Array] A list of all financial events that have modified this trasnfer. + # @param events [Array] A list of all financial events that have modified this trasnfer. # # @param from_balance [Array] The updated balance of the sending financial account. # @@ -142,149 +142,6 @@ module Category # @return [Array] end - class Event < Lithic::Internal::Type::BaseModel - # @!attribute token - # Globally unique identifier. - # - # @return [String, nil] - optional :token, String - - # @!attribute amount - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - # - # @return [Integer, nil] - optional :amount, Integer - - # @!attribute created - # Date and time when the financial event occurred. UTC time zone. - # - # @return [Time, nil] - optional :created, Time - - # @!attribute result - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @return [Symbol, Lithic::Models::Transfer::Event::Result, nil] - optional :result, enum: -> { Lithic::Transfer::Event::Result } - - # @!attribute type - # - # @return [Symbol, Lithic::Models::Transfer::Event::Type, nil] - optional :type, enum: -> { Lithic::Transfer::Event::Type } - - # @!method initialize(token: nil, amount: nil, created: nil, result: nil, type: nil) - # Some parameter documentations has been truncated, see - # {Lithic::Models::Transfer::Event} for more details. - # - # Financial Event - # - # @param token [String] Globally unique identifier. - # - # @param amount [Integer] Amount of the financial event that has been settled in the currency's smallest u - # - # @param created [Time] Date and time when the financial event occurred. UTC time zone. - # - # @param result [Symbol, Lithic::Models::Transfer::Event::Result] APPROVED financial events were successful while DECLINED financial events were d - # - # @param type [Symbol, Lithic::Models::Transfer::Event::Type] - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - # - # @see Lithic::Models::Transfer::Event#result - module Result - extend Lithic::Internal::Type::Enum - - APPROVED = :APPROVED - DECLINED = :DECLINED - - # @!method self.values - # @return [Array] - end - - # @see Lithic::Models::Transfer::Event#type - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED = :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED = :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED = :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED = :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED = :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED = :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED = :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED = :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED = :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED = :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED = :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED = :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED = :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED = :ACH_RETURN_SETTLED - AUTHORIZATION = :AUTHORIZATION - AUTHORIZATION_ADVICE = :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY = :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL = :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY = :BALANCE_INQUIRY - BILLING_ERROR = :BILLING_ERROR - BILLING_ERROR_REVERSAL = :BILLING_ERROR_REVERSAL - CARD_TO_CARD = :CARD_TO_CARD - CASH_BACK = :CASH_BACK - CASH_BACK_REVERSAL = :CASH_BACK_REVERSAL - CLEARING = :CLEARING - COLLECTION = :COLLECTION - CORRECTION_CREDIT = :CORRECTION_CREDIT - CORRECTION_DEBIT = :CORRECTION_DEBIT - CREDIT_AUTHORIZATION = :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE = :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION = :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL = :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON = :DISPUTE_WON - EXTERNAL_ACH_CANCELED = :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED = :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED = :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED = :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED = :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED = :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED = :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED = :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED = :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED = :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED = :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED = :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED = :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED = :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED = :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED = :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED = :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED = :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED = :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED = :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION = :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION = :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST = :INTEREST - INTEREST_REVERSAL = :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT = :INTERNAL_ADJUSTMENT - LATE_PAYMENT = :LATE_PAYMENT - LATE_PAYMENT_REVERSAL = :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF = :LOSS_WRITE_OFF - PROVISIONAL_CREDIT = :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL = :PROVISIONAL_CREDIT_REVERSAL - SERVICE = :SERVICE - RETURN = :RETURN - RETURN_REVERSAL = :RETURN_REVERSAL - TRANSFER = :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS = :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT = :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL = :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT = :LITHIC_NETWORK_PAYMENT - - # @!method self.values - # @return [Array] - end - end - # APPROVED transactions were successful while DECLINED transactions were declined # by user, Lithic, or the network. # diff --git a/lib/lithic/resources/auth_rules/v2.rb b/lib/lithic/resources/auth_rules/v2.rb index f1584f20..8039cc96 100644 --- a/lib/lithic/resources/auth_rules/v2.rb +++ b/lib/lithic/resources/auth_rules/v2.rb @@ -14,7 +14,7 @@ class V2 # # @overload create(parameters:, type:, card_tokens:, program_level:, account_tokens: nil, business_account_tokens: nil, event_stream: nil, name: nil, excluded_card_tokens: nil, request_options: {}) # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters] Parameters for the Auth Rule # # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] The type of Auth Rule. For certain rule types, this determines the event stream # @@ -178,7 +178,7 @@ def delete(auth_rule_token, params = {}) # # @param auth_rule_token [String] # - # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, nil] Parameters for the Auth Rule + # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, Lithic::Models::AuthRules::MerchantLockParameters, Lithic::Models::AuthRules::Conditional3DSActionParameters, Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters, Lithic::Models::AuthRules::ConditionalACHActionParameters, Lithic::Models::AuthRules::ConditionalTokenizationActionParameters, nil] Parameters for the Auth Rule # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # diff --git a/lib/lithic/resources/disputes.rb b/lib/lithic/resources/disputes.rb index 76009cb7..ef91109b 100644 --- a/lib/lithic/resources/disputes.rb +++ b/lib/lithic/resources/disputes.rb @@ -19,7 +19,7 @@ class Disputes # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Lithic::Models::DisputeCreateResponse] + # @return [Lithic::Models::Dispute] # # @see Lithic::Models::DisputeCreateParams def create(params) @@ -28,7 +28,7 @@ def create(params) method: :post, path: "v1/disputes", body: parsed, - model: Lithic::Models::DisputeCreateResponse, + model: Lithic::Dispute, options: options ) end @@ -40,14 +40,14 @@ def create(params) # @param dispute_token [String] # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Lithic::Models::DisputeRetrieveResponse] + # @return [Lithic::Models::Dispute] # # @see Lithic::Models::DisputeRetrieveParams def retrieve(dispute_token, params = {}) @client.request( method: :get, path: ["v1/disputes/%1$s", dispute_token], - model: Lithic::Models::DisputeRetrieveResponse, + model: Lithic::Dispute, options: params[:request_options] ) end @@ -68,7 +68,7 @@ def retrieve(dispute_token, params = {}) # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Lithic::Models::DisputeUpdateResponse] + # @return [Lithic::Models::Dispute] # # @see Lithic::Models::DisputeUpdateParams def update(dispute_token, params = {}) @@ -77,7 +77,7 @@ def update(dispute_token, params = {}) method: :patch, path: ["v1/disputes/%1$s", dispute_token], body: parsed, - model: Lithic::Models::DisputeUpdateResponse, + model: Lithic::Dispute, options: options ) end @@ -105,7 +105,7 @@ def update(dispute_token, params = {}) # # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Lithic::Internal::CursorPage] + # @return [Lithic::Internal::CursorPage] # # @see Lithic::Models::DisputeListParams def list(params = {}) @@ -115,7 +115,7 @@ def list(params = {}) path: "v1/disputes", query: parsed.transform_keys(begin_: "begin", end_: "end"), page: Lithic::Internal::CursorPage, - model: Lithic::Models::DisputeListResponse, + model: Lithic::Dispute, options: options ) end @@ -127,14 +127,14 @@ def list(params = {}) # @param dispute_token [String] # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [Lithic::Models::DisputeDeleteResponse] + # @return [Lithic::Models::Dispute] # # @see Lithic::Models::DisputeDeleteParams def delete(dispute_token, params = {}) @client.request( method: :delete, path: ["v1/disputes/%1$s", dispute_token], - model: Lithic::Models::DisputeDeleteResponse, + model: Lithic::Dispute, options: params[:request_options] ) end diff --git a/lib/lithic/resources/disputes_v2.rb b/lib/lithic/resources/disputes_v2.rb new file mode 100644 index 00000000..806c916a --- /dev/null +++ b/lib/lithic/resources/disputes_v2.rb @@ -0,0 +1,74 @@ +# frozen_string_literal: true + +module Lithic + module Resources + class DisputesV2 + # Retrieves a specific dispute by its token. + # + # @overload retrieve(dispute_token, request_options: {}) + # + # @param dispute_token [String] Token of the dispute to retrieve. + # + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Lithic::Models::DisputeV2] + # + # @see Lithic::Models::DisputesV2RetrieveParams + def retrieve(dispute_token, params = {}) + @client.request( + method: :get, + path: ["v2/disputes/%1$s", dispute_token], + model: Lithic::DisputeV2, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {Lithic::Models::DisputesV2ListParams} for more details. + # + # Returns a paginated list of disputes. + # + # @overload list(account_token: nil, begin_: nil, card_token: nil, disputed_transaction_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {}) + # + # @param account_token [String] Filter by account token. + # + # @param begin_ [Time] RFC 3339 timestamp for filtering by created date, inclusive. + # + # @param card_token [String] Filter by card token. + # + # @param disputed_transaction_token [String] Filter by the token of the transaction being disputed. Corresponds with transact + # + # @param end_ [Time] RFC 3339 timestamp for filtering by created date, inclusive. + # + # @param ending_before [String] A cursor representing an item's token before which a page of results should end. + # + # @param page_size [Integer] Number of items to return. + # + # @param starting_after [String] A cursor representing an item's token after which a page of results should begin + # + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Lithic::Internal::CursorPage] + # + # @see Lithic::Models::DisputesV2ListParams + def list(params = {}) + parsed, options = Lithic::DisputesV2ListParams.dump_request(params) + @client.request( + method: :get, + path: "v2/disputes", + query: parsed.transform_keys(begin_: "begin", end_: "end"), + page: Lithic::Internal::CursorPage, + model: Lithic::DisputeV2, + options: options + ) + end + + # @api private + # + # @param client [Lithic::Client] + def initialize(client:) + @client = client + end + end + end +end diff --git a/lib/lithic/resources/external_bank_accounts.rb b/lib/lithic/resources/external_bank_accounts.rb index baa36ff8..f7fe996e 100644 --- a/lib/lithic/resources/external_bank_accounts.rb +++ b/lib/lithic/resources/external_bank_accounts.rb @@ -211,6 +211,25 @@ def retry_prenote(external_bank_account_token, params = {}) ) end + # Unpause an external bank account + # + # @overload unpause(external_bank_account_token, request_options: {}) + # + # @param external_bank_account_token [String] + # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [Lithic::Models::ExternalBankAccountUnpauseResponse] + # + # @see Lithic::Models::ExternalBankAccountUnpauseParams + def unpause(external_bank_account_token, params = {}) + @client.request( + method: :post, + path: ["v1/external_bank_accounts/%1$s/unpause", external_bank_account_token], + model: Lithic::Models::ExternalBankAccountUnpauseResponse, + options: params[:request_options] + ) + end + # @api private # # @param client [Lithic::Client] diff --git a/lib/lithic/resources/payments.rb b/lib/lithic/resources/payments.rb index 1a4326bf..457ed732 100644 --- a/lib/lithic/resources/payments.rb +++ b/lib/lithic/resources/payments.rb @@ -128,6 +128,54 @@ def retry_(payment_token, params = {}) ) end + # Some parameter documentations has been truncated, see + # {Lithic::Models::PaymentReturnParams} for more details. + # + # Return an ACH payment with a specified return reason code. Returns must be + # initiated within the time window specified by NACHA rules for each return code + # (typically 2 banking days for most codes, 60 calendar days for unauthorized + # debits). For a complete list of return codes and their meanings, see the + # [ACH Return Reasons documentation](https://docs.lithic.com/docs/ach-overview#ach-return-reasons). + # + # Note: + # + # - This endpoint does not modify the state of the financial account associated + # with the payment. If you would like to change the account state, use the + # [Update financial account status](https://docs.lithic.com/reference/updatefinancialaccountstatus) + # endpoint. + # - By default this endpoint is not enabled for your account. Please contact your + # implementations manager to enable this feature. + # + # @overload return_(payment_token, financial_account_token:, return_reason_code:, addenda: nil, date_of_death: nil, memo: nil, request_options: {}) + # + # @param payment_token [String] + # + # @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}, nil] + # + # @return [Lithic::Models::Payment] + # + # @see Lithic::Models::PaymentReturnParams + def return_(payment_token, params) + parsed, options = Lithic::PaymentReturnParams.dump_request(params) + @client.request( + method: :post, + path: ["v1/payments/%1$s/return", payment_token], + body: parsed, + model: Lithic::Payment, + options: options + ) + end + # Simulate payment lifecycle event # # @overload simulate_action(payment_token, event_type:, date_of_death: nil, decline_reason: nil, return_addenda: nil, return_reason_code: nil, request_options: {}) diff --git a/lib/lithic/version.rb b/lib/lithic/version.rb index ad17b6ad..11022f18 100644 --- a/lib/lithic/version.rb +++ b/lib/lithic/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module Lithic - VERSION = "0.1.0.pre.alpha.55" + VERSION = "0.1.0.pre.alpha.56" end diff --git a/rbi/lithic/client.rbi b/rbi/lithic/client.rbi index a06e2e9a..26a564ae 100644 --- a/rbi/lithic/client.rbi +++ b/rbi/lithic/client.rbi @@ -52,6 +52,9 @@ module Lithic sig { returns(Lithic::Resources::Disputes) } attr_reader :disputes + sig { returns(Lithic::Resources::DisputesV2) } + attr_reader :disputes_v2 + sig { returns(Lithic::Resources::Events) } attr_reader :events diff --git a/rbi/lithic/models.rbi b/rbi/lithic/models.rbi index 5351899e..0ee5b25a 100644 --- a/rbi/lithic/models.rbi +++ b/rbi/lithic/models.rbi @@ -118,6 +118,8 @@ module Lithic Carrier = Lithic::Models::Carrier + CategoryDetails = Lithic::Models::CategoryDetails + ClientAPIStatusParams = Lithic::Models::ClientAPIStatusParams CreditProducts = Lithic::Models::CreditProducts @@ -151,8 +153,14 @@ module Lithic DisputeRetrieveParams = Lithic::Models::DisputeRetrieveParams + DisputesV2ListParams = Lithic::Models::DisputesV2ListParams + + DisputesV2RetrieveParams = Lithic::Models::DisputesV2RetrieveParams + DisputeUpdateParams = Lithic::Models::DisputeUpdateParams + DisputeV2 = Lithic::Models::DisputeV2 + Document = Lithic::Models::Document Event = Lithic::Models::Event @@ -185,6 +193,9 @@ module Lithic ExternalBankAccounts = Lithic::Models::ExternalBankAccounts + ExternalBankAccountUnpauseParams = + Lithic::Models::ExternalBankAccountUnpauseParams + ExternalBankAccountUpdateParams = Lithic::Models::ExternalBankAccountUpdateParams @@ -227,6 +238,8 @@ module Lithic FinancialAccountUpdateStatusParams = Lithic::Models::FinancialAccountUpdateStatusParams + FinancialEvent = Lithic::Models::FinancialEvent + FinancialTransaction = Lithic::Models::FinancialTransaction Fraud = Lithic::Models::Fraud @@ -262,6 +275,8 @@ module Lithic ManagementOperationTransaction = Lithic::Models::ManagementOperationTransaction + Merchant = Lithic::Models::Merchant + MessageAttempt = Lithic::Models::MessageAttempt NetworkProgram = Lithic::Models::NetworkProgram @@ -284,6 +299,8 @@ module Lithic PaymentRetryParams = Lithic::Models::PaymentRetryParams + PaymentReturnParams = Lithic::Models::PaymentReturnParams + PaymentSimulateActionParams = Lithic::Models::PaymentSimulateActionParams PaymentSimulateReceiptParams = Lithic::Models::PaymentSimulateReceiptParams @@ -317,6 +334,8 @@ module Lithic SpendLimitDuration = Lithic::Models::SpendLimitDuration + StatementTotals = Lithic::Models::StatementTotals + ThreeDS = Lithic::Models::ThreeDS Tokenization = Lithic::Models::Tokenization diff --git a/rbi/lithic/models/account_activity_list_response.rbi b/rbi/lithic/models/account_activity_list_response.rbi index 2b88635e..eb9e5a52 100644 --- a/rbi/lithic/models/account_activity_list_response.rbi +++ b/rbi/lithic/models/account_activity_list_response.rbi @@ -56,13 +56,7 @@ module Lithic attr_accessor :descriptor # List of transaction events - sig do - returns( - T::Array[ - Lithic::Models::AccountActivityListResponse::Internal::Event - ] - ) - end + sig { returns(T::Array[Lithic::FinancialEvent]) } attr_accessor :events # INTERNAL - Financial Transaction @@ -110,10 +104,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: - T::Array[ - Lithic::Models::AccountActivityListResponse::Internal::Event::OrHash - ], + events: T::Array[Lithic::FinancialEvent::OrHash], financial_account_token: String, pending_amount: Integer, result: @@ -164,10 +155,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: - T::Array[ - Lithic::Models::AccountActivityListResponse::Internal::Event - ], + events: T::Array[Lithic::FinancialEvent], family: Symbol, financial_account_token: String, pending_amount: Integer, @@ -298,532 +286,6 @@ module Lithic end end - class Event < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::AccountActivityListResponse::Internal::Event, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :token - - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - sig { returns(T.nilable(Integer)) } - attr_reader :amount - - sig { params(amount: Integer).void } - attr_writer :amount - - # Date and time when the financial event occurred. UTC time zone. - sig { returns(T.nilable(Time)) } - attr_reader :created - - sig { params(created: Time).void } - attr_writer :created - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - sig do - returns( - T.nilable( - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::TaggedSymbol - ) - ) - end - attr_reader :result - - sig do - params( - result: - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::OrSymbol - ).void - end - attr_writer :result - - sig do - returns( - T.nilable( - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::OrSymbol - ).void - end - attr_writer :type - - # Financial Event - sig do - params( - token: String, - amount: Integer, - created: Time, - result: - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::OrSymbol, - type: - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token: nil, - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - amount: nil, - # Date and time when the financial event occurred. UTC time zone. - created: nil, - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - result: nil, - type: nil - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - created: Time, - result: - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::TaggedSymbol, - type: - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - } - ) - end - def to_hash - end - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - module Result - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::AccountActivityListResponse::Internal::Event::Result - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - APPROVED = - T.let( - :APPROVED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::TaggedSymbol - ) - DECLINED = - T.let( - :DECLINED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::AccountActivityListResponse::Internal::Event::Result::TaggedSymbol - ] - ) - end - def self.values - end - end - - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ACH_ORIGINATION_CANCELLED = - T.let( - :ACH_ORIGINATION_CANCELLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_INITIATED = - T.let( - :ACH_ORIGINATION_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_PROCESSED = - T.let( - :ACH_ORIGINATION_PROCESSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_RELEASED = - T.let( - :ACH_ORIGINATION_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REJECTED = - T.let( - :ACH_ORIGINATION_REJECTED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REVIEWED = - T.let( - :ACH_ORIGINATION_REVIEWED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_SETTLED = - T.let( - :ACH_ORIGINATION_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_PROCESSED = - T.let( - :ACH_RECEIPT_PROCESSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_RELEASED = - T.let( - :ACH_RECEIPT_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_SETTLED = - T.let( - :ACH_RECEIPT_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_INITIATED = - T.let( - :ACH_RETURN_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_PROCESSED = - T.let( - :ACH_RETURN_PROCESSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_REJECTED = - T.let( - :ACH_RETURN_REJECTED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_SETTLED = - T.let( - :ACH_RETURN_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION = - T.let( - :AUTHORIZATION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_ADVICE = - T.let( - :AUTHORIZATION_ADVICE, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_EXPIRY = - T.let( - :AUTHORIZATION_EXPIRY, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_REVERSAL = - T.let( - :AUTHORIZATION_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - BALANCE_INQUIRY = - T.let( - :BALANCE_INQUIRY, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - BILLING_ERROR = - T.let( - :BILLING_ERROR, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - BILLING_ERROR_REVERSAL = - T.let( - :BILLING_ERROR_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CARD_TO_CARD = - T.let( - :CARD_TO_CARD, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CASH_BACK = - T.let( - :CASH_BACK, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CASH_BACK_REVERSAL = - T.let( - :CASH_BACK_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CLEARING = - T.let( - :CLEARING, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - COLLECTION = - T.let( - :COLLECTION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CORRECTION_CREDIT = - T.let( - :CORRECTION_CREDIT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CORRECTION_DEBIT = - T.let( - :CORRECTION_DEBIT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION = - T.let( - :CREDIT_AUTHORIZATION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION_ADVICE = - T.let( - :CREDIT_AUTHORIZATION_ADVICE, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION = - T.let( - :CURRENCY_CONVERSION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION_REVERSAL = - T.let( - :CURRENCY_CONVERSION_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - DISPUTE_WON = - T.let( - :DISPUTE_WON, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_CANCELED = - T.let( - :EXTERNAL_ACH_CANCELED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_INITIATED = - T.let( - :EXTERNAL_ACH_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_RELEASED = - T.let( - :EXTERNAL_ACH_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_REVERSED = - T.let( - :EXTERNAL_ACH_REVERSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_SETTLED = - T.let( - :EXTERNAL_ACH_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_CANCELED = - T.let( - :EXTERNAL_CHECK_CANCELED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_INITIATED = - T.let( - :EXTERNAL_CHECK_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_RELEASED = - T.let( - :EXTERNAL_CHECK_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_REVERSED = - T.let( - :EXTERNAL_CHECK_REVERSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_SETTLED = - T.let( - :EXTERNAL_CHECK_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_CANCELED = - T.let( - :EXTERNAL_TRANSFER_CANCELED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_INITIATED = - T.let( - :EXTERNAL_TRANSFER_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_RELEASED = - T.let( - :EXTERNAL_TRANSFER_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_REVERSED = - T.let( - :EXTERNAL_TRANSFER_REVERSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_SETTLED = - T.let( - :EXTERNAL_TRANSFER_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_CANCELED = - T.let( - :EXTERNAL_WIRE_CANCELED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_INITIATED = - T.let( - :EXTERNAL_WIRE_INITIATED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_RELEASED = - T.let( - :EXTERNAL_WIRE_RELEASED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_REVERSED = - T.let( - :EXTERNAL_WIRE_REVERSED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_SETTLED = - T.let( - :EXTERNAL_WIRE_SETTLED, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - FINANCIAL_AUTHORIZATION = - T.let( - :FINANCIAL_AUTHORIZATION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - FINANCIAL_CREDIT_AUTHORIZATION = - T.let( - :FINANCIAL_CREDIT_AUTHORIZATION, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - INTEREST = - T.let( - :INTEREST, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - INTEREST_REVERSAL = - T.let( - :INTEREST_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - INTERNAL_ADJUSTMENT = - T.let( - :INTERNAL_ADJUSTMENT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - LATE_PAYMENT = - T.let( - :LATE_PAYMENT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - LATE_PAYMENT_REVERSAL = - T.let( - :LATE_PAYMENT_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - LOSS_WRITE_OFF = - T.let( - :LOSS_WRITE_OFF, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT = - T.let( - :PROVISIONAL_CREDIT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT_REVERSAL = - T.let( - :PROVISIONAL_CREDIT_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - SERVICE = - T.let( - :SERVICE, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - RETURN = - T.let( - :RETURN, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - RETURN_REVERSAL = - T.let( - :RETURN_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - TRANSFER = - T.let( - :TRANSFER, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - TRANSFER_INSUFFICIENT_FUNDS = - T.let( - :TRANSFER_INSUFFICIENT_FUNDS, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT = - T.let( - :RETURNED_PAYMENT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT_REVERSAL = - T.let( - :RETURNED_PAYMENT_REVERSAL, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - LITHIC_NETWORK_PAYMENT = - T.let( - :LITHIC_NETWORK_PAYMENT, - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::AccountActivityListResponse::Internal::Event::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - end - # Transaction result module Result extend Lithic::Internal::Type::Enum @@ -897,6 +359,11 @@ module Lithic :CANCELED, Lithic::Models::AccountActivityListResponse::Internal::Status::TaggedSymbol ) + RETURNED = + T.let( + :RETURNED, + Lithic::Models::AccountActivityListResponse::Internal::Status::TaggedSymbol + ) sig do override.returns( @@ -919,14 +386,124 @@ module Lithic ) end + # Unique identifier for the transaction + sig { returns(String) } + attr_accessor :token + + # ISO 8601 timestamp of when the transaction was created + sig { returns(Time) } + attr_accessor :created + + # CARD - Card Transaction + sig { returns(Symbol) } + attr_accessor :family + + # The status of the transaction + sig do + returns( + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + end + attr_accessor :status + + # ISO 8601 timestamp of when the transaction was last updated + sig { returns(Time) } + attr_accessor :updated + # Card transaction with ledger base properties - sig { returns(T.attached_class) } - def self.new + sig do + params( + token: String, + created: Time, + status: + Lithic::Models::AccountActivityListResponse::Card::Status::OrSymbol, + updated: Time, + family: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the transaction + token:, + # ISO 8601 timestamp of when the transaction was created + created:, + # The status of the transaction + status:, + # ISO 8601 timestamp of when the transaction was last updated + updated:, + # CARD - Card Transaction + family: :CARD + ) end - sig { override.returns({}) } + sig do + override.returns( + { + token: String, + created: Time, + family: Symbol, + status: + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol, + updated: Time + } + ) + end def to_hash end + + # The status of the transaction + module Status + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::Models::AccountActivityListResponse::Card::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PENDING = + T.let( + :PENDING, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + SETTLED = + T.let( + :SETTLED, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + DECLINED = + T.let( + :DECLINED, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + REVERSED = + T.let( + :REVERSED, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + CANCELED = + T.let( + :CANCELED, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + RETURNED = + T.let( + :RETURNED, + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::Models::AccountActivityListResponse::Card::Status::TaggedSymbol + ] + ) + end + def self.values + end + end end sig do diff --git a/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi b/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi index 38877a6d..fe61f9ee 100644 --- a/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi +++ b/rbi/lithic/models/account_activity_retrieve_transaction_response.rbi @@ -56,13 +56,7 @@ module Lithic attr_accessor :descriptor # List of transaction events - sig do - returns( - T::Array[ - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event - ] - ) - end + sig { returns(T::Array[Lithic::FinancialEvent]) } attr_accessor :events # INTERNAL - Financial Transaction @@ -110,10 +104,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: - T::Array[ - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::OrHash - ], + events: T::Array[Lithic::FinancialEvent::OrHash], financial_account_token: String, pending_amount: Integer, result: @@ -164,10 +155,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: - T::Array[ - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event - ], + events: T::Array[Lithic::FinancialEvent], family: Symbol, financial_account_token: String, pending_amount: Integer, @@ -298,532 +286,6 @@ module Lithic end end - class Event < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :token - - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - sig { returns(T.nilable(Integer)) } - attr_reader :amount - - sig { params(amount: Integer).void } - attr_writer :amount - - # Date and time when the financial event occurred. UTC time zone. - sig { returns(T.nilable(Time)) } - attr_reader :created - - sig { params(created: Time).void } - attr_writer :created - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - sig do - returns( - T.nilable( - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::TaggedSymbol - ) - ) - end - attr_reader :result - - sig do - params( - result: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::OrSymbol - ).void - end - attr_writer :result - - sig do - returns( - T.nilable( - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ) - end - attr_reader :type - - sig do - params( - type: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::OrSymbol - ).void - end - attr_writer :type - - # Financial Event - sig do - params( - token: String, - amount: Integer, - created: Time, - result: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::OrSymbol, - type: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token: nil, - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - amount: nil, - # Date and time when the financial event occurred. UTC time zone. - created: nil, - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - result: nil, - type: nil - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - created: Time, - result: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::TaggedSymbol, - type: - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - } - ) - end - def to_hash - end - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - module Result - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - APPROVED = - T.let( - :APPROVED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::TaggedSymbol - ) - DECLINED = - T.let( - :DECLINED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Result::TaggedSymbol - ] - ) - end - def self.values - end - end - - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ACH_ORIGINATION_CANCELLED = - T.let( - :ACH_ORIGINATION_CANCELLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_INITIATED = - T.let( - :ACH_ORIGINATION_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_PROCESSED = - T.let( - :ACH_ORIGINATION_PROCESSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_RELEASED = - T.let( - :ACH_ORIGINATION_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REJECTED = - T.let( - :ACH_ORIGINATION_REJECTED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REVIEWED = - T.let( - :ACH_ORIGINATION_REVIEWED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_SETTLED = - T.let( - :ACH_ORIGINATION_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_PROCESSED = - T.let( - :ACH_RECEIPT_PROCESSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_RELEASED = - T.let( - :ACH_RECEIPT_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_SETTLED = - T.let( - :ACH_RECEIPT_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_INITIATED = - T.let( - :ACH_RETURN_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_PROCESSED = - T.let( - :ACH_RETURN_PROCESSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_REJECTED = - T.let( - :ACH_RETURN_REJECTED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - ACH_RETURN_SETTLED = - T.let( - :ACH_RETURN_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION = - T.let( - :AUTHORIZATION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_ADVICE = - T.let( - :AUTHORIZATION_ADVICE, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_EXPIRY = - T.let( - :AUTHORIZATION_EXPIRY, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - AUTHORIZATION_REVERSAL = - T.let( - :AUTHORIZATION_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - BALANCE_INQUIRY = - T.let( - :BALANCE_INQUIRY, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - BILLING_ERROR = - T.let( - :BILLING_ERROR, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - BILLING_ERROR_REVERSAL = - T.let( - :BILLING_ERROR_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CARD_TO_CARD = - T.let( - :CARD_TO_CARD, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CASH_BACK = - T.let( - :CASH_BACK, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CASH_BACK_REVERSAL = - T.let( - :CASH_BACK_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CLEARING = - T.let( - :CLEARING, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - COLLECTION = - T.let( - :COLLECTION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CORRECTION_CREDIT = - T.let( - :CORRECTION_CREDIT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CORRECTION_DEBIT = - T.let( - :CORRECTION_DEBIT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION = - T.let( - :CREDIT_AUTHORIZATION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION_ADVICE = - T.let( - :CREDIT_AUTHORIZATION_ADVICE, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION = - T.let( - :CURRENCY_CONVERSION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION_REVERSAL = - T.let( - :CURRENCY_CONVERSION_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - DISPUTE_WON = - T.let( - :DISPUTE_WON, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_CANCELED = - T.let( - :EXTERNAL_ACH_CANCELED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_INITIATED = - T.let( - :EXTERNAL_ACH_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_RELEASED = - T.let( - :EXTERNAL_ACH_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_REVERSED = - T.let( - :EXTERNAL_ACH_REVERSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_SETTLED = - T.let( - :EXTERNAL_ACH_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_CANCELED = - T.let( - :EXTERNAL_CHECK_CANCELED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_INITIATED = - T.let( - :EXTERNAL_CHECK_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_RELEASED = - T.let( - :EXTERNAL_CHECK_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_REVERSED = - T.let( - :EXTERNAL_CHECK_REVERSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_SETTLED = - T.let( - :EXTERNAL_CHECK_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_CANCELED = - T.let( - :EXTERNAL_TRANSFER_CANCELED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_INITIATED = - T.let( - :EXTERNAL_TRANSFER_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_RELEASED = - T.let( - :EXTERNAL_TRANSFER_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_REVERSED = - T.let( - :EXTERNAL_TRANSFER_REVERSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_SETTLED = - T.let( - :EXTERNAL_TRANSFER_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_CANCELED = - T.let( - :EXTERNAL_WIRE_CANCELED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_INITIATED = - T.let( - :EXTERNAL_WIRE_INITIATED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_RELEASED = - T.let( - :EXTERNAL_WIRE_RELEASED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_REVERSED = - T.let( - :EXTERNAL_WIRE_REVERSED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_SETTLED = - T.let( - :EXTERNAL_WIRE_SETTLED, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - FINANCIAL_AUTHORIZATION = - T.let( - :FINANCIAL_AUTHORIZATION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - FINANCIAL_CREDIT_AUTHORIZATION = - T.let( - :FINANCIAL_CREDIT_AUTHORIZATION, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - INTEREST = - T.let( - :INTEREST, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - INTEREST_REVERSAL = - T.let( - :INTEREST_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - INTERNAL_ADJUSTMENT = - T.let( - :INTERNAL_ADJUSTMENT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - LATE_PAYMENT = - T.let( - :LATE_PAYMENT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - LATE_PAYMENT_REVERSAL = - T.let( - :LATE_PAYMENT_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - LOSS_WRITE_OFF = - T.let( - :LOSS_WRITE_OFF, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT = - T.let( - :PROVISIONAL_CREDIT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT_REVERSAL = - T.let( - :PROVISIONAL_CREDIT_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - SERVICE = - T.let( - :SERVICE, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - RETURN = - T.let( - :RETURN, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - RETURN_REVERSAL = - T.let( - :RETURN_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - TRANSFER = - T.let( - :TRANSFER, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - TRANSFER_INSUFFICIENT_FUNDS = - T.let( - :TRANSFER_INSUFFICIENT_FUNDS, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT = - T.let( - :RETURNED_PAYMENT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT_REVERSAL = - T.let( - :RETURNED_PAYMENT_REVERSAL, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - LITHIC_NETWORK_PAYMENT = - T.let( - :LITHIC_NETWORK_PAYMENT, - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::Type::TaggedSymbol - ] - ) - end - def self.values - end - end - end - # Transaction result module Result extend Lithic::Internal::Type::Enum @@ -897,6 +359,11 @@ module Lithic :CANCELED, Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Status::TaggedSymbol ) + RETURNED = + T.let( + :RETURNED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Status::TaggedSymbol + ) sig do override.returns( @@ -919,14 +386,124 @@ module Lithic ) end + # Unique identifier for the transaction + sig { returns(String) } + attr_accessor :token + + # ISO 8601 timestamp of when the transaction was created + sig { returns(Time) } + attr_accessor :created + + # CARD - Card Transaction + sig { returns(Symbol) } + attr_accessor :family + + # The status of the transaction + sig do + returns( + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + end + attr_accessor :status + + # ISO 8601 timestamp of when the transaction was last updated + sig { returns(Time) } + attr_accessor :updated + # Card transaction with ledger base properties - sig { returns(T.attached_class) } - def self.new + sig do + params( + token: String, + created: Time, + status: + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::OrSymbol, + updated: Time, + family: Symbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the transaction + token:, + # ISO 8601 timestamp of when the transaction was created + created:, + # The status of the transaction + status:, + # ISO 8601 timestamp of when the transaction was last updated + updated:, + # CARD - Card Transaction + family: :CARD + ) end - sig { override.returns({}) } + sig do + override.returns( + { + token: String, + created: Time, + family: Symbol, + status: + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol, + updated: Time + } + ) + end def to_hash end + + # The status of the transaction + module Status + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PENDING = + T.let( + :PENDING, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + SETTLED = + T.let( + :SETTLED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + DECLINED = + T.let( + :DECLINED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + REVERSED = + T.let( + :REVERSED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + CANCELED = + T.let( + :CANCELED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + RETURNED = + T.let( + :RETURNED, + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::Status::TaggedSymbol + ] + ) + end + def self.values + end + end end sig do diff --git a/rbi/lithic/models/auth_rules/auth_rule_condition.rbi b/rbi/lithic/models/auth_rules/auth_rule_condition.rbi index f6cfb721..aa8a00a4 100644 --- a/rbi/lithic/models/auth_rules/auth_rule_condition.rbi +++ b/rbi/lithic/models/auth_rules/auth_rule_condition.rbi @@ -64,54 +64,22 @@ module Lithic # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. - sig do - returns(T.nilable(Lithic::AuthRules::ConditionalAttribute::OrSymbol)) - end - attr_reader :attribute - - sig do - params( - attribute: Lithic::AuthRules::ConditionalAttribute::OrSymbol - ).void - end - attr_writer :attribute + sig { returns(Lithic::AuthRules::ConditionalAttribute::OrSymbol) } + attr_accessor :attribute # The operation to apply to the attribute - sig do - returns( - T.nilable(Lithic::AuthRules::AuthRuleCondition::Operation::OrSymbol) - ) - end - attr_reader :operation - - sig do - params( - operation: Lithic::AuthRules::AuthRuleCondition::Operation::OrSymbol - ).void - end - attr_writer :operation + sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) } + attr_accessor :operation # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - sig do - returns( - T.nilable(Lithic::AuthRules::AuthRuleCondition::Value::Variants) - ) - end - attr_reader :value - - sig do - params( - value: Lithic::AuthRules::AuthRuleCondition::Value::Variants - ).void - end - attr_writer :value + sig { returns(Lithic::AuthRules::ConditionalValue::Variants) } + attr_accessor :value sig do params( attribute: Lithic::AuthRules::ConditionalAttribute::OrSymbol, - operation: - Lithic::AuthRules::AuthRuleCondition::Operation::OrSymbol, - value: Lithic::AuthRules::AuthRuleCondition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants ).returns(T.attached_class) end def self.new( @@ -165,11 +133,11 @@ module Lithic # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. - attribute: nil, + attribute:, # The operation to apply to the attribute - operation: nil, + operation:, # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - value: nil + value: ) end @@ -177,107 +145,13 @@ module Lithic override.returns( { attribute: Lithic::AuthRules::ConditionalAttribute::OrSymbol, - operation: - Lithic::AuthRules::AuthRuleCondition::Operation::OrSymbol, - value: Lithic::AuthRules::AuthRuleCondition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants } ) end def to_hash end - - # The operation to apply to the attribute - module Operation - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::AuthRules::AuthRuleCondition::Operation) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IS_ONE_OF = - T.let( - :IS_ONE_OF, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_NOT_ONE_OF = - T.let( - :IS_NOT_ONE_OF, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - MATCHES = - T.let( - :MATCHES, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - DOES_NOT_MATCH = - T.let( - :DOES_NOT_MATCH, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_EQUAL_TO = - T.let( - :IS_EQUAL_TO, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_NOT_EQUAL_TO = - T.let( - :IS_NOT_EQUAL_TO, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_GREATER_THAN = - T.let( - :IS_GREATER_THAN, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_GREATER_THAN_OR_EQUAL_TO = - T.let( - :IS_GREATER_THAN_OR_EQUAL_TO, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_LESS_THAN = - T.let( - :IS_LESS_THAN, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - IS_LESS_THAN_OR_EQUAL_TO = - T.let( - :IS_LESS_THAN_OR_EQUAL_TO, - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::AuthRules::AuthRuleCondition::Operation::TaggedSymbol - ] - ) - end - def self.values - end - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - module Value - extend Lithic::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Integer, T::Array[String]) } - - sig do - override.returns( - T::Array[Lithic::AuthRules::AuthRuleCondition::Value::Variants] - ) - end - def self.variants - end - - StringArray = - T.let( - Lithic::Internal::Type::ArrayOf[String], - Lithic::Internal::Type::Converter - ) - end end end end diff --git a/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi b/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi index d2c78f38..21567e53 100644 --- a/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi +++ b/rbi/lithic/models/auth_rules/conditional_3ds_action_parameters.rbi @@ -131,65 +131,25 @@ module Lithic # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. sig do returns( - T.nilable( - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol - ) + Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol ) end - attr_reader :attribute - - sig do - params( - attribute: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol - ).void - end - attr_writer :attribute + attr_accessor :attribute # The operation to apply to the attribute - sig do - returns( - T.nilable( - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol - ) - ) - end - attr_reader :operation - - sig do - params( - operation: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol - ).void - end - attr_writer :operation + sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) } + attr_accessor :operation # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - sig do - returns( - T.nilable( - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants - ) - ) - end - attr_reader :value - - sig do - params( - value: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants - ).void - end - attr_writer :value + sig { returns(Lithic::AuthRules::ConditionalValue::Variants) } + attr_accessor :value sig do params( attribute: Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol, - operation: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol, - value: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants ).returns(T.attached_class) end def self.new( @@ -217,11 +177,11 @@ module Lithic # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. - attribute: nil, + attribute:, # The operation to apply to the attribute - operation: nil, + operation:, # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - value: nil + value: ) end @@ -230,10 +190,8 @@ module Lithic { attribute: Lithic::AuthRules::Conditional3DSActionParameters::Condition::Attribute::OrSymbol, - operation: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::OrSymbol, - value: - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants } ) end @@ -332,104 +290,6 @@ module Lithic def self.values end end - - # The operation to apply to the attribute - module Operation - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IS_ONE_OF = - T.let( - :IS_ONE_OF, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_NOT_ONE_OF = - T.let( - :IS_NOT_ONE_OF, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - MATCHES = - T.let( - :MATCHES, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - DOES_NOT_MATCH = - T.let( - :DOES_NOT_MATCH, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_EQUAL_TO = - T.let( - :IS_EQUAL_TO, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_NOT_EQUAL_TO = - T.let( - :IS_NOT_EQUAL_TO, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_GREATER_THAN = - T.let( - :IS_GREATER_THAN, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_GREATER_THAN_OR_EQUAL_TO = - T.let( - :IS_GREATER_THAN_OR_EQUAL_TO, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_LESS_THAN = - T.let( - :IS_LESS_THAN, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - IS_LESS_THAN_OR_EQUAL_TO = - T.let( - :IS_LESS_THAN_OR_EQUAL_TO, - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Operation::TaggedSymbol - ] - ) - end - def self.values - end - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - module Value - extend Lithic::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Integer, T::Array[String]) } - - sig do - override.returns( - T::Array[ - Lithic::AuthRules::Conditional3DSActionParameters::Condition::Value::Variants - ] - ) - end - def self.variants - end - - StringArray = - T.let( - Lithic::Internal::Type::ArrayOf[String], - Lithic::Internal::Type::Converter - ) - end end end end diff --git a/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi b/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi new file mode 100644 index 00000000..1f4cebe2 --- /dev/null +++ b/rbi/lithic/models/auth_rules/conditional_ach_action_parameters.rbi @@ -0,0 +1,789 @@ +# typed: strong + +module Lithic + module Models + module AuthRules + class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::Internal::AnyHash + ) + end + + # The action to take if the conditions are met + sig do + returns( + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction + ) + ) + end + attr_accessor :action + + sig do + returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Condition + ] + ) + end + attr_accessor :conditions + + sig do + params( + action: + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::OrHash + ), + conditions: + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Condition::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # The action to take if the conditions are met + action:, + conditions: + ) + end + + sig do + override.returns( + { + action: + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction + ), + conditions: + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Condition + ] + } + ) + end + def to_hash + end + + # The action to take if the conditions are met + module Action + extend Lithic::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction + ) + end + + class ApproveAction < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction, + Lithic::Internal::AnyHash + ) + end + + # Approve the ACH transaction + sig do + returns( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + type: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Approve the ACH transaction + type: + ) + end + + sig do + override.returns( + { + type: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type::OrSymbol + } + ) + end + def to_hash + end + + # Approve the ACH transaction + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + APPROVE = + T.let( + :APPROVE, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class ReturnAction < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction, + Lithic::Internal::AnyHash + ) + end + + # NACHA return code to use when returning the transaction. Note that the list of + # available return codes is subject to an allowlist configured at the program + # level + sig do + returns( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::OrSymbol + ) + end + attr_accessor :code + + # Return the ACH transaction + sig do + returns( + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type::OrSymbol + ) + end + attr_accessor :type + + sig do + params( + code: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::OrSymbol, + type: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # NACHA return code to use when returning the transaction. Note that the list of + # available return codes is subject to an allowlist configured at the program + # level + code:, + # Return the ACH transaction + type: + ) + end + + sig do + override.returns( + { + code: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::OrSymbol, + type: + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type::OrSymbol + } + ) + end + def to_hash + end + + # NACHA return code to use when returning the transaction. Note that the list of + # available return codes is subject to an allowlist configured at the program + # level + module Code + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + R01 = + T.let( + :R01, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R02 = + T.let( + :R02, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R03 = + T.let( + :R03, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R04 = + T.let( + :R04, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R05 = + T.let( + :R05, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R06 = + T.let( + :R06, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R07 = + T.let( + :R07, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R08 = + T.let( + :R08, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R09 = + T.let( + :R09, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R10 = + T.let( + :R10, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R11 = + T.let( + :R11, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R12 = + T.let( + :R12, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R13 = + T.let( + :R13, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R14 = + T.let( + :R14, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R15 = + T.let( + :R15, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R16 = + T.let( + :R16, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R17 = + T.let( + :R17, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R18 = + T.let( + :R18, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R19 = + T.let( + :R19, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R20 = + T.let( + :R20, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R21 = + T.let( + :R21, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R22 = + T.let( + :R22, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R23 = + T.let( + :R23, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R24 = + T.let( + :R24, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R25 = + T.let( + :R25, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R26 = + T.let( + :R26, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R27 = + T.let( + :R27, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R28 = + T.let( + :R28, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R29 = + T.let( + :R29, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R30 = + T.let( + :R30, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R31 = + T.let( + :R31, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R32 = + T.let( + :R32, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R33 = + T.let( + :R33, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R34 = + T.let( + :R34, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R35 = + T.let( + :R35, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R36 = + T.let( + :R36, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R37 = + T.let( + :R37, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R38 = + T.let( + :R38, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R39 = + T.let( + :R39, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R40 = + T.let( + :R40, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R41 = + T.let( + :R41, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R42 = + T.let( + :R42, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R43 = + T.let( + :R43, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R44 = + T.let( + :R44, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R45 = + T.let( + :R45, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R46 = + T.let( + :R46, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R47 = + T.let( + :R47, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R50 = + T.let( + :R50, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R51 = + T.let( + :R51, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R52 = + T.let( + :R52, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R53 = + T.let( + :R53, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R61 = + T.let( + :R61, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R62 = + T.let( + :R62, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R67 = + T.let( + :R67, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R68 = + T.let( + :R68, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R69 = + T.let( + :R69, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R70 = + T.let( + :R70, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R71 = + T.let( + :R71, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R72 = + T.let( + :R72, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R73 = + T.let( + :R73, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R74 = + T.let( + :R74, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R75 = + T.let( + :R75, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R76 = + T.let( + :R76, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R77 = + T.let( + :R77, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R80 = + T.let( + :R80, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R81 = + T.let( + :R81, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R82 = + T.let( + :R82, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R83 = + T.let( + :R83, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R84 = + T.let( + :R84, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + R85 = + T.let( + :R85, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Code::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Return the ACH transaction + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + RETURN = + T.let( + :RETURN, + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Action::Variants + ] + ) + end + def self.variants + end + end + + class Condition < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalACHActionParameters::Condition, + Lithic::Internal::AnyHash + ) + end + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `COMPANY_NAME`: The name of the company initiating the ACH transaction. + # - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company + # ID) of the entity initiating the ACH transaction. + # - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format. + # - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units + # (cents). + # - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. + # Valid values include PPD (Prearranged Payment and Deposit Entry), CCD + # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL + # (Telephone-Initiated Entry), and others. + # - `MEMO`: Optional memo or description field included with the ACH transaction. + sig do + returns( + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::OrSymbol + ) + end + attr_accessor :attribute + + # The operation to apply to the attribute + sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) } + attr_accessor :operation + + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + sig { returns(Lithic::AuthRules::ConditionalValue::Variants) } + attr_accessor :value + + sig do + params( + attribute: + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::OrSymbol, + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants + ).returns(T.attached_class) + end + def self.new( + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `COMPANY_NAME`: The name of the company initiating the ACH transaction. + # - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company + # ID) of the entity initiating the ACH transaction. + # - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format. + # - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units + # (cents). + # - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. + # Valid values include PPD (Prearranged Payment and Deposit Entry), CCD + # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL + # (Telephone-Initiated Entry), and others. + # - `MEMO`: Optional memo or description field included with the ACH transaction. + attribute:, + # The operation to apply to the attribute + operation:, + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + value: + ) + end + + sig do + override.returns( + { + attribute: + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::OrSymbol, + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants + } + ) + end + def to_hash + end + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `COMPANY_NAME`: The name of the company initiating the ACH transaction. + # - `COMPANY_ID`: The company ID (also known as Standard Entry Class (SEC) Company + # ID) of the entity initiating the ACH transaction. + # - `TIMESTAMP`: The timestamp of the ACH transaction in ISO 8601 format. + # - `TRANSACTION_AMOUNT`: The amount of the ACH transaction in minor units + # (cents). + # - `SEC_CODE`: Standard Entry Class code indicating the type of ACH transaction. + # Valid values include PPD (Prearranged Payment and Deposit Entry), CCD + # (Corporate Credit or Debit Entry), WEB (Internet-Initiated/Mobile Entry), TEL + # (Telephone-Initiated Entry), and others. + # - `MEMO`: Optional memo or description field included with the ACH transaction. + module Attribute + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + COMPANY_NAME = + T.let( + :COMPANY_NAME, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + COMPANY_ID = + T.let( + :COMPANY_ID, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + TIMESTAMP = + T.let( + :TIMESTAMP, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + TRANSACTION_AMOUNT = + T.let( + :TRANSACTION_AMOUNT, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + SEC_CODE = + T.let( + :SEC_CODE, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + MEMO = + T.let( + :MEMO, + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalACHActionParameters::Condition::Attribute::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + end +end diff --git a/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi b/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi index 167a45b2..1ff8142c 100644 --- a/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi +++ b/rbi/lithic/models/auth_rules/conditional_authorization_action_parameters.rbi @@ -161,65 +161,25 @@ module Lithic # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. sig do returns( - T.nilable( - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol - ) + Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol ) end - attr_reader :attribute - - sig do - params( - attribute: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol - ).void - end - attr_writer :attribute + attr_accessor :attribute # The operation to apply to the attribute - sig do - returns( - T.nilable( - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::OrSymbol - ) - ) - end - attr_reader :operation - - sig do - params( - operation: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::OrSymbol - ).void - end - attr_writer :operation + sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) } + attr_accessor :operation # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - sig do - returns( - T.nilable( - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::Variants - ) - ) - end - attr_reader :value - - sig do - params( - value: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::Variants - ).void - end - attr_writer :value + sig { returns(Lithic::AuthRules::ConditionalValue::Variants) } + attr_accessor :value sig do params( attribute: Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol, - operation: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::OrSymbol, - value: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants ).returns(T.attached_class) end def self.new( @@ -277,11 +237,11 @@ module Lithic # - `ADDRESS_MATCH`: Lithic's evaluation result comparing transaction's address # data with the cardholder KYC data if it exists. Valid values are `MATCH`, # `MATCH_ADDRESS_ONLY`, `MATCH_ZIP_ONLY`,`MISMATCH`,`NOT_PRESENT`. - attribute: nil, + attribute:, # The operation to apply to the attribute - operation: nil, + operation:, # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - value: nil + value: ) end @@ -290,10 +250,8 @@ module Lithic { attribute: Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Attribute::OrSymbol, - operation: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::OrSymbol, - value: - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::Variants + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants } ) end @@ -472,104 +430,6 @@ module Lithic def self.values end end - - # The operation to apply to the attribute - module Operation - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - IS_ONE_OF = - T.let( - :IS_ONE_OF, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_NOT_ONE_OF = - T.let( - :IS_NOT_ONE_OF, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - MATCHES = - T.let( - :MATCHES, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - DOES_NOT_MATCH = - T.let( - :DOES_NOT_MATCH, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_EQUAL_TO = - T.let( - :IS_EQUAL_TO, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_NOT_EQUAL_TO = - T.let( - :IS_NOT_EQUAL_TO, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_GREATER_THAN = - T.let( - :IS_GREATER_THAN, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_GREATER_THAN_OR_EQUAL_TO = - T.let( - :IS_GREATER_THAN_OR_EQUAL_TO, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_LESS_THAN = - T.let( - :IS_LESS_THAN, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - IS_LESS_THAN_OR_EQUAL_TO = - T.let( - :IS_LESS_THAN_OR_EQUAL_TO, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Operation::TaggedSymbol - ] - ) - end - def self.values - end - end - - # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` - module Value - extend Lithic::Internal::Type::Union - - Variants = T.type_alias { T.any(String, Integer, T::Array[String]) } - - sig do - override.returns( - T::Array[ - Lithic::AuthRules::ConditionalAuthorizationActionParameters::Condition::Value::Variants - ] - ) - end - def self.variants - end - - StringArray = - T.let( - Lithic::Internal::Type::ArrayOf[String], - Lithic::Internal::Type::Converter - ) - end end end end diff --git a/rbi/lithic/models/auth_rules/conditional_operation.rbi b/rbi/lithic/models/auth_rules/conditional_operation.rbi new file mode 100644 index 00000000..a35f79a1 --- /dev/null +++ b/rbi/lithic/models/auth_rules/conditional_operation.rbi @@ -0,0 +1,74 @@ +# typed: strong + +module Lithic + module Models + module AuthRules + # The operation to apply to the attribute + module ConditionalOperation + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Lithic::AuthRules::ConditionalOperation) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + IS_ONE_OF = + T.let( + :IS_ONE_OF, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_NOT_ONE_OF = + T.let( + :IS_NOT_ONE_OF, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + MATCHES = + T.let(:MATCHES, Lithic::AuthRules::ConditionalOperation::TaggedSymbol) + DOES_NOT_MATCH = + T.let( + :DOES_NOT_MATCH, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_EQUAL_TO = + T.let( + :IS_EQUAL_TO, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_NOT_EQUAL_TO = + T.let( + :IS_NOT_EQUAL_TO, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_GREATER_THAN = + T.let( + :IS_GREATER_THAN, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_GREATER_THAN_OR_EQUAL_TO = + T.let( + :IS_GREATER_THAN_OR_EQUAL_TO, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_LESS_THAN = + T.let( + :IS_LESS_THAN, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + IS_LESS_THAN_OR_EQUAL_TO = + T.let( + :IS_LESS_THAN_OR_EQUAL_TO, + Lithic::AuthRules::ConditionalOperation::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Lithic::AuthRules::ConditionalOperation::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi b/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi new file mode 100644 index 00000000..034fbefb --- /dev/null +++ b/rbi/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbi @@ -0,0 +1,674 @@ +# typed: strong + +module Lithic + module Models + module AuthRules + class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters, + Lithic::Internal::AnyHash + ) + end + + # The action to take if the conditions are met + sig do + returns( + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction + ) + ) + end + attr_accessor :action + + sig do + returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition + ] + ) + end + attr_accessor :conditions + + sig do + params( + action: + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::OrHash + ), + conditions: + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::OrHash + ] + ).returns(T.attached_class) + end + def self.new( + # The action to take if the conditions are met + action:, + conditions: + ) + end + + sig do + override.returns( + { + action: + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction + ), + conditions: + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition + ] + } + ) + end + def to_hash + end + + # The action to take if the conditions are met + module Action + extend Lithic::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction + ) + end + + class DeclineAction < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction, + Lithic::Internal::AnyHash + ) + end + + # Decline the tokenization request + sig do + returns( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type::OrSymbol + ) + end + attr_accessor :type + + # Reason code for declining the tokenization request + sig do + returns( + T.nilable( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::OrSymbol + ) + ) + end + attr_reader :reason + + sig do + params( + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::OrSymbol + ).void + end + attr_writer :reason + + sig do + params( + type: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type::OrSymbol, + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Decline the tokenization request + type:, + # Reason code for declining the tokenization request + reason: nil + ) + end + + sig do + override.returns( + { + type: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type::OrSymbol, + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::OrSymbol + } + ) + end + def to_hash + end + + # Decline the tokenization request + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + DECLINE = + T.let( + :DECLINE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Reason code for declining the tokenization request + module Reason + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ACCOUNT_SCORE_1 = + T.let( + :ACCOUNT_SCORE_1, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + DEVICE_SCORE_1 = + T.let( + :DEVICE_SCORE_1, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + ALL_WALLET_DECLINE_REASONS_PRESENT = + T.let( + :ALL_WALLET_DECLINE_REASONS_PRESENT, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + WALLET_RECOMMENDED_DECISION_RED = + T.let( + :WALLET_RECOMMENDED_DECISION_RED, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + CVC_MISMATCH = + T.let( + :CVC_MISMATCH, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + CARD_EXPIRY_MONTH_MISMATCH = + T.let( + :CARD_EXPIRY_MONTH_MISMATCH, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + CARD_EXPIRY_YEAR_MISMATCH = + T.let( + :CARD_EXPIRY_YEAR_MISMATCH, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + CARD_INVALID_STATE = + T.let( + :CARD_INVALID_STATE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + CUSTOMER_RED_PATH = + T.let( + :CUSTOMER_RED_PATH, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + INVALID_CUSTOMER_RESPONSE = + T.let( + :INVALID_CUSTOMER_RESPONSE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + NETWORK_FAILURE = + T.let( + :NETWORK_FAILURE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + GENERIC_DECLINE = + T.let( + :GENERIC_DECLINE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + DIGITAL_CARD_ART_REQUIRED = + T.let( + :DIGITAL_CARD_ART_REQUIRED, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::Reason::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class RequireTfaAction < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction, + Lithic::Internal::AnyHash + ) + end + + # Require two-factor authentication for the tokenization request + sig do + returns( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type::OrSymbol + ) + end + attr_accessor :type + + # Reason code for requiring two-factor authentication + sig do + returns( + T.nilable( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::OrSymbol + ) + ) + end + attr_reader :reason + + sig do + params( + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::OrSymbol + ).void + end + attr_writer :reason + + sig do + params( + type: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type::OrSymbol, + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Require two-factor authentication for the tokenization request + type:, + # Reason code for requiring two-factor authentication + reason: nil + ) + end + + sig do + override.returns( + { + type: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type::OrSymbol, + reason: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::OrSymbol + } + ) + end + def to_hash + end + + # Require two-factor authentication for the tokenization request + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + REQUIRE_TFA = + T.let( + :REQUIRE_TFA, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Reason code for requiring two-factor authentication + module Reason + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WALLET_RECOMMENDED_TFA = + T.let( + :WALLET_RECOMMENDED_TFA, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + SUSPICIOUS_ACTIVITY = + T.let( + :SUSPICIOUS_ACTIVITY, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + DEVICE_RECENTLY_LOST = + T.let( + :DEVICE_RECENTLY_LOST, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + TOO_MANY_RECENT_ATTEMPTS = + T.let( + :TOO_MANY_RECENT_ATTEMPTS, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + TOO_MANY_RECENT_TOKENS = + T.let( + :TOO_MANY_RECENT_TOKENS, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + TOO_MANY_DIFFERENT_CARDHOLDERS = + T.let( + :TOO_MANY_DIFFERENT_CARDHOLDERS, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + OUTSIDE_HOME_TERRITORY = + T.let( + :OUTSIDE_HOME_TERRITORY, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + HAS_SUSPENDED_TOKENS = + T.let( + :HAS_SUSPENDED_TOKENS, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + HIGH_RISK = + T.let( + :HIGH_RISK, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + ACCOUNT_SCORE_LOW = + T.let( + :ACCOUNT_SCORE_LOW, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + DEVICE_SCORE_LOW = + T.let( + :DEVICE_SCORE_LOW, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + CARD_STATE_TFA = + T.let( + :CARD_STATE_TFA, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + HARDCODED_TFA = + T.let( + :HARDCODED_TFA, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + CUSTOMER_RULE_TFA = + T.let( + :CUSTOMER_RULE_TFA, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + DEVICE_HOST_CARD_EMULATION = + T.let( + :DEVICE_HOST_CARD_EMULATION, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::Reason::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::Variants + ] + ) + end + def self.variants + end + end + + class Condition < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition, + Lithic::Internal::AnyHash + ) + end + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format. + # - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was + # initiated (e.g., DIGITAL_WALLET, ECOMMERCE). + # - `TOKENIZATION_SOURCE`: The source of the tokenization request. + # - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid + # values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, + # `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, + # `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, + # `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`. + # - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet + # provider. Valid values include APPROVE, DECLINE, + # REQUIRE_ADDITIONAL_AUTHENTICATION. + # - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token. + # - `WALLET_TOKEN_STATUS`: The current status of the wallet token. + sig do + returns( + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::OrSymbol + ) + end + attr_accessor :attribute + + # The operation to apply to the attribute + sig { returns(Lithic::AuthRules::ConditionalOperation::OrSymbol) } + attr_accessor :operation + + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + sig { returns(Lithic::AuthRules::ConditionalValue::Variants) } + attr_accessor :value + + sig do + params( + attribute: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::OrSymbol, + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants + ).returns(T.attached_class) + end + def self.new( + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format. + # - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was + # initiated (e.g., DIGITAL_WALLET, ECOMMERCE). + # - `TOKENIZATION_SOURCE`: The source of the tokenization request. + # - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid + # values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, + # `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, + # `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, + # `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`. + # - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet + # provider. Valid values include APPROVE, DECLINE, + # REQUIRE_ADDITIONAL_AUTHENTICATION. + # - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token. + # - `WALLET_TOKEN_STATUS`: The current status of the wallet token. + attribute:, + # The operation to apply to the attribute + operation:, + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + value: + ) + end + + sig do + override.returns( + { + attribute: + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::OrSymbol, + operation: Lithic::AuthRules::ConditionalOperation::OrSymbol, + value: Lithic::AuthRules::ConditionalValue::Variants + } + ) + end + def to_hash + end + + # The attribute to target. + # + # The following attributes may be targeted: + # + # - `TIMESTAMP`: The timestamp of the tokenization request in ISO 8601 format. + # - `TOKENIZATION_CHANNEL`: The channel through which the tokenization request was + # initiated (e.g., DIGITAL_WALLET, ECOMMERCE). + # - `TOKENIZATION_SOURCE`: The source of the tokenization request. + # - `TOKEN_REQUESTOR_NAME`: The name of the entity requesting the token. Valid + # values are `ALT_ID`, `AMAZON_ONE`, `AMERICAN_EXPRESS_TOKEN_SERVICE`, + # `ANDROID_PAY`, `APPLE_PAY`, `FACEBOOK`, `FITBIT_PAY`, `GARMIN_PAY`, + # `GOOGLE_PAY`, `GOOGLE_VCN`, `ISSUER_HCE`, `MICROSOFT_PAY`, `NETFLIX`, + # `SAMSUNG_PAY`, `UNKNOWN`, `VISA_CHECKOUT`. + # - `WALLET_ACCOUNT_SCORE`: Risk score for the account in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_DEVICE_SCORE`: Risk score for the device in the digital wallet. + # Numeric value where lower numbers indicate higher risk (e.g., 1 = high risk, 2 + # = medium risk). + # - `WALLET_RECOMMENDED_DECISION`: The decision recommended by the digital wallet + # provider. Valid values include APPROVE, DECLINE, + # REQUIRE_ADDITIONAL_AUTHENTICATION. + # - `TOKEN_REQUESTOR_ID`: Unique identifier for the entity requesting the token. + # - `WALLET_TOKEN_STATUS`: The current status of the wallet token. + module Attribute + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + TIMESTAMP = + T.let( + :TIMESTAMP, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + TOKENIZATION_CHANNEL = + T.let( + :TOKENIZATION_CHANNEL, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + TOKENIZATION_SOURCE = + T.let( + :TOKENIZATION_SOURCE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + TOKEN_REQUESTOR_NAME = + T.let( + :TOKEN_REQUESTOR_NAME, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + WALLET_ACCOUNT_SCORE = + T.let( + :WALLET_ACCOUNT_SCORE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + WALLET_DEVICE_SCORE = + T.let( + :WALLET_DEVICE_SCORE, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + WALLET_RECOMMENDED_DECISION = + T.let( + :WALLET_RECOMMENDED_DECISION, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + TOKEN_REQUESTOR_ID = + T.let( + :TOKEN_REQUESTOR_ID, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + WALLET_TOKEN_STATUS = + T.let( + :WALLET_TOKEN_STATUS, + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition::Attribute::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end + end +end diff --git a/rbi/lithic/models/auth_rules/conditional_value.rbi b/rbi/lithic/models/auth_rules/conditional_value.rbi new file mode 100644 index 00000000..a49ab9c5 --- /dev/null +++ b/rbi/lithic/models/auth_rules/conditional_value.rbi @@ -0,0 +1,28 @@ +# typed: strong + +module Lithic + module Models + module AuthRules + # A regex string, to be used with `MATCHES` or `DOES_NOT_MATCH` + module ConditionalValue + extend Lithic::Internal::Type::Union + + Variants = T.type_alias { T.any(String, Integer, T::Array[String]) } + + sig do + override.returns( + T::Array[Lithic::AuthRules::ConditionalValue::Variants] + ) + end + def self.variants + end + + StringArray = + T.let( + Lithic::Internal::Type::ArrayOf[String], + Lithic::Internal::Type::Converter + ) + end + end + end +end diff --git a/rbi/lithic/models/auth_rules/v2_create_params.rbi b/rbi/lithic/models/auth_rules/v2_create_params.rbi index ec17fa50..d8f8147c 100644 --- a/rbi/lithic/models/auth_rules/v2_create_params.rbi +++ b/rbi/lithic/models/auth_rules/v2_create_params.rbi @@ -20,7 +20,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) ) end @@ -34,7 +36,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig { returns(Lithic::AuthRules::V2CreateParams::Type::OrSymbol) } attr_accessor :type @@ -95,7 +98,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), type: Lithic::AuthRules::V2CreateParams::Type::OrSymbol, card_tokens: T::Array[String], @@ -120,7 +125,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule applies. card_tokens:, @@ -149,7 +155,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ), type: Lithic::AuthRules::V2CreateParams::Type::OrSymbol, account_tokens: T::Array[String], @@ -178,7 +186,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -199,7 +209,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum @@ -259,6 +270,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::AuthRules::V2CreateParams::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::AuthRules::V2CreateParams::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::AuthRules::V2CreateParams::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::AuthRules::V2CreateParams::EventStream::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/lithic/models/auth_rules/v2_create_response.rbi b/rbi/lithic/models/auth_rules/v2_create_response.rbi index 53e94ee2..13ddfb69 100644 --- a/rbi/lithic/models/auth_rules/v2_create_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_create_response.rbi @@ -101,7 +101,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns( Lithic::Models::AuthRules::V2CreateResponse::Type::TaggedSymbol @@ -170,7 +171,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -238,7 +240,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -275,7 +279,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -321,7 +327,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -358,7 +366,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -397,6 +407,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2CreateResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2CreateResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2CreateResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2CreateResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -449,7 +474,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/auth_rules/v2_draft_params.rbi b/rbi/lithic/models/auth_rules/v2_draft_params.rbi index a111e43f..5c0ee652 100644 --- a/rbi/lithic/models/auth_rules/v2_draft_params.rbi +++ b/rbi/lithic/models/auth_rules/v2_draft_params.rbi @@ -21,7 +21,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) ) ) @@ -37,7 +39,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ) ), request_options: Lithic::RequestOptions::OrHash @@ -60,7 +64,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) ), request_options: Lithic::RequestOptions @@ -81,7 +87,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end diff --git a/rbi/lithic/models/auth_rules/v2_draft_response.rbi b/rbi/lithic/models/auth_rules/v2_draft_response.rbi index 416386ad..e934a2c8 100644 --- a/rbi/lithic/models/auth_rules/v2_draft_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_draft_response.rbi @@ -101,7 +101,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns( Lithic::Models::AuthRules::V2DraftResponse::Type::TaggedSymbol @@ -170,7 +171,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -238,7 +240,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -275,7 +279,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -321,7 +327,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -358,7 +366,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -397,6 +407,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2DraftResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2DraftResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2DraftResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2DraftResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -449,7 +474,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/auth_rules/v2_list_params.rbi b/rbi/lithic/models/auth_rules/v2_list_params.rbi index a53758a4..a3bebcf9 100644 --- a/rbi/lithic/models/auth_rules/v2_list_params.rbi +++ b/rbi/lithic/models/auth_rules/v2_list_params.rbi @@ -158,6 +158,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::AuthRules::V2ListParams::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::AuthRules::V2ListParams::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::AuthRules::V2ListParams::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::AuthRules::V2ListParams::EventStream::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/lithic/models/auth_rules/v2_list_response.rbi b/rbi/lithic/models/auth_rules/v2_list_response.rbi index 08cfee5e..c4f33a8c 100644 --- a/rbi/lithic/models/auth_rules/v2_list_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_list_response.rbi @@ -99,7 +99,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns(Lithic::Models::AuthRules::V2ListResponse::Type::TaggedSymbol) end @@ -166,7 +167,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -234,7 +236,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -271,7 +275,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -317,7 +323,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -354,7 +362,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -393,6 +403,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2ListResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2ListResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2ListResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2ListResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -445,7 +470,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/auth_rules/v2_promote_response.rbi b/rbi/lithic/models/auth_rules/v2_promote_response.rbi index 4889561f..00de0ae5 100644 --- a/rbi/lithic/models/auth_rules/v2_promote_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_promote_response.rbi @@ -103,7 +103,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns( Lithic::Models::AuthRules::V2PromoteResponse::Type::TaggedSymbol @@ -173,7 +174,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -241,7 +243,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -278,7 +282,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -324,7 +330,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -361,7 +369,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -400,6 +410,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2PromoteResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2PromoteResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2PromoteResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2PromoteResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -452,7 +477,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi b/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi index 567f674b..efefdafa 100644 --- a/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_retrieve_response.rbi @@ -103,7 +103,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns( Lithic::Models::AuthRules::V2RetrieveResponse::Type::TaggedSymbol @@ -173,7 +174,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -241,7 +243,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -278,7 +282,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -324,7 +330,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -361,7 +369,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -400,6 +410,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2RetrieveResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2RetrieveResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2RetrieveResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2RetrieveResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -455,7 +480,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/auth_rules/v2_update_response.rbi b/rbi/lithic/models/auth_rules/v2_update_response.rbi index 17243f47..355cac98 100644 --- a/rbi/lithic/models/auth_rules/v2_update_response.rbi +++ b/rbi/lithic/models/auth_rules/v2_update_response.rbi @@ -101,7 +101,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. sig do returns( Lithic::Models::AuthRules::V2UpdateResponse::Type::TaggedSymbol @@ -170,7 +171,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule does not apply. excluded_card_tokens: nil @@ -238,7 +240,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -275,7 +279,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -321,7 +327,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), version: Integer ).returns(T.attached_class) @@ -358,7 +366,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams, Lithic::AuthRules::MerchantLockParameters, Lithic::AuthRules::Conditional3DSActionParameters, - Lithic::AuthRules::ConditionalAuthorizationActionParameters + Lithic::AuthRules::ConditionalAuthorizationActionParameters, + Lithic::AuthRules::ConditionalACHActionParameters, + Lithic::AuthRules::ConditionalTokenizationActionParameters ) end @@ -397,6 +407,21 @@ module Lithic :THREE_DS_AUTHENTICATION, Lithic::Models::AuthRules::V2UpdateResponse::EventStream::TaggedSymbol ) + TOKENIZATION = + T.let( + :TOKENIZATION, + Lithic::Models::AuthRules::V2UpdateResponse::EventStream::TaggedSymbol + ) + ACH_CREDIT_RECEIPT = + T.let( + :ACH_CREDIT_RECEIPT, + Lithic::Models::AuthRules::V2UpdateResponse::EventStream::TaggedSymbol + ) + ACH_DEBIT_RECEIPT = + T.let( + :ACH_DEBIT_RECEIPT, + Lithic::Models::AuthRules::V2UpdateResponse::EventStream::TaggedSymbol + ) sig do override.returns( @@ -449,7 +474,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. module Type extend Lithic::Internal::Type::Enum diff --git a/rbi/lithic/models/book_transfer_response.rbi b/rbi/lithic/models/book_transfer_response.rbi index 2ad7b838..a5115590 100644 --- a/rbi/lithic/models/book_transfer_response.rbi +++ b/rbi/lithic/models/book_transfer_response.rbi @@ -637,6 +637,8 @@ module Lithic T.let(:REVERSED, Lithic::BookTransferResponse::Status::TaggedSymbol) CANCELED = T.let(:CANCELED, Lithic::BookTransferResponse::Status::TaggedSymbol) + RETURNED = + T.let(:RETURNED, Lithic::BookTransferResponse::Status::TaggedSymbol) sig do override.returns( diff --git a/rbi/lithic/models/category_details.rbi b/rbi/lithic/models/category_details.rbi new file mode 100644 index 00000000..599317f4 --- /dev/null +++ b/rbi/lithic/models/category_details.rbi @@ -0,0 +1,43 @@ +# typed: strong + +module Lithic + module Models + class CategoryDetails < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Lithic::CategoryDetails, Lithic::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :balance_transfers + + sig { returns(String) } + attr_accessor :cash_advances + + sig { returns(String) } + attr_accessor :purchases + + sig do + params( + balance_transfers: String, + cash_advances: String, + purchases: String + ).returns(T.attached_class) + end + def self.new(balance_transfers:, cash_advances:, purchases:) + end + + sig do + override.returns( + { + balance_transfers: String, + cash_advances: String, + purchases: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/dispute.rbi b/rbi/lithic/models/dispute.rbi index d3a97c46..dc0265fb 100644 --- a/rbi/lithic/models/dispute.rbi +++ b/rbi/lithic/models/dispute.rbi @@ -6,129 +6,237 @@ module Lithic OrHash = T.type_alias { T.any(Lithic::Dispute, Lithic::Internal::AnyHash) } - # Token assigned by Lithic for the dispute, in UUID format. + # Globally unique identifier. sig { returns(String) } attr_accessor :token - # Token for the account associated with the dispute, in UUID format. - sig { returns(String) } - attr_accessor :account_token - - # Token for the card used in the dispute, in UUID format. - sig { returns(String) } - attr_accessor :card_token + # Amount under dispute. May be different from the original transaction amount. + sig { returns(Integer) } + attr_accessor :amount - # Identifier assigned by the network for this dispute. - sig { returns(T.nilable(String)) } - attr_accessor :case_id + # Date dispute entered arbitration. + sig { returns(T.nilable(Time)) } + attr_accessor :arbitration_date - # When the dispute was created. + # Timestamp of when first Dispute was reported. sig { returns(Time) } attr_accessor :created - # Three-letter ISO 4217 currency code. - sig { returns(String) } - attr_accessor :currency - - # Dispute resolution outcome - sig { returns(T.nilable(Lithic::Dispute::Disposition::OrSymbol)) } - attr_accessor :disposition - - # Chronological list of events that have occurred in the dispute lifecycle - sig { returns(T::Array[Lithic::Dispute::Event]) } - attr_accessor :events - - # Current breakdown of how liability is allocated for the disputed amount - sig { returns(Lithic::Dispute::LiabilityAllocation) } - attr_reader :liability_allocation - - sig do - params( - liability_allocation: Lithic::Dispute::LiabilityAllocation::OrHash - ).void - end - attr_writer :liability_allocation + # Date that the dispute was filed by the customer making the dispute. + sig { returns(T.nilable(Time)) } + attr_accessor :customer_filed_date - sig { returns(Lithic::Dispute::Merchant) } - attr_reader :merchant + # End customer description of the reason for the dispute. + sig { returns(T.nilable(String)) } + attr_accessor :customer_note - sig { params(merchant: Lithic::Dispute::Merchant::OrHash).void } - attr_writer :merchant + # Unique identifiers for the dispute from the network. + sig { returns(T.nilable(T::Array[String])) } + attr_accessor :network_claim_ids - # Card network handling the dispute. - sig { returns(Lithic::Dispute::Network::OrSymbol) } - attr_accessor :network + # Date that the dispute was submitted to the network. + sig { returns(T.nilable(Time)) } + attr_accessor :network_filed_date - # Current status of the dispute. - sig { returns(T.nilable(Lithic::Dispute::Status::OrSymbol)) } - attr_accessor :status + # Network reason code used to file the dispute. + sig { returns(T.nilable(String)) } + attr_accessor :network_reason_code - # Contains identifiers for the transaction and specific event within being - # disputed; null if no transaction can be identified - sig { returns(T.nilable(Lithic::Dispute::TransactionSeries)) } - attr_reader :transaction_series + # Date dispute entered pre-arbitration. + sig { returns(T.nilable(Time)) } + attr_accessor :prearbitration_date + # Unique identifier for the dispute from the network. If there are multiple, this + # will be the first claim id set by the network + sig { returns(T.nilable(String)) } + attr_accessor :primary_claim_id + + # Dispute reason: + # + # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. + # - `CANCELLED`: Transaction was cancelled by the customer. + # - `DUPLICATED`: The transaction was a duplicate. + # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. + # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. + # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable + # merchant activity. + # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as + # described. + # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. + # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. + # - `MISSING_AUTH`: The transaction was missing authorization. + # - `OTHER`: Other reason. + # - `PROCESSING_ERROR`: Processing error. + # - `REFUND_NOT_PROCESSED`: The refund was not processed. + # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not + # cancelled. + sig { returns(Lithic::Dispute::Reason::TaggedSymbol) } + attr_accessor :reason + + # Date the representment was received. + sig { returns(T.nilable(Time)) } + attr_accessor :representment_date + + # Date that the dispute was resolved. + sig { returns(T.nilable(Time)) } + attr_accessor :resolution_date + + # Note by Dispute team on the case resolution. + sig { returns(T.nilable(String)) } + attr_accessor :resolution_note + + # Reason for the dispute resolution: + # + # - `CASE_LOST`: This case was lost at final arbitration. + # - `NETWORK_REJECTED`: Network rejected. + # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. + # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. + # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. + # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. + # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. + # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. + # - `PAST_FILING_DATE`: Past filing date. + # - `PREARBITRATION_REJECTED`: Prearbitration rejected. + # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. + # - `REFUNDED`: Refunded. + # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. + # - `WITHDRAWN`: Withdrawn. + # - `WON_ARBITRATION`: Won arbitration. + # - `WON_FIRST_CHARGEBACK`: Won first chargeback. + # - `WON_PREARBITRATION`: Won prearbitration. sig do - params( - transaction_series: - T.nilable(Lithic::Dispute::TransactionSeries::OrHash) - ).void + returns(T.nilable(Lithic::Dispute::ResolutionReason::TaggedSymbol)) end - attr_writer :transaction_series + attr_accessor :resolution_reason + + # Status types: + # + # - `NEW` - New dispute case is opened. + # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more + # information. + # - `SUBMITTED` - Dispute is submitted to the card network. + # - `REPRESENTMENT` - Case has entered second presentment. + # - `PREARBITRATION` - Case has entered prearbitration. + # - `ARBITRATION` - Case has entered arbitration. + # - `CASE_WON` - Case was won and credit will be issued. + # - `CASE_CLOSED` - Case was lost or withdrawn. + sig { returns(Lithic::Dispute::Status::TaggedSymbol) } + attr_accessor :status - # When the dispute was last updated. - sig { returns(Time) } - attr_accessor :updated + # The transaction that is being disputed. A transaction can only be disputed once + # but may have multiple dispute cases. + sig { returns(String) } + attr_accessor :transaction_token - # The Dispute object tracks the progression of a dispute throughout its lifecycle. + # Dispute. sig do params( token: String, - account_token: String, - card_token: String, - case_id: T.nilable(String), + amount: Integer, + arbitration_date: T.nilable(Time), created: Time, - currency: String, - disposition: T.nilable(Lithic::Dispute::Disposition::OrSymbol), - events: T::Array[Lithic::Dispute::Event::OrHash], - liability_allocation: Lithic::Dispute::LiabilityAllocation::OrHash, - merchant: Lithic::Dispute::Merchant::OrHash, - network: Lithic::Dispute::Network::OrSymbol, - status: T.nilable(Lithic::Dispute::Status::OrSymbol), - transaction_series: - T.nilable(Lithic::Dispute::TransactionSeries::OrHash), - updated: Time + customer_filed_date: T.nilable(Time), + customer_note: T.nilable(String), + network_claim_ids: T.nilable(T::Array[String]), + network_filed_date: T.nilable(Time), + network_reason_code: T.nilable(String), + prearbitration_date: T.nilable(Time), + primary_claim_id: T.nilable(String), + reason: Lithic::Dispute::Reason::OrSymbol, + representment_date: T.nilable(Time), + resolution_date: T.nilable(Time), + resolution_note: T.nilable(String), + resolution_reason: + T.nilable(Lithic::Dispute::ResolutionReason::OrSymbol), + status: Lithic::Dispute::Status::OrSymbol, + transaction_token: String ).returns(T.attached_class) end def self.new( - # Token assigned by Lithic for the dispute, in UUID format. + # Globally unique identifier. token:, - # Token for the account associated with the dispute, in UUID format. - account_token:, - # Token for the card used in the dispute, in UUID format. - card_token:, - # Identifier assigned by the network for this dispute. - case_id:, - # When the dispute was created. + # Amount under dispute. May be different from the original transaction amount. + amount:, + # Date dispute entered arbitration. + arbitration_date:, + # Timestamp of when first Dispute was reported. created:, - # Three-letter ISO 4217 currency code. - currency:, - # Dispute resolution outcome - disposition:, - # Chronological list of events that have occurred in the dispute lifecycle - events:, - # Current breakdown of how liability is allocated for the disputed amount - liability_allocation:, - merchant:, - # Card network handling the dispute. - network:, - # Current status of the dispute. + # Date that the dispute was filed by the customer making the dispute. + customer_filed_date:, + # End customer description of the reason for the dispute. + customer_note:, + # Unique identifiers for the dispute from the network. + network_claim_ids:, + # Date that the dispute was submitted to the network. + network_filed_date:, + # Network reason code used to file the dispute. + network_reason_code:, + # Date dispute entered pre-arbitration. + prearbitration_date:, + # Unique identifier for the dispute from the network. If there are multiple, this + # will be the first claim id set by the network + primary_claim_id:, + # Dispute reason: + # + # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. + # - `CANCELLED`: Transaction was cancelled by the customer. + # - `DUPLICATED`: The transaction was a duplicate. + # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. + # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. + # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable + # merchant activity. + # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as + # described. + # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. + # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. + # - `MISSING_AUTH`: The transaction was missing authorization. + # - `OTHER`: Other reason. + # - `PROCESSING_ERROR`: Processing error. + # - `REFUND_NOT_PROCESSED`: The refund was not processed. + # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not + # cancelled. + reason:, + # Date the representment was received. + representment_date:, + # Date that the dispute was resolved. + resolution_date:, + # Note by Dispute team on the case resolution. + resolution_note:, + # Reason for the dispute resolution: + # + # - `CASE_LOST`: This case was lost at final arbitration. + # - `NETWORK_REJECTED`: Network rejected. + # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. + # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. + # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. + # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. + # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. + # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. + # - `PAST_FILING_DATE`: Past filing date. + # - `PREARBITRATION_REJECTED`: Prearbitration rejected. + # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. + # - `REFUNDED`: Refunded. + # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. + # - `WITHDRAWN`: Withdrawn. + # - `WON_ARBITRATION`: Won arbitration. + # - `WON_FIRST_CHARGEBACK`: Won first chargeback. + # - `WON_PREARBITRATION`: Won prearbitration. + resolution_reason:, + # Status types: + # + # - `NEW` - New dispute case is opened. + # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more + # information. + # - `SUBMITTED` - Dispute is submitted to the card network. + # - `REPRESENTMENT` - Case has entered second presentment. + # - `PREARBITRATION` - Case has entered prearbitration. + # - `ARBITRATION` - Case has entered arbitration. + # - `CASE_WON` - Case was won and credit will be issued. + # - `CASE_CLOSED` - Case was lost or withdrawn. status:, - # Contains identifiers for the transaction and specific event within being - # disputed; null if no transaction can be identified - transaction_series:, - # When the dispute was last updated. - updated: + # The transaction that is being disputed. A transaction can only be disputed once + # but may have multiple dispute cases. + transaction_token: ) end @@ -136,811 +244,236 @@ module Lithic override.returns( { token: String, - account_token: String, - card_token: String, - case_id: T.nilable(String), + amount: Integer, + arbitration_date: T.nilable(Time), created: Time, - currency: String, - disposition: T.nilable(Lithic::Dispute::Disposition::OrSymbol), - events: T::Array[Lithic::Dispute::Event], - liability_allocation: Lithic::Dispute::LiabilityAllocation, - merchant: Lithic::Dispute::Merchant, - network: Lithic::Dispute::Network::OrSymbol, - status: T.nilable(Lithic::Dispute::Status::OrSymbol), - transaction_series: T.nilable(Lithic::Dispute::TransactionSeries), - updated: Time + customer_filed_date: T.nilable(Time), + customer_note: T.nilable(String), + network_claim_ids: T.nilable(T::Array[String]), + network_filed_date: T.nilable(Time), + network_reason_code: T.nilable(String), + prearbitration_date: T.nilable(Time), + primary_claim_id: T.nilable(String), + reason: Lithic::Dispute::Reason::TaggedSymbol, + representment_date: T.nilable(Time), + resolution_date: T.nilable(Time), + resolution_note: T.nilable(String), + resolution_reason: + T.nilable(Lithic::Dispute::ResolutionReason::TaggedSymbol), + status: Lithic::Dispute::Status::TaggedSymbol, + transaction_token: String } ) end def to_hash end - # Dispute resolution outcome - module Disposition + # Dispute reason: + # + # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. + # - `CANCELLED`: Transaction was cancelled by the customer. + # - `DUPLICATED`: The transaction was a duplicate. + # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. + # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. + # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable + # merchant activity. + # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as + # described. + # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. + # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. + # - `MISSING_AUTH`: The transaction was missing authorization. + # - `OTHER`: Other reason. + # - `PROCESSING_ERROR`: Processing error. + # - `REFUND_NOT_PROCESSED`: The refund was not processed. + # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not + # cancelled. + module Reason extend Lithic::Internal::Type::Enum - TaggedSymbol = - T.type_alias { T.all(Symbol, Lithic::Dispute::Disposition) } + TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Dispute::Reason) } OrSymbol = T.type_alias { T.any(Symbol, String) } - WON = T.let(:WON, Lithic::Dispute::Disposition::TaggedSymbol) - LOST = T.let(:LOST, Lithic::Dispute::Disposition::TaggedSymbol) - PARTIALLY_WON = - T.let(:PARTIALLY_WON, Lithic::Dispute::Disposition::TaggedSymbol) - WITHDRAWN = - T.let(:WITHDRAWN, Lithic::Dispute::Disposition::TaggedSymbol) - DENIED = T.let(:DENIED, Lithic::Dispute::Disposition::TaggedSymbol) + ATM_CASH_MISDISPENSE = + T.let(:ATM_CASH_MISDISPENSE, Lithic::Dispute::Reason::TaggedSymbol) + CANCELLED = T.let(:CANCELLED, Lithic::Dispute::Reason::TaggedSymbol) + DUPLICATED = T.let(:DUPLICATED, Lithic::Dispute::Reason::TaggedSymbol) + FRAUD_CARD_NOT_PRESENT = + T.let(:FRAUD_CARD_NOT_PRESENT, Lithic::Dispute::Reason::TaggedSymbol) + FRAUD_CARD_PRESENT = + T.let(:FRAUD_CARD_PRESENT, Lithic::Dispute::Reason::TaggedSymbol) + FRAUD_OTHER = T.let(:FRAUD_OTHER, Lithic::Dispute::Reason::TaggedSymbol) + GOODS_SERVICES_NOT_AS_DESCRIBED = + T.let( + :GOODS_SERVICES_NOT_AS_DESCRIBED, + Lithic::Dispute::Reason::TaggedSymbol + ) + GOODS_SERVICES_NOT_RECEIVED = + T.let( + :GOODS_SERVICES_NOT_RECEIVED, + Lithic::Dispute::Reason::TaggedSymbol + ) + INCORRECT_AMOUNT = + T.let(:INCORRECT_AMOUNT, Lithic::Dispute::Reason::TaggedSymbol) + MISSING_AUTH = + T.let(:MISSING_AUTH, Lithic::Dispute::Reason::TaggedSymbol) + OTHER = T.let(:OTHER, Lithic::Dispute::Reason::TaggedSymbol) + PROCESSING_ERROR = + T.let(:PROCESSING_ERROR, Lithic::Dispute::Reason::TaggedSymbol) + RECURRING_TRANSACTION_NOT_CANCELLED = + T.let( + :RECURRING_TRANSACTION_NOT_CANCELLED, + Lithic::Dispute::Reason::TaggedSymbol + ) + REFUND_NOT_PROCESSED = + T.let(:REFUND_NOT_PROCESSED, Lithic::Dispute::Reason::TaggedSymbol) sig do - override.returns(T::Array[Lithic::Dispute::Disposition::TaggedSymbol]) + override.returns(T::Array[Lithic::Dispute::Reason::TaggedSymbol]) end def self.values end end - class Event < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Dispute::Event, Lithic::Internal::AnyHash) - end - - # Unique identifier for the event, in UUID format - sig { returns(String) } - attr_accessor :token + # Reason for the dispute resolution: + # + # - `CASE_LOST`: This case was lost at final arbitration. + # - `NETWORK_REJECTED`: Network rejected. + # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. + # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. + # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. + # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. + # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. + # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. + # - `PAST_FILING_DATE`: Past filing date. + # - `PREARBITRATION_REJECTED`: Prearbitration rejected. + # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. + # - `REFUNDED`: Refunded. + # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. + # - `WITHDRAWN`: Withdrawn. + # - `WON_ARBITRATION`: Won arbitration. + # - `WON_FIRST_CHARGEBACK`: Won first chargeback. + # - `WON_PREARBITRATION`: Won prearbitration. + module ResolutionReason + extend Lithic::Internal::Type::Enum - # When the event occurred - sig { returns(Time) } - attr_accessor :created + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::Dispute::ResolutionReason) } + OrSymbol = T.type_alias { T.any(Symbol, String) } - # Details specific to the event type - sig do - returns( - T.any( - Lithic::Dispute::Event::Data::WorkflowEventData, - Lithic::Dispute::Event::Data::FinancialEventData, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData - ) + CASE_LOST = + T.let(:CASE_LOST, Lithic::Dispute::ResolutionReason::TaggedSymbol) + NETWORK_REJECTED = + T.let( + :NETWORK_REJECTED, + Lithic::Dispute::ResolutionReason::TaggedSymbol ) - end - attr_accessor :data - - # Type of event - sig { returns(Lithic::Dispute::Event::Type::OrSymbol) } - attr_accessor :type - - # Event that occurred in the dispute lifecycle - sig do - params( - token: String, - created: Time, - data: - T.any( - Lithic::Dispute::Event::Data::WorkflowEventData::OrHash, - Lithic::Dispute::Event::Data::FinancialEventData::OrHash, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::OrHash - ), - type: Lithic::Dispute::Event::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Unique identifier for the event, in UUID format - token:, - # When the event occurred - created:, - # Details specific to the event type - data:, - # Type of event - type: - ) - end - - sig do - override.returns( - { - token: String, - created: Time, - data: - T.any( - Lithic::Dispute::Event::Data::WorkflowEventData, - Lithic::Dispute::Event::Data::FinancialEventData, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData - ), - type: Lithic::Dispute::Event::Type::OrSymbol - } + NO_DISPUTE_RIGHTS_3DS = + T.let( + :NO_DISPUTE_RIGHTS_3DS, + Lithic::Dispute::ResolutionReason::TaggedSymbol ) - end - def to_hash - end - - # Details specific to the event type - module Data - extend Lithic::Internal::Type::Union - - Variants = - T.type_alias do - T.any( - Lithic::Dispute::Event::Data::WorkflowEventData, - Lithic::Dispute::Event::Data::FinancialEventData, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData - ) - end - - class WorkflowEventData < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Dispute::Event::Data::WorkflowEventData, - Lithic::Internal::AnyHash - ) - end - - # Action taken in this stage - sig do - returns( - Lithic::Dispute::Event::Data::WorkflowEventData::Action::OrSymbol - ) - end - attr_accessor :action - - # Amount in minor units - sig { returns(T.nilable(Integer)) } - attr_accessor :amount - - # Dispute resolution outcome - sig do - returns( - T.nilable( - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::OrSymbol - ) - ) - end - attr_accessor :disposition - - # Reason for the action - sig { returns(T.nilable(String)) } - attr_accessor :reason - - # Current stage of the dispute workflow - sig do - returns( - Lithic::Dispute::Event::Data::WorkflowEventData::Stage::OrSymbol - ) - end - attr_accessor :stage - - # Details specific to workflow events - sig do - params( - action: - Lithic::Dispute::Event::Data::WorkflowEventData::Action::OrSymbol, - amount: T.nilable(Integer), - disposition: - T.nilable( - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::OrSymbol - ), - reason: T.nilable(String), - stage: - Lithic::Dispute::Event::Data::WorkflowEventData::Stage::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Action taken in this stage - action:, - # Amount in minor units - amount:, - # Dispute resolution outcome - disposition:, - # Reason for the action - reason:, - # Current stage of the dispute workflow - stage: - ) - end - - sig do - override.returns( - { - action: - Lithic::Dispute::Event::Data::WorkflowEventData::Action::OrSymbol, - amount: T.nilable(Integer), - disposition: - T.nilable( - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::OrSymbol - ), - reason: T.nilable(String), - stage: - Lithic::Dispute::Event::Data::WorkflowEventData::Stage::OrSymbol - } - ) - end - def to_hash - end - - # Action taken in this stage - module Action - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::WorkflowEventData::Action - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - OPENED = - T.let( - :OPENED, - Lithic::Dispute::Event::Data::WorkflowEventData::Action::TaggedSymbol - ) - CLOSED = - T.let( - :CLOSED, - Lithic::Dispute::Event::Data::WorkflowEventData::Action::TaggedSymbol - ) - REOPENED = - T.let( - :REOPENED, - Lithic::Dispute::Event::Data::WorkflowEventData::Action::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::WorkflowEventData::Action::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Dispute resolution outcome - module Disposition - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WON = - T.let( - :WON, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ) - LOST = - T.let( - :LOST, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ) - PARTIALLY_WON = - T.let( - :PARTIALLY_WON, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ) - DENIED = - T.let( - :DENIED, - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::WorkflowEventData::Disposition::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Current stage of the dispute workflow - module Stage - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::WorkflowEventData::Stage - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CLAIM = - T.let( - :CLAIM, - Lithic::Dispute::Event::Data::WorkflowEventData::Stage::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::WorkflowEventData::Stage::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class FinancialEventData < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Dispute::Event::Data::FinancialEventData, - Lithic::Internal::AnyHash - ) - end - - # Amount in minor units - sig { returns(Integer) } - attr_accessor :amount - - # Direction of funds flow - sig do - returns( - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::OrSymbol - ) - end - attr_accessor :polarity - - # Stage at which the financial event occurred - sig do - returns( - Lithic::Dispute::Event::Data::FinancialEventData::Stage::OrSymbol - ) - end - attr_accessor :stage - - # Details specific to financial events - sig do - params( - amount: Integer, - polarity: - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::OrSymbol, - stage: - Lithic::Dispute::Event::Data::FinancialEventData::Stage::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Amount in minor units - amount:, - # Direction of funds flow - polarity:, - # Stage at which the financial event occurred - stage: - ) - end - - sig do - override.returns( - { - amount: Integer, - polarity: - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::OrSymbol, - stage: - Lithic::Dispute::Event::Data::FinancialEventData::Stage::OrSymbol - } - ) - end - def to_hash - end - - # Direction of funds flow - module Polarity - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::FinancialEventData::Polarity - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CREDIT = - T.let( - :CREDIT, - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::TaggedSymbol - ) - DEBIT = - T.let( - :DEBIT, - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::FinancialEventData::Polarity::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Stage at which the financial event occurred - module Stage - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::FinancialEventData::Stage - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CHARGEBACK = - T.let( - :CHARGEBACK, - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ) - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ) - COLLABORATION = - T.let( - :COLLABORATION, - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::FinancialEventData::Stage::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - class CardholderLiabilityEventData < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Dispute::Event::Data::CardholderLiabilityEventData, - Lithic::Internal::AnyHash - ) - end - - # Action taken regarding cardholder liability - sig do - returns( - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::OrSymbol - ) - end - attr_accessor :action - - # Amount in minor units - sig { returns(Integer) } - attr_accessor :amount - - # Reason for the action - sig { returns(String) } - attr_accessor :reason - - # Details specific to cardholder liability events - sig do - params( - action: - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::OrSymbol, - amount: Integer, - reason: String - ).returns(T.attached_class) - end - def self.new( - # Action taken regarding cardholder liability - action:, - # Amount in minor units - amount:, - # Reason for the action - reason: - ) - end - - sig do - override.returns( - { - action: - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::OrSymbol, - amount: Integer, - reason: String - } - ) - end - def to_hash - end - - # Action taken regarding cardholder liability - module Action - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - PROVISIONAL_CREDIT_GRANTED = - T.let( - :PROVISIONAL_CREDIT_GRANTED, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::TaggedSymbol - ) - PROVISIONAL_CREDIT_REVERSED = - T.let( - :PROVISIONAL_CREDIT_REVERSED, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::TaggedSymbol - ) - WRITTEN_OFF = - T.let( - :WRITTEN_OFF, - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Dispute::Event::Data::CardholderLiabilityEventData::Action::TaggedSymbol - ] - ) - end - def self.values - end - end - end - - sig do - override.returns(T::Array[Lithic::Dispute::Event::Data::Variants]) - end - def self.variants - end - end - - # Type of event - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Lithic::Dispute::Event::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - WORKFLOW = - T.let(:WORKFLOW, Lithic::Dispute::Event::Type::TaggedSymbol) - FINANCIAL = - T.let(:FINANCIAL, Lithic::Dispute::Event::Type::TaggedSymbol) - CARDHOLDER_LIABILITY = - T.let( - :CARDHOLDER_LIABILITY, - Lithic::Dispute::Event::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::Dispute::Event::Type::TaggedSymbol] - ) - end - def self.values - end - end - end - - class LiabilityAllocation < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Dispute::LiabilityAllocation, - Lithic::Internal::AnyHash - ) - end - - # The amount that has been denied to the cardholder - sig { returns(Integer) } - attr_accessor :denied_amount - - # The initial amount disputed - sig { returns(Integer) } - attr_accessor :original_amount - - # The amount that has been recovered from the merchant through the dispute process - sig { returns(Integer) } - attr_accessor :recovered_amount - - # Any disputed amount that is still outstanding, i.e. has not been recovered, - # written off, or denied - sig { returns(Integer) } - attr_accessor :remaining_amount - - # The amount the issuer has chosen to write off - sig { returns(Integer) } - attr_accessor :written_off_amount - - # Current breakdown of how liability is allocated for the disputed amount - sig do - params( - denied_amount: Integer, - original_amount: Integer, - recovered_amount: Integer, - remaining_amount: Integer, - written_off_amount: Integer - ).returns(T.attached_class) - end - def self.new( - # The amount that has been denied to the cardholder - denied_amount:, - # The initial amount disputed - original_amount:, - # The amount that has been recovered from the merchant through the dispute process - recovered_amount:, - # Any disputed amount that is still outstanding, i.e. has not been recovered, - # written off, or denied - remaining_amount:, - # The amount the issuer has chosen to write off - written_off_amount: - ) - end - - sig do - override.returns( - { - denied_amount: Integer, - original_amount: Integer, - recovered_amount: Integer, - remaining_amount: Integer, - written_off_amount: Integer - } + NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = + T.let( + :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + NO_DISPUTE_RIGHTS_CONTACTLESS = + T.let( + :NO_DISPUTE_RIGHTS_CONTACTLESS, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + NO_DISPUTE_RIGHTS_HYBRID = + T.let( + :NO_DISPUTE_RIGHTS_HYBRID, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = + T.let( + :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + NO_DISPUTE_RIGHTS_OTHER = + T.let( + :NO_DISPUTE_RIGHTS_OTHER, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + PAST_FILING_DATE = + T.let( + :PAST_FILING_DATE, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + PREARBITRATION_REJECTED = + T.let( + :PREARBITRATION_REJECTED, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + PROCESSOR_REJECTED_OTHER = + T.let( + :PROCESSOR_REJECTED_OTHER, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + REFUNDED = + T.let(:REFUNDED, Lithic::Dispute::ResolutionReason::TaggedSymbol) + REFUNDED_AFTER_CHARGEBACK = + T.let( + :REFUNDED_AFTER_CHARGEBACK, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + WITHDRAWN = + T.let(:WITHDRAWN, Lithic::Dispute::ResolutionReason::TaggedSymbol) + WON_ARBITRATION = + T.let( + :WON_ARBITRATION, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + WON_FIRST_CHARGEBACK = + T.let( + :WON_FIRST_CHARGEBACK, + Lithic::Dispute::ResolutionReason::TaggedSymbol + ) + WON_PREARBITRATION = + T.let( + :WON_PREARBITRATION, + Lithic::Dispute::ResolutionReason::TaggedSymbol ) - end - def to_hash - end - end - - class Merchant < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Dispute::Merchant, Lithic::Internal::AnyHash) - end - - # Unique alphanumeric identifier for the payment card acceptor (merchant). - sig { returns(String) } - attr_accessor :acceptor_id - - # Unique numeric identifier of the acquiring institution. - sig { returns(String) } - attr_accessor :acquiring_institution_id - - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - sig { returns(String) } - attr_accessor :city - - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - sig { returns(String) } - attr_accessor :country - - # Short description of card acceptor. - sig { returns(String) } - attr_accessor :descriptor - - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - sig { returns(String) } - attr_accessor :mcc - - # Geographic state of card acceptor. - sig { returns(String) } - attr_accessor :state - - sig do - params( - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - ).returns(T.attached_class) - end - def self.new( - # Unique alphanumeric identifier for the payment card acceptor (merchant). - acceptor_id:, - # Unique numeric identifier of the acquiring institution. - acquiring_institution_id:, - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - city:, - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - country:, - # Short description of card acceptor. - descriptor:, - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - mcc:, - # Geographic state of card acceptor. - state: - ) - end sig do override.returns( - { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } + T::Array[Lithic::Dispute::ResolutionReason::TaggedSymbol] ) end - def to_hash - end - end - - # Card network handling the dispute. - module Network - extend Lithic::Internal::Type::Enum - - TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Dispute::Network) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - VISA = T.let(:VISA, Lithic::Dispute::Network::TaggedSymbol) - MASTERCARD = T.let(:MASTERCARD, Lithic::Dispute::Network::TaggedSymbol) - - sig do - override.returns(T::Array[Lithic::Dispute::Network::TaggedSymbol]) - end def self.values end end - # Current status of the dispute. + # Status types: + # + # - `NEW` - New dispute case is opened. + # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more + # information. + # - `SUBMITTED` - Dispute is submitted to the card network. + # - `REPRESENTMENT` - Case has entered second presentment. + # - `PREARBITRATION` - Case has entered prearbitration. + # - `ARBITRATION` - Case has entered arbitration. + # - `CASE_WON` - Case was won and credit will be issued. + # - `CASE_CLOSED` - Case was lost or withdrawn. module Status extend Lithic::Internal::Type::Enum TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::Dispute::Status) } OrSymbol = T.type_alias { T.any(Symbol, String) } - OPEN = T.let(:OPEN, Lithic::Dispute::Status::TaggedSymbol) - CLOSED = T.let(:CLOSED, Lithic::Dispute::Status::TaggedSymbol) + ARBITRATION = T.let(:ARBITRATION, Lithic::Dispute::Status::TaggedSymbol) + CASE_CLOSED = T.let(:CASE_CLOSED, Lithic::Dispute::Status::TaggedSymbol) + CASE_WON = T.let(:CASE_WON, Lithic::Dispute::Status::TaggedSymbol) + NEW = T.let(:NEW, Lithic::Dispute::Status::TaggedSymbol) + PENDING_CUSTOMER = + T.let(:PENDING_CUSTOMER, Lithic::Dispute::Status::TaggedSymbol) + PREARBITRATION = + T.let(:PREARBITRATION, Lithic::Dispute::Status::TaggedSymbol) + REPRESENTMENT = + T.let(:REPRESENTMENT, Lithic::Dispute::Status::TaggedSymbol) + SUBMITTED = T.let(:SUBMITTED, Lithic::Dispute::Status::TaggedSymbol) sig do override.returns(T::Array[Lithic::Dispute::Status::TaggedSymbol]) @@ -948,86 +481,6 @@ module Lithic def self.values end end - - class TransactionSeries < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Dispute::TransactionSeries, Lithic::Internal::AnyHash) - end - - # Token of the specific event in the original transaction being disputed, in UUID - # format; null if no event can be identified - sig { returns(T.nilable(String)) } - attr_accessor :related_transaction_event_token - - # Token of the original transaction being disputed, in UUID format - sig { returns(String) } - attr_accessor :related_transaction_token - - # The type of transaction series associating the dispute and the original - # transaction. Always set to DISPUTE - sig { returns(Lithic::Dispute::TransactionSeries::Type::OrSymbol) } - attr_accessor :type - - # Contains identifiers for the transaction and specific event within being - # disputed; null if no transaction can be identified - sig do - params( - related_transaction_event_token: T.nilable(String), - related_transaction_token: String, - type: Lithic::Dispute::TransactionSeries::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Token of the specific event in the original transaction being disputed, in UUID - # format; null if no event can be identified - related_transaction_event_token:, - # Token of the original transaction being disputed, in UUID format - related_transaction_token:, - # The type of transaction series associating the dispute and the original - # transaction. Always set to DISPUTE - type: - ) - end - - sig do - override.returns( - { - related_transaction_event_token: T.nilable(String), - related_transaction_token: String, - type: Lithic::Dispute::TransactionSeries::Type::OrSymbol - } - ) - end - def to_hash - end - - # The type of transaction series associating the dispute and the original - # transaction. Always set to DISPUTE - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Dispute::TransactionSeries::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DISPUTE = - T.let( - :DISPUTE, - Lithic::Dispute::TransactionSeries::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::Dispute::TransactionSeries::Type::TaggedSymbol] - ) - end - def self.values - end - end - end end end end diff --git a/rbi/lithic/models/dispute_create_response.rbi b/rbi/lithic/models/dispute_create_response.rbi deleted file mode 100644 index fb7cae3a..00000000 --- a/rbi/lithic/models/dispute_create_response.rbi +++ /dev/null @@ -1,599 +0,0 @@ -# typed: strong - -module Lithic - module Models - class DisputeCreateResponse < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::DisputeCreateResponse, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(String) } - attr_accessor :token - - # Amount under dispute. May be different from the original transaction amount. - sig { returns(Integer) } - attr_accessor :amount - - # Date dispute entered arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :arbitration_date - - # Timestamp of when first Dispute was reported. - sig { returns(Time) } - attr_accessor :created - - # Date that the dispute was filed by the customer making the dispute. - sig { returns(T.nilable(Time)) } - attr_accessor :customer_filed_date - - # End customer description of the reason for the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :customer_note - - # Unique identifiers for the dispute from the network. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :network_claim_ids - - # Date that the dispute was submitted to the network. - sig { returns(T.nilable(Time)) } - attr_accessor :network_filed_date - - # Network reason code used to file the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :network_reason_code - - # Date dispute entered pre-arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :prearbitration_date - - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - sig { returns(T.nilable(String)) } - attr_accessor :primary_claim_id - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - sig do - returns(Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol) - end - attr_accessor :reason - - # Date the representment was received. - sig { returns(T.nilable(Time)) } - attr_accessor :representment_date - - # Date that the dispute was resolved. - sig { returns(T.nilable(Time)) } - attr_accessor :resolution_date - - # Note by Dispute team on the case resolution. - sig { returns(T.nilable(String)) } - attr_accessor :resolution_note - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - sig do - returns( - T.nilable( - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - ) - end - attr_accessor :resolution_reason - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - sig do - returns(Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol) - end - attr_accessor :status - - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - sig { returns(String) } - attr_accessor :transaction_token - - # Dispute. - sig do - params( - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeCreateResponse::Reason::OrSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeCreateResponse::ResolutionReason::OrSymbol - ), - status: Lithic::Models::DisputeCreateResponse::Status::OrSymbol, - transaction_token: String - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token:, - # Amount under dispute. May be different from the original transaction amount. - amount:, - # Date dispute entered arbitration. - arbitration_date:, - # Timestamp of when first Dispute was reported. - created:, - # Date that the dispute was filed by the customer making the dispute. - customer_filed_date:, - # End customer description of the reason for the dispute. - customer_note:, - # Unique identifiers for the dispute from the network. - network_claim_ids:, - # Date that the dispute was submitted to the network. - network_filed_date:, - # Network reason code used to file the dispute. - network_reason_code:, - # Date dispute entered pre-arbitration. - prearbitration_date:, - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - primary_claim_id:, - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - reason:, - # Date the representment was received. - representment_date:, - # Date that the dispute was resolved. - resolution_date:, - # Note by Dispute team on the case resolution. - resolution_note:, - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - resolution_reason:, - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - status:, - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - transaction_token: - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ), - status: Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol, - transaction_token: String - } - ) - end - def to_hash - end - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - module Reason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeCreateResponse::Reason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ATM_CASH_MISDISPENSE = - T.let( - :ATM_CASH_MISDISPENSE, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - CANCELLED = - T.let( - :CANCELLED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - DUPLICATED = - T.let( - :DUPLICATED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_NOT_PRESENT = - T.let( - :FRAUD_CARD_NOT_PRESENT, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_PRESENT = - T.let( - :FRAUD_CARD_PRESENT, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - FRAUD_OTHER = - T.let( - :FRAUD_OTHER, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_AS_DESCRIBED = - T.let( - :GOODS_SERVICES_NOT_AS_DESCRIBED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_RECEIVED = - T.let( - :GOODS_SERVICES_NOT_RECEIVED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - INCORRECT_AMOUNT = - T.let( - :INCORRECT_AMOUNT, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - MISSING_AUTH = - T.let( - :MISSING_AUTH, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - OTHER = - T.let( - :OTHER, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - PROCESSING_ERROR = - T.let( - :PROCESSING_ERROR, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - RECURRING_TRANSACTION_NOT_CANCELLED = - T.let( - :RECURRING_TRANSACTION_NOT_CANCELLED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - REFUND_NOT_PROCESSED = - T.let( - :REFUND_NOT_PROCESSED, - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeCreateResponse::Reason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - module ResolutionReason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::DisputeCreateResponse::ResolutionReason - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CASE_LOST = - T.let( - :CASE_LOST, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NETWORK_REJECTED = - T.let( - :NETWORK_REJECTED, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_3DS = - T.let( - :NO_DISPUTE_RIGHTS_3DS, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = - T.let( - :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_CONTACTLESS = - T.let( - :NO_DISPUTE_RIGHTS_CONTACTLESS, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_HYBRID = - T.let( - :NO_DISPUTE_RIGHTS_HYBRID, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = - T.let( - :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_OTHER = - T.let( - :NO_DISPUTE_RIGHTS_OTHER, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - PAST_FILING_DATE = - T.let( - :PAST_FILING_DATE, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - PREARBITRATION_REJECTED = - T.let( - :PREARBITRATION_REJECTED, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - PROCESSOR_REJECTED_OTHER = - T.let( - :PROCESSOR_REJECTED_OTHER, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED = - T.let( - :REFUNDED, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED_AFTER_CHARGEBACK = - T.let( - :REFUNDED_AFTER_CHARGEBACK, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - WON_ARBITRATION = - T.let( - :WON_ARBITRATION, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - WON_FIRST_CHARGEBACK = - T.let( - :WON_FIRST_CHARGEBACK, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - WON_PREARBITRATION = - T.let( - :WON_PREARBITRATION, - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeCreateResponse::ResolutionReason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - module Status - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeCreateResponse::Status) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - CASE_CLOSED = - T.let( - :CASE_CLOSED, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - CASE_WON = - T.let( - :CASE_WON, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - NEW = - T.let( - :NEW, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - PENDING_CUSTOMER = - T.let( - :PENDING_CUSTOMER, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - SUBMITTED = - T.let( - :SUBMITTED, - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeCreateResponse::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/lithic/models/dispute_delete_response.rbi b/rbi/lithic/models/dispute_delete_response.rbi deleted file mode 100644 index 5637d9ed..00000000 --- a/rbi/lithic/models/dispute_delete_response.rbi +++ /dev/null @@ -1,599 +0,0 @@ -# typed: strong - -module Lithic - module Models - class DisputeDeleteResponse < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::DisputeDeleteResponse, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(String) } - attr_accessor :token - - # Amount under dispute. May be different from the original transaction amount. - sig { returns(Integer) } - attr_accessor :amount - - # Date dispute entered arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :arbitration_date - - # Timestamp of when first Dispute was reported. - sig { returns(Time) } - attr_accessor :created - - # Date that the dispute was filed by the customer making the dispute. - sig { returns(T.nilable(Time)) } - attr_accessor :customer_filed_date - - # End customer description of the reason for the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :customer_note - - # Unique identifiers for the dispute from the network. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :network_claim_ids - - # Date that the dispute was submitted to the network. - sig { returns(T.nilable(Time)) } - attr_accessor :network_filed_date - - # Network reason code used to file the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :network_reason_code - - # Date dispute entered pre-arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :prearbitration_date - - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - sig { returns(T.nilable(String)) } - attr_accessor :primary_claim_id - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - sig do - returns(Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol) - end - attr_accessor :reason - - # Date the representment was received. - sig { returns(T.nilable(Time)) } - attr_accessor :representment_date - - # Date that the dispute was resolved. - sig { returns(T.nilable(Time)) } - attr_accessor :resolution_date - - # Note by Dispute team on the case resolution. - sig { returns(T.nilable(String)) } - attr_accessor :resolution_note - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - sig do - returns( - T.nilable( - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - ) - end - attr_accessor :resolution_reason - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - sig do - returns(Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol) - end - attr_accessor :status - - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - sig { returns(String) } - attr_accessor :transaction_token - - # Dispute. - sig do - params( - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeDeleteResponse::Reason::OrSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeDeleteResponse::ResolutionReason::OrSymbol - ), - status: Lithic::Models::DisputeDeleteResponse::Status::OrSymbol, - transaction_token: String - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token:, - # Amount under dispute. May be different from the original transaction amount. - amount:, - # Date dispute entered arbitration. - arbitration_date:, - # Timestamp of when first Dispute was reported. - created:, - # Date that the dispute was filed by the customer making the dispute. - customer_filed_date:, - # End customer description of the reason for the dispute. - customer_note:, - # Unique identifiers for the dispute from the network. - network_claim_ids:, - # Date that the dispute was submitted to the network. - network_filed_date:, - # Network reason code used to file the dispute. - network_reason_code:, - # Date dispute entered pre-arbitration. - prearbitration_date:, - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - primary_claim_id:, - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - reason:, - # Date the representment was received. - representment_date:, - # Date that the dispute was resolved. - resolution_date:, - # Note by Dispute team on the case resolution. - resolution_note:, - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - resolution_reason:, - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - status:, - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - transaction_token: - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ), - status: Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol, - transaction_token: String - } - ) - end - def to_hash - end - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - module Reason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeDeleteResponse::Reason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ATM_CASH_MISDISPENSE = - T.let( - :ATM_CASH_MISDISPENSE, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - CANCELLED = - T.let( - :CANCELLED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - DUPLICATED = - T.let( - :DUPLICATED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_NOT_PRESENT = - T.let( - :FRAUD_CARD_NOT_PRESENT, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_PRESENT = - T.let( - :FRAUD_CARD_PRESENT, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - FRAUD_OTHER = - T.let( - :FRAUD_OTHER, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_AS_DESCRIBED = - T.let( - :GOODS_SERVICES_NOT_AS_DESCRIBED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_RECEIVED = - T.let( - :GOODS_SERVICES_NOT_RECEIVED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - INCORRECT_AMOUNT = - T.let( - :INCORRECT_AMOUNT, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - MISSING_AUTH = - T.let( - :MISSING_AUTH, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - OTHER = - T.let( - :OTHER, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - PROCESSING_ERROR = - T.let( - :PROCESSING_ERROR, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - RECURRING_TRANSACTION_NOT_CANCELLED = - T.let( - :RECURRING_TRANSACTION_NOT_CANCELLED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - REFUND_NOT_PROCESSED = - T.let( - :REFUND_NOT_PROCESSED, - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeDeleteResponse::Reason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - module ResolutionReason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::DisputeDeleteResponse::ResolutionReason - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CASE_LOST = - T.let( - :CASE_LOST, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NETWORK_REJECTED = - T.let( - :NETWORK_REJECTED, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_3DS = - T.let( - :NO_DISPUTE_RIGHTS_3DS, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = - T.let( - :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_CONTACTLESS = - T.let( - :NO_DISPUTE_RIGHTS_CONTACTLESS, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_HYBRID = - T.let( - :NO_DISPUTE_RIGHTS_HYBRID, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = - T.let( - :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_OTHER = - T.let( - :NO_DISPUTE_RIGHTS_OTHER, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - PAST_FILING_DATE = - T.let( - :PAST_FILING_DATE, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - PREARBITRATION_REJECTED = - T.let( - :PREARBITRATION_REJECTED, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - PROCESSOR_REJECTED_OTHER = - T.let( - :PROCESSOR_REJECTED_OTHER, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED = - T.let( - :REFUNDED, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED_AFTER_CHARGEBACK = - T.let( - :REFUNDED_AFTER_CHARGEBACK, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - WON_ARBITRATION = - T.let( - :WON_ARBITRATION, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - WON_FIRST_CHARGEBACK = - T.let( - :WON_FIRST_CHARGEBACK, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - WON_PREARBITRATION = - T.let( - :WON_PREARBITRATION, - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeDeleteResponse::ResolutionReason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - module Status - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeDeleteResponse::Status) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - CASE_CLOSED = - T.let( - :CASE_CLOSED, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - CASE_WON = - T.let( - :CASE_WON, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - NEW = - T.let( - :NEW, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - PENDING_CUSTOMER = - T.let( - :PENDING_CUSTOMER, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - SUBMITTED = - T.let( - :SUBMITTED, - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeDeleteResponse::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/lithic/models/dispute_list_response.rbi b/rbi/lithic/models/dispute_list_response.rbi deleted file mode 100644 index db8ce494..00000000 --- a/rbi/lithic/models/dispute_list_response.rbi +++ /dev/null @@ -1,582 +0,0 @@ -# typed: strong - -module Lithic - module Models - class DisputeListResponse < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Models::DisputeListResponse, Lithic::Internal::AnyHash) - end - - # Globally unique identifier. - sig { returns(String) } - attr_accessor :token - - # Amount under dispute. May be different from the original transaction amount. - sig { returns(Integer) } - attr_accessor :amount - - # Date dispute entered arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :arbitration_date - - # Timestamp of when first Dispute was reported. - sig { returns(Time) } - attr_accessor :created - - # Date that the dispute was filed by the customer making the dispute. - sig { returns(T.nilable(Time)) } - attr_accessor :customer_filed_date - - # End customer description of the reason for the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :customer_note - - # Unique identifiers for the dispute from the network. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :network_claim_ids - - # Date that the dispute was submitted to the network. - sig { returns(T.nilable(Time)) } - attr_accessor :network_filed_date - - # Network reason code used to file the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :network_reason_code - - # Date dispute entered pre-arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :prearbitration_date - - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - sig { returns(T.nilable(String)) } - attr_accessor :primary_claim_id - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - sig { returns(Lithic::Models::DisputeListResponse::Reason::TaggedSymbol) } - attr_accessor :reason - - # Date the representment was received. - sig { returns(T.nilable(Time)) } - attr_accessor :representment_date - - # Date that the dispute was resolved. - sig { returns(T.nilable(Time)) } - attr_accessor :resolution_date - - # Note by Dispute team on the case resolution. - sig { returns(T.nilable(String)) } - attr_accessor :resolution_note - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - sig do - returns( - T.nilable( - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - ) - end - attr_accessor :resolution_reason - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - sig { returns(Lithic::Models::DisputeListResponse::Status::TaggedSymbol) } - attr_accessor :status - - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - sig { returns(String) } - attr_accessor :transaction_token - - # Dispute. - sig do - params( - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeListResponse::Reason::OrSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeListResponse::ResolutionReason::OrSymbol - ), - status: Lithic::Models::DisputeListResponse::Status::OrSymbol, - transaction_token: String - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token:, - # Amount under dispute. May be different from the original transaction amount. - amount:, - # Date dispute entered arbitration. - arbitration_date:, - # Timestamp of when first Dispute was reported. - created:, - # Date that the dispute was filed by the customer making the dispute. - customer_filed_date:, - # End customer description of the reason for the dispute. - customer_note:, - # Unique identifiers for the dispute from the network. - network_claim_ids:, - # Date that the dispute was submitted to the network. - network_filed_date:, - # Network reason code used to file the dispute. - network_reason_code:, - # Date dispute entered pre-arbitration. - prearbitration_date:, - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - primary_claim_id:, - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - reason:, - # Date the representment was received. - representment_date:, - # Date that the dispute was resolved. - resolution_date:, - # Note by Dispute team on the case resolution. - resolution_note:, - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - resolution_reason:, - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - status:, - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - transaction_token: - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeListResponse::Reason::TaggedSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ), - status: Lithic::Models::DisputeListResponse::Status::TaggedSymbol, - transaction_token: String - } - ) - end - def to_hash - end - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - module Reason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeListResponse::Reason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ATM_CASH_MISDISPENSE = - T.let( - :ATM_CASH_MISDISPENSE, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - CANCELLED = - T.let( - :CANCELLED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - DUPLICATED = - T.let( - :DUPLICATED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_NOT_PRESENT = - T.let( - :FRAUD_CARD_NOT_PRESENT, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_PRESENT = - T.let( - :FRAUD_CARD_PRESENT, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - FRAUD_OTHER = - T.let( - :FRAUD_OTHER, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_AS_DESCRIBED = - T.let( - :GOODS_SERVICES_NOT_AS_DESCRIBED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_RECEIVED = - T.let( - :GOODS_SERVICES_NOT_RECEIVED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - INCORRECT_AMOUNT = - T.let( - :INCORRECT_AMOUNT, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - MISSING_AUTH = - T.let( - :MISSING_AUTH, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - OTHER = - T.let( - :OTHER, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - PROCESSING_ERROR = - T.let( - :PROCESSING_ERROR, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - RECURRING_TRANSACTION_NOT_CANCELLED = - T.let( - :RECURRING_TRANSACTION_NOT_CANCELLED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - REFUND_NOT_PROCESSED = - T.let( - :REFUND_NOT_PROCESSED, - Lithic::Models::DisputeListResponse::Reason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::Models::DisputeListResponse::Reason::TaggedSymbol] - ) - end - def self.values - end - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - module ResolutionReason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeListResponse::ResolutionReason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CASE_LOST = - T.let( - :CASE_LOST, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NETWORK_REJECTED = - T.let( - :NETWORK_REJECTED, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_3DS = - T.let( - :NO_DISPUTE_RIGHTS_3DS, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = - T.let( - :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_CONTACTLESS = - T.let( - :NO_DISPUTE_RIGHTS_CONTACTLESS, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_HYBRID = - T.let( - :NO_DISPUTE_RIGHTS_HYBRID, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = - T.let( - :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_OTHER = - T.let( - :NO_DISPUTE_RIGHTS_OTHER, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - PAST_FILING_DATE = - T.let( - :PAST_FILING_DATE, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - PREARBITRATION_REJECTED = - T.let( - :PREARBITRATION_REJECTED, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - PROCESSOR_REJECTED_OTHER = - T.let( - :PROCESSOR_REJECTED_OTHER, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED = - T.let( - :REFUNDED, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED_AFTER_CHARGEBACK = - T.let( - :REFUNDED_AFTER_CHARGEBACK, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - WON_ARBITRATION = - T.let( - :WON_ARBITRATION, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - WON_FIRST_CHARGEBACK = - T.let( - :WON_FIRST_CHARGEBACK, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - WON_PREARBITRATION = - T.let( - :WON_PREARBITRATION, - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeListResponse::ResolutionReason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - module Status - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeListResponse::Status) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - CASE_CLOSED = - T.let( - :CASE_CLOSED, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - CASE_WON = - T.let( - :CASE_WON, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - NEW = - T.let(:NEW, Lithic::Models::DisputeListResponse::Status::TaggedSymbol) - PENDING_CUSTOMER = - T.let( - :PENDING_CUSTOMER, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - SUBMITTED = - T.let( - :SUBMITTED, - Lithic::Models::DisputeListResponse::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::Models::DisputeListResponse::Status::TaggedSymbol] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/lithic/models/dispute_retrieve_response.rbi b/rbi/lithic/models/dispute_retrieve_response.rbi deleted file mode 100644 index b57fdeef..00000000 --- a/rbi/lithic/models/dispute_retrieve_response.rbi +++ /dev/null @@ -1,601 +0,0 @@ -# typed: strong - -module Lithic - module Models - class DisputeRetrieveResponse < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::DisputeRetrieveResponse, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(String) } - attr_accessor :token - - # Amount under dispute. May be different from the original transaction amount. - sig { returns(Integer) } - attr_accessor :amount - - # Date dispute entered arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :arbitration_date - - # Timestamp of when first Dispute was reported. - sig { returns(Time) } - attr_accessor :created - - # Date that the dispute was filed by the customer making the dispute. - sig { returns(T.nilable(Time)) } - attr_accessor :customer_filed_date - - # End customer description of the reason for the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :customer_note - - # Unique identifiers for the dispute from the network. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :network_claim_ids - - # Date that the dispute was submitted to the network. - sig { returns(T.nilable(Time)) } - attr_accessor :network_filed_date - - # Network reason code used to file the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :network_reason_code - - # Date dispute entered pre-arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :prearbitration_date - - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - sig { returns(T.nilable(String)) } - attr_accessor :primary_claim_id - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - sig do - returns(Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol) - end - attr_accessor :reason - - # Date the representment was received. - sig { returns(T.nilable(Time)) } - attr_accessor :representment_date - - # Date that the dispute was resolved. - sig { returns(T.nilable(Time)) } - attr_accessor :resolution_date - - # Note by Dispute team on the case resolution. - sig { returns(T.nilable(String)) } - attr_accessor :resolution_note - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - sig do - returns( - T.nilable( - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - ) - end - attr_accessor :resolution_reason - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - sig do - returns(Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol) - end - attr_accessor :status - - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - sig { returns(String) } - attr_accessor :transaction_token - - # Dispute. - sig do - params( - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeRetrieveResponse::Reason::OrSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::OrSymbol - ), - status: Lithic::Models::DisputeRetrieveResponse::Status::OrSymbol, - transaction_token: String - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token:, - # Amount under dispute. May be different from the original transaction amount. - amount:, - # Date dispute entered arbitration. - arbitration_date:, - # Timestamp of when first Dispute was reported. - created:, - # Date that the dispute was filed by the customer making the dispute. - customer_filed_date:, - # End customer description of the reason for the dispute. - customer_note:, - # Unique identifiers for the dispute from the network. - network_claim_ids:, - # Date that the dispute was submitted to the network. - network_filed_date:, - # Network reason code used to file the dispute. - network_reason_code:, - # Date dispute entered pre-arbitration. - prearbitration_date:, - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - primary_claim_id:, - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - reason:, - # Date the representment was received. - representment_date:, - # Date that the dispute was resolved. - resolution_date:, - # Note by Dispute team on the case resolution. - resolution_note:, - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - resolution_reason:, - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - status:, - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - transaction_token: - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ), - status: - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol, - transaction_token: String - } - ) - end - def to_hash - end - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - module Reason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeRetrieveResponse::Reason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ATM_CASH_MISDISPENSE = - T.let( - :ATM_CASH_MISDISPENSE, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - CANCELLED = - T.let( - :CANCELLED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - DUPLICATED = - T.let( - :DUPLICATED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_NOT_PRESENT = - T.let( - :FRAUD_CARD_NOT_PRESENT, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_PRESENT = - T.let( - :FRAUD_CARD_PRESENT, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - FRAUD_OTHER = - T.let( - :FRAUD_OTHER, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_AS_DESCRIBED = - T.let( - :GOODS_SERVICES_NOT_AS_DESCRIBED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_RECEIVED = - T.let( - :GOODS_SERVICES_NOT_RECEIVED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - INCORRECT_AMOUNT = - T.let( - :INCORRECT_AMOUNT, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - MISSING_AUTH = - T.let( - :MISSING_AUTH, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - OTHER = - T.let( - :OTHER, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - PROCESSING_ERROR = - T.let( - :PROCESSING_ERROR, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - RECURRING_TRANSACTION_NOT_CANCELLED = - T.let( - :RECURRING_TRANSACTION_NOT_CANCELLED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - REFUND_NOT_PROCESSED = - T.let( - :REFUND_NOT_PROCESSED, - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeRetrieveResponse::Reason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - module ResolutionReason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CASE_LOST = - T.let( - :CASE_LOST, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NETWORK_REJECTED = - T.let( - :NETWORK_REJECTED, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_3DS = - T.let( - :NO_DISPUTE_RIGHTS_3DS, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = - T.let( - :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_CONTACTLESS = - T.let( - :NO_DISPUTE_RIGHTS_CONTACTLESS, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_HYBRID = - T.let( - :NO_DISPUTE_RIGHTS_HYBRID, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = - T.let( - :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_OTHER = - T.let( - :NO_DISPUTE_RIGHTS_OTHER, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - PAST_FILING_DATE = - T.let( - :PAST_FILING_DATE, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - PREARBITRATION_REJECTED = - T.let( - :PREARBITRATION_REJECTED, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - PROCESSOR_REJECTED_OTHER = - T.let( - :PROCESSOR_REJECTED_OTHER, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED = - T.let( - :REFUNDED, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED_AFTER_CHARGEBACK = - T.let( - :REFUNDED_AFTER_CHARGEBACK, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - WON_ARBITRATION = - T.let( - :WON_ARBITRATION, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - WON_FIRST_CHARGEBACK = - T.let( - :WON_FIRST_CHARGEBACK, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - WON_PREARBITRATION = - T.let( - :WON_PREARBITRATION, - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeRetrieveResponse::ResolutionReason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - module Status - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeRetrieveResponse::Status) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - CASE_CLOSED = - T.let( - :CASE_CLOSED, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - CASE_WON = - T.let( - :CASE_WON, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - NEW = - T.let( - :NEW, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - PENDING_CUSTOMER = - T.let( - :PENDING_CUSTOMER, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - SUBMITTED = - T.let( - :SUBMITTED, - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeRetrieveResponse::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/lithic/models/dispute_update_response.rbi b/rbi/lithic/models/dispute_update_response.rbi deleted file mode 100644 index 38647ea1..00000000 --- a/rbi/lithic/models/dispute_update_response.rbi +++ /dev/null @@ -1,599 +0,0 @@ -# typed: strong - -module Lithic - module Models - class DisputeUpdateResponse < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::Models::DisputeUpdateResponse, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(String) } - attr_accessor :token - - # Amount under dispute. May be different from the original transaction amount. - sig { returns(Integer) } - attr_accessor :amount - - # Date dispute entered arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :arbitration_date - - # Timestamp of when first Dispute was reported. - sig { returns(Time) } - attr_accessor :created - - # Date that the dispute was filed by the customer making the dispute. - sig { returns(T.nilable(Time)) } - attr_accessor :customer_filed_date - - # End customer description of the reason for the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :customer_note - - # Unique identifiers for the dispute from the network. - sig { returns(T.nilable(T::Array[String])) } - attr_accessor :network_claim_ids - - # Date that the dispute was submitted to the network. - sig { returns(T.nilable(Time)) } - attr_accessor :network_filed_date - - # Network reason code used to file the dispute. - sig { returns(T.nilable(String)) } - attr_accessor :network_reason_code - - # Date dispute entered pre-arbitration. - sig { returns(T.nilable(Time)) } - attr_accessor :prearbitration_date - - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - sig { returns(T.nilable(String)) } - attr_accessor :primary_claim_id - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - sig do - returns(Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol) - end - attr_accessor :reason - - # Date the representment was received. - sig { returns(T.nilable(Time)) } - attr_accessor :representment_date - - # Date that the dispute was resolved. - sig { returns(T.nilable(Time)) } - attr_accessor :resolution_date - - # Note by Dispute team on the case resolution. - sig { returns(T.nilable(String)) } - attr_accessor :resolution_note - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - sig do - returns( - T.nilable( - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - ) - end - attr_accessor :resolution_reason - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - sig do - returns(Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol) - end - attr_accessor :status - - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - sig { returns(String) } - attr_accessor :transaction_token - - # Dispute. - sig do - params( - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeUpdateResponse::Reason::OrSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeUpdateResponse::ResolutionReason::OrSymbol - ), - status: Lithic::Models::DisputeUpdateResponse::Status::OrSymbol, - transaction_token: String - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token:, - # Amount under dispute. May be different from the original transaction amount. - amount:, - # Date dispute entered arbitration. - arbitration_date:, - # Timestamp of when first Dispute was reported. - created:, - # Date that the dispute was filed by the customer making the dispute. - customer_filed_date:, - # End customer description of the reason for the dispute. - customer_note:, - # Unique identifiers for the dispute from the network. - network_claim_ids:, - # Date that the dispute was submitted to the network. - network_filed_date:, - # Network reason code used to file the dispute. - network_reason_code:, - # Date dispute entered pre-arbitration. - prearbitration_date:, - # Unique identifier for the dispute from the network. If there are multiple, this - # will be the first claim id set by the network - primary_claim_id:, - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - reason:, - # Date the representment was received. - representment_date:, - # Date that the dispute was resolved. - resolution_date:, - # Note by Dispute team on the case resolution. - resolution_note:, - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - resolution_reason:, - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - status:, - # The transaction that is being disputed. A transaction can only be disputed once - # but may have multiple dispute cases. - transaction_token: - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - arbitration_date: T.nilable(Time), - created: Time, - customer_filed_date: T.nilable(Time), - customer_note: T.nilable(String), - network_claim_ids: T.nilable(T::Array[String]), - network_filed_date: T.nilable(Time), - network_reason_code: T.nilable(String), - prearbitration_date: T.nilable(Time), - primary_claim_id: T.nilable(String), - reason: Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol, - representment_date: T.nilable(Time), - resolution_date: T.nilable(Time), - resolution_note: T.nilable(String), - resolution_reason: - T.nilable( - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ), - status: Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol, - transaction_token: String - } - ) - end - def to_hash - end - - # Dispute reason: - # - # - `ATM_CASH_MISDISPENSE`: ATM cash misdispense. - # - `CANCELLED`: Transaction was cancelled by the customer. - # - `DUPLICATED`: The transaction was a duplicate. - # - `FRAUD_CARD_NOT_PRESENT`: Fraudulent transaction, card not present. - # - `FRAUD_CARD_PRESENT`: Fraudulent transaction, card present. - # - `FRAUD_OTHER`: Fraudulent transaction, other types such as questionable - # merchant activity. - # - `GOODS_SERVICES_NOT_AS_DESCRIBED`: The goods or services were not as - # described. - # - `GOODS_SERVICES_NOT_RECEIVED`: The goods or services were not received. - # - `INCORRECT_AMOUNT`: The transaction amount was incorrect. - # - `MISSING_AUTH`: The transaction was missing authorization. - # - `OTHER`: Other reason. - # - `PROCESSING_ERROR`: Processing error. - # - `REFUND_NOT_PROCESSED`: The refund was not processed. - # - `RECURRING_TRANSACTION_NOT_CANCELLED`: The recurring transaction was not - # cancelled. - module Reason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeUpdateResponse::Reason) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ATM_CASH_MISDISPENSE = - T.let( - :ATM_CASH_MISDISPENSE, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - CANCELLED = - T.let( - :CANCELLED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - DUPLICATED = - T.let( - :DUPLICATED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_NOT_PRESENT = - T.let( - :FRAUD_CARD_NOT_PRESENT, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - FRAUD_CARD_PRESENT = - T.let( - :FRAUD_CARD_PRESENT, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - FRAUD_OTHER = - T.let( - :FRAUD_OTHER, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_AS_DESCRIBED = - T.let( - :GOODS_SERVICES_NOT_AS_DESCRIBED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - GOODS_SERVICES_NOT_RECEIVED = - T.let( - :GOODS_SERVICES_NOT_RECEIVED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - INCORRECT_AMOUNT = - T.let( - :INCORRECT_AMOUNT, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - MISSING_AUTH = - T.let( - :MISSING_AUTH, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - OTHER = - T.let( - :OTHER, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - PROCESSING_ERROR = - T.let( - :PROCESSING_ERROR, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - RECURRING_TRANSACTION_NOT_CANCELLED = - T.let( - :RECURRING_TRANSACTION_NOT_CANCELLED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - REFUND_NOT_PROCESSED = - T.let( - :REFUND_NOT_PROCESSED, - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeUpdateResponse::Reason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Reason for the dispute resolution: - # - # - `CASE_LOST`: This case was lost at final arbitration. - # - `NETWORK_REJECTED`: Network rejected. - # - `NO_DISPUTE_RIGHTS_3DS`: No dispute rights, 3DS. - # - `NO_DISPUTE_RIGHTS_BELOW_THRESHOLD`: No dispute rights, below threshold. - # - `NO_DISPUTE_RIGHTS_CONTACTLESS`: No dispute rights, contactless. - # - `NO_DISPUTE_RIGHTS_HYBRID`: No dispute rights, hybrid. - # - `NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS`: No dispute rights, max chargebacks. - # - `NO_DISPUTE_RIGHTS_OTHER`: No dispute rights, other. - # - `PAST_FILING_DATE`: Past filing date. - # - `PREARBITRATION_REJECTED`: Prearbitration rejected. - # - `PROCESSOR_REJECTED_OTHER`: Processor rejected, other. - # - `REFUNDED`: Refunded. - # - `REFUNDED_AFTER_CHARGEBACK`: Refunded after chargeback. - # - `WITHDRAWN`: Withdrawn. - # - `WON_ARBITRATION`: Won arbitration. - # - `WON_FIRST_CHARGEBACK`: Won first chargeback. - # - `WON_PREARBITRATION`: Won prearbitration. - module ResolutionReason - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - Lithic::Models::DisputeUpdateResponse::ResolutionReason - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - CASE_LOST = - T.let( - :CASE_LOST, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NETWORK_REJECTED = - T.let( - :NETWORK_REJECTED, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_3DS = - T.let( - :NO_DISPUTE_RIGHTS_3DS, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD = - T.let( - :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_CONTACTLESS = - T.let( - :NO_DISPUTE_RIGHTS_CONTACTLESS, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_HYBRID = - T.let( - :NO_DISPUTE_RIGHTS_HYBRID, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS = - T.let( - :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - NO_DISPUTE_RIGHTS_OTHER = - T.let( - :NO_DISPUTE_RIGHTS_OTHER, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - PAST_FILING_DATE = - T.let( - :PAST_FILING_DATE, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - PREARBITRATION_REJECTED = - T.let( - :PREARBITRATION_REJECTED, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - PROCESSOR_REJECTED_OTHER = - T.let( - :PROCESSOR_REJECTED_OTHER, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED = - T.let( - :REFUNDED, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - REFUNDED_AFTER_CHARGEBACK = - T.let( - :REFUNDED_AFTER_CHARGEBACK, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - WITHDRAWN = - T.let( - :WITHDRAWN, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - WON_ARBITRATION = - T.let( - :WON_ARBITRATION, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - WON_FIRST_CHARGEBACK = - T.let( - :WON_FIRST_CHARGEBACK, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - WON_PREARBITRATION = - T.let( - :WON_PREARBITRATION, - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeUpdateResponse::ResolutionReason::TaggedSymbol - ] - ) - end - def self.values - end - end - - # Status types: - # - # - `NEW` - New dispute case is opened. - # - `PENDING_CUSTOMER` - Lithic is waiting for customer to provide more - # information. - # - `SUBMITTED` - Dispute is submitted to the card network. - # - `REPRESENTMENT` - Case has entered second presentment. - # - `PREARBITRATION` - Case has entered prearbitration. - # - `ARBITRATION` - Case has entered arbitration. - # - `CASE_WON` - Case was won and credit will be issued. - # - `CASE_CLOSED` - Case was lost or withdrawn. - module Status - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::Models::DisputeUpdateResponse::Status) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ARBITRATION = - T.let( - :ARBITRATION, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - CASE_CLOSED = - T.let( - :CASE_CLOSED, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - CASE_WON = - T.let( - :CASE_WON, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - NEW = - T.let( - :NEW, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - PENDING_CUSTOMER = - T.let( - :PENDING_CUSTOMER, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - PREARBITRATION = - T.let( - :PREARBITRATION, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - REPRESENTMENT = - T.let( - :REPRESENTMENT, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - SUBMITTED = - T.let( - :SUBMITTED, - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::Models::DisputeUpdateResponse::Status::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end -end diff --git a/rbi/lithic/models/dispute_v2.rbi b/rbi/lithic/models/dispute_v2.rbi new file mode 100644 index 00000000..f7a8f41b --- /dev/null +++ b/rbi/lithic/models/dispute_v2.rbi @@ -0,0 +1,965 @@ +# typed: strong + +module Lithic + module Models + class DisputeV2 < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Lithic::DisputeV2, Lithic::Internal::AnyHash) } + + # Token assigned by Lithic for the dispute, in UUID format. + sig { returns(String) } + attr_accessor :token + + # Token for the account associated with the dispute, in UUID format. + sig { returns(String) } + attr_accessor :account_token + + # Token for the card used in the dispute, in UUID format. + sig { returns(String) } + attr_accessor :card_token + + # Identifier assigned by the network for this dispute. + sig { returns(T.nilable(String)) } + attr_accessor :case_id + + # When the dispute was created. + sig { returns(Time) } + attr_accessor :created + + # Three-letter ISO 4217 currency code. + sig { returns(String) } + attr_accessor :currency + + # Dispute resolution outcome + sig { returns(T.nilable(Lithic::DisputeV2::Disposition::TaggedSymbol)) } + attr_accessor :disposition + + # Chronological list of events that have occurred in the dispute lifecycle + sig { returns(T::Array[Lithic::DisputeV2::Event]) } + attr_accessor :events + + # Current breakdown of how liability is allocated for the disputed amount + sig { returns(Lithic::DisputeV2::LiabilityAllocation) } + attr_reader :liability_allocation + + sig do + params( + liability_allocation: Lithic::DisputeV2::LiabilityAllocation::OrHash + ).void + end + attr_writer :liability_allocation + + sig { returns(Lithic::Merchant) } + attr_reader :merchant + + sig { params(merchant: Lithic::Merchant::OrHash).void } + attr_writer :merchant + + # Card network handling the dispute. + sig { returns(Lithic::DisputeV2::Network::TaggedSymbol) } + attr_accessor :network + + # Current status of the dispute. + sig { returns(T.nilable(Lithic::DisputeV2::Status::TaggedSymbol)) } + attr_accessor :status + + # Contains identifiers for the transaction and specific event within being + # disputed; null if no transaction can be identified + sig { returns(T.nilable(Lithic::DisputeV2::TransactionSeries)) } + attr_reader :transaction_series + + sig do + params( + transaction_series: + T.nilable(Lithic::DisputeV2::TransactionSeries::OrHash) + ).void + end + attr_writer :transaction_series + + # When the dispute was last updated. + sig { returns(Time) } + attr_accessor :updated + + # The Dispute object tracks the progression of a dispute throughout its lifecycle. + sig do + params( + token: String, + account_token: String, + card_token: String, + case_id: T.nilable(String), + created: Time, + currency: String, + disposition: T.nilable(Lithic::DisputeV2::Disposition::OrSymbol), + events: T::Array[Lithic::DisputeV2::Event::OrHash], + liability_allocation: Lithic::DisputeV2::LiabilityAllocation::OrHash, + merchant: Lithic::Merchant::OrHash, + network: Lithic::DisputeV2::Network::OrSymbol, + status: T.nilable(Lithic::DisputeV2::Status::OrSymbol), + transaction_series: + T.nilable(Lithic::DisputeV2::TransactionSeries::OrHash), + updated: Time + ).returns(T.attached_class) + end + def self.new( + # Token assigned by Lithic for the dispute, in UUID format. + token:, + # Token for the account associated with the dispute, in UUID format. + account_token:, + # Token for the card used in the dispute, in UUID format. + card_token:, + # Identifier assigned by the network for this dispute. + case_id:, + # When the dispute was created. + created:, + # Three-letter ISO 4217 currency code. + currency:, + # Dispute resolution outcome + disposition:, + # Chronological list of events that have occurred in the dispute lifecycle + events:, + # Current breakdown of how liability is allocated for the disputed amount + liability_allocation:, + merchant:, + # Card network handling the dispute. + network:, + # Current status of the dispute. + status:, + # Contains identifiers for the transaction and specific event within being + # disputed; null if no transaction can be identified + transaction_series:, + # When the dispute was last updated. + updated: + ) + end + + sig do + override.returns( + { + token: String, + account_token: String, + card_token: String, + case_id: T.nilable(String), + created: Time, + currency: String, + disposition: + T.nilable(Lithic::DisputeV2::Disposition::TaggedSymbol), + events: T::Array[Lithic::DisputeV2::Event], + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::DisputeV2::Network::TaggedSymbol, + status: T.nilable(Lithic::DisputeV2::Status::TaggedSymbol), + transaction_series: T.nilable(Lithic::DisputeV2::TransactionSeries), + updated: Time + } + ) + end + def to_hash + end + + # Dispute resolution outcome + module Disposition + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::DisputeV2::Disposition) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WON = T.let(:WON, Lithic::DisputeV2::Disposition::TaggedSymbol) + LOST = T.let(:LOST, Lithic::DisputeV2::Disposition::TaggedSymbol) + PARTIALLY_WON = + T.let(:PARTIALLY_WON, Lithic::DisputeV2::Disposition::TaggedSymbol) + WITHDRAWN = + T.let(:WITHDRAWN, Lithic::DisputeV2::Disposition::TaggedSymbol) + DENIED = T.let(:DENIED, Lithic::DisputeV2::Disposition::TaggedSymbol) + + sig do + override.returns( + T::Array[Lithic::DisputeV2::Disposition::TaggedSymbol] + ) + end + def self.values + end + end + + class Event < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Lithic::DisputeV2::Event, Lithic::Internal::AnyHash) + end + + # Unique identifier for the event, in UUID format + sig { returns(String) } + attr_accessor :token + + # When the event occurred + sig { returns(Time) } + attr_accessor :created + + # Details specific to the event type + sig { returns(Lithic::DisputeV2::Event::Data::Variants) } + attr_accessor :data + + # Type of event + sig { returns(Lithic::DisputeV2::Event::Type::TaggedSymbol) } + attr_accessor :type + + # Event that occurred in the dispute lifecycle + sig do + params( + token: String, + created: Time, + data: + T.any( + Lithic::DisputeV2::Event::Data::Workflow::OrHash, + Lithic::DisputeV2::Event::Data::Financial::OrHash, + Lithic::DisputeV2::Event::Data::CardholderLiability::OrHash + ), + type: Lithic::DisputeV2::Event::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Unique identifier for the event, in UUID format + token:, + # When the event occurred + created:, + # Details specific to the event type + data:, + # Type of event + type: + ) + end + + sig do + override.returns( + { + token: String, + created: Time, + data: Lithic::DisputeV2::Event::Data::Variants, + type: Lithic::DisputeV2::Event::Type::TaggedSymbol + } + ) + end + def to_hash + end + + # Details specific to the event type + module Data + extend Lithic::Internal::Type::Union + + Variants = + T.type_alias do + T.any( + Lithic::DisputeV2::Event::Data::Workflow, + Lithic::DisputeV2::Event::Data::Financial, + Lithic::DisputeV2::Event::Data::CardholderLiability + ) + end + + class Workflow < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::DisputeV2::Event::Data::Workflow, + Lithic::Internal::AnyHash + ) + end + + # Action taken in this stage + sig do + returns( + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol + ) + end + attr_accessor :action + + # Amount in minor units + sig { returns(T.nilable(Integer)) } + attr_accessor :amount + + # Dispute resolution outcome + sig do + returns( + T.nilable( + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + ) + end + attr_accessor :disposition + + # Reason for the action + sig { returns(T.nilable(String)) } + attr_accessor :reason + + # Current stage of the dispute workflow + sig do + returns( + Lithic::DisputeV2::Event::Data::Workflow::Stage::TaggedSymbol + ) + end + attr_accessor :stage + + # Event type discriminator + sig { returns(Symbol) } + attr_accessor :type + + # Details specific to workflow events + sig do + params( + action: + Lithic::DisputeV2::Event::Data::Workflow::Action::OrSymbol, + amount: T.nilable(Integer), + disposition: + T.nilable( + Lithic::DisputeV2::Event::Data::Workflow::Disposition::OrSymbol + ), + reason: T.nilable(String), + stage: + Lithic::DisputeV2::Event::Data::Workflow::Stage::OrSymbol, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Action taken in this stage + action:, + # Amount in minor units + amount:, + # Dispute resolution outcome + disposition:, + # Reason for the action + reason:, + # Current stage of the dispute workflow + stage:, + # Event type discriminator + type: :WORKFLOW + ) + end + + sig do + override.returns( + { + action: + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol, + amount: T.nilable(Integer), + disposition: + T.nilable( + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ), + reason: T.nilable(String), + stage: + Lithic::DisputeV2::Event::Data::Workflow::Stage::TaggedSymbol, + type: Symbol + } + ) + end + def to_hash + end + + # Action taken in this stage + module Action + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::DisputeV2::Event::Data::Workflow::Action + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OPENED = + T.let( + :OPENED, + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol + ) + CLOSED = + T.let( + :CLOSED, + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol + ) + REOPENED = + T.let( + :REOPENED, + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::Workflow::Action::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Dispute resolution outcome + module Disposition + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::DisputeV2::Event::Data::Workflow::Disposition + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WON = + T.let( + :WON, + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + LOST = + T.let( + :LOST, + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + PARTIALLY_WON = + T.let( + :PARTIALLY_WON, + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + WITHDRAWN = + T.let( + :WITHDRAWN, + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + DENIED = + T.let( + :DENIED, + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::Workflow::Disposition::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Current stage of the dispute workflow + module Stage + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Lithic::DisputeV2::Event::Data::Workflow::Stage) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CLAIM = + T.let( + :CLAIM, + Lithic::DisputeV2::Event::Data::Workflow::Stage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::Workflow::Stage::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class Financial < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::DisputeV2::Event::Data::Financial, + Lithic::Internal::AnyHash + ) + end + + # Amount in minor units + sig { returns(Integer) } + attr_accessor :amount + + # Direction of funds flow + sig do + returns( + Lithic::DisputeV2::Event::Data::Financial::Polarity::TaggedSymbol + ) + end + attr_accessor :polarity + + # Stage at which the financial event occurred + sig do + returns( + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + end + attr_accessor :stage + + # Event type discriminator + sig { returns(Symbol) } + attr_accessor :type + + # Details specific to financial events + sig do + params( + amount: Integer, + polarity: + Lithic::DisputeV2::Event::Data::Financial::Polarity::OrSymbol, + stage: + Lithic::DisputeV2::Event::Data::Financial::Stage::OrSymbol, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Amount in minor units + amount:, + # Direction of funds flow + polarity:, + # Stage at which the financial event occurred + stage:, + # Event type discriminator + type: :FINANCIAL + ) + end + + sig do + override.returns( + { + amount: Integer, + polarity: + Lithic::DisputeV2::Event::Data::Financial::Polarity::TaggedSymbol, + stage: + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol, + type: Symbol + } + ) + end + def to_hash + end + + # Direction of funds flow + module Polarity + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::DisputeV2::Event::Data::Financial::Polarity + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CREDIT = + T.let( + :CREDIT, + Lithic::DisputeV2::Event::Data::Financial::Polarity::TaggedSymbol + ) + DEBIT = + T.let( + :DEBIT, + Lithic::DisputeV2::Event::Data::Financial::Polarity::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::Financial::Polarity::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Stage at which the financial event occurred + module Stage + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::DisputeV2::Event::Data::Financial::Stage + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHARGEBACK = + T.let( + :CHARGEBACK, + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + REPRESENTMENT = + T.let( + :REPRESENTMENT, + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + PREARBITRATION = + T.let( + :PREARBITRATION, + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + ARBITRATION = + T.let( + :ARBITRATION, + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + COLLABORATION = + T.let( + :COLLABORATION, + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::Financial::Stage::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + class CardholderLiability < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::DisputeV2::Event::Data::CardholderLiability, + Lithic::Internal::AnyHash + ) + end + + # Action taken regarding cardholder liability + sig do + returns( + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol + ) + end + attr_accessor :action + + # Amount in minor units + sig { returns(Integer) } + attr_accessor :amount + + # Reason for the action + sig { returns(String) } + attr_accessor :reason + + # Event type discriminator + sig { returns(Symbol) } + attr_accessor :type + + # Details specific to cardholder liability events + sig do + params( + action: + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::OrSymbol, + amount: Integer, + reason: String, + type: Symbol + ).returns(T.attached_class) + end + def self.new( + # Action taken regarding cardholder liability + action:, + # Amount in minor units + amount:, + # Reason for the action + reason:, + # Event type discriminator + type: :CARDHOLDER_LIABILITY + ) + end + + sig do + override.returns( + { + action: + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol, + amount: Integer, + reason: String, + type: Symbol + } + ) + end + def to_hash + end + + # Action taken regarding cardholder liability + module Action + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::DisputeV2::Event::Data::CardholderLiability::Action + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PROVISIONAL_CREDIT_GRANTED = + T.let( + :PROVISIONAL_CREDIT_GRANTED, + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol + ) + PROVISIONAL_CREDIT_REVERSED = + T.let( + :PROVISIONAL_CREDIT_REVERSED, + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol + ) + WRITTEN_OFF = + T.let( + :WRITTEN_OFF, + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::DisputeV2::Event::Data::CardholderLiability::Action::TaggedSymbol + ] + ) + end + def self.values + end + end + end + + sig do + override.returns(T::Array[Lithic::DisputeV2::Event::Data::Variants]) + end + def self.variants + end + end + + # Type of event + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::DisputeV2::Event::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + WORKFLOW = + T.let(:WORKFLOW, Lithic::DisputeV2::Event::Type::TaggedSymbol) + FINANCIAL = + T.let(:FINANCIAL, Lithic::DisputeV2::Event::Type::TaggedSymbol) + CARDHOLDER_LIABILITY = + T.let( + :CARDHOLDER_LIABILITY, + Lithic::DisputeV2::Event::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Lithic::DisputeV2::Event::Type::TaggedSymbol] + ) + end + def self.values + end + end + end + + class LiabilityAllocation < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::DisputeV2::LiabilityAllocation, + Lithic::Internal::AnyHash + ) + end + + # The amount that has been denied to the cardholder + sig { returns(Integer) } + attr_accessor :denied_amount + + # The initial amount disputed + sig { returns(Integer) } + attr_accessor :original_amount + + # The amount that has been recovered from the merchant through the dispute process + sig { returns(Integer) } + attr_accessor :recovered_amount + + # Any disputed amount that is still outstanding, i.e. has not been recovered, + # written off, or denied + sig { returns(Integer) } + attr_accessor :remaining_amount + + # The amount the issuer has chosen to write off + sig { returns(Integer) } + attr_accessor :written_off_amount + + # Current breakdown of how liability is allocated for the disputed amount + sig do + params( + denied_amount: Integer, + original_amount: Integer, + recovered_amount: Integer, + remaining_amount: Integer, + written_off_amount: Integer + ).returns(T.attached_class) + end + def self.new( + # The amount that has been denied to the cardholder + denied_amount:, + # The initial amount disputed + original_amount:, + # The amount that has been recovered from the merchant through the dispute process + recovered_amount:, + # Any disputed amount that is still outstanding, i.e. has not been recovered, + # written off, or denied + remaining_amount:, + # The amount the issuer has chosen to write off + written_off_amount: + ) + end + + sig do + override.returns( + { + denied_amount: Integer, + original_amount: Integer, + recovered_amount: Integer, + remaining_amount: Integer, + written_off_amount: Integer + } + ) + end + def to_hash + end + end + + # Card network handling the dispute. + module Network + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::DisputeV2::Network) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + VISA = T.let(:VISA, Lithic::DisputeV2::Network::TaggedSymbol) + MASTERCARD = + T.let(:MASTERCARD, Lithic::DisputeV2::Network::TaggedSymbol) + + sig do + override.returns(T::Array[Lithic::DisputeV2::Network::TaggedSymbol]) + end + def self.values + end + end + + # Current status of the dispute. + module Status + extend Lithic::Internal::Type::Enum + + TaggedSymbol = T.type_alias { T.all(Symbol, Lithic::DisputeV2::Status) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OPEN = T.let(:OPEN, Lithic::DisputeV2::Status::TaggedSymbol) + CLOSED = T.let(:CLOSED, Lithic::DisputeV2::Status::TaggedSymbol) + + sig do + override.returns(T::Array[Lithic::DisputeV2::Status::TaggedSymbol]) + end + def self.values + end + end + + class TransactionSeries < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::DisputeV2::TransactionSeries, + Lithic::Internal::AnyHash + ) + end + + # Token of the specific event in the original transaction being disputed, in UUID + # format; null if no event can be identified + sig { returns(T.nilable(String)) } + attr_accessor :related_transaction_event_token + + # Token of the original transaction being disputed, in UUID format + sig { returns(String) } + attr_accessor :related_transaction_token + + # The type of transaction series associating the dispute and the original + # transaction. Always set to DISPUTE + sig do + returns(Lithic::DisputeV2::TransactionSeries::Type::TaggedSymbol) + end + attr_accessor :type + + # Contains identifiers for the transaction and specific event within being + # disputed; null if no transaction can be identified + sig do + params( + related_transaction_event_token: T.nilable(String), + related_transaction_token: String, + type: Lithic::DisputeV2::TransactionSeries::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Token of the specific event in the original transaction being disputed, in UUID + # format; null if no event can be identified + related_transaction_event_token:, + # Token of the original transaction being disputed, in UUID format + related_transaction_token:, + # The type of transaction series associating the dispute and the original + # transaction. Always set to DISPUTE + type: + ) + end + + sig do + override.returns( + { + related_transaction_event_token: T.nilable(String), + related_transaction_token: String, + type: Lithic::DisputeV2::TransactionSeries::Type::TaggedSymbol + } + ) + end + def to_hash + end + + # The type of transaction series associating the dispute and the original + # transaction. Always set to DISPUTE + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, Lithic::DisputeV2::TransactionSeries::Type) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + DISPUTE = + T.let( + :DISPUTE, + Lithic::DisputeV2::TransactionSeries::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[Lithic::DisputeV2::TransactionSeries::Type::TaggedSymbol] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/lithic/models/disputes_v2_list_params.rbi b/rbi/lithic/models/disputes_v2_list_params.rbi new file mode 100644 index 00000000..4dd93783 --- /dev/null +++ b/rbi/lithic/models/disputes_v2_list_params.rbi @@ -0,0 +1,129 @@ +# typed: strong + +module Lithic + module Models + class DisputesV2ListParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Lithic::DisputesV2ListParams, Lithic::Internal::AnyHash) + end + + # Filter by account token. + sig { returns(T.nilable(String)) } + attr_reader :account_token + + sig { params(account_token: String).void } + attr_writer :account_token + + # RFC 3339 timestamp for filtering by created date, inclusive. + sig { returns(T.nilable(Time)) } + attr_reader :begin_ + + sig { params(begin_: Time).void } + attr_writer :begin_ + + # Filter by card token. + sig { returns(T.nilable(String)) } + attr_reader :card_token + + sig { params(card_token: String).void } + attr_writer :card_token + + # Filter by the token of the transaction being disputed. Corresponds with + # transaction_series.related_transaction_token in the Dispute. + sig { returns(T.nilable(String)) } + attr_reader :disputed_transaction_token + + sig { params(disputed_transaction_token: String).void } + attr_writer :disputed_transaction_token + + # RFC 3339 timestamp for filtering by created date, inclusive. + 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 + + # Number of items to return. + sig { returns(T.nilable(Integer)) } + attr_reader :page_size + + sig { params(page_size: Integer).void } + attr_writer :page_size + + # 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 + + sig do + params( + account_token: String, + begin_: Time, + card_token: String, + disputed_transaction_token: String, + end_: Time, + ending_before: String, + page_size: Integer, + starting_after: String, + request_options: Lithic::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Filter by account token. + account_token: nil, + # RFC 3339 timestamp for filtering by created date, inclusive. + begin_: nil, + # Filter by card token. + card_token: nil, + # Filter by the token of the transaction being disputed. Corresponds with + # transaction_series.related_transaction_token in the Dispute. + disputed_transaction_token: nil, + # RFC 3339 timestamp for filtering by created date, inclusive. + end_: nil, + # 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. + ending_before: nil, + # Number of items to return. + page_size: nil, + # 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. + starting_after: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + account_token: String, + begin_: Time, + card_token: String, + disputed_transaction_token: String, + end_: Time, + ending_before: String, + page_size: Integer, + starting_after: String, + request_options: Lithic::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/disputes_v2_retrieve_params.rbi b/rbi/lithic/models/disputes_v2_retrieve_params.rbi new file mode 100644 index 00000000..2432f72c --- /dev/null +++ b/rbi/lithic/models/disputes_v2_retrieve_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module Lithic + module Models + class DisputesV2RetrieveParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Lithic::DisputesV2RetrieveParams, Lithic::Internal::AnyHash) + end + + sig do + params(request_options: Lithic::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Lithic::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/external_bank_account_address.rbi b/rbi/lithic/models/external_bank_account_address.rbi index b6f88308..d75ff5c2 100644 --- a/rbi/lithic/models/external_bank_account_address.rbi +++ b/rbi/lithic/models/external_bank_account_address.rbi @@ -24,10 +24,7 @@ module Lithic attr_accessor :state sig { returns(T.nilable(String)) } - attr_reader :address2 - - sig { params(address2: String).void } - attr_writer :address2 + attr_accessor :address2 sig do params( @@ -36,7 +33,7 @@ module Lithic country: String, postal_code: String, state: String, - address2: String + address2: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -57,7 +54,7 @@ module Lithic country: String, postal_code: String, state: String, - address2: String + address2: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_create_response.rbi b/rbi/lithic/models/external_bank_account_create_response.rbi index a82816d6..27e0fde0 100644 --- a/rbi/lithic/models/external_bank_account_create_response.rbi +++ b/rbi/lithic/models/external_bank_account_create_response.rbi @@ -94,68 +94,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -177,15 +157,15 @@ module Lithic Lithic::Models::ExternalBankAccountCreateResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountCreateResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -268,15 +248,15 @@ module Lithic Lithic::Models::ExternalBankAccountCreateResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountCreateResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_list_response.rbi b/rbi/lithic/models/external_bank_account_list_response.rbi index af63e841..36acf69d 100644 --- a/rbi/lithic/models/external_bank_account_list_response.rbi +++ b/rbi/lithic/models/external_bank_account_list_response.rbi @@ -94,68 +94,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -176,15 +156,15 @@ module Lithic Lithic::Models::ExternalBankAccountListResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountListResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -267,15 +247,15 @@ module Lithic Lithic::Models::ExternalBankAccountListResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountListResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_retrieve_response.rbi b/rbi/lithic/models/external_bank_account_retrieve_response.rbi index 0785fd83..de65ad48 100644 --- a/rbi/lithic/models/external_bank_account_retrieve_response.rbi +++ b/rbi/lithic/models/external_bank_account_retrieve_response.rbi @@ -94,68 +94,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -177,15 +157,15 @@ module Lithic Lithic::Models::ExternalBankAccountRetrieveResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -268,15 +248,15 @@ module Lithic Lithic::Models::ExternalBankAccountRetrieveResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi b/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi index a474ccc4..db729557 100644 --- a/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi +++ b/rbi/lithic/models/external_bank_account_retry_micro_deposits_response.rbi @@ -94,68 +94,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -177,15 +157,15 @@ module Lithic Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -268,15 +248,15 @@ module Lithic Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi b/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi index d72a4792..39aa9d31 100644 --- a/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi +++ b/rbi/lithic/models/external_bank_account_retry_prenote_response.rbi @@ -86,68 +86,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -167,15 +147,15 @@ module Lithic verification_method: Lithic::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -256,15 +236,15 @@ module Lithic verification_method: Lithic::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_account_unpause_params.rbi b/rbi/lithic/models/external_bank_account_unpause_params.rbi new file mode 100644 index 00000000..7cb0c83f --- /dev/null +++ b/rbi/lithic/models/external_bank_account_unpause_params.rbi @@ -0,0 +1,30 @@ +# typed: strong + +module Lithic + module Models + class ExternalBankAccountUnpauseParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any( + Lithic::ExternalBankAccountUnpauseParams, + Lithic::Internal::AnyHash + ) + end + + sig do + params(request_options: Lithic::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: Lithic::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/external_bank_account_unpause_response.rbi b/rbi/lithic/models/external_bank_account_unpause_response.rbi new file mode 100644 index 00000000..ba8730e8 --- /dev/null +++ b/rbi/lithic/models/external_bank_account_unpause_response.rbi @@ -0,0 +1,375 @@ +# typed: strong + +module Lithic + module Models + class ExternalBankAccountUnpauseResponse < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::Models::ExternalBankAccountUnpauseResponse, + Lithic::Internal::AnyHash + ) + end + + # A globally unique identifier for this record of an external bank account + # association. If a program links an external bank account to more than one + # end-user or to both the program and the end-user, then Lithic will return each + # record of the association + sig { returns(String) } + attr_accessor :token + + # The country that the bank account is located in using ISO 3166-1. We will only + # accept USA bank accounts e.g., USA + sig { returns(String) } + attr_accessor :country + + # An ISO 8601 string representing when this funding source was added to the Lithic + # account. + sig { returns(Time) } + attr_accessor :created + + # currency of the external account 3-character alphabetic ISO 4217 code + sig { returns(String) } + attr_accessor :currency + + # The last 4 digits of the bank account. Derived by Lithic from the account number + # passed + sig { returns(String) } + attr_accessor :last_four + + # Legal Name of the business or individual who owns the external account. This + # will appear in statements + sig { returns(String) } + attr_accessor :owner + + # Owner Type + sig { returns(Lithic::OwnerType::TaggedSymbol) } + attr_accessor :owner_type + + # Routing Number + sig { returns(String) } + attr_accessor :routing_number + + # Account State + sig do + returns( + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol + ) + end + attr_accessor :state + + # Account Type + sig do + returns( + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::TaggedSymbol + ) + end + attr_accessor :type + + # The number of attempts at verification + sig { returns(Integer) } + attr_accessor :verification_attempts + + # Verification Method + sig { returns(Lithic::VerificationMethod::TaggedSymbol) } + attr_accessor :verification_method + + # Verification State + sig do + returns( + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ) + end + attr_accessor :verification_state + + # Indicates which Lithic account the external account is associated with. For + # external accounts that are associated with the program, account_token field + # returned will be null + sig { returns(T.nilable(String)) } + attr_accessor :account_token + + # Address + sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } + attr_reader :address + + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end + attr_writer :address + + # Optional field that helps identify bank accounts in receipts + sig { returns(T.nilable(String)) } + attr_accessor :company_id + + # Date of Birth of the Individual that owns the external bank account + sig { returns(T.nilable(Date)) } + attr_accessor :dob + + # Doing Business As + sig { returns(T.nilable(String)) } + attr_accessor :doing_business_as + + # The financial account token of the operating account to fund the micro deposits + sig { returns(T.nilable(String)) } + attr_accessor :financial_account_token + + # The nickname for this External Bank Account + sig { returns(T.nilable(String)) } + attr_accessor :name + + # User Defined ID + sig { returns(T.nilable(String)) } + attr_accessor :user_defined_id + + # Optional free text description of the reason for the failed verification. For + # ACH micro-deposits returned, this field will display the reason return code sent + # by the ACH network + sig { returns(T.nilable(String)) } + attr_accessor :verification_failed_reason + + sig do + params( + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::OwnerType::OrSymbol, + routing_number: String, + state: + Lithic::Models::ExternalBankAccountUnpauseResponse::State::OrSymbol, + type: + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::OrSymbol, + verification_attempts: Integer, + verification_method: Lithic::VerificationMethod::OrSymbol, + verification_state: + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::OrSymbol, + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + # A globally unique identifier for this record of an external bank account + # association. If a program links an external bank account to more than one + # end-user or to both the program and the end-user, then Lithic will return each + # record of the association + token:, + # The country that the bank account is located in using ISO 3166-1. We will only + # accept USA bank accounts e.g., USA + country:, + # An ISO 8601 string representing when this funding source was added to the Lithic + # account. + created:, + # currency of the external account 3-character alphabetic ISO 4217 code + currency:, + # The last 4 digits of the bank account. Derived by Lithic from the account number + # passed + last_four:, + # Legal Name of the business or individual who owns the external account. This + # will appear in statements + owner:, + # Owner Type + owner_type:, + # Routing Number + routing_number:, + # Account State + state:, + # Account Type + type:, + # The number of attempts at verification + verification_attempts:, + # Verification Method + verification_method:, + # Verification State + verification_state:, + # Indicates which Lithic account the external account is associated with. For + # external accounts that are associated with the program, account_token field + # returned will be null + account_token: nil, + # Address + address: nil, + # Optional field that helps identify bank accounts in receipts + company_id: nil, + # Date of Birth of the Individual that owns the external bank account + dob: nil, + # Doing Business As + doing_business_as: nil, + # The financial account token of the operating account to fund the micro deposits + financial_account_token: nil, + # The nickname for this External Bank Account + name: nil, + # User Defined ID + user_defined_id: nil, + # Optional free text description of the reason for the failed verification. For + # ACH micro-deposits returned, this field will display the reason return code sent + # by the ACH network + verification_failed_reason: nil + ) + end + + sig do + override.returns( + { + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::OwnerType::TaggedSymbol, + routing_number: String, + state: + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol, + type: + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::TaggedSymbol, + verification_attempts: Integer, + verification_method: Lithic::VerificationMethod::TaggedSymbol, + verification_state: + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol, + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) + } + ) + end + def to_hash + end + + # Account State + module State + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::Models::ExternalBankAccountUnpauseResponse::State + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ENABLED = + T.let( + :ENABLED, + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol + ) + CLOSED = + T.let( + :CLOSED, + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol + ) + PAUSED = + T.let( + :PAUSED, + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::Models::ExternalBankAccountUnpauseResponse::State::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Account Type + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::Models::ExternalBankAccountUnpauseResponse::Type + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CHECKING = + T.let( + :CHECKING, + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::TaggedSymbol + ) + SAVINGS = + T.let( + :SAVINGS, + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::Models::ExternalBankAccountUnpauseResponse::Type::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Verification State + module VerificationState + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + PENDING = + T.let( + :PENDING, + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ) + ENABLED = + T.let( + :ENABLED, + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ) + FAILED_VERIFICATION = + T.let( + :FAILED_VERIFICATION, + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ) + INSUFFICIENT_FUNDS = + T.let( + :INSUFFICIENT_FUNDS, + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/lithic/models/external_bank_account_update_response.rbi b/rbi/lithic/models/external_bank_account_update_response.rbi index 4cc5de3d..f54376f5 100644 --- a/rbi/lithic/models/external_bank_account_update_response.rbi +++ b/rbi/lithic/models/external_bank_account_update_response.rbi @@ -94,68 +94,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -177,15 +157,15 @@ module Lithic Lithic::Models::ExternalBankAccountUpdateResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -268,15 +248,15 @@ module Lithic Lithic::Models::ExternalBankAccountUpdateResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi b/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi index cf50db6c..7d10603b 100644 --- a/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi +++ b/rbi/lithic/models/external_bank_accounts/micro_deposit_create_response.rbi @@ -95,68 +95,48 @@ module Lithic # external accounts that are associated with the program, account_token field # returned will be null sig { returns(T.nilable(String)) } - attr_reader :account_token - - sig { params(account_token: String).void } - attr_writer :account_token + attr_accessor :account_token # Address sig { returns(T.nilable(Lithic::ExternalBankAccountAddress)) } attr_reader :address - sig { params(address: Lithic::ExternalBankAccountAddress::OrHash).void } + sig do + params( + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash) + ).void + end attr_writer :address # Optional field that helps identify bank accounts in receipts sig { returns(T.nilable(String)) } - attr_reader :company_id - - sig { params(company_id: String).void } - attr_writer :company_id + attr_accessor :company_id # Date of Birth of the Individual that owns the external bank account sig { returns(T.nilable(Date)) } - attr_reader :dob - - sig { params(dob: Date).void } - attr_writer :dob + attr_accessor :dob # Doing Business As sig { returns(T.nilable(String)) } - attr_reader :doing_business_as - - sig { params(doing_business_as: String).void } - attr_writer :doing_business_as + attr_accessor :doing_business_as # The financial account token of the operating account to fund the micro deposits sig { returns(T.nilable(String)) } - attr_reader :financial_account_token - - sig { params(financial_account_token: String).void } - attr_writer :financial_account_token + attr_accessor :financial_account_token # The nickname for this External Bank Account sig { returns(T.nilable(String)) } - attr_reader :name - - sig { params(name: String).void } - attr_writer :name + attr_accessor :name # User Defined ID sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id # Optional free text description of the reason for the failed verification. For # ACH micro-deposits returned, this field will display the reason return code sent # by the ACH network sig { returns(T.nilable(String)) } - attr_reader :verification_failed_reason - - sig { params(verification_failed_reason: String).void } - attr_writer :verification_failed_reason + attr_accessor :verification_failed_reason sig do params( @@ -178,15 +158,15 @@ module Lithic Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod::OrSymbol, verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState::OrSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress::OrHash, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress::OrHash), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -269,15 +249,15 @@ module Lithic Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationMethod::TaggedSymbol, verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::VerificationState::TaggedSymbol, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: T.nilable(String), + address: T.nilable(Lithic::ExternalBankAccountAddress), + company_id: T.nilable(String), + dob: T.nilable(Date), + doing_business_as: T.nilable(String), + financial_account_token: T.nilable(String), + name: T.nilable(String), + user_defined_id: T.nilable(String), + verification_failed_reason: T.nilable(String) } ) end diff --git a/rbi/lithic/models/external_payment.rbi b/rbi/lithic/models/external_payment.rbi index 5e773fa4..e587dc4f 100644 --- a/rbi/lithic/models/external_payment.rbi +++ b/rbi/lithic/models/external_payment.rbi @@ -90,10 +90,7 @@ module Lithic attr_writer :settled_amount sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id sig do params( @@ -110,7 +107,7 @@ module Lithic pending_amount: Integer, result: Lithic::ExternalPayment::Result::OrSymbol, settled_amount: Integer, - user_defined_id: String + user_defined_id: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -152,7 +149,7 @@ module Lithic pending_amount: Integer, result: Lithic::ExternalPayment::Result::TaggedSymbol, settled_amount: Integer, - user_defined_id: String + user_defined_id: T.nilable(String) } ) end @@ -175,6 +172,8 @@ module Lithic T.let(:REVERSED, Lithic::ExternalPayment::Status::TaggedSymbol) CANCELED = T.let(:CANCELED, Lithic::ExternalPayment::Status::TaggedSymbol) + RETURNED = + T.let(:RETURNED, Lithic::ExternalPayment::Status::TaggedSymbol) sig do override.returns( diff --git a/rbi/lithic/models/external_payment_list_params.rbi b/rbi/lithic/models/external_payment_list_params.rbi index 383bf56a..a95ffcfd 100644 --- a/rbi/lithic/models/external_payment_list_params.rbi +++ b/rbi/lithic/models/external_payment_list_params.rbi @@ -270,6 +270,11 @@ module Lithic :CANCELED, Lithic::ExternalPaymentListParams::Status::TaggedSymbol ) + RETURNED = + T.let( + :RETURNED, + Lithic::ExternalPaymentListParams::Status::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/lithic/models/financial_account.rbi b/rbi/lithic/models/financial_account.rbi index 690f3c7e..d5b67207 100644 --- a/rbi/lithic/models/financial_account.rbi +++ b/rbi/lithic/models/financial_account.rbi @@ -129,7 +129,9 @@ module Lithic sig do returns( - Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration + T.nilable( + Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration + ) ) end attr_reader :auto_collection_configuration @@ -137,7 +139,9 @@ module Lithic sig do params( auto_collection_configuration: - Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration::OrHash + T.nilable( + Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration::OrHash + ) ).void end attr_writer :auto_collection_configuration @@ -159,7 +163,9 @@ module Lithic sig do params( auto_collection_configuration: - Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration::OrHash, + T.nilable( + Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration::OrHash + ), credit_limit: T.nilable(Integer), credit_product_token: T.nilable(String), external_bank_account_token: T.nilable(String), @@ -181,7 +187,9 @@ module Lithic override.returns( { auto_collection_configuration: - Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, + T.nilable( + Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration + ), credit_limit: T.nilable(Integer), credit_product_token: T.nilable(String), external_bank_account_token: T.nilable(String), diff --git a/rbi/lithic/models/financial_accounts/category_balances.rbi b/rbi/lithic/models/financial_accounts/category_balances.rbi new file mode 100644 index 00000000..6fab8951 --- /dev/null +++ b/rbi/lithic/models/financial_accounts/category_balances.rbi @@ -0,0 +1,42 @@ +# typed: strong + +module Lithic + module Models + module FinancialAccounts + class CategoryBalances < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::FinancialAccounts::CategoryBalances, + Lithic::Internal::AnyHash + ) + end + + sig { returns(Integer) } + attr_accessor :fees + + sig { returns(Integer) } + attr_accessor :interest + + sig { returns(Integer) } + attr_accessor :principal + + sig do + params(fees: Integer, interest: Integer, principal: Integer).returns( + T.attached_class + ) + end + def self.new(fees:, interest:, principal:) + end + + sig do + override.returns( + { fees: Integer, interest: Integer, principal: Integer } + ) + end + def to_hash + end + end + end + end +end diff --git a/rbi/lithic/models/financial_accounts/loan_tape.rbi b/rbi/lithic/models/financial_accounts/loan_tape.rbi index c18c1e65..26791021 100644 --- a/rbi/lithic/models/financial_accounts/loan_tape.rbi +++ b/rbi/lithic/models/financial_accounts/loan_tape.rbi @@ -59,14 +59,10 @@ module Lithic sig { returns(Date) } attr_accessor :date - sig { returns(Lithic::FinancialAccounts::LoanTape::DayTotals) } + sig { returns(Lithic::StatementTotals) } attr_reader :day_totals - sig do - params( - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals::OrHash - ).void - end + sig { params(day_totals: Lithic::StatementTotals::OrHash).void } attr_writer :day_totals # Balance at the end of the day @@ -113,26 +109,21 @@ module Lithic end attr_writer :minimum_payment_balance - sig { returns(Lithic::FinancialAccounts::LoanTape::PaymentAllocation) } + sig { returns(Lithic::FinancialAccounts::CategoryBalances) } attr_reader :payment_allocation sig do params( payment_allocation: - Lithic::FinancialAccounts::LoanTape::PaymentAllocation::OrHash + Lithic::FinancialAccounts::CategoryBalances::OrHash ).void end attr_writer :payment_allocation - sig { returns(Lithic::FinancialAccounts::LoanTape::PeriodTotals) } + sig { returns(Lithic::StatementTotals) } attr_reader :period_totals - sig do - params( - period_totals: - Lithic::FinancialAccounts::LoanTape::PeriodTotals::OrHash - ).void - end + sig { params(period_totals: Lithic::StatementTotals::OrHash).void } attr_writer :period_totals sig do @@ -160,22 +151,15 @@ module Lithic sig { returns(Integer) } attr_accessor :version - sig { returns(Lithic::FinancialAccounts::LoanTape::YtdTotals) } + sig { returns(Lithic::StatementTotals) } attr_reader :ytd_totals - sig do - params( - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals::OrHash - ).void - end + sig { params(ytd_totals: Lithic::StatementTotals::OrHash).void } attr_writer :ytd_totals # Interest tier to which this account belongs to sig { returns(T.nilable(String)) } - attr_reader :tier - - sig { params(tier: String).void } - attr_writer :tier + attr_accessor :tier sig do params( @@ -188,7 +172,7 @@ module Lithic credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals::OrHash, + day_totals: Lithic::StatementTotals::OrHash, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, @@ -199,16 +183,15 @@ module Lithic minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance::OrHash, payment_allocation: - Lithic::FinancialAccounts::LoanTape::PaymentAllocation::OrHash, - period_totals: - Lithic::FinancialAccounts::LoanTape::PeriodTotals::OrHash, + Lithic::FinancialAccounts::CategoryBalances::OrHash, + period_totals: Lithic::StatementTotals::OrHash, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance::OrHash, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals::OrHash, - tier: String + ytd_totals: Lithic::StatementTotals::OrHash, + tier: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -266,7 +249,7 @@ module Lithic credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, @@ -274,16 +257,15 @@ module Lithic T.nilable(Lithic::FinancialAccounts::LoanTape::InterestDetails), minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: - Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, - tier: String + ytd_totals: Lithic::StatementTotals, + tier: T.nilable(String) } ) end @@ -606,12 +588,12 @@ module Lithic # Amount due for the prior billing cycle. Any amounts not fully paid off on this # due date will be considered past due the next day - sig { returns(Lithic::FinancialAccounts::LoanTape::Balances::Due) } + sig { returns(Lithic::FinancialAccounts::CategoryBalances) } attr_reader :due sig do params( - due: Lithic::FinancialAccounts::LoanTape::Balances::Due::OrHash + due: Lithic::FinancialAccounts::CategoryBalances::OrHash ).void end attr_writer :due @@ -619,60 +601,48 @@ module Lithic # Amount due for the current billing cycle. Any amounts not paid off by early # payments or credits will be considered due at the end of the current billing # period - sig do - returns( - Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue - ) - end + sig { returns(Lithic::FinancialAccounts::CategoryBalances) } attr_reader :next_statement_due sig do params( next_statement_due: - Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue::OrHash + Lithic::FinancialAccounts::CategoryBalances::OrHash ).void end attr_writer :next_statement_due # Amount not paid off on previous due dates - sig do - returns(Lithic::FinancialAccounts::LoanTape::Balances::PastDue) - end + sig { returns(Lithic::FinancialAccounts::CategoryBalances) } attr_reader :past_due sig do params( - past_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastDue::OrHash + past_due: Lithic::FinancialAccounts::CategoryBalances::OrHash ).void end attr_writer :past_due # Amount due for the past billing cycles. - sig do - returns( - Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue - ) - end + sig { returns(Lithic::FinancialAccounts::CategoryBalances) } attr_reader :past_statements_due sig do params( past_statements_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue::OrHash + Lithic::FinancialAccounts::CategoryBalances::OrHash ).void end attr_writer :past_statements_due sig do params( - due: Lithic::FinancialAccounts::LoanTape::Balances::Due::OrHash, + due: Lithic::FinancialAccounts::CategoryBalances::OrHash, next_statement_due: - Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue::OrHash, - past_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastDue::OrHash, + Lithic::FinancialAccounts::CategoryBalances::OrHash, + past_due: Lithic::FinancialAccounts::CategoryBalances::OrHash, past_statements_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue::OrHash + Lithic::FinancialAccounts::CategoryBalances::OrHash ).returns(T.attached_class) end def self.new( @@ -693,294 +663,10 @@ module Lithic sig do override.returns( { - due: Lithic::FinancialAccounts::LoanTape::Balances::Due, - next_statement_due: - Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue, - past_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastDue, - past_statements_due: - Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue - } - ) - end - def to_hash - end - - class Due < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::Balances::Due, - Lithic::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :fees - - sig { returns(Integer) } - attr_accessor :interest - - sig { returns(Integer) } - attr_accessor :principal - - # Amount due for the prior billing cycle. Any amounts not fully paid off on this - # due date will be considered past due the next day - sig do - params( - fees: Integer, - interest: Integer, - principal: Integer - ).returns(T.attached_class) - end - def self.new(fees:, interest:, principal:) - end - - sig do - override.returns( - { fees: Integer, interest: Integer, principal: Integer } - ) - end - def to_hash - end - end - - class NextStatementDue < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue, - Lithic::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :fees - - sig { returns(Integer) } - attr_accessor :interest - - sig { returns(Integer) } - attr_accessor :principal - - # Amount due for the current billing cycle. Any amounts not paid off by early - # payments or credits will be considered due at the end of the current billing - # period - sig do - params( - fees: Integer, - interest: Integer, - principal: Integer - ).returns(T.attached_class) - end - def self.new(fees:, interest:, principal:) - end - - sig do - override.returns( - { fees: Integer, interest: Integer, principal: Integer } - ) - end - def to_hash - end - end - - class PastDue < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::Balances::PastDue, - Lithic::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :fees - - sig { returns(Integer) } - attr_accessor :interest - - sig { returns(Integer) } - attr_accessor :principal - - # Amount not paid off on previous due dates - sig do - params( - fees: Integer, - interest: Integer, - principal: Integer - ).returns(T.attached_class) - end - def self.new(fees:, interest:, principal:) - end - - sig do - override.returns( - { fees: Integer, interest: Integer, principal: Integer } - ) - end - def to_hash - end - end - - class PastStatementsDue < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue, - Lithic::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :fees - - sig { returns(Integer) } - attr_accessor :interest - - sig { returns(Integer) } - attr_accessor :principal - - # Amount due for the past billing cycles. - sig do - params( - fees: Integer, - interest: Integer, - principal: Integer - ).returns(T.attached_class) - end - def self.new(fees:, interest:, principal:) - end - - sig do - override.returns( - { fees: Integer, interest: Integer, principal: Integer } - ) - end - def to_hash - end - end - end - - class DayTotals < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::DayTotals, - Lithic::Internal::AnyHash - ) - end - - # Opening balance transferred from previous account in cents - sig { returns(Integer) } - attr_accessor :balance_transfers - - # ATM and cashback transactions in cents - sig { returns(Integer) } - attr_accessor :cash_advances - - # Volume of credit management operation transactions less any balance transfers in - # cents - sig { returns(Integer) } - attr_accessor :credits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :debits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :fees - - # Interest accrued in cents - sig { returns(Integer) } - attr_accessor :interest - - # Any funds transfers which affective the balance in cents - sig { returns(Integer) } - attr_accessor :payments - - # Net card transaction volume less any cash advances in cents - sig { returns(Integer) } - attr_accessor :purchases - - # Breakdown of credits - sig { returns(T.nilable(T.anything)) } - attr_reader :credit_details - - sig { params(credit_details: T.anything).void } - attr_writer :credit_details - - # Breakdown of debits - sig { returns(T.nilable(T.anything)) } - attr_reader :debit_details - - sig { params(debit_details: T.anything).void } - attr_writer :debit_details - - # Breakdown of payments - sig { returns(T.nilable(T.anything)) } - attr_reader :payment_details - - sig { params(payment_details: T.anything).void } - attr_writer :payment_details - - sig do - params( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - ).returns(T.attached_class) - end - def self.new( - # Opening balance transferred from previous account in cents - balance_transfers:, - # ATM and cashback transactions in cents - cash_advances:, - # Volume of credit management operation transactions less any balance transfers in - # cents - credits:, - # Volume of debit management operation transactions less any interest in cents - debits:, - # Volume of debit management operation transactions less any interest in cents - fees:, - # Interest accrued in cents - interest:, - # Any funds transfers which affective the balance in cents - payments:, - # Net card transaction volume less any cash advances in cents - purchases:, - # Breakdown of credits - credit_details: nil, - # Breakdown of debits - debit_details: nil, - # Breakdown of payments - payment_details: nil - ) - end - - sig do - override.returns( - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything + due: Lithic::FinancialAccounts::CategoryBalances, + next_statement_due: Lithic::FinancialAccounts::CategoryBalances, + past_due: Lithic::FinancialAccounts::CategoryBalances, + past_statements_due: Lithic::FinancialAccounts::CategoryBalances } ) end @@ -1000,34 +686,18 @@ module Lithic sig { returns(T.nilable(Integer)) } attr_accessor :actual_interest_charged - sig do - returns( - Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :daily_balance_amounts sig do - params( - daily_balance_amounts: - Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts::OrHash - ).void + params(daily_balance_amounts: Lithic::CategoryDetails::OrHash).void end attr_writer :daily_balance_amounts - sig do - returns( - Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :effective_apr - sig do - params( - effective_apr: - Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr::OrHash - ).void - end + sig { params(effective_apr: Lithic::CategoryDetails::OrHash).void } attr_writer :effective_apr sig do @@ -1037,18 +707,11 @@ module Lithic end attr_accessor :interest_calculation_method - sig do - returns( - Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :interest_for_period sig do - params( - interest_for_period: - Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod::OrHash - ).void + params(interest_for_period: Lithic::CategoryDetails::OrHash).void end attr_writer :interest_for_period @@ -1061,14 +724,11 @@ module Lithic sig do params( actual_interest_charged: T.nilable(Integer), - daily_balance_amounts: - Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts::OrHash, - effective_apr: - Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr::OrHash, + daily_balance_amounts: Lithic::CategoryDetails::OrHash, + effective_apr: Lithic::CategoryDetails::OrHash, interest_calculation_method: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod::OrSymbol, - interest_for_period: - Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod::OrHash, + interest_for_period: Lithic::CategoryDetails::OrHash, prime_rate: T.nilable(String), minimum_interest_charged: T.nilable(Integer) ).returns(T.attached_class) @@ -1088,14 +748,11 @@ module Lithic override.returns( { actual_interest_charged: T.nilable(Integer), - daily_balance_amounts: - Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts, - effective_apr: - Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestCalculationMethod::TaggedSymbol, - interest_for_period: - Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: T.nilable(String), minimum_interest_charged: T.nilable(Integer) } @@ -1104,88 +761,6 @@ module Lithic def to_hash end - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts, - Lithic::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :balance_transfers - - sig { returns(String) } - attr_accessor :cash_advances - - sig { returns(String) } - attr_accessor :purchases - - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end - - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end - end - - class EffectiveApr < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr, - Lithic::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :balance_transfers - - sig { returns(String) } - attr_accessor :cash_advances - - sig { returns(String) } - attr_accessor :purchases - - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end - - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end - end - module InterestCalculationMethod extend Lithic::Internal::Type::Enum @@ -1219,47 +794,6 @@ module Lithic def self.values end end - - class InterestForPeriod < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod, - Lithic::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :balance_transfers - - sig { returns(String) } - attr_accessor :cash_advances - - sig { returns(String) } - attr_accessor :purchases - - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end - - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end - end end class MinimumPaymentBalance < Lithic::Internal::Type::BaseModel @@ -1290,169 +824,6 @@ module Lithic end end - class PaymentAllocation < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - Lithic::Internal::AnyHash - ) - end - - sig { returns(Integer) } - attr_accessor :fees - - sig { returns(Integer) } - attr_accessor :interest - - sig { returns(Integer) } - attr_accessor :principal - - sig do - params( - fees: Integer, - interest: Integer, - principal: Integer - ).returns(T.attached_class) - end - def self.new(fees:, interest:, principal:) - end - - sig do - override.returns( - { fees: Integer, interest: Integer, principal: Integer } - ) - end - def to_hash - end - end - - class PeriodTotals < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::PeriodTotals, - Lithic::Internal::AnyHash - ) - end - - # Opening balance transferred from previous account in cents - sig { returns(Integer) } - attr_accessor :balance_transfers - - # ATM and cashback transactions in cents - sig { returns(Integer) } - attr_accessor :cash_advances - - # Volume of credit management operation transactions less any balance transfers in - # cents - sig { returns(Integer) } - attr_accessor :credits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :debits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :fees - - # Interest accrued in cents - sig { returns(Integer) } - attr_accessor :interest - - # Any funds transfers which affective the balance in cents - sig { returns(Integer) } - attr_accessor :payments - - # Net card transaction volume less any cash advances in cents - sig { returns(Integer) } - attr_accessor :purchases - - # Breakdown of credits - sig { returns(T.nilable(T.anything)) } - attr_reader :credit_details - - sig { params(credit_details: T.anything).void } - attr_writer :credit_details - - # Breakdown of debits - sig { returns(T.nilable(T.anything)) } - attr_reader :debit_details - - sig { params(debit_details: T.anything).void } - attr_writer :debit_details - - # Breakdown of payments - sig { returns(T.nilable(T.anything)) } - attr_reader :payment_details - - sig { params(payment_details: T.anything).void } - attr_writer :payment_details - - sig do - params( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - ).returns(T.attached_class) - end - def self.new( - # Opening balance transferred from previous account in cents - balance_transfers:, - # ATM and cashback transactions in cents - cash_advances:, - # Volume of credit management operation transactions less any balance transfers in - # cents - credits:, - # Volume of debit management operation transactions less any interest in cents - debits:, - # Volume of debit management operation transactions less any interest in cents - fees:, - # Interest accrued in cents - interest:, - # Any funds transfers which affective the balance in cents - payments:, - # Net card transaction volume less any cash advances in cents - purchases:, - # Breakdown of credits - credit_details: nil, - # Breakdown of debits - debit_details: nil, - # Breakdown of payments - payment_details: nil - ) - end - - sig do - override.returns( - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - } - ) - end - def to_hash - end - end - class PreviousStatementBalance < Lithic::Internal::Type::BaseModel OrHash = T.type_alias do @@ -1480,132 +851,6 @@ module Lithic def to_hash end end - - class YtdTotals < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::LoanTape::YtdTotals, - Lithic::Internal::AnyHash - ) - end - - # Opening balance transferred from previous account in cents - sig { returns(Integer) } - attr_accessor :balance_transfers - - # ATM and cashback transactions in cents - sig { returns(Integer) } - attr_accessor :cash_advances - - # Volume of credit management operation transactions less any balance transfers in - # cents - sig { returns(Integer) } - attr_accessor :credits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :debits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :fees - - # Interest accrued in cents - sig { returns(Integer) } - attr_accessor :interest - - # Any funds transfers which affective the balance in cents - sig { returns(Integer) } - attr_accessor :payments - - # Net card transaction volume less any cash advances in cents - sig { returns(Integer) } - attr_accessor :purchases - - # Breakdown of credits - sig { returns(T.nilable(T.anything)) } - attr_reader :credit_details - - sig { params(credit_details: T.anything).void } - attr_writer :credit_details - - # Breakdown of debits - sig { returns(T.nilable(T.anything)) } - attr_reader :debit_details - - sig { params(debit_details: T.anything).void } - attr_writer :debit_details - - # Breakdown of payments - sig { returns(T.nilable(T.anything)) } - attr_reader :payment_details - - sig { params(payment_details: T.anything).void } - attr_writer :payment_details - - sig do - params( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - ).returns(T.attached_class) - end - def self.new( - # Opening balance transferred from previous account in cents - balance_transfers:, - # ATM and cashback transactions in cents - cash_advances:, - # Volume of credit management operation transactions less any balance transfers in - # cents - credits:, - # Volume of debit management operation transactions less any interest in cents - debits:, - # Volume of debit management operation transactions less any interest in cents - fees:, - # Interest accrued in cents - interest:, - # Any funds transfers which affective the balance in cents - payments:, - # Net card transaction volume less any cash advances in cents - purchases:, - # Breakdown of credits - credit_details: nil, - # Breakdown of debits - debit_details: nil, - # Breakdown of payments - payment_details: nil - ) - end - - sig do - override.returns( - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - } - ) - end - def to_hash - end - end end end end diff --git a/rbi/lithic/models/financial_accounts/statement.rbi b/rbi/lithic/models/financial_accounts/statement.rbi index 96326be4..2a999bb1 100644 --- a/rbi/lithic/models/financial_accounts/statement.rbi +++ b/rbi/lithic/models/financial_accounts/statement.rbi @@ -70,15 +70,10 @@ module Lithic sig { returns(T.nilable(Date)) } attr_accessor :payment_due_date - sig { returns(Lithic::FinancialAccounts::Statement::PeriodTotals) } + sig { returns(Lithic::StatementTotals) } attr_reader :period_totals - sig do - params( - period_totals: - Lithic::FinancialAccounts::Statement::PeriodTotals::OrHash - ).void - end + sig { params(period_totals: Lithic::StatementTotals::OrHash).void } attr_writer :period_totals # Balance at the start of the billing period @@ -104,14 +99,10 @@ module Lithic sig { returns(Time) } attr_accessor :updated - sig { returns(Lithic::FinancialAccounts::Statement::YtdTotals) } + sig { returns(Lithic::StatementTotals) } attr_reader :ytd_totals - sig do - params( - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals::OrHash - ).void - end + sig { params(ytd_totals: Lithic::StatementTotals::OrHash).void } attr_writer :ytd_totals sig do @@ -145,6 +136,24 @@ module Lithic sig { params(next_statement_end_date: Date).void } attr_writer :next_statement_end_date + # Details on number and size of payments to pay off balance + sig do + returns( + T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails) + ) + end + attr_reader :payoff_details + + sig do + params( + payoff_details: + T.nilable( + Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash + ) + ).void + end + attr_writer :payoff_details + sig do params( token: String, @@ -159,21 +168,24 @@ module Lithic ending_balance: Integer, financial_account_token: String, payment_due_date: T.nilable(Date), - period_totals: - Lithic::FinancialAccounts::Statement::PeriodTotals::OrHash, + period_totals: Lithic::StatementTotals::OrHash, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::FinancialAccounts::Statement::StatementType::OrSymbol, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals::OrHash, + ytd_totals: Lithic::StatementTotals::OrHash, interest_details: T.nilable( Lithic::FinancialAccounts::Statement::InterestDetails::OrHash ), next_payment_due_date: Date, - next_statement_end_date: Date + next_statement_end_date: Date, + payoff_details: + T.nilable( + Lithic::FinancialAccounts::Statement::PayoffDetails::OrHash + ) ).returns(T.attached_class) end def self.new( @@ -213,7 +225,9 @@ module Lithic # Date when the next payment is due next_payment_due_date: nil, # Date when the next billing period will end - next_statement_end_date: nil + next_statement_end_date: nil, + # Details on number and size of payments to pay off balance + payoff_details: nil ) end @@ -232,20 +246,22 @@ module Lithic ending_balance: Integer, financial_account_token: String, payment_due_date: T.nilable(Date), - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::FinancialAccounts::Statement::StatementType::TaggedSymbol, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, interest_details: T.nilable( Lithic::FinancialAccounts::Statement::InterestDetails ), next_payment_due_date: Date, - next_statement_end_date: Date + next_statement_end_date: Date, + payoff_details: + T.nilable(Lithic::FinancialAccounts::Statement::PayoffDetails) } ) end @@ -596,132 +612,6 @@ module Lithic end end - class PeriodTotals < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::Statement::PeriodTotals, - Lithic::Internal::AnyHash - ) - end - - # Opening balance transferred from previous account in cents - sig { returns(Integer) } - attr_accessor :balance_transfers - - # ATM and cashback transactions in cents - sig { returns(Integer) } - attr_accessor :cash_advances - - # Volume of credit management operation transactions less any balance transfers in - # cents - sig { returns(Integer) } - attr_accessor :credits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :debits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :fees - - # Interest accrued in cents - sig { returns(Integer) } - attr_accessor :interest - - # Any funds transfers which affective the balance in cents - sig { returns(Integer) } - attr_accessor :payments - - # Net card transaction volume less any cash advances in cents - sig { returns(Integer) } - attr_accessor :purchases - - # Breakdown of credits - sig { returns(T.nilable(T.anything)) } - attr_reader :credit_details - - sig { params(credit_details: T.anything).void } - attr_writer :credit_details - - # Breakdown of debits - sig { returns(T.nilable(T.anything)) } - attr_reader :debit_details - - sig { params(debit_details: T.anything).void } - attr_writer :debit_details - - # Breakdown of payments - sig { returns(T.nilable(T.anything)) } - attr_reader :payment_details - - sig { params(payment_details: T.anything).void } - attr_writer :payment_details - - sig do - params( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - ).returns(T.attached_class) - end - def self.new( - # Opening balance transferred from previous account in cents - balance_transfers:, - # ATM and cashback transactions in cents - cash_advances:, - # Volume of credit management operation transactions less any balance transfers in - # cents - credits:, - # Volume of debit management operation transactions less any interest in cents - debits:, - # Volume of debit management operation transactions less any interest in cents - fees:, - # Interest accrued in cents - interest:, - # Any funds transfers which affective the balance in cents - payments:, - # Net card transaction volume less any cash advances in cents - purchases:, - # Breakdown of credits - credit_details: nil, - # Breakdown of debits - debit_details: nil, - # Breakdown of payments - payment_details: nil - ) - end - - sig do - override.returns( - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - } - ) - end - def to_hash - end - end - module StatementType extend Lithic::Internal::Type::Enum @@ -758,132 +648,6 @@ module Lithic end end - class YtdTotals < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::Statement::YtdTotals, - Lithic::Internal::AnyHash - ) - end - - # Opening balance transferred from previous account in cents - sig { returns(Integer) } - attr_accessor :balance_transfers - - # ATM and cashback transactions in cents - sig { returns(Integer) } - attr_accessor :cash_advances - - # Volume of credit management operation transactions less any balance transfers in - # cents - sig { returns(Integer) } - attr_accessor :credits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :debits - - # Volume of debit management operation transactions less any interest in cents - sig { returns(Integer) } - attr_accessor :fees - - # Interest accrued in cents - sig { returns(Integer) } - attr_accessor :interest - - # Any funds transfers which affective the balance in cents - sig { returns(Integer) } - attr_accessor :payments - - # Net card transaction volume less any cash advances in cents - sig { returns(Integer) } - attr_accessor :purchases - - # Breakdown of credits - sig { returns(T.nilable(T.anything)) } - attr_reader :credit_details - - sig { params(credit_details: T.anything).void } - attr_writer :credit_details - - # Breakdown of debits - sig { returns(T.nilable(T.anything)) } - attr_reader :debit_details - - sig { params(debit_details: T.anything).void } - attr_writer :debit_details - - # Breakdown of payments - sig { returns(T.nilable(T.anything)) } - attr_reader :payment_details - - sig { params(payment_details: T.anything).void } - attr_writer :payment_details - - sig do - params( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - ).returns(T.attached_class) - end - def self.new( - # Opening balance transferred from previous account in cents - balance_transfers:, - # ATM and cashback transactions in cents - cash_advances:, - # Volume of credit management operation transactions less any balance transfers in - # cents - credits:, - # Volume of debit management operation transactions less any interest in cents - debits:, - # Volume of debit management operation transactions less any interest in cents - fees:, - # Interest accrued in cents - interest:, - # Any funds transfers which affective the balance in cents - payments:, - # Net card transaction volume less any cash advances in cents - purchases:, - # Breakdown of credits - credit_details: nil, - # Breakdown of debits - debit_details: nil, - # Breakdown of payments - payment_details: nil - ) - end - - sig do - override.returns( - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: T.anything, - debit_details: T.anything, - payment_details: T.anything - } - ) - end - def to_hash - end - end - class InterestDetails < Lithic::Internal::Type::BaseModel OrHash = T.type_alias do @@ -896,34 +660,18 @@ module Lithic sig { returns(T.nilable(Integer)) } attr_accessor :actual_interest_charged - sig do - returns( - Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :daily_balance_amounts sig do - params( - daily_balance_amounts: - Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts::OrHash - ).void + params(daily_balance_amounts: Lithic::CategoryDetails::OrHash).void end attr_writer :daily_balance_amounts - sig do - returns( - Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :effective_apr - sig do - params( - effective_apr: - Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr::OrHash - ).void - end + sig { params(effective_apr: Lithic::CategoryDetails::OrHash).void } attr_writer :effective_apr sig do @@ -933,18 +681,11 @@ module Lithic end attr_accessor :interest_calculation_method - sig do - returns( - Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod - ) - end + sig { returns(Lithic::CategoryDetails) } attr_reader :interest_for_period sig do - params( - interest_for_period: - Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod::OrHash - ).void + params(interest_for_period: Lithic::CategoryDetails::OrHash).void end attr_writer :interest_for_period @@ -957,14 +698,11 @@ module Lithic sig do params( actual_interest_charged: T.nilable(Integer), - daily_balance_amounts: - Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts::OrHash, - effective_apr: - Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr::OrHash, + daily_balance_amounts: Lithic::CategoryDetails::OrHash, + effective_apr: Lithic::CategoryDetails::OrHash, interest_calculation_method: Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod::OrSymbol, - interest_for_period: - Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod::OrHash, + interest_for_period: Lithic::CategoryDetails::OrHash, prime_rate: T.nilable(String), minimum_interest_charged: T.nilable(Integer) ).returns(T.attached_class) @@ -984,14 +722,11 @@ module Lithic override.returns( { actual_interest_charged: T.nilable(Integer), - daily_balance_amounts: - Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts, - effective_apr: - Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::FinancialAccounts::Statement::InterestDetails::InterestCalculationMethod::TaggedSymbol, - interest_for_period: - Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: T.nilable(String), minimum_interest_charged: T.nilable(Integer) } @@ -1000,88 +735,6 @@ module Lithic def to_hash end - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts, - Lithic::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :balance_transfers - - sig { returns(String) } - attr_accessor :cash_advances - - sig { returns(String) } - attr_accessor :purchases - - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end - - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end - end - - class EffectiveApr < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr, - Lithic::Internal::AnyHash - ) - end - - sig { returns(String) } - attr_accessor :balance_transfers - - sig { returns(String) } - attr_accessor :cash_advances - - sig { returns(String) } - attr_accessor :purchases - - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end - - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end - end - module InterestCalculationMethod extend Lithic::Internal::Type::Enum @@ -1115,46 +768,81 @@ module Lithic def self.values end end + end - class InterestForPeriod < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod, - Lithic::Internal::AnyHash - ) - end + class PayoffDetails < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + Lithic::FinancialAccounts::Statement::PayoffDetails, + Lithic::Internal::AnyHash + ) + end - sig { returns(String) } - attr_accessor :balance_transfers + # The number of months it would take to pay off the balance in full by only paying + # the minimum payment. "NA" will signal negative or zero amortization + sig { returns(String) } + attr_accessor :minimum_payment_months - sig { returns(String) } - attr_accessor :cash_advances + # The sum of all interest and principal paid, in cents, when only paying minimum + # monthly payment. "NA" will signal negative or zero amortization + sig { returns(String) } + attr_accessor :minimum_payment_total - sig { returns(String) } - attr_accessor :purchases + # Number of months to full pay off + sig { returns(Integer) } + attr_accessor :payoff_period_length_months - sig do - params( - balance_transfers: String, - cash_advances: String, - purchases: String - ).returns(T.attached_class) - end - def self.new(balance_transfers:, cash_advances:, purchases:) - end + # The amount needed to be paid, in cents, each month in order to pay off current + # balance in the payoff period + sig { returns(Integer) } + attr_accessor :payoff_period_monthly_payment_amount - sig do - override.returns( - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - ) - end - def to_hash - end + # The sum of all interest and principal paid, in cents, when paying off in the + # payoff period + sig { returns(Integer) } + attr_accessor :payoff_period_payment_total + + # Details on number and size of payments to pay off balance + sig do + params( + minimum_payment_months: String, + minimum_payment_total: String, + payoff_period_length_months: Integer, + payoff_period_monthly_payment_amount: Integer, + payoff_period_payment_total: Integer + ).returns(T.attached_class) + end + def self.new( + # The number of months it would take to pay off the balance in full by only paying + # the minimum payment. "NA" will signal negative or zero amortization + minimum_payment_months:, + # The sum of all interest and principal paid, in cents, when only paying minimum + # monthly payment. "NA" will signal negative or zero amortization + minimum_payment_total:, + # Number of months to full pay off + payoff_period_length_months:, + # The amount needed to be paid, in cents, each month in order to pay off current + # balance in the payoff period + payoff_period_monthly_payment_amount:, + # The sum of all interest and principal paid, in cents, when paying off in the + # payoff period + payoff_period_payment_total: + ) + end + + sig do + override.returns( + { + minimum_payment_months: String, + minimum_payment_total: String, + payoff_period_length_months: Integer, + payoff_period_monthly_payment_amount: Integer, + payoff_period_payment_total: Integer + } + ) + end + def to_hash end end end diff --git a/rbi/lithic/models/financial_event.rbi b/rbi/lithic/models/financial_event.rbi new file mode 100644 index 00000000..a9bbdc61 --- /dev/null +++ b/rbi/lithic/models/financial_event.rbi @@ -0,0 +1,409 @@ +# typed: strong + +module Lithic + module Models + class FinancialEvent < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Lithic::FinancialEvent, Lithic::Internal::AnyHash) + end + + # Globally unique identifier. + sig { returns(T.nilable(String)) } + attr_reader :token + + sig { params(token: String).void } + attr_writer :token + + # Amount of the financial event that has been settled in the currency's smallest + # unit (e.g., cents). + sig { returns(T.nilable(Integer)) } + attr_reader :amount + + sig { params(amount: Integer).void } + attr_writer :amount + + # Date and time when the financial event occurred. UTC time zone. + sig { returns(T.nilable(Time)) } + attr_reader :created + + sig { params(created: Time).void } + attr_writer :created + + # APPROVED financial events were successful while DECLINED financial events were + # declined by user, Lithic, or the network. + sig { returns(T.nilable(Lithic::FinancialEvent::Result::TaggedSymbol)) } + attr_reader :result + + sig { params(result: Lithic::FinancialEvent::Result::OrSymbol).void } + attr_writer :result + + sig { returns(T.nilable(Lithic::FinancialEvent::Type::TaggedSymbol)) } + attr_reader :type + + sig { params(type: Lithic::FinancialEvent::Type::OrSymbol).void } + attr_writer :type + + # Financial Event + sig do + params( + token: String, + amount: Integer, + created: Time, + result: Lithic::FinancialEvent::Result::OrSymbol, + type: Lithic::FinancialEvent::Type::OrSymbol + ).returns(T.attached_class) + end + def self.new( + # Globally unique identifier. + token: nil, + # Amount of the financial event that has been settled in the currency's smallest + # unit (e.g., cents). + amount: nil, + # Date and time when the financial event occurred. UTC time zone. + created: nil, + # APPROVED financial events were successful while DECLINED financial events were + # declined by user, Lithic, or the network. + result: nil, + type: nil + ) + end + + sig do + override.returns( + { + token: String, + amount: Integer, + created: Time, + result: Lithic::FinancialEvent::Result::TaggedSymbol, + type: Lithic::FinancialEvent::Type::TaggedSymbol + } + ) + end + def to_hash + end + + # APPROVED financial events were successful while DECLINED financial events were + # declined by user, Lithic, or the network. + module Result + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::FinancialEvent::Result) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + APPROVED = + T.let(:APPROVED, Lithic::FinancialEvent::Result::TaggedSymbol) + DECLINED = + T.let(:DECLINED, Lithic::FinancialEvent::Result::TaggedSymbol) + + sig do + override.returns( + T::Array[Lithic::FinancialEvent::Result::TaggedSymbol] + ) + end + def self.values + end + end + + module Type + extend Lithic::Internal::Type::Enum + + TaggedSymbol = + T.type_alias { T.all(Symbol, Lithic::FinancialEvent::Type) } + OrSymbol = T.type_alias { T.any(Symbol, String) } + + ACH_ORIGINATION_CANCELLED = + T.let( + :ACH_ORIGINATION_CANCELLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_INITIATED = + T.let( + :ACH_ORIGINATION_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_PROCESSED = + T.let( + :ACH_ORIGINATION_PROCESSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_RELEASED = + T.let( + :ACH_ORIGINATION_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_REJECTED = + T.let( + :ACH_ORIGINATION_REJECTED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_REVIEWED = + T.let( + :ACH_ORIGINATION_REVIEWED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_ORIGINATION_SETTLED = + T.let( + :ACH_ORIGINATION_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RECEIPT_PROCESSED = + T.let( + :ACH_RECEIPT_PROCESSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RECEIPT_RELEASED = + T.let( + :ACH_RECEIPT_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RECEIPT_SETTLED = + T.let( + :ACH_RECEIPT_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RETURN_INITIATED = + T.let( + :ACH_RETURN_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RETURN_PROCESSED = + T.let( + :ACH_RETURN_PROCESSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RETURN_REJECTED = + T.let( + :ACH_RETURN_REJECTED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + ACH_RETURN_SETTLED = + T.let(:ACH_RETURN_SETTLED, Lithic::FinancialEvent::Type::TaggedSymbol) + AUTHORIZATION = + T.let(:AUTHORIZATION, Lithic::FinancialEvent::Type::TaggedSymbol) + AUTHORIZATION_ADVICE = + T.let( + :AUTHORIZATION_ADVICE, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + AUTHORIZATION_EXPIRY = + T.let( + :AUTHORIZATION_EXPIRY, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + AUTHORIZATION_REVERSAL = + T.let( + :AUTHORIZATION_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + BALANCE_INQUIRY = + T.let(:BALANCE_INQUIRY, Lithic::FinancialEvent::Type::TaggedSymbol) + BILLING_ERROR = + T.let(:BILLING_ERROR, Lithic::FinancialEvent::Type::TaggedSymbol) + BILLING_ERROR_REVERSAL = + T.let( + :BILLING_ERROR_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + CARD_TO_CARD = + T.let(:CARD_TO_CARD, Lithic::FinancialEvent::Type::TaggedSymbol) + CASH_BACK = + T.let(:CASH_BACK, Lithic::FinancialEvent::Type::TaggedSymbol) + CASH_BACK_REVERSAL = + T.let(:CASH_BACK_REVERSAL, Lithic::FinancialEvent::Type::TaggedSymbol) + CLEARING = T.let(:CLEARING, Lithic::FinancialEvent::Type::TaggedSymbol) + COLLECTION = + T.let(:COLLECTION, Lithic::FinancialEvent::Type::TaggedSymbol) + CORRECTION_CREDIT = + T.let(:CORRECTION_CREDIT, Lithic::FinancialEvent::Type::TaggedSymbol) + CORRECTION_DEBIT = + T.let(:CORRECTION_DEBIT, Lithic::FinancialEvent::Type::TaggedSymbol) + CREDIT_AUTHORIZATION = + T.let( + :CREDIT_AUTHORIZATION, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + CREDIT_AUTHORIZATION_ADVICE = + T.let( + :CREDIT_AUTHORIZATION_ADVICE, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + CURRENCY_CONVERSION = + T.let( + :CURRENCY_CONVERSION, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + CURRENCY_CONVERSION_REVERSAL = + T.let( + :CURRENCY_CONVERSION_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + DISPUTE_WON = + T.let(:DISPUTE_WON, Lithic::FinancialEvent::Type::TaggedSymbol) + EXTERNAL_ACH_CANCELED = + T.let( + :EXTERNAL_ACH_CANCELED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_ACH_INITIATED = + T.let( + :EXTERNAL_ACH_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_ACH_RELEASED = + T.let( + :EXTERNAL_ACH_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_ACH_REVERSED = + T.let( + :EXTERNAL_ACH_REVERSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_ACH_SETTLED = + T.let( + :EXTERNAL_ACH_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_CHECK_CANCELED = + T.let( + :EXTERNAL_CHECK_CANCELED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_CHECK_INITIATED = + T.let( + :EXTERNAL_CHECK_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_CHECK_RELEASED = + T.let( + :EXTERNAL_CHECK_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_CHECK_REVERSED = + T.let( + :EXTERNAL_CHECK_REVERSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_CHECK_SETTLED = + T.let( + :EXTERNAL_CHECK_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_TRANSFER_CANCELED = + T.let( + :EXTERNAL_TRANSFER_CANCELED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_TRANSFER_INITIATED = + T.let( + :EXTERNAL_TRANSFER_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_TRANSFER_RELEASED = + T.let( + :EXTERNAL_TRANSFER_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_TRANSFER_REVERSED = + T.let( + :EXTERNAL_TRANSFER_REVERSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_TRANSFER_SETTLED = + T.let( + :EXTERNAL_TRANSFER_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_WIRE_CANCELED = + T.let( + :EXTERNAL_WIRE_CANCELED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_WIRE_INITIATED = + T.let( + :EXTERNAL_WIRE_INITIATED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_WIRE_RELEASED = + T.let( + :EXTERNAL_WIRE_RELEASED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_WIRE_REVERSED = + T.let( + :EXTERNAL_WIRE_REVERSED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + EXTERNAL_WIRE_SETTLED = + T.let( + :EXTERNAL_WIRE_SETTLED, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + FINANCIAL_AUTHORIZATION = + T.let( + :FINANCIAL_AUTHORIZATION, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + FINANCIAL_CREDIT_AUTHORIZATION = + T.let( + :FINANCIAL_CREDIT_AUTHORIZATION, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + INTEREST = T.let(:INTEREST, Lithic::FinancialEvent::Type::TaggedSymbol) + INTEREST_REVERSAL = + T.let(:INTEREST_REVERSAL, Lithic::FinancialEvent::Type::TaggedSymbol) + INTERNAL_ADJUSTMENT = + T.let( + :INTERNAL_ADJUSTMENT, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + LATE_PAYMENT = + T.let(:LATE_PAYMENT, Lithic::FinancialEvent::Type::TaggedSymbol) + LATE_PAYMENT_REVERSAL = + T.let( + :LATE_PAYMENT_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + LOSS_WRITE_OFF = + T.let(:LOSS_WRITE_OFF, Lithic::FinancialEvent::Type::TaggedSymbol) + PROVISIONAL_CREDIT = + T.let(:PROVISIONAL_CREDIT, Lithic::FinancialEvent::Type::TaggedSymbol) + PROVISIONAL_CREDIT_REVERSAL = + T.let( + :PROVISIONAL_CREDIT_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + SERVICE = T.let(:SERVICE, Lithic::FinancialEvent::Type::TaggedSymbol) + RETURN = T.let(:RETURN, Lithic::FinancialEvent::Type::TaggedSymbol) + RETURN_REVERSAL = + T.let(:RETURN_REVERSAL, Lithic::FinancialEvent::Type::TaggedSymbol) + TRANSFER = T.let(:TRANSFER, Lithic::FinancialEvent::Type::TaggedSymbol) + TRANSFER_INSUFFICIENT_FUNDS = + T.let( + :TRANSFER_INSUFFICIENT_FUNDS, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + RETURNED_PAYMENT = + T.let(:RETURNED_PAYMENT, Lithic::FinancialEvent::Type::TaggedSymbol) + RETURNED_PAYMENT_REVERSAL = + T.let( + :RETURNED_PAYMENT_REVERSAL, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + LITHIC_NETWORK_PAYMENT = + T.let( + :LITHIC_NETWORK_PAYMENT, + Lithic::FinancialEvent::Type::TaggedSymbol + ) + + sig do + override.returns(T::Array[Lithic::FinancialEvent::Type::TaggedSymbol]) + end + def self.values + end + end + end + end +end diff --git a/rbi/lithic/models/financial_transaction.rbi b/rbi/lithic/models/financial_transaction.rbi index 825a333f..ea7aa4f6 100644 --- a/rbi/lithic/models/financial_transaction.rbi +++ b/rbi/lithic/models/financial_transaction.rbi @@ -37,7 +37,7 @@ module Lithic attr_accessor :descriptor # A list of all financial events that have modified this financial transaction. - sig { returns(T::Array[Lithic::FinancialTransaction::Event]) } + sig { returns(T::Array[Lithic::FinancialEvent]) } attr_accessor :events # Pending amount of the transaction in the currency's smallest unit (e.g., cents), @@ -79,7 +79,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: T::Array[Lithic::FinancialTransaction::Event::OrHash], + events: T::Array[Lithic::FinancialEvent::OrHash], pending_amount: Integer, result: Lithic::FinancialTransaction::Result::OrSymbol, settled_amount: Integer, @@ -141,7 +141,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: T::Array[Lithic::FinancialTransaction::Event], + events: T::Array[Lithic::FinancialEvent], pending_amount: Integer, result: Lithic::FinancialTransaction::Result::TaggedSymbol, settled_amount: Integer, @@ -184,512 +184,6 @@ module Lithic end end - class Event < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - Lithic::FinancialTransaction::Event, - Lithic::Internal::AnyHash - ) - end - - # Globally unique identifier. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :token - - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - sig { returns(T.nilable(Integer)) } - attr_reader :amount - - sig { params(amount: Integer).void } - attr_writer :amount - - # Date and time when the financial event occurred. UTC time zone. - sig { returns(T.nilable(Time)) } - attr_reader :created - - sig { params(created: Time).void } - attr_writer :created - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - sig do - returns( - T.nilable(Lithic::FinancialTransaction::Event::Result::TaggedSymbol) - ) - end - attr_reader :result - - sig do - params( - result: Lithic::FinancialTransaction::Event::Result::OrSymbol - ).void - end - attr_writer :result - - sig do - returns( - T.nilable(Lithic::FinancialTransaction::Event::Type::TaggedSymbol) - ) - end - attr_reader :type - - sig do - params(type: Lithic::FinancialTransaction::Event::Type::OrSymbol).void - end - attr_writer :type - - # Financial Event - sig do - params( - token: String, - amount: Integer, - created: Time, - result: Lithic::FinancialTransaction::Event::Result::OrSymbol, - type: Lithic::FinancialTransaction::Event::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token: nil, - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - amount: nil, - # Date and time when the financial event occurred. UTC time zone. - created: nil, - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - result: nil, - type: nil - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - created: Time, - result: Lithic::FinancialTransaction::Event::Result::TaggedSymbol, - type: Lithic::FinancialTransaction::Event::Type::TaggedSymbol - } - ) - end - def to_hash - end - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - module Result - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::FinancialTransaction::Event::Result) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - APPROVED = - T.let( - :APPROVED, - Lithic::FinancialTransaction::Event::Result::TaggedSymbol - ) - DECLINED = - T.let( - :DECLINED, - Lithic::FinancialTransaction::Event::Result::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - Lithic::FinancialTransaction::Event::Result::TaggedSymbol - ] - ) - end - def self.values - end - end - - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all(Symbol, Lithic::FinancialTransaction::Event::Type) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ACH_ORIGINATION_CANCELLED = - T.let( - :ACH_ORIGINATION_CANCELLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_INITIATED = - T.let( - :ACH_ORIGINATION_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_PROCESSED = - T.let( - :ACH_ORIGINATION_PROCESSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_RELEASED = - T.let( - :ACH_ORIGINATION_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REJECTED = - T.let( - :ACH_ORIGINATION_REJECTED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REVIEWED = - T.let( - :ACH_ORIGINATION_REVIEWED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_SETTLED = - T.let( - :ACH_ORIGINATION_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_PROCESSED = - T.let( - :ACH_RECEIPT_PROCESSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_RELEASED = - T.let( - :ACH_RECEIPT_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_SETTLED = - T.let( - :ACH_RECEIPT_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RETURN_INITIATED = - T.let( - :ACH_RETURN_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RETURN_PROCESSED = - T.let( - :ACH_RETURN_PROCESSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RETURN_REJECTED = - T.let( - :ACH_RETURN_REJECTED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - ACH_RETURN_SETTLED = - T.let( - :ACH_RETURN_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - AUTHORIZATION = - T.let( - :AUTHORIZATION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - AUTHORIZATION_ADVICE = - T.let( - :AUTHORIZATION_ADVICE, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - AUTHORIZATION_EXPIRY = - T.let( - :AUTHORIZATION_EXPIRY, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - AUTHORIZATION_REVERSAL = - T.let( - :AUTHORIZATION_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - BALANCE_INQUIRY = - T.let( - :BALANCE_INQUIRY, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - BILLING_ERROR = - T.let( - :BILLING_ERROR, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - BILLING_ERROR_REVERSAL = - T.let( - :BILLING_ERROR_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CARD_TO_CARD = - T.let( - :CARD_TO_CARD, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CASH_BACK = - T.let( - :CASH_BACK, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CASH_BACK_REVERSAL = - T.let( - :CASH_BACK_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CLEARING = - T.let( - :CLEARING, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - COLLECTION = - T.let( - :COLLECTION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CORRECTION_CREDIT = - T.let( - :CORRECTION_CREDIT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CORRECTION_DEBIT = - T.let( - :CORRECTION_DEBIT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION = - T.let( - :CREDIT_AUTHORIZATION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION_ADVICE = - T.let( - :CREDIT_AUTHORIZATION_ADVICE, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION = - T.let( - :CURRENCY_CONVERSION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION_REVERSAL = - T.let( - :CURRENCY_CONVERSION_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - DISPUTE_WON = - T.let( - :DISPUTE_WON, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_CANCELED = - T.let( - :EXTERNAL_ACH_CANCELED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_INITIATED = - T.let( - :EXTERNAL_ACH_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_RELEASED = - T.let( - :EXTERNAL_ACH_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_REVERSED = - T.let( - :EXTERNAL_ACH_REVERSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_SETTLED = - T.let( - :EXTERNAL_ACH_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_CANCELED = - T.let( - :EXTERNAL_CHECK_CANCELED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_INITIATED = - T.let( - :EXTERNAL_CHECK_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_RELEASED = - T.let( - :EXTERNAL_CHECK_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_REVERSED = - T.let( - :EXTERNAL_CHECK_REVERSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_SETTLED = - T.let( - :EXTERNAL_CHECK_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_CANCELED = - T.let( - :EXTERNAL_TRANSFER_CANCELED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_INITIATED = - T.let( - :EXTERNAL_TRANSFER_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_RELEASED = - T.let( - :EXTERNAL_TRANSFER_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_REVERSED = - T.let( - :EXTERNAL_TRANSFER_REVERSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_SETTLED = - T.let( - :EXTERNAL_TRANSFER_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_CANCELED = - T.let( - :EXTERNAL_WIRE_CANCELED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_INITIATED = - T.let( - :EXTERNAL_WIRE_INITIATED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_RELEASED = - T.let( - :EXTERNAL_WIRE_RELEASED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_REVERSED = - T.let( - :EXTERNAL_WIRE_REVERSED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_SETTLED = - T.let( - :EXTERNAL_WIRE_SETTLED, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - FINANCIAL_AUTHORIZATION = - T.let( - :FINANCIAL_AUTHORIZATION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - FINANCIAL_CREDIT_AUTHORIZATION = - T.let( - :FINANCIAL_CREDIT_AUTHORIZATION, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - INTEREST = - T.let( - :INTEREST, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - INTEREST_REVERSAL = - T.let( - :INTEREST_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - INTERNAL_ADJUSTMENT = - T.let( - :INTERNAL_ADJUSTMENT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - LATE_PAYMENT = - T.let( - :LATE_PAYMENT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - LATE_PAYMENT_REVERSAL = - T.let( - :LATE_PAYMENT_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - LOSS_WRITE_OFF = - T.let( - :LOSS_WRITE_OFF, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT = - T.let( - :PROVISIONAL_CREDIT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT_REVERSAL = - T.let( - :PROVISIONAL_CREDIT_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - SERVICE = - T.let( - :SERVICE, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - RETURN = - T.let( - :RETURN, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - RETURN_REVERSAL = - T.let( - :RETURN_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - TRANSFER = - T.let( - :TRANSFER, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - TRANSFER_INSUFFICIENT_FUNDS = - T.let( - :TRANSFER_INSUFFICIENT_FUNDS, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT = - T.let( - :RETURNED_PAYMENT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT_REVERSAL = - T.let( - :RETURNED_PAYMENT_REVERSAL, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - LITHIC_NETWORK_PAYMENT = - T.let( - :LITHIC_NETWORK_PAYMENT, - Lithic::FinancialTransaction::Event::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::FinancialTransaction::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 diff --git a/rbi/lithic/models/management_operation_list_params.rbi b/rbi/lithic/models/management_operation_list_params.rbi index 0196a153..989387dd 100644 --- a/rbi/lithic/models/management_operation_list_params.rbi +++ b/rbi/lithic/models/management_operation_list_params.rbi @@ -239,6 +239,11 @@ module Lithic :CANCELED, Lithic::ManagementOperationListParams::Status::TaggedSymbol ) + RETURNED = + T.let( + :RETURNED, + Lithic::ManagementOperationListParams::Status::TaggedSymbol + ) sig do override.returns( diff --git a/rbi/lithic/models/management_operation_transaction.rbi b/rbi/lithic/models/management_operation_transaction.rbi index d400348a..57de7ee8 100644 --- a/rbi/lithic/models/management_operation_transaction.rbi +++ b/rbi/lithic/models/management_operation_transaction.rbi @@ -162,10 +162,7 @@ module Lithic attr_writer :transaction_series sig { returns(T.nilable(String)) } - attr_reader :user_defined_id - - sig { params(user_defined_id: String).void } - attr_writer :user_defined_id + attr_accessor :user_defined_id sig do params( @@ -189,7 +186,7 @@ module Lithic T.nilable( Lithic::ManagementOperationTransaction::TransactionSeries::OrHash ), - user_defined_id: String + user_defined_id: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -244,7 +241,7 @@ module Lithic T.nilable( Lithic::ManagementOperationTransaction::TransactionSeries ), - user_defined_id: String + user_defined_id: T.nilable(String) } ) end @@ -286,6 +283,11 @@ module Lithic :CANCELED, Lithic::ManagementOperationTransaction::Status::TaggedSymbol ) + RETURNED = + T.let( + :RETURNED, + Lithic::ManagementOperationTransaction::Status::TaggedSymbol + ) sig do override.returns( @@ -423,10 +425,7 @@ module Lithic attr_accessor :type sig { returns(T.nilable(String)) } - attr_reader :subtype - - sig { params(subtype: String).void } - attr_writer :subtype + attr_accessor :subtype sig do params( @@ -442,7 +441,7 @@ module Lithic result: Lithic::ManagementOperationTransaction::Event::Result::OrSymbol, type: Lithic::ManagementOperationTransaction::Event::Type::OrSymbol, - subtype: String + subtype: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -474,7 +473,7 @@ module Lithic Lithic::ManagementOperationTransaction::Event::Result::TaggedSymbol, type: Lithic::ManagementOperationTransaction::Event::Type::TaggedSymbol, - subtype: String + subtype: T.nilable(String) } ) end diff --git a/rbi/lithic/models/merchant.rbi b/rbi/lithic/models/merchant.rbi new file mode 100644 index 00000000..ae956093 --- /dev/null +++ b/rbi/lithic/models/merchant.rbi @@ -0,0 +1,89 @@ +# typed: strong + +module Lithic + module Models + class Merchant < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias { T.any(Lithic::Merchant, Lithic::Internal::AnyHash) } + + # Unique alphanumeric identifier for the payment card acceptor (merchant). + sig { returns(String) } + attr_accessor :acceptor_id + + # Unique numeric identifier of the acquiring institution. + sig { returns(String) } + attr_accessor :acquiring_institution_id + + # City of card acceptor. Note that in many cases, particularly in card-not-present + # transactions, merchants may send through a phone number or URL in this field. + sig { returns(String) } + attr_accessor :city + + # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 + # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. + sig { returns(String) } + attr_accessor :country + + # Short description of card acceptor. + sig { returns(String) } + attr_accessor :descriptor + + # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is + # used to classify a business by the types of goods or services it provides. + sig { returns(String) } + attr_accessor :mcc + + # Geographic state of card acceptor. + sig { returns(String) } + attr_accessor :state + + sig do + params( + acceptor_id: String, + acquiring_institution_id: String, + city: String, + country: String, + descriptor: String, + mcc: String, + state: String + ).returns(T.attached_class) + end + def self.new( + # Unique alphanumeric identifier for the payment card acceptor (merchant). + acceptor_id:, + # Unique numeric identifier of the acquiring institution. + acquiring_institution_id:, + # City of card acceptor. Note that in many cases, particularly in card-not-present + # transactions, merchants may send through a phone number or URL in this field. + city:, + # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 + # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. + country:, + # Short description of card acceptor. + descriptor:, + # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is + # used to classify a business by the types of goods or services it provides. + mcc:, + # Geographic state of card acceptor. + state: + ) + end + + sig do + override.returns( + { + acceptor_id: String, + acquiring_institution_id: String, + city: String, + country: String, + descriptor: String, + mcc: String, + state: String + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/payment.rbi b/rbi/lithic/models/payment.rbi index 6aae41de..adad3b3f 100644 --- a/rbi/lithic/models/payment.rbi +++ b/rbi/lithic/models/payment.rbi @@ -50,13 +50,14 @@ module Lithic sig { returns(Integer) } attr_accessor :pending_amount - # Related account tokens for the transaction - sig { returns(Lithic::Payment::RelatedAccountTokens) } + # Account tokens related to a payment transaction + sig { returns(T.nilable(Lithic::Payment::RelatedAccountTokens)) } attr_reader :related_account_tokens sig do params( - related_account_tokens: Lithic::Payment::RelatedAccountTokens::OrHash + related_account_tokens: + T.nilable(Lithic::Payment::RelatedAccountTokens::OrHash) ).void end attr_writer :related_account_tokens @@ -123,7 +124,8 @@ module Lithic Lithic::Payment::MethodAttributes::WireMethodAttributes::OrHash ), pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens::OrHash, + related_account_tokens: + T.nilable(Lithic::Payment::RelatedAccountTokens::OrHash), result: Lithic::Payment::Result::OrSymbol, settled_amount: Integer, source: Lithic::Payment::Source::OrSymbol, @@ -158,7 +160,7 @@ module Lithic method_attributes:, # Pending amount in cents pending_amount:, - # Related account tokens for the transaction + # Account tokens related to a payment transaction related_account_tokens:, # Transaction result result:, @@ -198,7 +200,8 @@ module Lithic method_: Lithic::Payment::Method::TaggedSymbol, method_attributes: Lithic::Payment::MethodAttributes::Variants, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: + T.nilable(Lithic::Payment::RelatedAccountTokens), result: Lithic::Payment::Result::TaggedSymbol, settled_amount: Integer, source: Lithic::Payment::Source::TaggedSymbol, @@ -567,6 +570,11 @@ module Lithic :APPROVED, Lithic::Payment::Event::DetailedResult::TaggedSymbol ) + DECLINED = + T.let( + :DECLINED, + Lithic::Payment::Event::DetailedResult::TaggedSymbol + ) FUNDS_INSUFFICIENT = T.let( :FUNDS_INSUFFICIENT, @@ -928,7 +936,7 @@ module Lithic sig { returns(T.nilable(String)) } attr_accessor :business_account_token - # Related account tokens for the transaction + # Account tokens related to a payment transaction sig do params( account_token: T.nilable(String), @@ -1002,6 +1010,7 @@ module Lithic DECLINED = T.let(:DECLINED, Lithic::Payment::Status::TaggedSymbol) REVERSED = T.let(:REVERSED, Lithic::Payment::Status::TaggedSymbol) CANCELED = T.let(:CANCELED, Lithic::Payment::Status::TaggedSymbol) + RETURNED = T.let(:RETURNED, Lithic::Payment::Status::TaggedSymbol) sig do override.returns(T::Array[Lithic::Payment::Status::TaggedSymbol]) diff --git a/rbi/lithic/models/payment_return_params.rbi b/rbi/lithic/models/payment_return_params.rbi new file mode 100644 index 00000000..dcb3bccb --- /dev/null +++ b/rbi/lithic/models/payment_return_params.rbi @@ -0,0 +1,85 @@ +# typed: strong + +module Lithic + module Models + class PaymentReturnParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(Lithic::PaymentReturnParams, Lithic::Internal::AnyHash) + end + + # Globally unique identifier for the financial account + sig { returns(String) } + attr_accessor :financial_account_token + + # 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) + sig { returns(String) } + attr_accessor :return_reason_code + + # Optional additional information about the return. Limited to 44 characters + sig { returns(T.nilable(String)) } + attr_accessor :addenda + + # Date of death in YYYY-MM-DD format. Required when using return codes **R14** + # (representative payee deceased) or **R15** (beneficiary or account holder + # deceased) + sig { returns(T.nilable(Date)) } + attr_accessor :date_of_death + + # Optional memo for the return. Limited to 10 characters + sig { returns(T.nilable(String)) } + attr_accessor :memo + + sig do + params( + financial_account_token: String, + return_reason_code: String, + addenda: T.nilable(String), + date_of_death: T.nilable(Date), + memo: T.nilable(String), + request_options: Lithic::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Globally unique identifier for the financial account + financial_account_token:, + # 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_reason_code:, + # Optional additional information about the return. Limited to 44 characters + addenda: nil, + # Date of death in YYYY-MM-DD format. Required when using return codes **R14** + # (representative payee deceased) or **R15** (beneficiary or account holder + # deceased) + date_of_death: nil, + # Optional memo for the return. Limited to 10 characters + memo: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + financial_account_token: String, + return_reason_code: String, + addenda: T.nilable(String), + date_of_death: T.nilable(Date), + memo: T.nilable(String), + request_options: Lithic::RequestOptions + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/statement_totals.rbi b/rbi/lithic/models/statement_totals.rbi new file mode 100644 index 00000000..a784f027 --- /dev/null +++ b/rbi/lithic/models/statement_totals.rbi @@ -0,0 +1,128 @@ +# typed: strong + +module Lithic + module Models + class StatementTotals < Lithic::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(Lithic::StatementTotals, Lithic::Internal::AnyHash) + end + + # Opening balance transferred from previous account in cents + sig { returns(Integer) } + attr_accessor :balance_transfers + + # ATM and cashback transactions in cents + sig { returns(Integer) } + attr_accessor :cash_advances + + # Volume of credit management operation transactions less any balance transfers in + # cents + sig { returns(Integer) } + attr_accessor :credits + + # Volume of debit management operation transactions less any interest in cents + sig { returns(Integer) } + attr_accessor :debits + + # Volume of debit management operation transactions less any interest in cents + sig { returns(Integer) } + attr_accessor :fees + + # Interest accrued in cents + sig { returns(Integer) } + attr_accessor :interest + + # Any funds transfers which affective the balance in cents + sig { returns(Integer) } + attr_accessor :payments + + # Net card transaction volume less any cash advances in cents + sig { returns(Integer) } + attr_accessor :purchases + + # Breakdown of credits + sig { returns(T.nilable(T.anything)) } + attr_reader :credit_details + + sig { params(credit_details: T.anything).void } + attr_writer :credit_details + + # Breakdown of debits + sig { returns(T.nilable(T.anything)) } + attr_reader :debit_details + + sig { params(debit_details: T.anything).void } + attr_writer :debit_details + + # Breakdown of payments + sig { returns(T.nilable(T.anything)) } + attr_reader :payment_details + + sig { params(payment_details: T.anything).void } + attr_writer :payment_details + + sig do + params( + balance_transfers: Integer, + cash_advances: Integer, + credits: Integer, + debits: Integer, + fees: Integer, + interest: Integer, + payments: Integer, + purchases: Integer, + credit_details: T.anything, + debit_details: T.anything, + payment_details: T.anything + ).returns(T.attached_class) + end + def self.new( + # Opening balance transferred from previous account in cents + balance_transfers:, + # ATM and cashback transactions in cents + cash_advances:, + # Volume of credit management operation transactions less any balance transfers in + # cents + credits:, + # Volume of debit management operation transactions less any interest in cents + debits:, + # Volume of debit management operation transactions less any interest in cents + fees:, + # Interest accrued in cents + interest:, + # Any funds transfers which affective the balance in cents + payments:, + # Net card transaction volume less any cash advances in cents + purchases:, + # Breakdown of credits + credit_details: nil, + # Breakdown of debits + debit_details: nil, + # Breakdown of payments + payment_details: nil + ) + end + + sig do + override.returns( + { + balance_transfers: Integer, + cash_advances: Integer, + credits: Integer, + debits: Integer, + fees: Integer, + interest: Integer, + payments: Integer, + purchases: Integer, + credit_details: T.anything, + debit_details: T.anything, + payment_details: T.anything + } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi b/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi index c63f6339..467d9068 100644 --- a/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi +++ b/rbi/lithic/models/three_ds/authentication_retrieve_response.rbi @@ -677,18 +677,18 @@ module Lithic sig { returns(T.nilable(String)) } attr_accessor :name - # Home phone number provided by the cardholder. Maps to EMV 3DS fields - # `homePhone.cc` and `homePhone.subscriber`. + # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `homePhone.cc` and `homePhone.subscriber`. sig { returns(T.nilable(String)) } attr_accessor :phone_number_home - # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields - # `mobilePhone.cc` and `mobilePhone.subscriber`. + # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV + # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`. sig { returns(T.nilable(String)) } attr_accessor :phone_number_mobile - # Work phone number provided by the cardholder. Maps to EMV 3DS fields - # `workPhone.cc` and `workPhone.subscriber`. + # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `workPhone.cc` and `workPhone.subscriber`. sig { returns(T.nilable(String)) } attr_accessor :phone_number_work @@ -745,14 +745,14 @@ module Lithic email: nil, # Name of the cardholder. Maps to EMV 3DS field `cardholderName`. name: nil, - # Home phone number provided by the cardholder. Maps to EMV 3DS fields - # `homePhone.cc` and `homePhone.subscriber`. + # Home phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `homePhone.cc` and `homePhone.subscriber`. phone_number_home: nil, - # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields - # `mobilePhone.cc` and `mobilePhone.subscriber`. + # Mobile/cell phone number in E.164 format provided by the cardholder. Maps to EMV + # 3DS fields `mobilePhone.cc` and `mobilePhone.subscriber`. phone_number_mobile: nil, - # Work phone number provided by the cardholder. Maps to EMV 3DS fields - # `workPhone.cc` and `workPhone.subscriber`. + # Work phone number in E.164 format provided by the cardholder. Maps to EMV 3DS + # fields `workPhone.cc` and `workPhone.subscriber`. phone_number_work: nil, # Object containing data on the shipping address provided during the transaction. shipping_address: nil diff --git a/rbi/lithic/models/transaction.rbi b/rbi/lithic/models/transaction.rbi index cfc6ef88..7c9768a3 100644 --- a/rbi/lithic/models/transaction.rbi +++ b/rbi/lithic/models/transaction.rbi @@ -76,10 +76,10 @@ module Lithic sig { returns(T.nilable(String)) } attr_accessor :financial_account_token - sig { returns(Lithic::Transaction::Merchant) } + sig { returns(Lithic::Merchant) } attr_reader :merchant - sig { params(merchant: Lithic::Transaction::Merchant::OrHash).void } + sig { params(merchant: Lithic::Merchant::OrHash).void } attr_writer :merchant # Analogous to the 'amount', but in the merchant currency. @@ -160,7 +160,7 @@ module Lithic T.nilable(Lithic::Transaction::CardholderAuthentication::OrHash), created: Time, financial_account_token: T.nilable(String), - merchant: Lithic::Transaction::Merchant::OrHash, + merchant: Lithic::Merchant::OrHash, merchant_amount: T.nilable(Integer), merchant_authorization_amount: T.nilable(Integer), merchant_currency: String, @@ -252,7 +252,7 @@ module Lithic T.nilable(Lithic::Transaction::CardholderAuthentication), created: Time, financial_account_token: T.nilable(String), - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: T.nilable(Integer), merchant_authorization_amount: T.nilable(Integer), merchant_currency: String, @@ -820,92 +820,6 @@ module Lithic end end - class Merchant < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Transaction::Merchant, Lithic::Internal::AnyHash) - end - - # Unique alphanumeric identifier for the payment card acceptor (merchant). - sig { returns(String) } - attr_accessor :acceptor_id - - # Unique numeric identifier of the acquiring institution. - sig { returns(String) } - attr_accessor :acquiring_institution_id - - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - sig { returns(String) } - attr_accessor :city - - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - sig { returns(String) } - attr_accessor :country - - # Short description of card acceptor. - sig { returns(String) } - attr_accessor :descriptor - - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - sig { returns(String) } - attr_accessor :mcc - - # Geographic state of card acceptor. - sig { returns(String) } - attr_accessor :state - - sig do - params( - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - ).returns(T.attached_class) - end - def self.new( - # Unique alphanumeric identifier for the payment card acceptor (merchant). - acceptor_id:, - # Unique numeric identifier of the acquiring institution. - acquiring_institution_id:, - # City of card acceptor. Note that in many cases, particularly in card-not-present - # transactions, merchants may send through a phone number or URL in this field. - city:, - # Country or entity of card acceptor. Possible values are: (1) all ISO 3166-1 - # alpha-3 country codes, (2) QZZ for Kosovo, and (3) ANT for Netherlands Antilles. - country:, - # Short description of card acceptor. - descriptor:, - # Merchant category code (MCC). A four-digit number listed in ISO 18245. An MCC is - # used to classify a business by the types of goods or services it provides. - mcc:, - # Geographic state of card acceptor. - state: - ) - end - - sig do - override.returns( - { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } - ) - end - def to_hash - end - end - # Card network of the authorization. Value is `UNKNOWN` when Lithic cannot # determine the network code from the upstream provider. module Network diff --git a/rbi/lithic/models/transactions/events/enhanced_data.rbi b/rbi/lithic/models/transactions/events/enhanced_data.rbi index 403cd01d..cb2b76a5 100644 --- a/rbi/lithic/models/transactions/events/enhanced_data.rbi +++ b/rbi/lithic/models/transactions/events/enhanced_data.rbi @@ -113,24 +113,15 @@ module Lithic # A customer identifier. sig { returns(T.nilable(String)) } - attr_reader :customer_reference_number - - sig { params(customer_reference_number: String).void } - attr_writer :customer_reference_number + attr_accessor :customer_reference_number # A merchant identifier. sig { returns(T.nilable(String)) } - attr_reader :merchant_reference_number - - sig { params(merchant_reference_number: String).void } - attr_writer :merchant_reference_number + attr_accessor :merchant_reference_number # The date of the order. sig { returns(T.nilable(Date)) } - attr_reader :order_date - - sig { params(order_date: Date).void } - attr_writer :order_date + attr_accessor :order_date sig do params( @@ -140,9 +131,9 @@ module Lithic ], tax: Lithic::Transactions::Events::EnhancedData::Common::Tax::OrHash, - customer_reference_number: String, - merchant_reference_number: String, - order_date: Date + customer_reference_number: T.nilable(String), + merchant_reference_number: T.nilable(String), + order_date: T.nilable(Date) ).returns(T.attached_class) end def self.new( @@ -165,9 +156,9 @@ module Lithic Lithic::Transactions::Events::EnhancedData::Common::LineItem ], tax: Lithic::Transactions::Events::EnhancedData::Common::Tax, - customer_reference_number: String, - merchant_reference_number: String, - order_date: Date + customer_reference_number: T.nilable(String), + merchant_reference_number: T.nilable(String), + order_date: T.nilable(Date) } ) end @@ -185,39 +176,27 @@ module Lithic # The price of the item purchased in merchant currency. sig { returns(T.nilable(String)) } - attr_reader :amount - - sig { params(amount: String).void } - attr_writer :amount + attr_accessor :amount # A human-readable description of the item. sig { returns(T.nilable(String)) } - attr_reader :description - - sig { params(description: String).void } - attr_writer :description + attr_accessor :description # An identifier for the item purchased. sig { returns(T.nilable(String)) } - attr_reader :product_code - - sig { params(product_code: String).void } - attr_writer :product_code + attr_accessor :product_code # The quantity of the item purchased. sig { returns(T.nilable(String)) } - attr_reader :quantity - - sig { params(quantity: String).void } - attr_writer :quantity + attr_accessor :quantity # An L2/L3 enhanced commercial data line item. sig do params( - amount: String, - description: String, - product_code: String, - quantity: String + amount: T.nilable(String), + description: T.nilable(String), + product_code: T.nilable(String), + quantity: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -235,10 +214,10 @@ module Lithic sig do override.returns( { - amount: String, - description: String, - product_code: String, - quantity: String + amount: T.nilable(String), + description: T.nilable(String), + product_code: T.nilable(String), + quantity: T.nilable(String) } ) end @@ -257,10 +236,7 @@ module Lithic # The amount of tax collected. sig { returns(T.nilable(Integer)) } - attr_reader :amount - - sig { params(amount: Integer).void } - attr_writer :amount + attr_accessor :amount # A flag indicating whether the transaction is tax exempt or not. sig do @@ -270,29 +246,20 @@ module Lithic ) ) end - attr_reader :exempt - - sig do - params( - exempt: - Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt::OrSymbol - ).void - end - attr_writer :exempt + attr_accessor :exempt # The tax ID of the merchant. sig { returns(T.nilable(String)) } - attr_reader :merchant_tax_id - - sig { params(merchant_tax_id: String).void } - attr_writer :merchant_tax_id + attr_accessor :merchant_tax_id sig do params( - amount: Integer, + amount: T.nilable(Integer), exempt: - Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt::OrSymbol, - merchant_tax_id: String + T.nilable( + Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt::OrSymbol + ), + merchant_tax_id: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -308,10 +275,12 @@ module Lithic sig do override.returns( { - amount: Integer, + amount: T.nilable(Integer), exempt: - Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt::TaggedSymbol, - merchant_tax_id: String + T.nilable( + Lithic::Transactions::Events::EnhancedData::Common::Tax::Exempt::TaggedSymbol + ), + merchant_tax_id: T.nilable(String) } ) end @@ -400,17 +369,11 @@ module Lithic # The driver number entered into the terminal at the time of sale, with leading # zeros stripped. sig { returns(T.nilable(String)) } - attr_reader :driver_number - - sig { params(driver_number: String).void } - attr_writer :driver_number + attr_accessor :driver_number # The odometer reading entered into the terminal at the time of sale. sig { returns(T.nilable(Integer)) } - attr_reader :odometer - - sig { params(odometer: Integer).void } - attr_writer :odometer + attr_accessor :odometer # The type of fuel service. sig do @@ -433,10 +396,7 @@ module Lithic # The vehicle number entered into the terminal at the time of sale, with leading # zeros stripped. sig { returns(T.nilable(String)) } - attr_reader :vehicle_number - - sig { params(vehicle_number: String).void } - attr_writer :vehicle_number + attr_accessor :vehicle_number sig do params( @@ -444,11 +404,11 @@ module Lithic Lithic::Transactions::Events::EnhancedData::Fleet::AmountTotals::OrHash, fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::OrHash, - driver_number: String, - odometer: Integer, + driver_number: T.nilable(String), + odometer: T.nilable(Integer), service_type: Lithic::Transactions::Events::EnhancedData::Fleet::ServiceType::OrSymbol, - vehicle_number: String + vehicle_number: T.nilable(String) ).returns(T.attached_class) end def self.new( @@ -473,11 +433,11 @@ module Lithic amount_totals: Lithic::Transactions::Events::EnhancedData::Fleet::AmountTotals, fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel, - driver_number: String, - odometer: Integer, + driver_number: T.nilable(String), + odometer: T.nilable(Integer), service_type: Lithic::Transactions::Events::EnhancedData::Fleet::ServiceType::TaggedSymbol, - vehicle_number: String + vehicle_number: T.nilable(String) } ) end @@ -495,30 +455,21 @@ module Lithic # The discount applied to the gross sale amount. sig { returns(T.nilable(Integer)) } - attr_reader :discount - - sig { params(discount: Integer).void } - attr_writer :discount + attr_accessor :discount # The gross sale amount. sig { returns(T.nilable(Integer)) } - attr_reader :gross_sale - - sig { params(gross_sale: Integer).void } - attr_writer :gross_sale + attr_accessor :gross_sale # The amount after discount. sig { returns(T.nilable(Integer)) } - attr_reader :net_sale - - sig { params(net_sale: Integer).void } - attr_writer :net_sale + attr_accessor :net_sale sig do params( - discount: Integer, - gross_sale: Integer, - net_sale: Integer + discount: T.nilable(Integer), + gross_sale: T.nilable(Integer), + net_sale: T.nilable(Integer) ).returns(T.attached_class) end def self.new( @@ -533,7 +484,11 @@ module Lithic sig do override.returns( - { discount: Integer, gross_sale: Integer, net_sale: Integer } + { + discount: T.nilable(Integer), + gross_sale: T.nilable(Integer), + net_sale: T.nilable(Integer) + } ) end def to_hash @@ -551,10 +506,7 @@ module Lithic # The quantity of fuel purchased. sig { returns(T.nilable(String)) } - attr_reader :quantity - - sig { params(quantity: String).void } - attr_writer :quantity + attr_accessor :quantity # The type of fuel purchased. sig do @@ -564,15 +516,7 @@ module Lithic ) ) end - attr_reader :type - - sig do - params( - type: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type::OrSymbol - ).void - end - attr_writer :type + attr_accessor :type # Unit of measure for fuel disbursement. sig do @@ -582,31 +526,24 @@ module Lithic ) ) end - attr_reader :unit_of_measure - - sig do - params( - unit_of_measure: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure::OrSymbol - ).void - end - attr_writer :unit_of_measure + attr_accessor :unit_of_measure # The price per unit of fuel. sig { returns(T.nilable(Integer)) } - attr_reader :unit_price - - sig { params(unit_price: Integer).void } - attr_writer :unit_price + attr_accessor :unit_price sig do params( - quantity: String, + quantity: T.nilable(String), type: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type::OrSymbol, + T.nilable( + Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type::OrSymbol + ), unit_of_measure: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure::OrSymbol, - unit_price: Integer + T.nilable( + Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure::OrSymbol + ), + unit_price: T.nilable(Integer) ).returns(T.attached_class) end def self.new( @@ -624,12 +561,16 @@ module Lithic sig do override.returns( { - quantity: String, + quantity: T.nilable(String), type: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type::TaggedSymbol, + T.nilable( + Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::Type::TaggedSymbol + ), unit_of_measure: - Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure::TaggedSymbol, - unit_price: Integer + T.nilable( + Lithic::Transactions::Events::EnhancedData::Fleet::Fuel::UnitOfMeasure::TaggedSymbol + ), + unit_price: T.nilable(Integer) } ) end diff --git a/rbi/lithic/models/transfer.rbi b/rbi/lithic/models/transfer.rbi index 1bce8da9..aa204151 100644 --- a/rbi/lithic/models/transfer.rbi +++ b/rbi/lithic/models/transfer.rbi @@ -47,10 +47,10 @@ module Lithic attr_writer :descriptor # A list of all financial events that have modified this trasnfer. - sig { returns(T.nilable(T::Array[Lithic::Transfer::Event])) } + sig { returns(T.nilable(T::Array[Lithic::FinancialEvent])) } attr_reader :events - sig { params(events: T::Array[Lithic::Transfer::Event::OrHash]).void } + sig { params(events: T::Array[Lithic::FinancialEvent::OrHash]).void } attr_writer :events # The updated balance of the sending financial account. @@ -119,7 +119,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: T::Array[Lithic::Transfer::Event::OrHash], + events: T::Array[Lithic::FinancialEvent::OrHash], from_balance: T::Array[Lithic::Balance::OrHash], pending_amount: Integer, result: Lithic::Transfer::Result::OrSymbol, @@ -182,7 +182,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: T::Array[Lithic::Transfer::Event], + events: T::Array[Lithic::FinancialEvent], from_balance: T::Array[Lithic::Balance], pending_amount: Integer, result: Lithic::Transfer::Result::TaggedSymbol, @@ -216,438 +216,6 @@ module Lithic end end - class Event < Lithic::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any(Lithic::Transfer::Event, Lithic::Internal::AnyHash) - end - - # Globally unique identifier. - sig { returns(T.nilable(String)) } - attr_reader :token - - sig { params(token: String).void } - attr_writer :token - - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - sig { returns(T.nilable(Integer)) } - attr_reader :amount - - sig { params(amount: Integer).void } - attr_writer :amount - - # Date and time when the financial event occurred. UTC time zone. - sig { returns(T.nilable(Time)) } - attr_reader :created - - sig { params(created: Time).void } - attr_writer :created - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - sig do - returns(T.nilable(Lithic::Transfer::Event::Result::TaggedSymbol)) - end - attr_reader :result - - sig { params(result: Lithic::Transfer::Event::Result::OrSymbol).void } - attr_writer :result - - sig { returns(T.nilable(Lithic::Transfer::Event::Type::TaggedSymbol)) } - attr_reader :type - - sig { params(type: Lithic::Transfer::Event::Type::OrSymbol).void } - attr_writer :type - - # Financial Event - sig do - params( - token: String, - amount: Integer, - created: Time, - result: Lithic::Transfer::Event::Result::OrSymbol, - type: Lithic::Transfer::Event::Type::OrSymbol - ).returns(T.attached_class) - end - def self.new( - # Globally unique identifier. - token: nil, - # Amount of the financial event that has been settled in the currency's smallest - # unit (e.g., cents). - amount: nil, - # Date and time when the financial event occurred. UTC time zone. - created: nil, - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - result: nil, - type: nil - ) - end - - sig do - override.returns( - { - token: String, - amount: Integer, - created: Time, - result: Lithic::Transfer::Event::Result::TaggedSymbol, - type: Lithic::Transfer::Event::Type::TaggedSymbol - } - ) - end - def to_hash - end - - # APPROVED financial events were successful while DECLINED financial events were - # declined by user, Lithic, or the network. - module Result - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Lithic::Transfer::Event::Result) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - APPROVED = - T.let(:APPROVED, Lithic::Transfer::Event::Result::TaggedSymbol) - DECLINED = - T.let(:DECLINED, Lithic::Transfer::Event::Result::TaggedSymbol) - - sig do - override.returns( - T::Array[Lithic::Transfer::Event::Result::TaggedSymbol] - ) - end - def self.values - end - end - - module Type - extend Lithic::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, Lithic::Transfer::Event::Type) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - ACH_ORIGINATION_CANCELLED = - T.let( - :ACH_ORIGINATION_CANCELLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_INITIATED = - T.let( - :ACH_ORIGINATION_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_PROCESSED = - T.let( - :ACH_ORIGINATION_PROCESSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_RELEASED = - T.let( - :ACH_ORIGINATION_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REJECTED = - T.let( - :ACH_ORIGINATION_REJECTED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_REVIEWED = - T.let( - :ACH_ORIGINATION_REVIEWED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_ORIGINATION_SETTLED = - T.let( - :ACH_ORIGINATION_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_PROCESSED = - T.let( - :ACH_RECEIPT_PROCESSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_RELEASED = - T.let( - :ACH_RECEIPT_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RECEIPT_SETTLED = - T.let( - :ACH_RECEIPT_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RETURN_INITIATED = - T.let( - :ACH_RETURN_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RETURN_PROCESSED = - T.let( - :ACH_RETURN_PROCESSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RETURN_REJECTED = - T.let( - :ACH_RETURN_REJECTED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - ACH_RETURN_SETTLED = - T.let( - :ACH_RETURN_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - AUTHORIZATION = - T.let(:AUTHORIZATION, Lithic::Transfer::Event::Type::TaggedSymbol) - AUTHORIZATION_ADVICE = - T.let( - :AUTHORIZATION_ADVICE, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - AUTHORIZATION_EXPIRY = - T.let( - :AUTHORIZATION_EXPIRY, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - AUTHORIZATION_REVERSAL = - T.let( - :AUTHORIZATION_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - BALANCE_INQUIRY = - T.let(:BALANCE_INQUIRY, Lithic::Transfer::Event::Type::TaggedSymbol) - BILLING_ERROR = - T.let(:BILLING_ERROR, Lithic::Transfer::Event::Type::TaggedSymbol) - BILLING_ERROR_REVERSAL = - T.let( - :BILLING_ERROR_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CARD_TO_CARD = - T.let(:CARD_TO_CARD, Lithic::Transfer::Event::Type::TaggedSymbol) - CASH_BACK = - T.let(:CASH_BACK, Lithic::Transfer::Event::Type::TaggedSymbol) - CASH_BACK_REVERSAL = - T.let( - :CASH_BACK_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CLEARING = - T.let(:CLEARING, Lithic::Transfer::Event::Type::TaggedSymbol) - COLLECTION = - T.let(:COLLECTION, Lithic::Transfer::Event::Type::TaggedSymbol) - CORRECTION_CREDIT = - T.let( - :CORRECTION_CREDIT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CORRECTION_DEBIT = - T.let( - :CORRECTION_DEBIT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION = - T.let( - :CREDIT_AUTHORIZATION, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CREDIT_AUTHORIZATION_ADVICE = - T.let( - :CREDIT_AUTHORIZATION_ADVICE, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION = - T.let( - :CURRENCY_CONVERSION, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - CURRENCY_CONVERSION_REVERSAL = - T.let( - :CURRENCY_CONVERSION_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - DISPUTE_WON = - T.let(:DISPUTE_WON, Lithic::Transfer::Event::Type::TaggedSymbol) - EXTERNAL_ACH_CANCELED = - T.let( - :EXTERNAL_ACH_CANCELED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_INITIATED = - T.let( - :EXTERNAL_ACH_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_RELEASED = - T.let( - :EXTERNAL_ACH_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_REVERSED = - T.let( - :EXTERNAL_ACH_REVERSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_ACH_SETTLED = - T.let( - :EXTERNAL_ACH_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_CANCELED = - T.let( - :EXTERNAL_CHECK_CANCELED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_INITIATED = - T.let( - :EXTERNAL_CHECK_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_RELEASED = - T.let( - :EXTERNAL_CHECK_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_REVERSED = - T.let( - :EXTERNAL_CHECK_REVERSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_CHECK_SETTLED = - T.let( - :EXTERNAL_CHECK_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_CANCELED = - T.let( - :EXTERNAL_TRANSFER_CANCELED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_INITIATED = - T.let( - :EXTERNAL_TRANSFER_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_RELEASED = - T.let( - :EXTERNAL_TRANSFER_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_REVERSED = - T.let( - :EXTERNAL_TRANSFER_REVERSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_TRANSFER_SETTLED = - T.let( - :EXTERNAL_TRANSFER_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_CANCELED = - T.let( - :EXTERNAL_WIRE_CANCELED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_INITIATED = - T.let( - :EXTERNAL_WIRE_INITIATED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_RELEASED = - T.let( - :EXTERNAL_WIRE_RELEASED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_REVERSED = - T.let( - :EXTERNAL_WIRE_REVERSED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - EXTERNAL_WIRE_SETTLED = - T.let( - :EXTERNAL_WIRE_SETTLED, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - FINANCIAL_AUTHORIZATION = - T.let( - :FINANCIAL_AUTHORIZATION, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - FINANCIAL_CREDIT_AUTHORIZATION = - T.let( - :FINANCIAL_CREDIT_AUTHORIZATION, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - INTEREST = - T.let(:INTEREST, Lithic::Transfer::Event::Type::TaggedSymbol) - INTEREST_REVERSAL = - T.let( - :INTEREST_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - INTERNAL_ADJUSTMENT = - T.let( - :INTERNAL_ADJUSTMENT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - LATE_PAYMENT = - T.let(:LATE_PAYMENT, Lithic::Transfer::Event::Type::TaggedSymbol) - LATE_PAYMENT_REVERSAL = - T.let( - :LATE_PAYMENT_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - LOSS_WRITE_OFF = - T.let(:LOSS_WRITE_OFF, Lithic::Transfer::Event::Type::TaggedSymbol) - PROVISIONAL_CREDIT = - T.let( - :PROVISIONAL_CREDIT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - PROVISIONAL_CREDIT_REVERSAL = - T.let( - :PROVISIONAL_CREDIT_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - SERVICE = T.let(:SERVICE, Lithic::Transfer::Event::Type::TaggedSymbol) - RETURN = T.let(:RETURN, Lithic::Transfer::Event::Type::TaggedSymbol) - RETURN_REVERSAL = - T.let(:RETURN_REVERSAL, Lithic::Transfer::Event::Type::TaggedSymbol) - TRANSFER = - T.let(:TRANSFER, Lithic::Transfer::Event::Type::TaggedSymbol) - TRANSFER_INSUFFICIENT_FUNDS = - T.let( - :TRANSFER_INSUFFICIENT_FUNDS, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT = - T.let( - :RETURNED_PAYMENT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - RETURNED_PAYMENT_REVERSAL = - T.let( - :RETURNED_PAYMENT_REVERSAL, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - LITHIC_NETWORK_PAYMENT = - T.let( - :LITHIC_NETWORK_PAYMENT, - Lithic::Transfer::Event::Type::TaggedSymbol - ) - - sig do - override.returns( - T::Array[Lithic::Transfer::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 diff --git a/rbi/lithic/resources/auth_rules/v2.rbi b/rbi/lithic/resources/auth_rules/v2.rbi index f72f2d99..0ff6ba9f 100644 --- a/rbi/lithic/resources/auth_rules/v2.rbi +++ b/rbi/lithic/resources/auth_rules/v2.rbi @@ -16,7 +16,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ), type: Lithic::AuthRules::V2CreateParams::Type::OrSymbol, card_tokens: T::Array[String], @@ -41,7 +43,8 @@ module Lithic # - `CONDITIONAL_BLOCK`: AUTHORIZATION event stream. # - `VELOCITY_LIMIT`: AUTHORIZATION event stream. # - `MERCHANT_LOCK`: AUTHORIZATION event stream. - # - `CONDITIONAL_ACTION`: AUTHORIZATION or THREE_DS_AUTHENTICATION event stream. + # - `CONDITIONAL_ACTION`: AUTHORIZATION, THREE_DS_AUTHENTICATION, TOKENIZATION, + # ACH_CREDIT_RECEIPT, or ACH_DEBIT_RECEIPT event stream. type:, # Card tokens to which the Auth Rule applies. card_tokens:, @@ -179,7 +182,9 @@ module Lithic Lithic::AuthRules::VelocityLimitParams::OrHash, Lithic::AuthRules::MerchantLockParameters::OrHash, Lithic::AuthRules::Conditional3DSActionParameters::OrHash, - Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash + Lithic::AuthRules::ConditionalAuthorizationActionParameters::OrHash, + Lithic::AuthRules::ConditionalACHActionParameters::OrHash, + Lithic::AuthRules::ConditionalTokenizationActionParameters::OrHash ) ), request_options: Lithic::RequestOptions::OrHash diff --git a/rbi/lithic/resources/disputes.rbi b/rbi/lithic/resources/disputes.rbi index 4f6bbcc3..3a1df74f 100644 --- a/rbi/lithic/resources/disputes.rbi +++ b/rbi/lithic/resources/disputes.rbi @@ -12,7 +12,7 @@ module Lithic customer_filed_date: Time, customer_note: String, request_options: Lithic::RequestOptions::OrHash - ).returns(Lithic::Models::DisputeCreateResponse) + ).returns(Lithic::Dispute) end def create( # Amount to dispute @@ -34,7 +34,7 @@ module Lithic params( dispute_token: String, request_options: Lithic::RequestOptions::OrHash - ).returns(Lithic::Models::DisputeRetrieveResponse) + ).returns(Lithic::Dispute) end def retrieve(dispute_token, request_options: {}) end @@ -48,7 +48,7 @@ module Lithic customer_note: String, reason: Lithic::DisputeUpdateParams::Reason::OrSymbol, request_options: Lithic::RequestOptions::OrHash - ).returns(Lithic::Models::DisputeUpdateResponse) + ).returns(Lithic::Dispute) end def update( dispute_token, @@ -75,9 +75,7 @@ module Lithic status: Lithic::DisputeListParams::Status::OrSymbol, transaction_tokens: T::Array[String], request_options: Lithic::RequestOptions::OrHash - ).returns( - Lithic::Internal::CursorPage[Lithic::Models::DisputeListResponse] - ) + ).returns(Lithic::Internal::CursorPage[Lithic::Dispute]) end def list( # Date string in RFC 3339 format. Only entries created after the specified time @@ -107,7 +105,7 @@ module Lithic params( dispute_token: String, request_options: Lithic::RequestOptions::OrHash - ).returns(Lithic::Models::DisputeDeleteResponse) + ).returns(Lithic::Dispute) end def delete(dispute_token, request_options: {}) end diff --git a/rbi/lithic/resources/disputes_v2.rbi b/rbi/lithic/resources/disputes_v2.rbi new file mode 100644 index 00000000..23b97002 --- /dev/null +++ b/rbi/lithic/resources/disputes_v2.rbi @@ -0,0 +1,64 @@ +# typed: strong + +module Lithic + module Resources + class DisputesV2 + # Retrieves a specific dispute by its token. + sig do + params( + dispute_token: String, + request_options: Lithic::RequestOptions::OrHash + ).returns(Lithic::DisputeV2) + end + def retrieve( + # Token of the dispute to retrieve. + dispute_token, + request_options: {} + ) + end + + # Returns a paginated list of disputes. + sig do + params( + account_token: String, + begin_: Time, + card_token: String, + disputed_transaction_token: String, + end_: Time, + ending_before: String, + page_size: Integer, + starting_after: String, + request_options: Lithic::RequestOptions::OrHash + ).returns(Lithic::Internal::CursorPage[Lithic::DisputeV2]) + end + def list( + # Filter by account token. + account_token: nil, + # RFC 3339 timestamp for filtering by created date, inclusive. + begin_: nil, + # Filter by card token. + card_token: nil, + # Filter by the token of the transaction being disputed. Corresponds with + # transaction_series.related_transaction_token in the Dispute. + disputed_transaction_token: nil, + # RFC 3339 timestamp for filtering by created date, inclusive. + end_: nil, + # 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. + ending_before: nil, + # Number of items to return. + page_size: nil, + # 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. + starting_after: nil, + request_options: {} + ) + end + + # @api private + sig { params(client: Lithic::Client).returns(T.attached_class) } + def self.new(client:) + end + end + end +end diff --git a/rbi/lithic/resources/external_bank_accounts.rbi b/rbi/lithic/resources/external_bank_accounts.rbi index ab7777b1..4e2c95c3 100644 --- a/rbi/lithic/resources/external_bank_accounts.rbi +++ b/rbi/lithic/resources/external_bank_accounts.rbi @@ -197,6 +197,16 @@ module Lithic ) end + # Unpause an external bank account + sig do + params( + external_bank_account_token: String, + request_options: Lithic::RequestOptions::OrHash + ).returns(Lithic::Models::ExternalBankAccountUnpauseResponse) + end + def unpause(external_bank_account_token, request_options: {}) + end + # @api private sig { params(client: Lithic::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/lithic/resources/payments.rbi b/rbi/lithic/resources/payments.rbi index 731d697b..bd1d9579 100644 --- a/rbi/lithic/resources/payments.rbi +++ b/rbi/lithic/resources/payments.rbi @@ -97,6 +97,52 @@ module Lithic def retry_(payment_token, request_options: {}) end + # Return an ACH payment with a specified return reason code. Returns must be + # initiated within the time window specified by NACHA rules for each return code + # (typically 2 banking days for most codes, 60 calendar days for unauthorized + # debits). For a complete list of return codes and their meanings, see the + # [ACH Return Reasons documentation](https://docs.lithic.com/docs/ach-overview#ach-return-reasons). + # + # Note: + # + # - This endpoint does not modify the state of the financial account associated + # with the payment. If you would like to change the account state, use the + # [Update financial account status](https://docs.lithic.com/reference/updatefinancialaccountstatus) + # endpoint. + # - By default this endpoint is not enabled for your account. Please contact your + # implementations manager to enable this feature. + sig do + params( + payment_token: String, + financial_account_token: String, + return_reason_code: String, + addenda: T.nilable(String), + date_of_death: T.nilable(Date), + memo: T.nilable(String), + request_options: Lithic::RequestOptions::OrHash + ).returns(Lithic::Payment) + end + def return_( + payment_token, + # Globally unique identifier for the financial account + financial_account_token:, + # 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_reason_code:, + # Optional additional information about the return. Limited to 44 characters + addenda: nil, + # Date of death in YYYY-MM-DD format. Required when using return codes **R14** + # (representative payee deceased) or **R15** (beneficiary or account holder + # deceased) + date_of_death: nil, + # Optional memo for the return. Limited to 10 characters + memo: nil, + request_options: {} + ) + end + # Simulate payment lifecycle event sig do params( diff --git a/sig/lithic/client.rbs b/sig/lithic/client.rbs index a2c7f061..19f25f0b 100644 --- a/sig/lithic/client.rbs +++ b/sig/lithic/client.rbs @@ -35,6 +35,8 @@ module Lithic attr_reader disputes: Lithic::Resources::Disputes + attr_reader disputes_v2: Lithic::Resources::DisputesV2 + attr_reader events: Lithic::Resources::Events attr_reader transfers: Lithic::Resources::Transfers diff --git a/sig/lithic/models.rbs b/sig/lithic/models.rbs index d1c285c5..e8f63cb6 100644 --- a/sig/lithic/models.rbs +++ b/sig/lithic/models.rbs @@ -107,6 +107,8 @@ module Lithic class Carrier = Lithic::Models::Carrier + class CategoryDetails = Lithic::Models::CategoryDetails + class ClientAPIStatusParams = Lithic::Models::ClientAPIStatusParams module CreditProducts = Lithic::Models::CreditProducts @@ -139,8 +141,14 @@ module Lithic class DisputeRetrieveParams = Lithic::Models::DisputeRetrieveParams + class DisputesV2ListParams = Lithic::Models::DisputesV2ListParams + + class DisputesV2RetrieveParams = Lithic::Models::DisputesV2RetrieveParams + class DisputeUpdateParams = Lithic::Models::DisputeUpdateParams + class DisputeV2 = Lithic::Models::DisputeV2 + class Document = Lithic::Models::Document class Event = Lithic::Models::Event @@ -169,6 +177,8 @@ module Lithic module ExternalBankAccounts = Lithic::Models::ExternalBankAccounts + class ExternalBankAccountUnpauseParams = Lithic::Models::ExternalBankAccountUnpauseParams + class ExternalBankAccountUpdateParams = Lithic::Models::ExternalBankAccountUpdateParams class ExternalPayment = Lithic::Models::ExternalPayment @@ -207,6 +217,8 @@ module Lithic class FinancialAccountUpdateStatusParams = Lithic::Models::FinancialAccountUpdateStatusParams + class FinancialEvent = Lithic::Models::FinancialEvent + class FinancialTransaction = Lithic::Models::FinancialTransaction module Fraud = Lithic::Models::Fraud @@ -237,6 +249,8 @@ module Lithic class ManagementOperationTransaction = Lithic::Models::ManagementOperationTransaction + class Merchant = Lithic::Models::Merchant + class MessageAttempt = Lithic::Models::MessageAttempt class NetworkProgram = Lithic::Models::NetworkProgram @@ -259,6 +273,8 @@ module Lithic class PaymentRetryParams = Lithic::Models::PaymentRetryParams + class PaymentReturnParams = Lithic::Models::PaymentReturnParams + class PaymentSimulateActionParams = Lithic::Models::PaymentSimulateActionParams class PaymentSimulateReceiptParams = Lithic::Models::PaymentSimulateReceiptParams @@ -291,6 +307,8 @@ module Lithic module SpendLimitDuration = Lithic::Models::SpendLimitDuration + class StatementTotals = Lithic::Models::StatementTotals + module ThreeDS = Lithic::Models::ThreeDS class Tokenization = Lithic::Models::Tokenization diff --git a/sig/lithic/models/account_activity_list_response.rbs b/sig/lithic/models/account_activity_list_response.rbs index 2775eebb..fa6809fd 100644 --- a/sig/lithic/models/account_activity_list_response.rbs +++ b/sig/lithic/models/account_activity_list_response.rbs @@ -18,7 +18,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], family: :INTERNAL, financial_account_token: String, pending_amount: Integer, @@ -39,7 +39,7 @@ module Lithic attr_accessor descriptor: String - attr_accessor events: ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event] + attr_accessor events: ::Array[Lithic::FinancialEvent] attr_accessor family: :INTERNAL @@ -61,7 +61,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], financial_account_token: String, pending_amount: Integer, result: Lithic::Models::AccountActivityListResponse::Internal::result, @@ -77,7 +77,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], family: :INTERNAL, financial_account_token: String, pending_amount: Integer, @@ -132,219 +132,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::category] end - type event = - { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::AccountActivityListResponse::Internal::Event::result, - type: Lithic::Models::AccountActivityListResponse::Internal::Event::type_ - } - - class Event < Lithic::Internal::Type::BaseModel - attr_reader token: String? - - def token=: (String) -> String - - attr_reader amount: Integer? - - def amount=: (Integer) -> Integer - - attr_reader created: Time? - - def created=: (Time) -> Time - - attr_reader result: Lithic::Models::AccountActivityListResponse::Internal::Event::result? - - def result=: ( - Lithic::Models::AccountActivityListResponse::Internal::Event::result - ) -> Lithic::Models::AccountActivityListResponse::Internal::Event::result - - attr_reader type: Lithic::Models::AccountActivityListResponse::Internal::Event::type_? - - def type=: ( - Lithic::Models::AccountActivityListResponse::Internal::Event::type_ - ) -> Lithic::Models::AccountActivityListResponse::Internal::Event::type_ - - def initialize: ( - ?token: String, - ?amount: Integer, - ?created: Time, - ?result: Lithic::Models::AccountActivityListResponse::Internal::Event::result, - ?type: Lithic::Models::AccountActivityListResponse::Internal::Event::type_ - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::AccountActivityListResponse::Internal::Event::result, - type: Lithic::Models::AccountActivityListResponse::Internal::Event::type_ - } - - type result = :APPROVED | :DECLINED - - module Result - extend Lithic::Internal::Type::Enum - - APPROVED: :APPROVED - DECLINED: :DECLINED - - def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event::result] - end - - type type_ = - :ACH_ORIGINATION_CANCELLED - | :ACH_ORIGINATION_INITIATED - | :ACH_ORIGINATION_PROCESSED - | :ACH_ORIGINATION_RELEASED - | :ACH_ORIGINATION_REJECTED - | :ACH_ORIGINATION_REVIEWED - | :ACH_ORIGINATION_SETTLED - | :ACH_RECEIPT_PROCESSED - | :ACH_RECEIPT_RELEASED - | :ACH_RECEIPT_SETTLED - | :ACH_RETURN_INITIATED - | :ACH_RETURN_PROCESSED - | :ACH_RETURN_REJECTED - | :ACH_RETURN_SETTLED - | :AUTHORIZATION - | :AUTHORIZATION_ADVICE - | :AUTHORIZATION_EXPIRY - | :AUTHORIZATION_REVERSAL - | :BALANCE_INQUIRY - | :BILLING_ERROR - | :BILLING_ERROR_REVERSAL - | :CARD_TO_CARD - | :CASH_BACK - | :CASH_BACK_REVERSAL - | :CLEARING - | :COLLECTION - | :CORRECTION_CREDIT - | :CORRECTION_DEBIT - | :CREDIT_AUTHORIZATION - | :CREDIT_AUTHORIZATION_ADVICE - | :CURRENCY_CONVERSION - | :CURRENCY_CONVERSION_REVERSAL - | :DISPUTE_WON - | :EXTERNAL_ACH_CANCELED - | :EXTERNAL_ACH_INITIATED - | :EXTERNAL_ACH_RELEASED - | :EXTERNAL_ACH_REVERSED - | :EXTERNAL_ACH_SETTLED - | :EXTERNAL_CHECK_CANCELED - | :EXTERNAL_CHECK_INITIATED - | :EXTERNAL_CHECK_RELEASED - | :EXTERNAL_CHECK_REVERSED - | :EXTERNAL_CHECK_SETTLED - | :EXTERNAL_TRANSFER_CANCELED - | :EXTERNAL_TRANSFER_INITIATED - | :EXTERNAL_TRANSFER_RELEASED - | :EXTERNAL_TRANSFER_REVERSED - | :EXTERNAL_TRANSFER_SETTLED - | :EXTERNAL_WIRE_CANCELED - | :EXTERNAL_WIRE_INITIATED - | :EXTERNAL_WIRE_RELEASED - | :EXTERNAL_WIRE_REVERSED - | :EXTERNAL_WIRE_SETTLED - | :FINANCIAL_AUTHORIZATION - | :FINANCIAL_CREDIT_AUTHORIZATION - | :INTEREST - | :INTEREST_REVERSAL - | :INTERNAL_ADJUSTMENT - | :LATE_PAYMENT - | :LATE_PAYMENT_REVERSAL - | :LOSS_WRITE_OFF - | :PROVISIONAL_CREDIT - | :PROVISIONAL_CREDIT_REVERSAL - | :SERVICE - | :RETURN - | :RETURN_REVERSAL - | :TRANSFER - | :TRANSFER_INSUFFICIENT_FUNDS - | :RETURNED_PAYMENT - | :RETURNED_PAYMENT_REVERSAL - | :LITHIC_NETWORK_PAYMENT - - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED: :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED: :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED: :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED: :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED: :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED: :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED: :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED: :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED: :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED: :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED: :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED: :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED: :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED: :ACH_RETURN_SETTLED - AUTHORIZATION: :AUTHORIZATION - AUTHORIZATION_ADVICE: :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY: :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL: :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY: :BALANCE_INQUIRY - BILLING_ERROR: :BILLING_ERROR - BILLING_ERROR_REVERSAL: :BILLING_ERROR_REVERSAL - CARD_TO_CARD: :CARD_TO_CARD - CASH_BACK: :CASH_BACK - CASH_BACK_REVERSAL: :CASH_BACK_REVERSAL - CLEARING: :CLEARING - COLLECTION: :COLLECTION - CORRECTION_CREDIT: :CORRECTION_CREDIT - CORRECTION_DEBIT: :CORRECTION_DEBIT - CREDIT_AUTHORIZATION: :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE: :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION: :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL: :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON: :DISPUTE_WON - EXTERNAL_ACH_CANCELED: :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED: :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED: :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED: :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED: :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED: :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED: :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED: :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED: :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED: :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED: :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED: :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED: :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED: :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED: :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED: :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED: :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED: :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED: :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED: :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION: :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION: :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST: :INTEREST - INTEREST_REVERSAL: :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT: :INTERNAL_ADJUSTMENT - LATE_PAYMENT: :LATE_PAYMENT - LATE_PAYMENT_REVERSAL: :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF: :LOSS_WRITE_OFF - PROVISIONAL_CREDIT: :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL: :PROVISIONAL_CREDIT_REVERSAL - SERVICE: :SERVICE - RETURN: :RETURN - RETURN_REVERSAL: :RETURN_REVERSAL - TRANSFER: :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS: :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT: :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL: :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT: :LITHIC_NETWORK_PAYMENT - - def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::Event::type_] - end - end - type result = :APPROVED | :DECLINED module Result @@ -356,7 +143,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::result] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -366,17 +154,75 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Internal::status] end end - type card = { } + type card = + { + token: String, + created: Time, + family: :CARD, + status: Lithic::Models::AccountActivityListResponse::Card::status, + updated: Time + } class Card < Lithic::Models::Transaction - def initialize: -> void + def token: -> String + + def token=: (String _) -> String + + def created: -> Time + + def created=: (Time _) -> Time - def to_hash: -> { } + def family: -> :CARD + + def family=: (:CARD _) -> :CARD + + def status: -> Lithic::Models::AccountActivityListResponse::Card::status + + def status=: ( + Lithic::Models::AccountActivityListResponse::Card::status _ + ) -> Lithic::Models::AccountActivityListResponse::Card::status + + def updated: -> Time + + def updated=: (Time _) -> Time + + def initialize: ( + token: String, + created: Time, + status: Lithic::Models::AccountActivityListResponse::Card::status, + updated: Time, + ?family: :CARD + ) -> void + + def to_hash: -> { + token: String, + created: Time, + family: :CARD, + status: Lithic::Models::AccountActivityListResponse::Card::status, + updated: Time + } + + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED + + module Status + extend Lithic::Internal::Type::Enum + + PENDING: :PENDING + SETTLED: :SETTLED + DECLINED: :DECLINED + REVERSED: :REVERSED + CANCELED: :CANCELED + RETURNED: :RETURNED + + def self?.values: -> ::Array[Lithic::Models::AccountActivityListResponse::Card::status] + end end def self?.variants: -> ::Array[Lithic::Models::account_activity_list_response] diff --git a/sig/lithic/models/account_activity_retrieve_transaction_response.rbs b/sig/lithic/models/account_activity_retrieve_transaction_response.rbs index adf40eb3..91bcf695 100644 --- a/sig/lithic/models/account_activity_retrieve_transaction_response.rbs +++ b/sig/lithic/models/account_activity_retrieve_transaction_response.rbs @@ -18,7 +18,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], family: :INTERNAL, financial_account_token: String, pending_amount: Integer, @@ -39,7 +39,7 @@ module Lithic attr_accessor descriptor: String - attr_accessor events: ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event] + attr_accessor events: ::Array[Lithic::FinancialEvent] attr_accessor family: :INTERNAL @@ -61,7 +61,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], financial_account_token: String, pending_amount: Integer, result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::result, @@ -77,7 +77,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event], + events: ::Array[Lithic::FinancialEvent], family: :INTERNAL, financial_account_token: String, pending_amount: Integer, @@ -132,219 +132,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::category] end - type event = - { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result, - type: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_ - } - - class Event < Lithic::Internal::Type::BaseModel - attr_reader token: String? - - def token=: (String) -> String - - attr_reader amount: Integer? - - def amount=: (Integer) -> Integer - - attr_reader created: Time? - - def created=: (Time) -> Time - - attr_reader result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result? - - def result=: ( - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result - ) -> Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result - - attr_reader type: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_? - - def type=: ( - Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_ - ) -> Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_ - - def initialize: ( - ?token: String, - ?amount: Integer, - ?created: Time, - ?result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result, - ?type: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_ - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result, - type: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_ - } - - type result = :APPROVED | :DECLINED - - module Result - extend Lithic::Internal::Type::Enum - - APPROVED: :APPROVED - DECLINED: :DECLINED - - def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::result] - end - - type type_ = - :ACH_ORIGINATION_CANCELLED - | :ACH_ORIGINATION_INITIATED - | :ACH_ORIGINATION_PROCESSED - | :ACH_ORIGINATION_RELEASED - | :ACH_ORIGINATION_REJECTED - | :ACH_ORIGINATION_REVIEWED - | :ACH_ORIGINATION_SETTLED - | :ACH_RECEIPT_PROCESSED - | :ACH_RECEIPT_RELEASED - | :ACH_RECEIPT_SETTLED - | :ACH_RETURN_INITIATED - | :ACH_RETURN_PROCESSED - | :ACH_RETURN_REJECTED - | :ACH_RETURN_SETTLED - | :AUTHORIZATION - | :AUTHORIZATION_ADVICE - | :AUTHORIZATION_EXPIRY - | :AUTHORIZATION_REVERSAL - | :BALANCE_INQUIRY - | :BILLING_ERROR - | :BILLING_ERROR_REVERSAL - | :CARD_TO_CARD - | :CASH_BACK - | :CASH_BACK_REVERSAL - | :CLEARING - | :COLLECTION - | :CORRECTION_CREDIT - | :CORRECTION_DEBIT - | :CREDIT_AUTHORIZATION - | :CREDIT_AUTHORIZATION_ADVICE - | :CURRENCY_CONVERSION - | :CURRENCY_CONVERSION_REVERSAL - | :DISPUTE_WON - | :EXTERNAL_ACH_CANCELED - | :EXTERNAL_ACH_INITIATED - | :EXTERNAL_ACH_RELEASED - | :EXTERNAL_ACH_REVERSED - | :EXTERNAL_ACH_SETTLED - | :EXTERNAL_CHECK_CANCELED - | :EXTERNAL_CHECK_INITIATED - | :EXTERNAL_CHECK_RELEASED - | :EXTERNAL_CHECK_REVERSED - | :EXTERNAL_CHECK_SETTLED - | :EXTERNAL_TRANSFER_CANCELED - | :EXTERNAL_TRANSFER_INITIATED - | :EXTERNAL_TRANSFER_RELEASED - | :EXTERNAL_TRANSFER_REVERSED - | :EXTERNAL_TRANSFER_SETTLED - | :EXTERNAL_WIRE_CANCELED - | :EXTERNAL_WIRE_INITIATED - | :EXTERNAL_WIRE_RELEASED - | :EXTERNAL_WIRE_REVERSED - | :EXTERNAL_WIRE_SETTLED - | :FINANCIAL_AUTHORIZATION - | :FINANCIAL_CREDIT_AUTHORIZATION - | :INTEREST - | :INTEREST_REVERSAL - | :INTERNAL_ADJUSTMENT - | :LATE_PAYMENT - | :LATE_PAYMENT_REVERSAL - | :LOSS_WRITE_OFF - | :PROVISIONAL_CREDIT - | :PROVISIONAL_CREDIT_REVERSAL - | :SERVICE - | :RETURN - | :RETURN_REVERSAL - | :TRANSFER - | :TRANSFER_INSUFFICIENT_FUNDS - | :RETURNED_PAYMENT - | :RETURNED_PAYMENT_REVERSAL - | :LITHIC_NETWORK_PAYMENT - - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED: :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED: :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED: :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED: :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED: :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED: :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED: :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED: :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED: :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED: :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED: :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED: :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED: :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED: :ACH_RETURN_SETTLED - AUTHORIZATION: :AUTHORIZATION - AUTHORIZATION_ADVICE: :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY: :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL: :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY: :BALANCE_INQUIRY - BILLING_ERROR: :BILLING_ERROR - BILLING_ERROR_REVERSAL: :BILLING_ERROR_REVERSAL - CARD_TO_CARD: :CARD_TO_CARD - CASH_BACK: :CASH_BACK - CASH_BACK_REVERSAL: :CASH_BACK_REVERSAL - CLEARING: :CLEARING - COLLECTION: :COLLECTION - CORRECTION_CREDIT: :CORRECTION_CREDIT - CORRECTION_DEBIT: :CORRECTION_DEBIT - CREDIT_AUTHORIZATION: :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE: :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION: :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL: :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON: :DISPUTE_WON - EXTERNAL_ACH_CANCELED: :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED: :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED: :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED: :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED: :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED: :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED: :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED: :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED: :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED: :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED: :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED: :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED: :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED: :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED: :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED: :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED: :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED: :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED: :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED: :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION: :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION: :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST: :INTEREST - INTEREST_REVERSAL: :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT: :INTERNAL_ADJUSTMENT - LATE_PAYMENT: :LATE_PAYMENT - LATE_PAYMENT_REVERSAL: :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF: :LOSS_WRITE_OFF - PROVISIONAL_CREDIT: :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL: :PROVISIONAL_CREDIT_REVERSAL - SERVICE: :SERVICE - RETURN: :RETURN - RETURN_REVERSAL: :RETURN_REVERSAL - TRANSFER: :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS: :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT: :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL: :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT: :LITHIC_NETWORK_PAYMENT - - def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event::type_] - end - end - type result = :APPROVED | :DECLINED module Result @@ -356,7 +143,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::result] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -366,17 +154,75 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::status] end end - type card = { } + type card = + { + token: String, + created: Time, + family: :CARD, + status: Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status, + updated: Time + } class Card < Lithic::Models::Transaction - def initialize: -> void + def token: -> String + + def token=: (String _) -> String + + def created: -> Time + + def created=: (Time _) -> Time - def to_hash: -> { } + def family: -> :CARD + + def family=: (:CARD _) -> :CARD + + def status: -> Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status + + def status=: ( + Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status _ + ) -> Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status + + def updated: -> Time + + def updated=: (Time _) -> Time + + def initialize: ( + token: String, + created: Time, + status: Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status, + updated: Time, + ?family: :CARD + ) -> void + + def to_hash: -> { + token: String, + created: Time, + family: :CARD, + status: Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status, + updated: Time + } + + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED + + module Status + extend Lithic::Internal::Type::Enum + + PENDING: :PENDING + SETTLED: :SETTLED + DECLINED: :DECLINED + REVERSED: :REVERSED + CANCELED: :CANCELED + RETURNED: :RETURNED + + def self?.values: -> ::Array[Lithic::Models::AccountActivityRetrieveTransactionResponse::Card::status] + end end def self?.variants: -> ::Array[Lithic::Models::account_activity_retrieve_transaction_response] diff --git a/sig/lithic/models/auth_rules/auth_rule_condition.rbs b/sig/lithic/models/auth_rules/auth_rule_condition.rbs index ead6a46a..89722681 100644 --- a/sig/lithic/models/auth_rules/auth_rule_condition.rbs +++ b/sig/lithic/models/auth_rules/auth_rule_condition.rbs @@ -6,79 +6,28 @@ module Lithic type auth_rule_condition = { attribute: Lithic::Models::AuthRules::conditional_attribute, - operation: Lithic::Models::AuthRules::AuthRuleCondition::operation, - value: Lithic::Models::AuthRules::AuthRuleCondition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } class AuthRuleCondition < Lithic::Internal::Type::BaseModel - attr_reader attribute: Lithic::Models::AuthRules::conditional_attribute? + attr_accessor attribute: Lithic::Models::AuthRules::conditional_attribute - def attribute=: ( - Lithic::Models::AuthRules::conditional_attribute - ) -> Lithic::Models::AuthRules::conditional_attribute + attr_accessor operation: Lithic::Models::AuthRules::conditional_operation - attr_reader operation: Lithic::Models::AuthRules::AuthRuleCondition::operation? - - def operation=: ( - Lithic::Models::AuthRules::AuthRuleCondition::operation - ) -> Lithic::Models::AuthRules::AuthRuleCondition::operation - - attr_reader value: Lithic::Models::AuthRules::AuthRuleCondition::value? - - def value=: ( - Lithic::Models::AuthRules::AuthRuleCondition::value - ) -> Lithic::Models::AuthRules::AuthRuleCondition::value + attr_accessor value: Lithic::Models::AuthRules::conditional_value def initialize: ( - ?attribute: Lithic::Models::AuthRules::conditional_attribute, - ?operation: Lithic::Models::AuthRules::AuthRuleCondition::operation, - ?value: Lithic::Models::AuthRules::AuthRuleCondition::value + attribute: Lithic::Models::AuthRules::conditional_attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value ) -> void def to_hash: -> { attribute: Lithic::Models::AuthRules::conditional_attribute, - operation: Lithic::Models::AuthRules::AuthRuleCondition::operation, - value: Lithic::Models::AuthRules::AuthRuleCondition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } - - type operation = - :IS_ONE_OF - | :IS_NOT_ONE_OF - | :MATCHES - | :DOES_NOT_MATCH - | :IS_EQUAL_TO - | :IS_NOT_EQUAL_TO - | :IS_GREATER_THAN - | :IS_GREATER_THAN_OR_EQUAL_TO - | :IS_LESS_THAN - | :IS_LESS_THAN_OR_EQUAL_TO - - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF: :IS_ONE_OF - IS_NOT_ONE_OF: :IS_NOT_ONE_OF - MATCHES: :MATCHES - DOES_NOT_MATCH: :DOES_NOT_MATCH - IS_EQUAL_TO: :IS_EQUAL_TO - IS_NOT_EQUAL_TO: :IS_NOT_EQUAL_TO - IS_GREATER_THAN: :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO: :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN: :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO: :IS_LESS_THAN_OR_EQUAL_TO - - def self?.values: -> ::Array[Lithic::Models::AuthRules::AuthRuleCondition::operation] - end - - type value = String | Integer | ::Array[String] - - module Value - extend Lithic::Internal::Type::Union - - def self?.variants: -> ::Array[Lithic::Models::AuthRules::AuthRuleCondition::value] - - StringArray: Lithic::Internal::Type::Converter - end end end end diff --git a/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs b/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs index 6e778cfc..4d676309 100644 --- a/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs +++ b/sig/lithic/models/auth_rules/conditional_3ds_action_parameters.rbs @@ -36,39 +36,27 @@ module Lithic type condition = { attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute, - operation: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation, - value: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } class Condition < Lithic::Internal::Type::BaseModel - attr_reader attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute? + attr_accessor attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute - def attribute=: ( - Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute - ) -> Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute + attr_accessor operation: Lithic::Models::AuthRules::conditional_operation - attr_reader operation: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation? - - def operation=: ( - Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation - ) -> Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation - - attr_reader value: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value? - - def value=: ( - Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value - ) -> Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value + attr_accessor value: Lithic::Models::AuthRules::conditional_value def initialize: ( - ?attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute, - ?operation: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation, - ?value: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value + attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value ) -> void def to_hash: -> { attribute: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute, - operation: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation, - value: Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } type attribute = @@ -97,45 +85,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::attribute] end - - type operation = - :IS_ONE_OF - | :IS_NOT_ONE_OF - | :MATCHES - | :DOES_NOT_MATCH - | :IS_EQUAL_TO - | :IS_NOT_EQUAL_TO - | :IS_GREATER_THAN - | :IS_GREATER_THAN_OR_EQUAL_TO - | :IS_LESS_THAN - | :IS_LESS_THAN_OR_EQUAL_TO - - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF: :IS_ONE_OF - IS_NOT_ONE_OF: :IS_NOT_ONE_OF - MATCHES: :MATCHES - DOES_NOT_MATCH: :DOES_NOT_MATCH - IS_EQUAL_TO: :IS_EQUAL_TO - IS_NOT_EQUAL_TO: :IS_NOT_EQUAL_TO - IS_GREATER_THAN: :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO: :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN: :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO: :IS_LESS_THAN_OR_EQUAL_TO - - def self?.values: -> ::Array[Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::operation] - end - - type value = String | Integer | ::Array[String] - - module Value - extend Lithic::Internal::Type::Union - - def self?.variants: -> ::Array[Lithic::Models::AuthRules::Conditional3DSActionParameters::Condition::value] - - StringArray: Lithic::Internal::Type::Converter - end end end end diff --git a/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs b/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs new file mode 100644 index 00000000..6958e51a --- /dev/null +++ b/sig/lithic/models/auth_rules/conditional_ach_action_parameters.rbs @@ -0,0 +1,293 @@ +module Lithic + module Models + module AuthRules + type conditional_ach_action_parameters = + { + action: Lithic::Models::AuthRules::ConditionalACHActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalACHActionParameters::Condition] + } + + class ConditionalACHActionParameters < Lithic::Internal::Type::BaseModel + attr_accessor action: Lithic::Models::AuthRules::ConditionalACHActionParameters::action + + attr_accessor conditions: ::Array[Lithic::AuthRules::ConditionalACHActionParameters::Condition] + + def initialize: ( + action: Lithic::Models::AuthRules::ConditionalACHActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalACHActionParameters::Condition] + ) -> void + + def to_hash: -> { + action: Lithic::Models::AuthRules::ConditionalACHActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalACHActionParameters::Condition] + } + + type action = + Lithic::AuthRules::ConditionalACHActionParameters::Action::ApproveAction + | Lithic::AuthRules::ConditionalACHActionParameters::Action::ReturnAction + + module Action + extend Lithic::Internal::Type::Union + + type approve_action = + { + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::type_ + } + + class ApproveAction < Lithic::Internal::Type::BaseModel + attr_accessor type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::type_ + + def initialize: ( + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::type_ + ) -> void + + def to_hash: -> { + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::type_ + } + + type type_ = :APPROVE + + module Type + extend Lithic::Internal::Type::Enum + + APPROVE: :APPROVE + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ApproveAction::type_] + end + end + + type return_action = + { + code: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::code, + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::type_ + } + + class ReturnAction < Lithic::Internal::Type::BaseModel + attr_accessor code: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::code + + attr_accessor type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::type_ + + def initialize: ( + code: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::code, + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::type_ + ) -> void + + def to_hash: -> { + code: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::code, + type: Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::type_ + } + + type code = + :R01 + | :R02 + | :R03 + | :R04 + | :R05 + | :R06 + | :R07 + | :R08 + | :R09 + | :R10 + | :R11 + | :R12 + | :R13 + | :R14 + | :R15 + | :R16 + | :R17 + | :R18 + | :R19 + | :R20 + | :R21 + | :R22 + | :R23 + | :R24 + | :R25 + | :R26 + | :R27 + | :R28 + | :R29 + | :R30 + | :R31 + | :R32 + | :R33 + | :R34 + | :R35 + | :R36 + | :R37 + | :R38 + | :R39 + | :R40 + | :R41 + | :R42 + | :R43 + | :R44 + | :R45 + | :R46 + | :R47 + | :R50 + | :R51 + | :R52 + | :R53 + | :R61 + | :R62 + | :R67 + | :R68 + | :R69 + | :R70 + | :R71 + | :R72 + | :R73 + | :R74 + | :R75 + | :R76 + | :R77 + | :R80 + | :R81 + | :R82 + | :R83 + | :R84 + | :R85 + + module Code + extend Lithic::Internal::Type::Enum + + R01: :R01 + R02: :R02 + R03: :R03 + R04: :R04 + R05: :R05 + R06: :R06 + R07: :R07 + R08: :R08 + R09: :R09 + R10: :R10 + R11: :R11 + R12: :R12 + R13: :R13 + R14: :R14 + R15: :R15 + R16: :R16 + R17: :R17 + R18: :R18 + R19: :R19 + R20: :R20 + R21: :R21 + R22: :R22 + R23: :R23 + R24: :R24 + R25: :R25 + R26: :R26 + R27: :R27 + R28: :R28 + R29: :R29 + R30: :R30 + R31: :R31 + R32: :R32 + R33: :R33 + R34: :R34 + R35: :R35 + R36: :R36 + R37: :R37 + R38: :R38 + R39: :R39 + R40: :R40 + R41: :R41 + R42: :R42 + R43: :R43 + R44: :R44 + R45: :R45 + R46: :R46 + R47: :R47 + R50: :R50 + R51: :R51 + R52: :R52 + R53: :R53 + R61: :R61 + R62: :R62 + R67: :R67 + R68: :R68 + R69: :R69 + R70: :R70 + R71: :R71 + R72: :R72 + R73: :R73 + R74: :R74 + R75: :R75 + R76: :R76 + R77: :R77 + R80: :R80 + R81: :R81 + R82: :R82 + R83: :R83 + R84: :R84 + R85: :R85 + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::code] + end + + type type_ = :RETURN + + module Type + extend Lithic::Internal::Type::Enum + + RETURN: :RETURN + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::Action::ReturnAction::type_] + end + end + + def self?.variants: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::action] + end + + type condition = + { + attribute: Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + } + + class Condition < Lithic::Internal::Type::BaseModel + attr_accessor attribute: Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute + + attr_accessor operation: Lithic::Models::AuthRules::conditional_operation + + attr_accessor value: Lithic::Models::AuthRules::conditional_value + + def initialize: ( + attribute: Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + ) -> void + + def to_hash: -> { + attribute: Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + } + + type attribute = + :COMPANY_NAME + | :COMPANY_ID + | :TIMESTAMP + | :TRANSACTION_AMOUNT + | :SEC_CODE + | :MEMO + + module Attribute + extend Lithic::Internal::Type::Enum + + COMPANY_NAME: :COMPANY_NAME + COMPANY_ID: :COMPANY_ID + TIMESTAMP: :TIMESTAMP + TRANSACTION_AMOUNT: :TRANSACTION_AMOUNT + SEC_CODE: :SEC_CODE + MEMO: :MEMO + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalACHActionParameters::Condition::attribute] + end + end + end + end + end +end diff --git a/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs b/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs index 8438ddd7..7a87a63c 100644 --- a/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs +++ b/sig/lithic/models/auth_rules/conditional_authorization_action_parameters.rbs @@ -36,39 +36,27 @@ module Lithic type condition = { attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute, - operation: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation, - value: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } class Condition < Lithic::Internal::Type::BaseModel - attr_reader attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute? + attr_accessor attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute - def attribute=: ( - Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute - ) -> Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute + attr_accessor operation: Lithic::Models::AuthRules::conditional_operation - attr_reader operation: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation? - - def operation=: ( - Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation - ) -> Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation - - attr_reader value: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value? - - def value=: ( - Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value - ) -> Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value + attr_accessor value: Lithic::Models::AuthRules::conditional_value def initialize: ( - ?attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute, - ?operation: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation, - ?value: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value + attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value ) -> void def to_hash: -> { attribute: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute, - operation: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation, - value: Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value } type attribute = @@ -117,45 +105,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::attribute] end - - type operation = - :IS_ONE_OF - | :IS_NOT_ONE_OF - | :MATCHES - | :DOES_NOT_MATCH - | :IS_EQUAL_TO - | :IS_NOT_EQUAL_TO - | :IS_GREATER_THAN - | :IS_GREATER_THAN_OR_EQUAL_TO - | :IS_LESS_THAN - | :IS_LESS_THAN_OR_EQUAL_TO - - module Operation - extend Lithic::Internal::Type::Enum - - IS_ONE_OF: :IS_ONE_OF - IS_NOT_ONE_OF: :IS_NOT_ONE_OF - MATCHES: :MATCHES - DOES_NOT_MATCH: :DOES_NOT_MATCH - IS_EQUAL_TO: :IS_EQUAL_TO - IS_NOT_EQUAL_TO: :IS_NOT_EQUAL_TO - IS_GREATER_THAN: :IS_GREATER_THAN - IS_GREATER_THAN_OR_EQUAL_TO: :IS_GREATER_THAN_OR_EQUAL_TO - IS_LESS_THAN: :IS_LESS_THAN - IS_LESS_THAN_OR_EQUAL_TO: :IS_LESS_THAN_OR_EQUAL_TO - - def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::operation] - end - - type value = String | Integer | ::Array[String] - - module Value - extend Lithic::Internal::Type::Union - - def self?.variants: -> ::Array[Lithic::Models::AuthRules::ConditionalAuthorizationActionParameters::Condition::value] - - StringArray: Lithic::Internal::Type::Converter - end end end end diff --git a/sig/lithic/models/auth_rules/conditional_operation.rbs b/sig/lithic/models/auth_rules/conditional_operation.rbs new file mode 100644 index 00000000..1eaacc6b --- /dev/null +++ b/sig/lithic/models/auth_rules/conditional_operation.rbs @@ -0,0 +1,34 @@ +module Lithic + module Models + module AuthRules + type conditional_operation = + :IS_ONE_OF + | :IS_NOT_ONE_OF + | :MATCHES + | :DOES_NOT_MATCH + | :IS_EQUAL_TO + | :IS_NOT_EQUAL_TO + | :IS_GREATER_THAN + | :IS_GREATER_THAN_OR_EQUAL_TO + | :IS_LESS_THAN + | :IS_LESS_THAN_OR_EQUAL_TO + + module ConditionalOperation + extend Lithic::Internal::Type::Enum + + IS_ONE_OF: :IS_ONE_OF + IS_NOT_ONE_OF: :IS_NOT_ONE_OF + MATCHES: :MATCHES + DOES_NOT_MATCH: :DOES_NOT_MATCH + IS_EQUAL_TO: :IS_EQUAL_TO + IS_NOT_EQUAL_TO: :IS_NOT_EQUAL_TO + IS_GREATER_THAN: :IS_GREATER_THAN + IS_GREATER_THAN_OR_EQUAL_TO: :IS_GREATER_THAN_OR_EQUAL_TO + IS_LESS_THAN: :IS_LESS_THAN + IS_LESS_THAN_OR_EQUAL_TO: :IS_LESS_THAN_OR_EQUAL_TO + + def self?.values: -> ::Array[Lithic::Models::AuthRules::conditional_operation] + end + end + end +end diff --git a/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs b/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs new file mode 100644 index 00000000..7fe94ae5 --- /dev/null +++ b/sig/lithic/models/auth_rules/conditional_tokenization_action_parameters.rbs @@ -0,0 +1,237 @@ +module Lithic + module Models + module AuthRules + type conditional_tokenization_action_parameters = + { + action: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] + } + + class ConditionalTokenizationActionParameters < Lithic::Internal::Type::BaseModel + attr_accessor action: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::action + + attr_accessor conditions: ::Array[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] + + def initialize: ( + action: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] + ) -> void + + def to_hash: -> { + action: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::action, + conditions: ::Array[Lithic::AuthRules::ConditionalTokenizationActionParameters::Condition] + } + + type action = + Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction + | Lithic::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction + + module Action + extend Lithic::Internal::Type::Union + + type decline_action = + { + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::type_, + reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason + } + + class DeclineAction < Lithic::Internal::Type::BaseModel + attr_accessor type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::type_ + + attr_reader reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason? + + def reason=: ( + Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason + ) -> Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason + + def initialize: ( + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::type_, + ?reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason + ) -> void + + def to_hash: -> { + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::type_, + reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason + } + + type type_ = :DECLINE + + module Type + extend Lithic::Internal::Type::Enum + + DECLINE: :DECLINE + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::type_] + end + + type reason = + :ACCOUNT_SCORE_1 + | :DEVICE_SCORE_1 + | :ALL_WALLET_DECLINE_REASONS_PRESENT + | :WALLET_RECOMMENDED_DECISION_RED + | :CVC_MISMATCH + | :CARD_EXPIRY_MONTH_MISMATCH + | :CARD_EXPIRY_YEAR_MISMATCH + | :CARD_INVALID_STATE + | :CUSTOMER_RED_PATH + | :INVALID_CUSTOMER_RESPONSE + | :NETWORK_FAILURE + | :GENERIC_DECLINE + | :DIGITAL_CARD_ART_REQUIRED + + module Reason + extend Lithic::Internal::Type::Enum + + ACCOUNT_SCORE_1: :ACCOUNT_SCORE_1 + DEVICE_SCORE_1: :DEVICE_SCORE_1 + ALL_WALLET_DECLINE_REASONS_PRESENT: :ALL_WALLET_DECLINE_REASONS_PRESENT + WALLET_RECOMMENDED_DECISION_RED: :WALLET_RECOMMENDED_DECISION_RED + CVC_MISMATCH: :CVC_MISMATCH + CARD_EXPIRY_MONTH_MISMATCH: :CARD_EXPIRY_MONTH_MISMATCH + CARD_EXPIRY_YEAR_MISMATCH: :CARD_EXPIRY_YEAR_MISMATCH + CARD_INVALID_STATE: :CARD_INVALID_STATE + CUSTOMER_RED_PATH: :CUSTOMER_RED_PATH + INVALID_CUSTOMER_RESPONSE: :INVALID_CUSTOMER_RESPONSE + NETWORK_FAILURE: :NETWORK_FAILURE + GENERIC_DECLINE: :GENERIC_DECLINE + DIGITAL_CARD_ART_REQUIRED: :DIGITAL_CARD_ART_REQUIRED + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::DeclineAction::reason] + end + end + + type require_tfa_action = + { + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::type_, + reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason + } + + class RequireTfaAction < Lithic::Internal::Type::BaseModel + attr_accessor type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::type_ + + attr_reader reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason? + + def reason=: ( + Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason + ) -> Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason + + def initialize: ( + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::type_, + ?reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason + ) -> void + + def to_hash: -> { + type: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::type_, + reason: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason + } + + type type_ = :REQUIRE_TFA + + module Type + extend Lithic::Internal::Type::Enum + + REQUIRE_TFA: :REQUIRE_TFA + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::type_] + end + + type reason = + :WALLET_RECOMMENDED_TFA + | :SUSPICIOUS_ACTIVITY + | :DEVICE_RECENTLY_LOST + | :TOO_MANY_RECENT_ATTEMPTS + | :TOO_MANY_RECENT_TOKENS + | :TOO_MANY_DIFFERENT_CARDHOLDERS + | :OUTSIDE_HOME_TERRITORY + | :HAS_SUSPENDED_TOKENS + | :HIGH_RISK + | :ACCOUNT_SCORE_LOW + | :DEVICE_SCORE_LOW + | :CARD_STATE_TFA + | :HARDCODED_TFA + | :CUSTOMER_RULE_TFA + | :DEVICE_HOST_CARD_EMULATION + + module Reason + extend Lithic::Internal::Type::Enum + + WALLET_RECOMMENDED_TFA: :WALLET_RECOMMENDED_TFA + SUSPICIOUS_ACTIVITY: :SUSPICIOUS_ACTIVITY + DEVICE_RECENTLY_LOST: :DEVICE_RECENTLY_LOST + TOO_MANY_RECENT_ATTEMPTS: :TOO_MANY_RECENT_ATTEMPTS + TOO_MANY_RECENT_TOKENS: :TOO_MANY_RECENT_TOKENS + TOO_MANY_DIFFERENT_CARDHOLDERS: :TOO_MANY_DIFFERENT_CARDHOLDERS + OUTSIDE_HOME_TERRITORY: :OUTSIDE_HOME_TERRITORY + HAS_SUSPENDED_TOKENS: :HAS_SUSPENDED_TOKENS + HIGH_RISK: :HIGH_RISK + ACCOUNT_SCORE_LOW: :ACCOUNT_SCORE_LOW + DEVICE_SCORE_LOW: :DEVICE_SCORE_LOW + CARD_STATE_TFA: :CARD_STATE_TFA + HARDCODED_TFA: :HARDCODED_TFA + CUSTOMER_RULE_TFA: :CUSTOMER_RULE_TFA + DEVICE_HOST_CARD_EMULATION: :DEVICE_HOST_CARD_EMULATION + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Action::RequireTfaAction::reason] + end + end + + def self?.variants: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::action] + end + + type condition = + { + attribute: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + } + + class Condition < Lithic::Internal::Type::BaseModel + attr_accessor attribute: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::attribute + + attr_accessor operation: Lithic::Models::AuthRules::conditional_operation + + attr_accessor value: Lithic::Models::AuthRules::conditional_value + + def initialize: ( + attribute: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + ) -> void + + def to_hash: -> { + attribute: Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::attribute, + operation: Lithic::Models::AuthRules::conditional_operation, + value: Lithic::Models::AuthRules::conditional_value + } + + type attribute = + :TIMESTAMP + | :TOKENIZATION_CHANNEL + | :TOKENIZATION_SOURCE + | :TOKEN_REQUESTOR_NAME + | :WALLET_ACCOUNT_SCORE + | :WALLET_DEVICE_SCORE + | :WALLET_RECOMMENDED_DECISION + | :TOKEN_REQUESTOR_ID + | :WALLET_TOKEN_STATUS + + module Attribute + extend Lithic::Internal::Type::Enum + + TIMESTAMP: :TIMESTAMP + TOKENIZATION_CHANNEL: :TOKENIZATION_CHANNEL + TOKENIZATION_SOURCE: :TOKENIZATION_SOURCE + TOKEN_REQUESTOR_NAME: :TOKEN_REQUESTOR_NAME + WALLET_ACCOUNT_SCORE: :WALLET_ACCOUNT_SCORE + WALLET_DEVICE_SCORE: :WALLET_DEVICE_SCORE + WALLET_RECOMMENDED_DECISION: :WALLET_RECOMMENDED_DECISION + TOKEN_REQUESTOR_ID: :TOKEN_REQUESTOR_ID + WALLET_TOKEN_STATUS: :WALLET_TOKEN_STATUS + + def self?.values: -> ::Array[Lithic::Models::AuthRules::ConditionalTokenizationActionParameters::Condition::attribute] + end + end + end + end + end +end diff --git a/sig/lithic/models/auth_rules/conditional_value.rbs b/sig/lithic/models/auth_rules/conditional_value.rbs new file mode 100644 index 00000000..89c50e74 --- /dev/null +++ b/sig/lithic/models/auth_rules/conditional_value.rbs @@ -0,0 +1,15 @@ +module Lithic + module Models + module AuthRules + type conditional_value = String | Integer | ::Array[String] + + module ConditionalValue + extend Lithic::Internal::Type::Union + + def self?.variants: -> ::Array[Lithic::Models::AuthRules::conditional_value] + + StringArray: Lithic::Internal::Type::Converter + end + end + end +end diff --git a/sig/lithic/models/auth_rules/v2_create_params.rbs b/sig/lithic/models/auth_rules/v2_create_params.rbs index 255ee195..0032aebc 100644 --- a/sig/lithic/models/auth_rules/v2_create_params.rbs +++ b/sig/lithic/models/auth_rules/v2_create_params.rbs @@ -79,6 +79,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -103,13 +105,21 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::AuthRules::V2CreateParams::type_] end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2CreateParams::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_create_response.rbs b/sig/lithic/models/auth_rules/v2_create_response.rbs index ff9b52f1..299e5ae6 100644 --- a/sig/lithic/models/auth_rules/v2_create_response.rbs +++ b/sig/lithic/models/auth_rules/v2_create_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2CreateResponse::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_draft_params.rbs b/sig/lithic/models/auth_rules/v2_draft_params.rbs index 728b8d87..e458a2b3 100644 --- a/sig/lithic/models/auth_rules/v2_draft_params.rbs +++ b/sig/lithic/models/auth_rules/v2_draft_params.rbs @@ -27,6 +27,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union diff --git a/sig/lithic/models/auth_rules/v2_draft_response.rbs b/sig/lithic/models/auth_rules/v2_draft_response.rbs index 6f30098b..837cbf04 100644 --- a/sig/lithic/models/auth_rules/v2_draft_response.rbs +++ b/sig/lithic/models/auth_rules/v2_draft_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2DraftResponse::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_list_params.rbs b/sig/lithic/models/auth_rules/v2_list_params.rbs index 1dfe13ac..96ae5cb2 100644 --- a/sig/lithic/models/auth_rules/v2_list_params.rbs +++ b/sig/lithic/models/auth_rules/v2_list_params.rbs @@ -78,13 +78,21 @@ module Lithic request_options: Lithic::RequestOptions } - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2ListParams::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_list_response.rbs b/sig/lithic/models/auth_rules/v2_list_response.rbs index f9767075..c88786c0 100644 --- a/sig/lithic/models/auth_rules/v2_list_response.rbs +++ b/sig/lithic/models/auth_rules/v2_list_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2ListResponse::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_promote_response.rbs b/sig/lithic/models/auth_rules/v2_promote_response.rbs index c693e5d1..897eae52 100644 --- a/sig/lithic/models/auth_rules/v2_promote_response.rbs +++ b/sig/lithic/models/auth_rules/v2_promote_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2PromoteResponse::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_retrieve_response.rbs b/sig/lithic/models/auth_rules/v2_retrieve_response.rbs index 646617ad..91f58a93 100644 --- a/sig/lithic/models/auth_rules/v2_retrieve_response.rbs +++ b/sig/lithic/models/auth_rules/v2_retrieve_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2RetrieveResponse::event_stream] end diff --git a/sig/lithic/models/auth_rules/v2_update_response.rbs b/sig/lithic/models/auth_rules/v2_update_response.rbs index bedfebc1..1a59f799 100644 --- a/sig/lithic/models/auth_rules/v2_update_response.rbs +++ b/sig/lithic/models/auth_rules/v2_update_response.rbs @@ -106,6 +106,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -141,6 +143,8 @@ module Lithic | Lithic::AuthRules::MerchantLockParameters | Lithic::AuthRules::Conditional3DSActionParameters | Lithic::AuthRules::ConditionalAuthorizationActionParameters + | Lithic::AuthRules::ConditionalACHActionParameters + | Lithic::AuthRules::ConditionalTokenizationActionParameters module Parameters extend Lithic::Internal::Type::Union @@ -149,13 +153,21 @@ module Lithic end end - type event_stream = :AUTHORIZATION | :THREE_DS_AUTHENTICATION + type event_stream = + :AUTHORIZATION + | :THREE_DS_AUTHENTICATION + | :TOKENIZATION + | :ACH_CREDIT_RECEIPT + | :ACH_DEBIT_RECEIPT module EventStream extend Lithic::Internal::Type::Enum AUTHORIZATION: :AUTHORIZATION THREE_DS_AUTHENTICATION: :THREE_DS_AUTHENTICATION + TOKENIZATION: :TOKENIZATION + ACH_CREDIT_RECEIPT: :ACH_CREDIT_RECEIPT + ACH_DEBIT_RECEIPT: :ACH_DEBIT_RECEIPT def self?.values: -> ::Array[Lithic::Models::AuthRules::V2UpdateResponse::event_stream] end diff --git a/sig/lithic/models/book_transfer_response.rbs b/sig/lithic/models/book_transfer_response.rbs index 3756f11a..760bcd97 100644 --- a/sig/lithic/models/book_transfer_response.rbs +++ b/sig/lithic/models/book_transfer_response.rbs @@ -282,7 +282,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::BookTransferResponse::result] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -292,6 +293,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::BookTransferResponse::status] end diff --git a/sig/lithic/models/category_details.rbs b/sig/lithic/models/category_details.rbs new file mode 100644 index 00000000..36a6d750 --- /dev/null +++ b/sig/lithic/models/category_details.rbs @@ -0,0 +1,26 @@ +module Lithic + module Models + type category_details = + { balance_transfers: String, cash_advances: String, purchases: String } + + class CategoryDetails < Lithic::Internal::Type::BaseModel + attr_accessor balance_transfers: String + + attr_accessor cash_advances: String + + attr_accessor purchases: String + + def initialize: ( + balance_transfers: String, + cash_advances: String, + purchases: String + ) -> void + + def to_hash: -> { + balance_transfers: String, + cash_advances: String, + purchases: String + } + end + end +end diff --git a/sig/lithic/models/dispute.rbs b/sig/lithic/models/dispute.rbs index 17666f5e..cd7c62ac 100644 --- a/sig/lithic/models/dispute.rbs +++ b/sig/lithic/models/dispute.rbs @@ -3,468 +3,208 @@ module Lithic type dispute = { token: String, - account_token: String, - card_token: String, - case_id: String?, + amount: Integer, + arbitration_date: Time?, created: Time, - currency: String, - disposition: Lithic::Models::Dispute::disposition?, - events: ::Array[Lithic::Dispute::Event], - liability_allocation: Lithic::Dispute::LiabilityAllocation, - merchant: Lithic::Dispute::Merchant, - network: Lithic::Models::Dispute::network, - status: Lithic::Models::Dispute::status?, - transaction_series: Lithic::Dispute::TransactionSeries?, - updated: Time + customer_filed_date: Time?, + customer_note: String?, + network_claim_ids: ::Array[String]?, + network_filed_date: Time?, + network_reason_code: String?, + prearbitration_date: Time?, + primary_claim_id: String?, + reason: Lithic::Models::Dispute::reason, + representment_date: Time?, + resolution_date: Time?, + resolution_note: String?, + resolution_reason: Lithic::Models::Dispute::resolution_reason?, + status: Lithic::Models::Dispute::status, + transaction_token: String } class Dispute < Lithic::Internal::Type::BaseModel attr_accessor token: String - attr_accessor account_token: String + attr_accessor amount: Integer - attr_accessor card_token: String - - attr_accessor case_id: String? + attr_accessor arbitration_date: Time? attr_accessor created: Time - attr_accessor currency: String + attr_accessor customer_filed_date: Time? + + attr_accessor customer_note: String? + + attr_accessor network_claim_ids: ::Array[String]? + + attr_accessor network_filed_date: Time? + + attr_accessor network_reason_code: String? + + attr_accessor prearbitration_date: Time? - attr_accessor disposition: Lithic::Models::Dispute::disposition? + attr_accessor primary_claim_id: String? - attr_accessor events: ::Array[Lithic::Dispute::Event] + attr_accessor reason: Lithic::Models::Dispute::reason - attr_accessor liability_allocation: Lithic::Dispute::LiabilityAllocation + attr_accessor representment_date: Time? - attr_accessor merchant: Lithic::Dispute::Merchant + attr_accessor resolution_date: Time? - attr_accessor network: Lithic::Models::Dispute::network + attr_accessor resolution_note: String? - attr_accessor status: Lithic::Models::Dispute::status? + attr_accessor resolution_reason: Lithic::Models::Dispute::resolution_reason? - attr_accessor transaction_series: Lithic::Dispute::TransactionSeries? + attr_accessor status: Lithic::Models::Dispute::status - attr_accessor updated: Time + attr_accessor transaction_token: String def initialize: ( token: String, - account_token: String, - card_token: String, - case_id: String?, + amount: Integer, + arbitration_date: Time?, created: Time, - currency: String, - disposition: Lithic::Models::Dispute::disposition?, - events: ::Array[Lithic::Dispute::Event], - liability_allocation: Lithic::Dispute::LiabilityAllocation, - merchant: Lithic::Dispute::Merchant, - network: Lithic::Models::Dispute::network, - status: Lithic::Models::Dispute::status?, - transaction_series: Lithic::Dispute::TransactionSeries?, - updated: Time + customer_filed_date: Time?, + customer_note: String?, + network_claim_ids: ::Array[String]?, + network_filed_date: Time?, + network_reason_code: String?, + prearbitration_date: Time?, + primary_claim_id: String?, + reason: Lithic::Models::Dispute::reason, + representment_date: Time?, + resolution_date: Time?, + resolution_note: String?, + resolution_reason: Lithic::Models::Dispute::resolution_reason?, + status: Lithic::Models::Dispute::status, + transaction_token: String ) -> void def to_hash: -> { token: String, - account_token: String, - card_token: String, - case_id: String?, + amount: Integer, + arbitration_date: Time?, created: Time, - currency: String, - disposition: Lithic::Models::Dispute::disposition?, - events: ::Array[Lithic::Dispute::Event], - liability_allocation: Lithic::Dispute::LiabilityAllocation, - merchant: Lithic::Dispute::Merchant, - network: Lithic::Models::Dispute::network, - status: Lithic::Models::Dispute::status?, - transaction_series: Lithic::Dispute::TransactionSeries?, - updated: Time + customer_filed_date: Time?, + customer_note: String?, + network_claim_ids: ::Array[String]?, + network_filed_date: Time?, + network_reason_code: String?, + prearbitration_date: Time?, + primary_claim_id: String?, + reason: Lithic::Models::Dispute::reason, + representment_date: Time?, + resolution_date: Time?, + resolution_note: String?, + resolution_reason: Lithic::Models::Dispute::resolution_reason?, + status: Lithic::Models::Dispute::status, + transaction_token: String } - type disposition = :WON | :LOST | :PARTIALLY_WON | :WITHDRAWN | :DENIED - - module Disposition + type reason = + :ATM_CASH_MISDISPENSE + | :CANCELLED + | :DUPLICATED + | :FRAUD_CARD_NOT_PRESENT + | :FRAUD_CARD_PRESENT + | :FRAUD_OTHER + | :GOODS_SERVICES_NOT_AS_DESCRIBED + | :GOODS_SERVICES_NOT_RECEIVED + | :INCORRECT_AMOUNT + | :MISSING_AUTH + | :OTHER + | :PROCESSING_ERROR + | :RECURRING_TRANSACTION_NOT_CANCELLED + | :REFUND_NOT_PROCESSED + + module Reason extend Lithic::Internal::Type::Enum - WON: :WON - LOST: :LOST - PARTIALLY_WON: :PARTIALLY_WON - WITHDRAWN: :WITHDRAWN - DENIED: :DENIED - - def self?.values: -> ::Array[Lithic::Models::Dispute::disposition] + ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE + CANCELLED: :CANCELLED + DUPLICATED: :DUPLICATED + FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT + FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT + FRAUD_OTHER: :FRAUD_OTHER + GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED + GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED + INCORRECT_AMOUNT: :INCORRECT_AMOUNT + MISSING_AUTH: :MISSING_AUTH + OTHER: :OTHER + PROCESSING_ERROR: :PROCESSING_ERROR + RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED + REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED + + def self?.values: -> ::Array[Lithic::Models::Dispute::reason] end - type event = - { - token: String, - created: Time, - data: Lithic::Models::Dispute::Event::data, - type: Lithic::Models::Dispute::Event::type_ - } - - class Event < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor created: Time - - attr_accessor data: Lithic::Models::Dispute::Event::data - - attr_accessor type: Lithic::Models::Dispute::Event::type_ - - def initialize: ( - token: String, - created: Time, - data: Lithic::Models::Dispute::Event::data, - type: Lithic::Models::Dispute::Event::type_ - ) -> void - - def to_hash: -> { - token: String, - created: Time, - data: Lithic::Models::Dispute::Event::data, - type: Lithic::Models::Dispute::Event::type_ - } - - type data = - Lithic::Dispute::Event::Data::WorkflowEventData - | Lithic::Dispute::Event::Data::FinancialEventData - | Lithic::Dispute::Event::Data::CardholderLiabilityEventData - - module Data - extend Lithic::Internal::Type::Union - - type workflow_event_data = - { - action: Lithic::Models::Dispute::Event::Data::WorkflowEventData::action, - amount: Integer?, - disposition: Lithic::Models::Dispute::Event::Data::WorkflowEventData::disposition?, - reason: String?, - stage: Lithic::Models::Dispute::Event::Data::WorkflowEventData::stage - } - - class WorkflowEventData < Lithic::Internal::Type::BaseModel - attr_accessor action: Lithic::Models::Dispute::Event::Data::WorkflowEventData::action - - attr_accessor amount: Integer? - - attr_accessor disposition: Lithic::Models::Dispute::Event::Data::WorkflowEventData::disposition? - - attr_accessor reason: String? - - attr_accessor stage: Lithic::Models::Dispute::Event::Data::WorkflowEventData::stage - - def initialize: ( - action: Lithic::Models::Dispute::Event::Data::WorkflowEventData::action, - amount: Integer?, - disposition: Lithic::Models::Dispute::Event::Data::WorkflowEventData::disposition?, - reason: String?, - stage: Lithic::Models::Dispute::Event::Data::WorkflowEventData::stage - ) -> void - - def to_hash: -> { - action: Lithic::Models::Dispute::Event::Data::WorkflowEventData::action, - amount: Integer?, - disposition: Lithic::Models::Dispute::Event::Data::WorkflowEventData::disposition?, - reason: String?, - stage: Lithic::Models::Dispute::Event::Data::WorkflowEventData::stage - } - - type action = :OPENED | :CLOSED | :REOPENED - - module Action - extend Lithic::Internal::Type::Enum - - OPENED: :OPENED - CLOSED: :CLOSED - REOPENED: :REOPENED - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::WorkflowEventData::action] - end - - type disposition = - :WON | :LOST | :PARTIALLY_WON | :WITHDRAWN | :DENIED - - module Disposition - extend Lithic::Internal::Type::Enum - - WON: :WON - LOST: :LOST - PARTIALLY_WON: :PARTIALLY_WON - WITHDRAWN: :WITHDRAWN - DENIED: :DENIED - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::WorkflowEventData::disposition] - end - - type stage = :CLAIM - - module Stage - extend Lithic::Internal::Type::Enum - - CLAIM: :CLAIM - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::WorkflowEventData::stage] - end - end - - type financial_event_data = - { - amount: Integer, - polarity: Lithic::Models::Dispute::Event::Data::FinancialEventData::polarity, - stage: Lithic::Models::Dispute::Event::Data::FinancialEventData::stage - } - - class FinancialEventData < Lithic::Internal::Type::BaseModel - attr_accessor amount: Integer - - attr_accessor polarity: Lithic::Models::Dispute::Event::Data::FinancialEventData::polarity - - attr_accessor stage: Lithic::Models::Dispute::Event::Data::FinancialEventData::stage - - def initialize: ( - amount: Integer, - polarity: Lithic::Models::Dispute::Event::Data::FinancialEventData::polarity, - stage: Lithic::Models::Dispute::Event::Data::FinancialEventData::stage - ) -> void - - def to_hash: -> { - amount: Integer, - polarity: Lithic::Models::Dispute::Event::Data::FinancialEventData::polarity, - stage: Lithic::Models::Dispute::Event::Data::FinancialEventData::stage - } - - type polarity = :CREDIT | :DEBIT - - module Polarity - extend Lithic::Internal::Type::Enum - - CREDIT: :CREDIT - DEBIT: :DEBIT - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::FinancialEventData::polarity] - end - - type stage = - :CHARGEBACK - | :REPRESENTMENT - | :PREARBITRATION - | :ARBITRATION - | :COLLABORATION - - module Stage - extend Lithic::Internal::Type::Enum - - CHARGEBACK: :CHARGEBACK - REPRESENTMENT: :REPRESENTMENT - PREARBITRATION: :PREARBITRATION - ARBITRATION: :ARBITRATION - COLLABORATION: :COLLABORATION - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::FinancialEventData::stage] - end - end - - type cardholder_liability_event_data = - { - action: Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::action, - amount: Integer, - reason: String - } - - class CardholderLiabilityEventData < Lithic::Internal::Type::BaseModel - attr_accessor action: Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::action - - attr_accessor amount: Integer - - attr_accessor reason: String - - def initialize: ( - action: Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::action, - amount: Integer, - reason: String - ) -> void - - def to_hash: -> { - action: Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::action, - amount: Integer, - reason: String - } - - type action = - :PROVISIONAL_CREDIT_GRANTED - | :PROVISIONAL_CREDIT_REVERSED - | :WRITTEN_OFF - - module Action - extend Lithic::Internal::Type::Enum - - PROVISIONAL_CREDIT_GRANTED: :PROVISIONAL_CREDIT_GRANTED - PROVISIONAL_CREDIT_REVERSED: :PROVISIONAL_CREDIT_REVERSED - WRITTEN_OFF: :WRITTEN_OFF - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::Data::CardholderLiabilityEventData::action] - end - end - - def self?.variants: -> ::Array[Lithic::Models::Dispute::Event::data] - end - - type type_ = :WORKFLOW | :FINANCIAL | :CARDHOLDER_LIABILITY - - module Type - extend Lithic::Internal::Type::Enum - - WORKFLOW: :WORKFLOW - FINANCIAL: :FINANCIAL - CARDHOLDER_LIABILITY: :CARDHOLDER_LIABILITY - - def self?.values: -> ::Array[Lithic::Models::Dispute::Event::type_] - end - end - - type liability_allocation = - { - denied_amount: Integer, - original_amount: Integer, - recovered_amount: Integer, - remaining_amount: Integer, - written_off_amount: Integer - } - - class LiabilityAllocation < Lithic::Internal::Type::BaseModel - attr_accessor denied_amount: Integer - - attr_accessor original_amount: Integer - - attr_accessor recovered_amount: Integer - - attr_accessor remaining_amount: Integer - - attr_accessor written_off_amount: Integer - - def initialize: ( - denied_amount: Integer, - original_amount: Integer, - recovered_amount: Integer, - remaining_amount: Integer, - written_off_amount: Integer - ) -> void - - def to_hash: -> { - denied_amount: Integer, - original_amount: Integer, - recovered_amount: Integer, - remaining_amount: Integer, - written_off_amount: Integer - } - end - - type merchant = - { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } - - class Merchant < Lithic::Internal::Type::BaseModel - attr_accessor acceptor_id: String - - attr_accessor acquiring_institution_id: String - - attr_accessor city: String - - attr_accessor country: String - - attr_accessor descriptor: String - - attr_accessor mcc: String - - attr_accessor state: String - - def initialize: ( - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - ) -> void - - def to_hash: -> { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } - end - - type network = :VISA | :MASTERCARD - - module Network + type resolution_reason = + :CASE_LOST + | :NETWORK_REJECTED + | :NO_DISPUTE_RIGHTS_3DS + | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD + | :NO_DISPUTE_RIGHTS_CONTACTLESS + | :NO_DISPUTE_RIGHTS_HYBRID + | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS + | :NO_DISPUTE_RIGHTS_OTHER + | :PAST_FILING_DATE + | :PREARBITRATION_REJECTED + | :PROCESSOR_REJECTED_OTHER + | :REFUNDED + | :REFUNDED_AFTER_CHARGEBACK + | :WITHDRAWN + | :WON_ARBITRATION + | :WON_FIRST_CHARGEBACK + | :WON_PREARBITRATION + + module ResolutionReason extend Lithic::Internal::Type::Enum - VISA: :VISA - MASTERCARD: :MASTERCARD + CASE_LOST: :CASE_LOST + NETWORK_REJECTED: :NETWORK_REJECTED + NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS + NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD + NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS + NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID + NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS + NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER + PAST_FILING_DATE: :PAST_FILING_DATE + PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED + PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER + REFUNDED: :REFUNDED + REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK + WITHDRAWN: :WITHDRAWN + WON_ARBITRATION: :WON_ARBITRATION + WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK + WON_PREARBITRATION: :WON_PREARBITRATION - def self?.values: -> ::Array[Lithic::Models::Dispute::network] + def self?.values: -> ::Array[Lithic::Models::Dispute::resolution_reason] end - type status = :OPEN | :CLOSED + type status = + :ARBITRATION + | :CASE_CLOSED + | :CASE_WON + | :NEW + | :PENDING_CUSTOMER + | :PREARBITRATION + | :REPRESENTMENT + | :SUBMITTED module Status extend Lithic::Internal::Type::Enum - OPEN: :OPEN - CLOSED: :CLOSED + ARBITRATION: :ARBITRATION + CASE_CLOSED: :CASE_CLOSED + CASE_WON: :CASE_WON + NEW: :NEW + PENDING_CUSTOMER: :PENDING_CUSTOMER + PREARBITRATION: :PREARBITRATION + REPRESENTMENT: :REPRESENTMENT + SUBMITTED: :SUBMITTED def self?.values: -> ::Array[Lithic::Models::Dispute::status] end - - type transaction_series = - { - related_transaction_event_token: String?, - related_transaction_token: String, - type: Lithic::Models::Dispute::TransactionSeries::type_ - } - - class TransactionSeries < Lithic::Internal::Type::BaseModel - attr_accessor related_transaction_event_token: String? - - attr_accessor related_transaction_token: String - - attr_accessor type: Lithic::Models::Dispute::TransactionSeries::type_ - - def initialize: ( - related_transaction_event_token: String?, - related_transaction_token: String, - type: Lithic::Models::Dispute::TransactionSeries::type_ - ) -> void - - def to_hash: -> { - related_transaction_event_token: String?, - related_transaction_token: String, - type: Lithic::Models::Dispute::TransactionSeries::type_ - } - - type type_ = :DISPUTE - - module Type - extend Lithic::Internal::Type::Enum - - DISPUTE: :DISPUTE - - def self?.values: -> ::Array[Lithic::Models::Dispute::TransactionSeries::type_] - end - end end end end diff --git a/sig/lithic/models/dispute_create_response.rbs b/sig/lithic/models/dispute_create_response.rbs deleted file mode 100644 index 27f56d6c..00000000 --- a/sig/lithic/models/dispute_create_response.rbs +++ /dev/null @@ -1,210 +0,0 @@ -module Lithic - module Models - type dispute_create_response = - { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeCreateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeCreateResponse::resolution_reason?, - status: Lithic::Models::DisputeCreateResponse::status, - transaction_token: String - } - - class DisputeCreateResponse < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor amount: Integer - - attr_accessor arbitration_date: Time? - - attr_accessor created: Time - - attr_accessor customer_filed_date: Time? - - attr_accessor customer_note: String? - - attr_accessor network_claim_ids: ::Array[String]? - - attr_accessor network_filed_date: Time? - - attr_accessor network_reason_code: String? - - attr_accessor prearbitration_date: Time? - - attr_accessor primary_claim_id: String? - - attr_accessor reason: Lithic::Models::DisputeCreateResponse::reason - - attr_accessor representment_date: Time? - - attr_accessor resolution_date: Time? - - attr_accessor resolution_note: String? - - attr_accessor resolution_reason: Lithic::Models::DisputeCreateResponse::resolution_reason? - - attr_accessor status: Lithic::Models::DisputeCreateResponse::status - - attr_accessor transaction_token: String - - def initialize: ( - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeCreateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeCreateResponse::resolution_reason?, - status: Lithic::Models::DisputeCreateResponse::status, - transaction_token: String - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeCreateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeCreateResponse::resolution_reason?, - status: Lithic::Models::DisputeCreateResponse::status, - transaction_token: String - } - - type reason = - :ATM_CASH_MISDISPENSE - | :CANCELLED - | :DUPLICATED - | :FRAUD_CARD_NOT_PRESENT - | :FRAUD_CARD_PRESENT - | :FRAUD_OTHER - | :GOODS_SERVICES_NOT_AS_DESCRIBED - | :GOODS_SERVICES_NOT_RECEIVED - | :INCORRECT_AMOUNT - | :MISSING_AUTH - | :OTHER - | :PROCESSING_ERROR - | :RECURRING_TRANSACTION_NOT_CANCELLED - | :REFUND_NOT_PROCESSED - - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE - CANCELLED: :CANCELLED - DUPLICATED: :DUPLICATED - FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT - FRAUD_OTHER: :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT: :INCORRECT_AMOUNT - MISSING_AUTH: :MISSING_AUTH - OTHER: :OTHER - PROCESSING_ERROR: :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED - - def self?.values: -> ::Array[Lithic::Models::DisputeCreateResponse::reason] - end - - type resolution_reason = - :CASE_LOST - | :NETWORK_REJECTED - | :NO_DISPUTE_RIGHTS_3DS - | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - | :NO_DISPUTE_RIGHTS_CONTACTLESS - | :NO_DISPUTE_RIGHTS_HYBRID - | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - | :NO_DISPUTE_RIGHTS_OTHER - | :PAST_FILING_DATE - | :PREARBITRATION_REJECTED - | :PROCESSOR_REJECTED_OTHER - | :REFUNDED - | :REFUNDED_AFTER_CHARGEBACK - | :WITHDRAWN - | :WON_ARBITRATION - | :WON_FIRST_CHARGEBACK - | :WON_PREARBITRATION - - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST: :CASE_LOST - NETWORK_REJECTED: :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE: :PAST_FILING_DATE - PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER - REFUNDED: :REFUNDED - REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN: :WITHDRAWN - WON_ARBITRATION: :WON_ARBITRATION - WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK - WON_PREARBITRATION: :WON_PREARBITRATION - - def self?.values: -> ::Array[Lithic::Models::DisputeCreateResponse::resolution_reason] - end - - type status = - :ARBITRATION - | :CASE_CLOSED - | :CASE_WON - | :NEW - | :PENDING_CUSTOMER - | :PREARBITRATION - | :REPRESENTMENT - | :SUBMITTED - - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION: :ARBITRATION - CASE_CLOSED: :CASE_CLOSED - CASE_WON: :CASE_WON - NEW: :NEW - PENDING_CUSTOMER: :PENDING_CUSTOMER - PREARBITRATION: :PREARBITRATION - REPRESENTMENT: :REPRESENTMENT - SUBMITTED: :SUBMITTED - - def self?.values: -> ::Array[Lithic::Models::DisputeCreateResponse::status] - end - end - end -end diff --git a/sig/lithic/models/dispute_delete_response.rbs b/sig/lithic/models/dispute_delete_response.rbs deleted file mode 100644 index 35281f7f..00000000 --- a/sig/lithic/models/dispute_delete_response.rbs +++ /dev/null @@ -1,210 +0,0 @@ -module Lithic - module Models - type dispute_delete_response = - { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeDeleteResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeDeleteResponse::resolution_reason?, - status: Lithic::Models::DisputeDeleteResponse::status, - transaction_token: String - } - - class DisputeDeleteResponse < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor amount: Integer - - attr_accessor arbitration_date: Time? - - attr_accessor created: Time - - attr_accessor customer_filed_date: Time? - - attr_accessor customer_note: String? - - attr_accessor network_claim_ids: ::Array[String]? - - attr_accessor network_filed_date: Time? - - attr_accessor network_reason_code: String? - - attr_accessor prearbitration_date: Time? - - attr_accessor primary_claim_id: String? - - attr_accessor reason: Lithic::Models::DisputeDeleteResponse::reason - - attr_accessor representment_date: Time? - - attr_accessor resolution_date: Time? - - attr_accessor resolution_note: String? - - attr_accessor resolution_reason: Lithic::Models::DisputeDeleteResponse::resolution_reason? - - attr_accessor status: Lithic::Models::DisputeDeleteResponse::status - - attr_accessor transaction_token: String - - def initialize: ( - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeDeleteResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeDeleteResponse::resolution_reason?, - status: Lithic::Models::DisputeDeleteResponse::status, - transaction_token: String - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeDeleteResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeDeleteResponse::resolution_reason?, - status: Lithic::Models::DisputeDeleteResponse::status, - transaction_token: String - } - - type reason = - :ATM_CASH_MISDISPENSE - | :CANCELLED - | :DUPLICATED - | :FRAUD_CARD_NOT_PRESENT - | :FRAUD_CARD_PRESENT - | :FRAUD_OTHER - | :GOODS_SERVICES_NOT_AS_DESCRIBED - | :GOODS_SERVICES_NOT_RECEIVED - | :INCORRECT_AMOUNT - | :MISSING_AUTH - | :OTHER - | :PROCESSING_ERROR - | :RECURRING_TRANSACTION_NOT_CANCELLED - | :REFUND_NOT_PROCESSED - - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE - CANCELLED: :CANCELLED - DUPLICATED: :DUPLICATED - FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT - FRAUD_OTHER: :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT: :INCORRECT_AMOUNT - MISSING_AUTH: :MISSING_AUTH - OTHER: :OTHER - PROCESSING_ERROR: :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED - - def self?.values: -> ::Array[Lithic::Models::DisputeDeleteResponse::reason] - end - - type resolution_reason = - :CASE_LOST - | :NETWORK_REJECTED - | :NO_DISPUTE_RIGHTS_3DS - | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - | :NO_DISPUTE_RIGHTS_CONTACTLESS - | :NO_DISPUTE_RIGHTS_HYBRID - | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - | :NO_DISPUTE_RIGHTS_OTHER - | :PAST_FILING_DATE - | :PREARBITRATION_REJECTED - | :PROCESSOR_REJECTED_OTHER - | :REFUNDED - | :REFUNDED_AFTER_CHARGEBACK - | :WITHDRAWN - | :WON_ARBITRATION - | :WON_FIRST_CHARGEBACK - | :WON_PREARBITRATION - - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST: :CASE_LOST - NETWORK_REJECTED: :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE: :PAST_FILING_DATE - PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER - REFUNDED: :REFUNDED - REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN: :WITHDRAWN - WON_ARBITRATION: :WON_ARBITRATION - WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK - WON_PREARBITRATION: :WON_PREARBITRATION - - def self?.values: -> ::Array[Lithic::Models::DisputeDeleteResponse::resolution_reason] - end - - type status = - :ARBITRATION - | :CASE_CLOSED - | :CASE_WON - | :NEW - | :PENDING_CUSTOMER - | :PREARBITRATION - | :REPRESENTMENT - | :SUBMITTED - - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION: :ARBITRATION - CASE_CLOSED: :CASE_CLOSED - CASE_WON: :CASE_WON - NEW: :NEW - PENDING_CUSTOMER: :PENDING_CUSTOMER - PREARBITRATION: :PREARBITRATION - REPRESENTMENT: :REPRESENTMENT - SUBMITTED: :SUBMITTED - - def self?.values: -> ::Array[Lithic::Models::DisputeDeleteResponse::status] - end - end - end -end diff --git a/sig/lithic/models/dispute_list_response.rbs b/sig/lithic/models/dispute_list_response.rbs deleted file mode 100644 index 626b4324..00000000 --- a/sig/lithic/models/dispute_list_response.rbs +++ /dev/null @@ -1,210 +0,0 @@ -module Lithic - module Models - type dispute_list_response = - { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeListResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeListResponse::resolution_reason?, - status: Lithic::Models::DisputeListResponse::status, - transaction_token: String - } - - class DisputeListResponse < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor amount: Integer - - attr_accessor arbitration_date: Time? - - attr_accessor created: Time - - attr_accessor customer_filed_date: Time? - - attr_accessor customer_note: String? - - attr_accessor network_claim_ids: ::Array[String]? - - attr_accessor network_filed_date: Time? - - attr_accessor network_reason_code: String? - - attr_accessor prearbitration_date: Time? - - attr_accessor primary_claim_id: String? - - attr_accessor reason: Lithic::Models::DisputeListResponse::reason - - attr_accessor representment_date: Time? - - attr_accessor resolution_date: Time? - - attr_accessor resolution_note: String? - - attr_accessor resolution_reason: Lithic::Models::DisputeListResponse::resolution_reason? - - attr_accessor status: Lithic::Models::DisputeListResponse::status - - attr_accessor transaction_token: String - - def initialize: ( - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeListResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeListResponse::resolution_reason?, - status: Lithic::Models::DisputeListResponse::status, - transaction_token: String - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeListResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeListResponse::resolution_reason?, - status: Lithic::Models::DisputeListResponse::status, - transaction_token: String - } - - type reason = - :ATM_CASH_MISDISPENSE - | :CANCELLED - | :DUPLICATED - | :FRAUD_CARD_NOT_PRESENT - | :FRAUD_CARD_PRESENT - | :FRAUD_OTHER - | :GOODS_SERVICES_NOT_AS_DESCRIBED - | :GOODS_SERVICES_NOT_RECEIVED - | :INCORRECT_AMOUNT - | :MISSING_AUTH - | :OTHER - | :PROCESSING_ERROR - | :RECURRING_TRANSACTION_NOT_CANCELLED - | :REFUND_NOT_PROCESSED - - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE - CANCELLED: :CANCELLED - DUPLICATED: :DUPLICATED - FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT - FRAUD_OTHER: :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT: :INCORRECT_AMOUNT - MISSING_AUTH: :MISSING_AUTH - OTHER: :OTHER - PROCESSING_ERROR: :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED - - def self?.values: -> ::Array[Lithic::Models::DisputeListResponse::reason] - end - - type resolution_reason = - :CASE_LOST - | :NETWORK_REJECTED - | :NO_DISPUTE_RIGHTS_3DS - | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - | :NO_DISPUTE_RIGHTS_CONTACTLESS - | :NO_DISPUTE_RIGHTS_HYBRID - | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - | :NO_DISPUTE_RIGHTS_OTHER - | :PAST_FILING_DATE - | :PREARBITRATION_REJECTED - | :PROCESSOR_REJECTED_OTHER - | :REFUNDED - | :REFUNDED_AFTER_CHARGEBACK - | :WITHDRAWN - | :WON_ARBITRATION - | :WON_FIRST_CHARGEBACK - | :WON_PREARBITRATION - - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST: :CASE_LOST - NETWORK_REJECTED: :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE: :PAST_FILING_DATE - PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER - REFUNDED: :REFUNDED - REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN: :WITHDRAWN - WON_ARBITRATION: :WON_ARBITRATION - WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK - WON_PREARBITRATION: :WON_PREARBITRATION - - def self?.values: -> ::Array[Lithic::Models::DisputeListResponse::resolution_reason] - end - - type status = - :ARBITRATION - | :CASE_CLOSED - | :CASE_WON - | :NEW - | :PENDING_CUSTOMER - | :PREARBITRATION - | :REPRESENTMENT - | :SUBMITTED - - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION: :ARBITRATION - CASE_CLOSED: :CASE_CLOSED - CASE_WON: :CASE_WON - NEW: :NEW - PENDING_CUSTOMER: :PENDING_CUSTOMER - PREARBITRATION: :PREARBITRATION - REPRESENTMENT: :REPRESENTMENT - SUBMITTED: :SUBMITTED - - def self?.values: -> ::Array[Lithic::Models::DisputeListResponse::status] - end - end - end -end diff --git a/sig/lithic/models/dispute_retrieve_response.rbs b/sig/lithic/models/dispute_retrieve_response.rbs deleted file mode 100644 index e34aa66e..00000000 --- a/sig/lithic/models/dispute_retrieve_response.rbs +++ /dev/null @@ -1,210 +0,0 @@ -module Lithic - module Models - type dispute_retrieve_response = - { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeRetrieveResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeRetrieveResponse::resolution_reason?, - status: Lithic::Models::DisputeRetrieveResponse::status, - transaction_token: String - } - - class DisputeRetrieveResponse < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor amount: Integer - - attr_accessor arbitration_date: Time? - - attr_accessor created: Time - - attr_accessor customer_filed_date: Time? - - attr_accessor customer_note: String? - - attr_accessor network_claim_ids: ::Array[String]? - - attr_accessor network_filed_date: Time? - - attr_accessor network_reason_code: String? - - attr_accessor prearbitration_date: Time? - - attr_accessor primary_claim_id: String? - - attr_accessor reason: Lithic::Models::DisputeRetrieveResponse::reason - - attr_accessor representment_date: Time? - - attr_accessor resolution_date: Time? - - attr_accessor resolution_note: String? - - attr_accessor resolution_reason: Lithic::Models::DisputeRetrieveResponse::resolution_reason? - - attr_accessor status: Lithic::Models::DisputeRetrieveResponse::status - - attr_accessor transaction_token: String - - def initialize: ( - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeRetrieveResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeRetrieveResponse::resolution_reason?, - status: Lithic::Models::DisputeRetrieveResponse::status, - transaction_token: String - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeRetrieveResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeRetrieveResponse::resolution_reason?, - status: Lithic::Models::DisputeRetrieveResponse::status, - transaction_token: String - } - - type reason = - :ATM_CASH_MISDISPENSE - | :CANCELLED - | :DUPLICATED - | :FRAUD_CARD_NOT_PRESENT - | :FRAUD_CARD_PRESENT - | :FRAUD_OTHER - | :GOODS_SERVICES_NOT_AS_DESCRIBED - | :GOODS_SERVICES_NOT_RECEIVED - | :INCORRECT_AMOUNT - | :MISSING_AUTH - | :OTHER - | :PROCESSING_ERROR - | :RECURRING_TRANSACTION_NOT_CANCELLED - | :REFUND_NOT_PROCESSED - - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE - CANCELLED: :CANCELLED - DUPLICATED: :DUPLICATED - FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT - FRAUD_OTHER: :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT: :INCORRECT_AMOUNT - MISSING_AUTH: :MISSING_AUTH - OTHER: :OTHER - PROCESSING_ERROR: :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED - - def self?.values: -> ::Array[Lithic::Models::DisputeRetrieveResponse::reason] - end - - type resolution_reason = - :CASE_LOST - | :NETWORK_REJECTED - | :NO_DISPUTE_RIGHTS_3DS - | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - | :NO_DISPUTE_RIGHTS_CONTACTLESS - | :NO_DISPUTE_RIGHTS_HYBRID - | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - | :NO_DISPUTE_RIGHTS_OTHER - | :PAST_FILING_DATE - | :PREARBITRATION_REJECTED - | :PROCESSOR_REJECTED_OTHER - | :REFUNDED - | :REFUNDED_AFTER_CHARGEBACK - | :WITHDRAWN - | :WON_ARBITRATION - | :WON_FIRST_CHARGEBACK - | :WON_PREARBITRATION - - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST: :CASE_LOST - NETWORK_REJECTED: :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE: :PAST_FILING_DATE - PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER - REFUNDED: :REFUNDED - REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN: :WITHDRAWN - WON_ARBITRATION: :WON_ARBITRATION - WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK - WON_PREARBITRATION: :WON_PREARBITRATION - - def self?.values: -> ::Array[Lithic::Models::DisputeRetrieveResponse::resolution_reason] - end - - type status = - :ARBITRATION - | :CASE_CLOSED - | :CASE_WON - | :NEW - | :PENDING_CUSTOMER - | :PREARBITRATION - | :REPRESENTMENT - | :SUBMITTED - - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION: :ARBITRATION - CASE_CLOSED: :CASE_CLOSED - CASE_WON: :CASE_WON - NEW: :NEW - PENDING_CUSTOMER: :PENDING_CUSTOMER - PREARBITRATION: :PREARBITRATION - REPRESENTMENT: :REPRESENTMENT - SUBMITTED: :SUBMITTED - - def self?.values: -> ::Array[Lithic::Models::DisputeRetrieveResponse::status] - end - end - end -end diff --git a/sig/lithic/models/dispute_update_response.rbs b/sig/lithic/models/dispute_update_response.rbs deleted file mode 100644 index 3158e030..00000000 --- a/sig/lithic/models/dispute_update_response.rbs +++ /dev/null @@ -1,210 +0,0 @@ -module Lithic - module Models - type dispute_update_response = - { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeUpdateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeUpdateResponse::resolution_reason?, - status: Lithic::Models::DisputeUpdateResponse::status, - transaction_token: String - } - - class DisputeUpdateResponse < Lithic::Internal::Type::BaseModel - attr_accessor token: String - - attr_accessor amount: Integer - - attr_accessor arbitration_date: Time? - - attr_accessor created: Time - - attr_accessor customer_filed_date: Time? - - attr_accessor customer_note: String? - - attr_accessor network_claim_ids: ::Array[String]? - - attr_accessor network_filed_date: Time? - - attr_accessor network_reason_code: String? - - attr_accessor prearbitration_date: Time? - - attr_accessor primary_claim_id: String? - - attr_accessor reason: Lithic::Models::DisputeUpdateResponse::reason - - attr_accessor representment_date: Time? - - attr_accessor resolution_date: Time? - - attr_accessor resolution_note: String? - - attr_accessor resolution_reason: Lithic::Models::DisputeUpdateResponse::resolution_reason? - - attr_accessor status: Lithic::Models::DisputeUpdateResponse::status - - attr_accessor transaction_token: String - - def initialize: ( - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeUpdateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeUpdateResponse::resolution_reason?, - status: Lithic::Models::DisputeUpdateResponse::status, - transaction_token: String - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - arbitration_date: Time?, - created: Time, - customer_filed_date: Time?, - customer_note: String?, - network_claim_ids: ::Array[String]?, - network_filed_date: Time?, - network_reason_code: String?, - prearbitration_date: Time?, - primary_claim_id: String?, - reason: Lithic::Models::DisputeUpdateResponse::reason, - representment_date: Time?, - resolution_date: Time?, - resolution_note: String?, - resolution_reason: Lithic::Models::DisputeUpdateResponse::resolution_reason?, - status: Lithic::Models::DisputeUpdateResponse::status, - transaction_token: String - } - - type reason = - :ATM_CASH_MISDISPENSE - | :CANCELLED - | :DUPLICATED - | :FRAUD_CARD_NOT_PRESENT - | :FRAUD_CARD_PRESENT - | :FRAUD_OTHER - | :GOODS_SERVICES_NOT_AS_DESCRIBED - | :GOODS_SERVICES_NOT_RECEIVED - | :INCORRECT_AMOUNT - | :MISSING_AUTH - | :OTHER - | :PROCESSING_ERROR - | :RECURRING_TRANSACTION_NOT_CANCELLED - | :REFUND_NOT_PROCESSED - - module Reason - extend Lithic::Internal::Type::Enum - - ATM_CASH_MISDISPENSE: :ATM_CASH_MISDISPENSE - CANCELLED: :CANCELLED - DUPLICATED: :DUPLICATED - FRAUD_CARD_NOT_PRESENT: :FRAUD_CARD_NOT_PRESENT - FRAUD_CARD_PRESENT: :FRAUD_CARD_PRESENT - FRAUD_OTHER: :FRAUD_OTHER - GOODS_SERVICES_NOT_AS_DESCRIBED: :GOODS_SERVICES_NOT_AS_DESCRIBED - GOODS_SERVICES_NOT_RECEIVED: :GOODS_SERVICES_NOT_RECEIVED - INCORRECT_AMOUNT: :INCORRECT_AMOUNT - MISSING_AUTH: :MISSING_AUTH - OTHER: :OTHER - PROCESSING_ERROR: :PROCESSING_ERROR - RECURRING_TRANSACTION_NOT_CANCELLED: :RECURRING_TRANSACTION_NOT_CANCELLED - REFUND_NOT_PROCESSED: :REFUND_NOT_PROCESSED - - def self?.values: -> ::Array[Lithic::Models::DisputeUpdateResponse::reason] - end - - type resolution_reason = - :CASE_LOST - | :NETWORK_REJECTED - | :NO_DISPUTE_RIGHTS_3DS - | :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - | :NO_DISPUTE_RIGHTS_CONTACTLESS - | :NO_DISPUTE_RIGHTS_HYBRID - | :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - | :NO_DISPUTE_RIGHTS_OTHER - | :PAST_FILING_DATE - | :PREARBITRATION_REJECTED - | :PROCESSOR_REJECTED_OTHER - | :REFUNDED - | :REFUNDED_AFTER_CHARGEBACK - | :WITHDRAWN - | :WON_ARBITRATION - | :WON_FIRST_CHARGEBACK - | :WON_PREARBITRATION - - module ResolutionReason - extend Lithic::Internal::Type::Enum - - CASE_LOST: :CASE_LOST - NETWORK_REJECTED: :NETWORK_REJECTED - NO_DISPUTE_RIGHTS_3DS: :NO_DISPUTE_RIGHTS_3DS - NO_DISPUTE_RIGHTS_BELOW_THRESHOLD: :NO_DISPUTE_RIGHTS_BELOW_THRESHOLD - NO_DISPUTE_RIGHTS_CONTACTLESS: :NO_DISPUTE_RIGHTS_CONTACTLESS - NO_DISPUTE_RIGHTS_HYBRID: :NO_DISPUTE_RIGHTS_HYBRID - NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS: :NO_DISPUTE_RIGHTS_MAX_CHARGEBACKS - NO_DISPUTE_RIGHTS_OTHER: :NO_DISPUTE_RIGHTS_OTHER - PAST_FILING_DATE: :PAST_FILING_DATE - PREARBITRATION_REJECTED: :PREARBITRATION_REJECTED - PROCESSOR_REJECTED_OTHER: :PROCESSOR_REJECTED_OTHER - REFUNDED: :REFUNDED - REFUNDED_AFTER_CHARGEBACK: :REFUNDED_AFTER_CHARGEBACK - WITHDRAWN: :WITHDRAWN - WON_ARBITRATION: :WON_ARBITRATION - WON_FIRST_CHARGEBACK: :WON_FIRST_CHARGEBACK - WON_PREARBITRATION: :WON_PREARBITRATION - - def self?.values: -> ::Array[Lithic::Models::DisputeUpdateResponse::resolution_reason] - end - - type status = - :ARBITRATION - | :CASE_CLOSED - | :CASE_WON - | :NEW - | :PENDING_CUSTOMER - | :PREARBITRATION - | :REPRESENTMENT - | :SUBMITTED - - module Status - extend Lithic::Internal::Type::Enum - - ARBITRATION: :ARBITRATION - CASE_CLOSED: :CASE_CLOSED - CASE_WON: :CASE_WON - NEW: :NEW - PENDING_CUSTOMER: :PENDING_CUSTOMER - PREARBITRATION: :PREARBITRATION - REPRESENTMENT: :REPRESENTMENT - SUBMITTED: :SUBMITTED - - def self?.values: -> ::Array[Lithic::Models::DisputeUpdateResponse::status] - end - end - end -end diff --git a/sig/lithic/models/dispute_v2.rbs b/sig/lithic/models/dispute_v2.rbs new file mode 100644 index 00000000..836a7b7b --- /dev/null +++ b/sig/lithic/models/dispute_v2.rbs @@ -0,0 +1,438 @@ +module Lithic + module Models + type dispute_v2 = + { + token: String, + account_token: String, + card_token: String, + case_id: String?, + created: Time, + currency: String, + disposition: Lithic::Models::DisputeV2::disposition?, + events: ::Array[Lithic::DisputeV2::Event], + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::Models::DisputeV2::network, + status: Lithic::Models::DisputeV2::status?, + transaction_series: Lithic::DisputeV2::TransactionSeries?, + updated: Time + } + + class DisputeV2 < Lithic::Internal::Type::BaseModel + attr_accessor token: String + + attr_accessor account_token: String + + attr_accessor card_token: String + + attr_accessor case_id: String? + + attr_accessor created: Time + + attr_accessor currency: String + + attr_accessor disposition: Lithic::Models::DisputeV2::disposition? + + attr_accessor events: ::Array[Lithic::DisputeV2::Event] + + attr_accessor liability_allocation: Lithic::DisputeV2::LiabilityAllocation + + attr_accessor merchant: Lithic::Merchant + + attr_accessor network: Lithic::Models::DisputeV2::network + + attr_accessor status: Lithic::Models::DisputeV2::status? + + attr_accessor transaction_series: Lithic::DisputeV2::TransactionSeries? + + attr_accessor updated: Time + + def initialize: ( + token: String, + account_token: String, + card_token: String, + case_id: String?, + created: Time, + currency: String, + disposition: Lithic::Models::DisputeV2::disposition?, + events: ::Array[Lithic::DisputeV2::Event], + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::Models::DisputeV2::network, + status: Lithic::Models::DisputeV2::status?, + transaction_series: Lithic::DisputeV2::TransactionSeries?, + updated: Time + ) -> void + + def to_hash: -> { + token: String, + account_token: String, + card_token: String, + case_id: String?, + created: Time, + currency: String, + disposition: Lithic::Models::DisputeV2::disposition?, + events: ::Array[Lithic::DisputeV2::Event], + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::Models::DisputeV2::network, + status: Lithic::Models::DisputeV2::status?, + transaction_series: Lithic::DisputeV2::TransactionSeries?, + updated: Time + } + + type disposition = :WON | :LOST | :PARTIALLY_WON | :WITHDRAWN | :DENIED + + module Disposition + extend Lithic::Internal::Type::Enum + + WON: :WON + LOST: :LOST + PARTIALLY_WON: :PARTIALLY_WON + WITHDRAWN: :WITHDRAWN + DENIED: :DENIED + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::disposition] + end + + type event = + { + token: String, + created: Time, + data: Lithic::Models::DisputeV2::Event::data, + type: Lithic::Models::DisputeV2::Event::type_ + } + + class Event < Lithic::Internal::Type::BaseModel + attr_accessor token: String + + attr_accessor created: Time + + attr_accessor data: Lithic::Models::DisputeV2::Event::data + + attr_accessor type: Lithic::Models::DisputeV2::Event::type_ + + def initialize: ( + token: String, + created: Time, + data: Lithic::Models::DisputeV2::Event::data, + type: Lithic::Models::DisputeV2::Event::type_ + ) -> void + + def to_hash: -> { + token: String, + created: Time, + data: Lithic::Models::DisputeV2::Event::data, + type: Lithic::Models::DisputeV2::Event::type_ + } + + type data = + Lithic::DisputeV2::Event::Data::Workflow + | Lithic::DisputeV2::Event::Data::Financial + | Lithic::DisputeV2::Event::Data::CardholderLiability + + module Data + extend Lithic::Internal::Type::Union + + type workflow = + { + action: Lithic::Models::DisputeV2::Event::Data::Workflow::action, + amount: Integer?, + disposition: Lithic::Models::DisputeV2::Event::Data::Workflow::disposition?, + reason: String?, + stage: Lithic::Models::DisputeV2::Event::Data::Workflow::stage, + type: :WORKFLOW + } + + class Workflow < Lithic::Internal::Type::BaseModel + attr_accessor action: Lithic::Models::DisputeV2::Event::Data::Workflow::action + + attr_accessor amount: Integer? + + attr_accessor disposition: Lithic::Models::DisputeV2::Event::Data::Workflow::disposition? + + attr_accessor reason: String? + + attr_accessor stage: Lithic::Models::DisputeV2::Event::Data::Workflow::stage + + attr_accessor type: :WORKFLOW + + def initialize: ( + action: Lithic::Models::DisputeV2::Event::Data::Workflow::action, + amount: Integer?, + disposition: Lithic::Models::DisputeV2::Event::Data::Workflow::disposition?, + reason: String?, + stage: Lithic::Models::DisputeV2::Event::Data::Workflow::stage, + ?type: :WORKFLOW + ) -> void + + def to_hash: -> { + action: Lithic::Models::DisputeV2::Event::Data::Workflow::action, + amount: Integer?, + disposition: Lithic::Models::DisputeV2::Event::Data::Workflow::disposition?, + reason: String?, + stage: Lithic::Models::DisputeV2::Event::Data::Workflow::stage, + type: :WORKFLOW + } + + type action = :OPENED | :CLOSED | :REOPENED + + module Action + extend Lithic::Internal::Type::Enum + + OPENED: :OPENED + CLOSED: :CLOSED + REOPENED: :REOPENED + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::Workflow::action] + end + + type disposition = + :WON | :LOST | :PARTIALLY_WON | :WITHDRAWN | :DENIED + + module Disposition + extend Lithic::Internal::Type::Enum + + WON: :WON + LOST: :LOST + PARTIALLY_WON: :PARTIALLY_WON + WITHDRAWN: :WITHDRAWN + DENIED: :DENIED + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::Workflow::disposition] + end + + type stage = :CLAIM + + module Stage + extend Lithic::Internal::Type::Enum + + CLAIM: :CLAIM + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::Workflow::stage] + end + end + + type financial = + { + amount: Integer, + polarity: Lithic::Models::DisputeV2::Event::Data::Financial::polarity, + stage: Lithic::Models::DisputeV2::Event::Data::Financial::stage, + type: :FINANCIAL + } + + class Financial < Lithic::Internal::Type::BaseModel + attr_accessor amount: Integer + + attr_accessor polarity: Lithic::Models::DisputeV2::Event::Data::Financial::polarity + + attr_accessor stage: Lithic::Models::DisputeV2::Event::Data::Financial::stage + + attr_accessor type: :FINANCIAL + + def initialize: ( + amount: Integer, + polarity: Lithic::Models::DisputeV2::Event::Data::Financial::polarity, + stage: Lithic::Models::DisputeV2::Event::Data::Financial::stage, + ?type: :FINANCIAL + ) -> void + + def to_hash: -> { + amount: Integer, + polarity: Lithic::Models::DisputeV2::Event::Data::Financial::polarity, + stage: Lithic::Models::DisputeV2::Event::Data::Financial::stage, + type: :FINANCIAL + } + + type polarity = :CREDIT | :DEBIT + + module Polarity + extend Lithic::Internal::Type::Enum + + CREDIT: :CREDIT + DEBIT: :DEBIT + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::Financial::polarity] + end + + type stage = + :CHARGEBACK + | :REPRESENTMENT + | :PREARBITRATION + | :ARBITRATION + | :COLLABORATION + + module Stage + extend Lithic::Internal::Type::Enum + + CHARGEBACK: :CHARGEBACK + REPRESENTMENT: :REPRESENTMENT + PREARBITRATION: :PREARBITRATION + ARBITRATION: :ARBITRATION + COLLABORATION: :COLLABORATION + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::Financial::stage] + end + end + + type cardholder_liability = + { + action: Lithic::Models::DisputeV2::Event::Data::CardholderLiability::action, + amount: Integer, + reason: String, + type: :CARDHOLDER_LIABILITY + } + + class CardholderLiability < Lithic::Internal::Type::BaseModel + attr_accessor action: Lithic::Models::DisputeV2::Event::Data::CardholderLiability::action + + attr_accessor amount: Integer + + attr_accessor reason: String + + attr_accessor type: :CARDHOLDER_LIABILITY + + def initialize: ( + action: Lithic::Models::DisputeV2::Event::Data::CardholderLiability::action, + amount: Integer, + reason: String, + ?type: :CARDHOLDER_LIABILITY + ) -> void + + def to_hash: -> { + action: Lithic::Models::DisputeV2::Event::Data::CardholderLiability::action, + amount: Integer, + reason: String, + type: :CARDHOLDER_LIABILITY + } + + type action = + :PROVISIONAL_CREDIT_GRANTED + | :PROVISIONAL_CREDIT_REVERSED + | :WRITTEN_OFF + + module Action + extend Lithic::Internal::Type::Enum + + PROVISIONAL_CREDIT_GRANTED: :PROVISIONAL_CREDIT_GRANTED + PROVISIONAL_CREDIT_REVERSED: :PROVISIONAL_CREDIT_REVERSED + WRITTEN_OFF: :WRITTEN_OFF + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::Data::CardholderLiability::action] + end + end + + def self?.variants: -> ::Array[Lithic::Models::DisputeV2::Event::data] + end + + type type_ = :WORKFLOW | :FINANCIAL | :CARDHOLDER_LIABILITY + + module Type + extend Lithic::Internal::Type::Enum + + WORKFLOW: :WORKFLOW + FINANCIAL: :FINANCIAL + CARDHOLDER_LIABILITY: :CARDHOLDER_LIABILITY + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::Event::type_] + end + end + + type liability_allocation = + { + denied_amount: Integer, + original_amount: Integer, + recovered_amount: Integer, + remaining_amount: Integer, + written_off_amount: Integer + } + + class LiabilityAllocation < Lithic::Internal::Type::BaseModel + attr_accessor denied_amount: Integer + + attr_accessor original_amount: Integer + + attr_accessor recovered_amount: Integer + + attr_accessor remaining_amount: Integer + + attr_accessor written_off_amount: Integer + + def initialize: ( + denied_amount: Integer, + original_amount: Integer, + recovered_amount: Integer, + remaining_amount: Integer, + written_off_amount: Integer + ) -> void + + def to_hash: -> { + denied_amount: Integer, + original_amount: Integer, + recovered_amount: Integer, + remaining_amount: Integer, + written_off_amount: Integer + } + end + + type network = :VISA | :MASTERCARD + + module Network + extend Lithic::Internal::Type::Enum + + VISA: :VISA + MASTERCARD: :MASTERCARD + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::network] + end + + type status = :OPEN | :CLOSED + + module Status + extend Lithic::Internal::Type::Enum + + OPEN: :OPEN + CLOSED: :CLOSED + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::status] + end + + type transaction_series = + { + related_transaction_event_token: String?, + related_transaction_token: String, + type: Lithic::Models::DisputeV2::TransactionSeries::type_ + } + + class TransactionSeries < Lithic::Internal::Type::BaseModel + attr_accessor related_transaction_event_token: String? + + attr_accessor related_transaction_token: String + + attr_accessor type: Lithic::Models::DisputeV2::TransactionSeries::type_ + + def initialize: ( + related_transaction_event_token: String?, + related_transaction_token: String, + type: Lithic::Models::DisputeV2::TransactionSeries::type_ + ) -> void + + def to_hash: -> { + related_transaction_event_token: String?, + related_transaction_token: String, + type: Lithic::Models::DisputeV2::TransactionSeries::type_ + } + + type type_ = :DISPUTE + + module Type + extend Lithic::Internal::Type::Enum + + DISPUTE: :DISPUTE + + def self?.values: -> ::Array[Lithic::Models::DisputeV2::TransactionSeries::type_] + end + end + end + end +end diff --git a/sig/lithic/models/disputes_v2_list_params.rbs b/sig/lithic/models/disputes_v2_list_params.rbs new file mode 100644 index 00000000..9e1444a9 --- /dev/null +++ b/sig/lithic/models/disputes_v2_list_params.rbs @@ -0,0 +1,77 @@ +module Lithic + module Models + type disputes_v2_list_params = + { + account_token: String, + begin_: Time, + card_token: String, + disputed_transaction_token: String, + end_: Time, + ending_before: String, + page_size: Integer, + starting_after: String + } + & Lithic::Internal::Type::request_parameters + + class DisputesV2ListParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + attr_reader account_token: String? + + def account_token=: (String) -> String + + attr_reader begin_: Time? + + def begin_=: (Time) -> Time + + attr_reader card_token: String? + + def card_token=: (String) -> String + + attr_reader disputed_transaction_token: String? + + def disputed_transaction_token=: (String) -> String + + attr_reader end_: Time? + + def end_=: (Time) -> Time + + attr_reader ending_before: String? + + def ending_before=: (String) -> String + + attr_reader page_size: Integer? + + def page_size=: (Integer) -> Integer + + attr_reader starting_after: String? + + def starting_after=: (String) -> String + + def initialize: ( + ?account_token: String, + ?begin_: Time, + ?card_token: String, + ?disputed_transaction_token: String, + ?end_: Time, + ?ending_before: String, + ?page_size: Integer, + ?starting_after: String, + ?request_options: Lithic::request_opts + ) -> void + + def to_hash: -> { + account_token: String, + begin_: Time, + card_token: String, + disputed_transaction_token: String, + end_: Time, + ending_before: String, + page_size: Integer, + starting_after: String, + request_options: Lithic::RequestOptions + } + end + end +end diff --git a/sig/lithic/models/disputes_v2_retrieve_params.rbs b/sig/lithic/models/disputes_v2_retrieve_params.rbs new file mode 100644 index 00000000..a7e8da8c --- /dev/null +++ b/sig/lithic/models/disputes_v2_retrieve_params.rbs @@ -0,0 +1,15 @@ +module Lithic + module Models + type disputes_v2_retrieve_params = + { } & Lithic::Internal::Type::request_parameters + + class DisputesV2RetrieveParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + def initialize: (?request_options: Lithic::request_opts) -> void + + def to_hash: -> { request_options: Lithic::RequestOptions } + end + end +end diff --git a/sig/lithic/models/external_bank_account_address.rbs b/sig/lithic/models/external_bank_account_address.rbs index 661c135a..d8740b9f 100644 --- a/sig/lithic/models/external_bank_account_address.rbs +++ b/sig/lithic/models/external_bank_account_address.rbs @@ -7,7 +7,7 @@ module Lithic country: String, postal_code: String, state: String, - :address2 => String + :address2 => String? } class ExternalBankAccountAddress < Lithic::Internal::Type::BaseModel @@ -21,9 +21,7 @@ module Lithic attr_accessor state: String - attr_reader address2: String? - - def address2=: (String) -> String + attr_accessor address2: String? def initialize: ( address1: String, @@ -31,7 +29,7 @@ module Lithic country: String, postal_code: String, state: String, - ?address2: String + ?address2: String? ) -> void def to_hash: -> { @@ -40,7 +38,7 @@ module Lithic country: String, postal_code: String, state: String, - :address2 => String + :address2 => String? } end end diff --git a/sig/lithic/models/external_bank_account_create_response.rbs b/sig/lithic/models/external_bank_account_create_response.rbs index 640c1102..8ff3bee8 100644 --- a/sig/lithic/models/external_bank_account_create_response.rbs +++ b/sig/lithic/models/external_bank_account_create_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountCreateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountCreateResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountCreateResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountCreateResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountCreateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_bank_account_list_response.rbs b/sig/lithic/models/external_bank_account_list_response.rbs index c3c3e54a..9724d5aa 100644 --- a/sig/lithic/models/external_bank_account_list_response.rbs +++ b/sig/lithic/models/external_bank_account_list_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountListResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountListResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountListResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountListResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountListResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountListResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountListResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountListResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_bank_account_retrieve_response.rbs b/sig/lithic/models/external_bank_account_retrieve_response.rbs index 53cacd43..bc4d2af1 100644 --- a/sig/lithic/models/external_bank_account_retrieve_response.rbs +++ b/sig/lithic/models/external_bank_account_retrieve_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountRetrieveResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetrieveResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs b/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs index 19221e43..1e29115c 100644 --- a/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs +++ b/sig/lithic/models/external_bank_account_retry_micro_deposits_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountRetryMicroDepositsResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryMicroDepositsResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_bank_account_retry_prenote_response.rbs b/sig/lithic/models/external_bank_account_retry_prenote_response.rbs index a068ebb8..536b47ca 100644 --- a/sig/lithic/models/external_bank_account_retry_prenote_response.rbs +++ b/sig/lithic/models/external_bank_account_retry_prenote_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountRetryPrenoteResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::verification_method, verification_state: Lithic::Models::ExternalBankAccountRetryPrenoteResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type state = :ENABLED | :CLOSED | :PAUSED diff --git a/sig/lithic/models/external_bank_account_unpause_params.rbs b/sig/lithic/models/external_bank_account_unpause_params.rbs new file mode 100644 index 00000000..d16460af --- /dev/null +++ b/sig/lithic/models/external_bank_account_unpause_params.rbs @@ -0,0 +1,15 @@ +module Lithic + module Models + type external_bank_account_unpause_params = + { } & Lithic::Internal::Type::request_parameters + + class ExternalBankAccountUnpauseParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + def initialize: (?request_options: Lithic::request_opts) -> void + + def to_hash: -> { request_options: Lithic::RequestOptions } + end + end +end diff --git a/sig/lithic/models/external_bank_account_unpause_response.rbs b/sig/lithic/models/external_bank_account_unpause_response.rbs new file mode 100644 index 00000000..1a80b5b1 --- /dev/null +++ b/sig/lithic/models/external_bank_account_unpause_response.rbs @@ -0,0 +1,162 @@ +module Lithic + module Models + type external_bank_account_unpause_response = + { + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::Models::owner_type, + routing_number: String, + state: Lithic::Models::ExternalBankAccountUnpauseResponse::state, + type: Lithic::Models::ExternalBankAccountUnpauseResponse::type_, + verification_attempts: Integer, + verification_method: Lithic::Models::verification_method, + verification_state: Lithic::Models::ExternalBankAccountUnpauseResponse::verification_state, + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? + } + + class ExternalBankAccountUnpauseResponse < Lithic::Internal::Type::BaseModel + attr_accessor token: String + + attr_accessor country: String + + attr_accessor created: Time + + attr_accessor currency: String + + attr_accessor last_four: String + + attr_accessor owner: String + + attr_accessor owner_type: Lithic::Models::owner_type + + attr_accessor routing_number: String + + attr_accessor state: Lithic::Models::ExternalBankAccountUnpauseResponse::state + + attr_accessor type: Lithic::Models::ExternalBankAccountUnpauseResponse::type_ + + attr_accessor verification_attempts: Integer + + attr_accessor verification_method: Lithic::Models::verification_method + + attr_accessor verification_state: Lithic::Models::ExternalBankAccountUnpauseResponse::verification_state + + attr_accessor account_token: String? + + attr_accessor address: Lithic::ExternalBankAccountAddress? + + attr_accessor company_id: String? + + attr_accessor dob: Date? + + attr_accessor doing_business_as: String? + + attr_accessor financial_account_token: String? + + attr_accessor name: String? + + attr_accessor user_defined_id: String? + + attr_accessor verification_failed_reason: String? + + def initialize: ( + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::Models::owner_type, + routing_number: String, + state: Lithic::Models::ExternalBankAccountUnpauseResponse::state, + type: Lithic::Models::ExternalBankAccountUnpauseResponse::type_, + verification_attempts: Integer, + verification_method: Lithic::Models::verification_method, + verification_state: Lithic::Models::ExternalBankAccountUnpauseResponse::verification_state, + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? + ) -> void + + def to_hash: -> { + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::Models::owner_type, + routing_number: String, + state: Lithic::Models::ExternalBankAccountUnpauseResponse::state, + type: Lithic::Models::ExternalBankAccountUnpauseResponse::type_, + verification_attempts: Integer, + verification_method: Lithic::Models::verification_method, + verification_state: Lithic::Models::ExternalBankAccountUnpauseResponse::verification_state, + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? + } + + type state = :ENABLED | :CLOSED | :PAUSED + + module State + extend Lithic::Internal::Type::Enum + + ENABLED: :ENABLED + CLOSED: :CLOSED + PAUSED: :PAUSED + + def self?.values: -> ::Array[Lithic::Models::ExternalBankAccountUnpauseResponse::state] + end + + type type_ = :CHECKING | :SAVINGS + + module Type + extend Lithic::Internal::Type::Enum + + CHECKING: :CHECKING + SAVINGS: :SAVINGS + + def self?.values: -> ::Array[Lithic::Models::ExternalBankAccountUnpauseResponse::type_] + end + + type verification_state = + :PENDING | :ENABLED | :FAILED_VERIFICATION | :INSUFFICIENT_FUNDS + + module VerificationState + extend Lithic::Internal::Type::Enum + + PENDING: :PENDING + ENABLED: :ENABLED + FAILED_VERIFICATION: :FAILED_VERIFICATION + INSUFFICIENT_FUNDS: :INSUFFICIENT_FUNDS + + def self?.values: -> ::Array[Lithic::Models::ExternalBankAccountUnpauseResponse::verification_state] + end + end + end +end diff --git a/sig/lithic/models/external_bank_account_update_response.rbs b/sig/lithic/models/external_bank_account_update_response.rbs index 27a741b7..ac41f341 100644 --- a/sig/lithic/models/external_bank_account_update_response.rbs +++ b/sig/lithic/models/external_bank_account_update_response.rbs @@ -15,15 +15,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountUpdateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class ExternalBankAccountUpdateResponse < Lithic::Internal::Type::BaseModel @@ -53,43 +53,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -105,15 +85,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountUpdateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -130,15 +110,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccountUpdateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccountUpdateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs b/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs index 5c8d3690..51185528 100644 --- a/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs +++ b/sig/lithic/models/external_bank_accounts/micro_deposit_create_response.rbs @@ -16,15 +16,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } class MicroDepositCreateResponse < Lithic::Internal::Type::BaseModel @@ -54,43 +54,23 @@ module Lithic attr_accessor verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_state - attr_reader account_token: String? + attr_accessor account_token: String? - def account_token=: (String) -> String + attr_accessor address: Lithic::ExternalBankAccountAddress? - attr_reader address: Lithic::ExternalBankAccountAddress? + attr_accessor company_id: String? - def address=: ( - Lithic::ExternalBankAccountAddress - ) -> Lithic::ExternalBankAccountAddress + attr_accessor dob: Date? - attr_reader company_id: String? + attr_accessor doing_business_as: String? - def company_id=: (String) -> String + attr_accessor financial_account_token: String? - attr_reader dob: Date? + attr_accessor name: String? - def dob=: (Date) -> Date + attr_accessor user_defined_id: String? - attr_reader doing_business_as: String? - - def doing_business_as=: (String) -> String - - attr_reader financial_account_token: String? - - def financial_account_token=: (String) -> String - - attr_reader name: String? - - def name=: (String) -> String - - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String - - attr_reader verification_failed_reason: String? - - def verification_failed_reason=: (String) -> String + attr_accessor verification_failed_reason: String? def initialize: ( token: String, @@ -106,15 +86,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_state, - ?account_token: String, - ?address: Lithic::ExternalBankAccountAddress, - ?company_id: String, - ?dob: Date, - ?doing_business_as: String, - ?financial_account_token: String, - ?name: String, - ?user_defined_id: String, - ?verification_failed_reason: String + ?account_token: String?, + ?address: Lithic::ExternalBankAccountAddress?, + ?company_id: String?, + ?dob: Date?, + ?doing_business_as: String?, + ?financial_account_token: String?, + ?name: String?, + ?user_defined_id: String?, + ?verification_failed_reason: String? ) -> void def to_hash: -> { @@ -131,15 +111,15 @@ module Lithic verification_attempts: Integer, verification_method: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_method, verification_state: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse::verification_state, - account_token: String, - address: Lithic::ExternalBankAccountAddress, - company_id: String, - dob: Date, - doing_business_as: String, - financial_account_token: String, - name: String, - user_defined_id: String, - verification_failed_reason: String + account_token: String?, + address: Lithic::ExternalBankAccountAddress?, + company_id: String?, + dob: Date?, + doing_business_as: String?, + financial_account_token: String?, + name: String?, + user_defined_id: String?, + verification_failed_reason: String? } type owner_type = :BUSINESS | :INDIVIDUAL diff --git a/sig/lithic/models/external_payment.rbs b/sig/lithic/models/external_payment.rbs index 55a0173c..b9c47b90 100644 --- a/sig/lithic/models/external_payment.rbs +++ b/sig/lithic/models/external_payment.rbs @@ -15,7 +15,7 @@ module Lithic pending_amount: Integer, result: Lithic::Models::ExternalPayment::result, settled_amount: Integer, - user_defined_id: String + user_defined_id: String? } class ExternalPayment < Lithic::Internal::Type::BaseModel @@ -73,9 +73,7 @@ module Lithic def settled_amount=: (Integer) -> Integer - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String + attr_accessor user_defined_id: String? def initialize: ( token: String, @@ -91,7 +89,7 @@ module Lithic ?pending_amount: Integer, ?result: Lithic::Models::ExternalPayment::result, ?settled_amount: Integer, - ?user_defined_id: String + ?user_defined_id: String? ) -> void def to_hash: -> { @@ -108,10 +106,11 @@ module Lithic pending_amount: Integer, result: Lithic::Models::ExternalPayment::result, settled_amount: Integer, - user_defined_id: String + user_defined_id: String? } - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -121,6 +120,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::ExternalPayment::status] end diff --git a/sig/lithic/models/external_payment_list_params.rbs b/sig/lithic/models/external_payment_list_params.rbs index 0b1f2b4e..089016d0 100644 --- a/sig/lithic/models/external_payment_list_params.rbs +++ b/sig/lithic/models/external_payment_list_params.rbs @@ -118,7 +118,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::ExternalPaymentListParams::result] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -128,6 +129,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::ExternalPaymentListParams::status] end diff --git a/sig/lithic/models/financial_account.rbs b/sig/lithic/models/financial_account.rbs index f65ab4f7..d5384592 100644 --- a/sig/lithic/models/financial_account.rbs +++ b/sig/lithic/models/financial_account.rbs @@ -73,7 +73,7 @@ module Lithic type credit_configuration = { - auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, + auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration?, credit_limit: Integer?, credit_product_token: String?, external_bank_account_token: String?, @@ -81,7 +81,7 @@ module Lithic } class CreditConfiguration < Lithic::Internal::Type::BaseModel - attr_accessor auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration + attr_accessor auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration? attr_accessor credit_limit: Integer? @@ -92,7 +92,7 @@ module Lithic attr_accessor tier: String? def initialize: ( - auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, + auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration?, credit_limit: Integer?, credit_product_token: String?, external_bank_account_token: String?, @@ -100,7 +100,7 @@ module Lithic ) -> void def to_hash: -> { - auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration, + auto_collection_configuration: Lithic::FinancialAccount::CreditConfiguration::AutoCollectionConfiguration?, credit_limit: Integer?, credit_product_token: String?, external_bank_account_token: String?, diff --git a/sig/lithic/models/financial_accounts/category_balances.rbs b/sig/lithic/models/financial_accounts/category_balances.rbs new file mode 100644 index 00000000..93502748 --- /dev/null +++ b/sig/lithic/models/financial_accounts/category_balances.rbs @@ -0,0 +1,24 @@ +module Lithic + module Models + module FinancialAccounts + type category_balances = + { fees: Integer, interest: Integer, principal: Integer } + + class CategoryBalances < Lithic::Internal::Type::BaseModel + attr_accessor fees: Integer + + attr_accessor interest: Integer + + attr_accessor principal: Integer + + def initialize: ( + fees: Integer, + interest: Integer, + principal: Integer + ) -> void + + def to_hash: -> { fees: Integer, interest: Integer, principal: Integer } + end + end + end +end diff --git a/sig/lithic/models/financial_accounts/loan_tape.rbs b/sig/lithic/models/financial_accounts/loan_tape.rbs index e13f209f..593b18be 100644 --- a/sig/lithic/models/financial_accounts/loan_tape.rbs +++ b/sig/lithic/models/financial_accounts/loan_tape.rbs @@ -11,20 +11,20 @@ module Lithic credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, interest_details: Lithic::FinancialAccounts::LoanTape::InterestDetails?, minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, - tier: String + ytd_totals: Lithic::StatementTotals, + tier: String? } class LoanTape < Lithic::Internal::Type::BaseModel @@ -44,7 +44,7 @@ module Lithic attr_accessor date: Date - attr_accessor day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals + attr_accessor day_totals: Lithic::StatementTotals attr_accessor ending_balance: Integer @@ -56,9 +56,9 @@ module Lithic attr_accessor minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance - attr_accessor payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation + attr_accessor payment_allocation: Lithic::FinancialAccounts::CategoryBalances - attr_accessor period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals + attr_accessor period_totals: Lithic::StatementTotals attr_accessor previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance @@ -68,11 +68,9 @@ module Lithic attr_accessor version: Integer - attr_accessor ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals + attr_accessor ytd_totals: Lithic::StatementTotals - attr_reader tier: String? - - def tier=: (String) -> String + attr_accessor tier: String? def initialize: ( token: String, @@ -83,20 +81,20 @@ module Lithic credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, interest_details: Lithic::FinancialAccounts::LoanTape::InterestDetails?, minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, - ?tier: String + ytd_totals: Lithic::StatementTotals, + ?tier: String? ) -> void def to_hash: -> { @@ -108,20 +106,20 @@ module Lithic credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, interest_details: Lithic::FinancialAccounts::LoanTape::InterestDetails?, minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, - tier: String + ytd_totals: Lithic::StatementTotals, + tier: String? } type account_standing = @@ -244,207 +242,43 @@ module Lithic type balances = { - due: Lithic::FinancialAccounts::LoanTape::Balances::Due, - next_statement_due: Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue, - past_due: Lithic::FinancialAccounts::LoanTape::Balances::PastDue, - past_statements_due: Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue + due: Lithic::FinancialAccounts::CategoryBalances, + next_statement_due: Lithic::FinancialAccounts::CategoryBalances, + past_due: Lithic::FinancialAccounts::CategoryBalances, + past_statements_due: Lithic::FinancialAccounts::CategoryBalances } class Balances < Lithic::Internal::Type::BaseModel - attr_accessor due: Lithic::FinancialAccounts::LoanTape::Balances::Due - - attr_accessor next_statement_due: Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue - - attr_accessor past_due: Lithic::FinancialAccounts::LoanTape::Balances::PastDue - - attr_accessor past_statements_due: Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue - - def initialize: ( - due: Lithic::FinancialAccounts::LoanTape::Balances::Due, - next_statement_due: Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue, - past_due: Lithic::FinancialAccounts::LoanTape::Balances::PastDue, - past_statements_due: Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue - ) -> void - - def to_hash: -> { - due: Lithic::FinancialAccounts::LoanTape::Balances::Due, - next_statement_due: Lithic::FinancialAccounts::LoanTape::Balances::NextStatementDue, - past_due: Lithic::FinancialAccounts::LoanTape::Balances::PastDue, - past_statements_due: Lithic::FinancialAccounts::LoanTape::Balances::PastStatementsDue - } - - type due = { fees: Integer, interest: Integer, principal: Integer } - - class Due < Lithic::Internal::Type::BaseModel - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor principal: Integer - - def initialize: ( - fees: Integer, - interest: Integer, - principal: Integer - ) -> void - - def to_hash: -> { - fees: Integer, - interest: Integer, - principal: Integer - } - end - - type next_statement_due = - { fees: Integer, interest: Integer, principal: Integer } - - class NextStatementDue < Lithic::Internal::Type::BaseModel - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor principal: Integer - - def initialize: ( - fees: Integer, - interest: Integer, - principal: Integer - ) -> void - - def to_hash: -> { - fees: Integer, - interest: Integer, - principal: Integer - } - end - - type past_due = - { fees: Integer, interest: Integer, principal: Integer } - - class PastDue < Lithic::Internal::Type::BaseModel - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor principal: Integer - - def initialize: ( - fees: Integer, - interest: Integer, - principal: Integer - ) -> void - - def to_hash: -> { - fees: Integer, - interest: Integer, - principal: Integer - } - end - - type past_statements_due = - { fees: Integer, interest: Integer, principal: Integer } - - class PastStatementsDue < Lithic::Internal::Type::BaseModel - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor principal: Integer - - def initialize: ( - fees: Integer, - interest: Integer, - principal: Integer - ) -> void - - def to_hash: -> { - fees: Integer, - interest: Integer, - principal: Integer - } - end - end - - type day_totals = - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - - class DayTotals < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: Integer - - attr_accessor cash_advances: Integer - - attr_accessor credits: Integer - - attr_accessor debits: Integer - - attr_accessor fees: Integer + attr_accessor due: Lithic::FinancialAccounts::CategoryBalances - attr_accessor interest: Integer + attr_accessor next_statement_due: Lithic::FinancialAccounts::CategoryBalances - attr_accessor payments: Integer + attr_accessor past_due: Lithic::FinancialAccounts::CategoryBalances - attr_accessor purchases: Integer - - attr_reader credit_details: top? - - def credit_details=: (top) -> top - - attr_reader debit_details: top? - - def debit_details=: (top) -> top - - attr_reader payment_details: top? - - def payment_details=: (top) -> top + attr_accessor past_statements_due: Lithic::FinancialAccounts::CategoryBalances def initialize: ( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - ?credit_details: top, - ?debit_details: top, - ?payment_details: top + due: Lithic::FinancialAccounts::CategoryBalances, + next_statement_due: Lithic::FinancialAccounts::CategoryBalances, + past_due: Lithic::FinancialAccounts::CategoryBalances, + past_statements_due: Lithic::FinancialAccounts::CategoryBalances ) -> void def to_hash: -> { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top + due: Lithic::FinancialAccounts::CategoryBalances, + next_statement_due: Lithic::FinancialAccounts::CategoryBalances, + past_due: Lithic::FinancialAccounts::CategoryBalances, + past_statements_due: Lithic::FinancialAccounts::CategoryBalances } end type interest_details = { actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, minimum_interest_charged: Integer? } @@ -452,13 +286,13 @@ module Lithic class InterestDetails < Lithic::Internal::Type::BaseModel attr_accessor actual_interest_charged: Integer? - attr_accessor daily_balance_amounts: Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts + attr_accessor daily_balance_amounts: Lithic::CategoryDetails - attr_accessor effective_apr: Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr + attr_accessor effective_apr: Lithic::CategoryDetails attr_accessor interest_calculation_method: Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::interest_calculation_method - attr_accessor interest_for_period: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod + attr_accessor interest_for_period: Lithic::CategoryDetails attr_accessor prime_rate: String? @@ -466,78 +300,24 @@ module Lithic def initialize: ( actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, ?minimum_interest_charged: Integer? ) -> void def to_hash: -> { actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::LoanTape::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::LoanTape::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::LoanTape::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, minimum_interest_charged: Integer? } - type daily_balance_amounts = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String - - attr_accessor cash_advances: String - - attr_accessor purchases: String - - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void - - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end - - type effective_apr = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - - class EffectiveApr < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String - - attr_accessor cash_advances: String - - attr_accessor purchases: String - - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void - - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end - type interest_calculation_method = :DAILY | :AVERAGE_DAILY module InterestCalculationMethod @@ -548,33 +328,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::FinancialAccounts::LoanTape::InterestDetails::interest_calculation_method] end - - type interest_for_period = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - - class InterestForPeriod < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String - - attr_accessor cash_advances: String - - attr_accessor purchases: String - - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void - - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end end type minimum_payment_balance = { amount: Integer, remaining: Integer } @@ -589,102 +342,6 @@ module Lithic def to_hash: -> { amount: Integer, remaining: Integer } end - type payment_allocation = - { fees: Integer, interest: Integer, principal: Integer } - - class PaymentAllocation < Lithic::Internal::Type::BaseModel - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor principal: Integer - - def initialize: ( - fees: Integer, - interest: Integer, - principal: Integer - ) -> void - - def to_hash: -> { - fees: Integer, - interest: Integer, - principal: Integer - } - end - - type period_totals = - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - - class PeriodTotals < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: Integer - - attr_accessor cash_advances: Integer - - attr_accessor credits: Integer - - attr_accessor debits: Integer - - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor payments: Integer - - attr_accessor purchases: Integer - - attr_reader credit_details: top? - - def credit_details=: (top) -> top - - attr_reader debit_details: top? - - def debit_details=: (top) -> top - - attr_reader payment_details: top? - - def payment_details=: (top) -> top - - def initialize: ( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - ?credit_details: top, - ?debit_details: top, - ?payment_details: top - ) -> void - - def to_hash: -> { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - end - type previous_statement_balance = { amount: Integer, remaining: Integer } @@ -697,79 +354,6 @@ module Lithic def to_hash: -> { amount: Integer, remaining: Integer } end - - type ytd_totals = - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - - class YtdTotals < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: Integer - - attr_accessor cash_advances: Integer - - attr_accessor credits: Integer - - attr_accessor debits: Integer - - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor payments: Integer - - attr_accessor purchases: Integer - - attr_reader credit_details: top? - - def credit_details=: (top) -> top - - attr_reader debit_details: top? - - def debit_details=: (top) -> top - - attr_reader payment_details: top? - - def payment_details=: (top) -> top - - def initialize: ( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - ?credit_details: top, - ?debit_details: top, - ?payment_details: top - ) -> void - - def to_hash: -> { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - end end end end diff --git a/sig/lithic/models/financial_accounts/statement.rbs b/sig/lithic/models/financial_accounts/statement.rbs index e17c944e..c33d01e3 100644 --- a/sig/lithic/models/financial_accounts/statement.rbs +++ b/sig/lithic/models/financial_accounts/statement.rbs @@ -14,16 +14,17 @@ module Lithic ending_balance: Integer, financial_account_token: String, payment_due_date: Date?, - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::Models::FinancialAccounts::Statement::statement_type, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, interest_details: Lithic::FinancialAccounts::Statement::InterestDetails?, next_payment_due_date: Date, - next_statement_end_date: Date + next_statement_end_date: Date, + payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails? } class Statement < Lithic::Internal::Type::BaseModel @@ -49,7 +50,7 @@ module Lithic attr_accessor payment_due_date: Date? - attr_accessor period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals + attr_accessor period_totals: Lithic::StatementTotals attr_accessor starting_balance: Integer @@ -61,7 +62,7 @@ module Lithic attr_accessor updated: Time - attr_accessor ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals + attr_accessor ytd_totals: Lithic::StatementTotals attr_accessor interest_details: Lithic::FinancialAccounts::Statement::InterestDetails? @@ -73,6 +74,8 @@ module Lithic def next_statement_end_date=: (Date) -> Date + attr_accessor payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails? + def initialize: ( token: String, account_standing: Lithic::FinancialAccounts::Statement::AccountStanding, @@ -85,16 +88,17 @@ module Lithic ending_balance: Integer, financial_account_token: String, payment_due_date: Date?, - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::Models::FinancialAccounts::Statement::statement_type, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, ?interest_details: Lithic::FinancialAccounts::Statement::InterestDetails?, ?next_payment_due_date: Date, - ?next_statement_end_date: Date + ?next_statement_end_date: Date, + ?payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails? ) -> void def to_hash: -> { @@ -109,16 +113,17 @@ module Lithic ending_balance: Integer, financial_account_token: String, payment_due_date: Date?, - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::Models::FinancialAccounts::Statement::statement_type, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, interest_details: Lithic::FinancialAccounts::Statement::InterestDetails?, next_payment_due_date: Date, - next_statement_end_date: Date + next_statement_end_date: Date, + payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails? } type account_standing = @@ -251,79 +256,6 @@ module Lithic def to_hash: -> { amount: Integer, past_due: Integer } end - type period_totals = - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - - class PeriodTotals < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: Integer - - attr_accessor cash_advances: Integer - - attr_accessor credits: Integer - - attr_accessor debits: Integer - - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor payments: Integer - - attr_accessor purchases: Integer - - attr_reader credit_details: top? - - def credit_details=: (top) -> top - - attr_reader debit_details: top? - - def debit_details=: (top) -> top - - attr_reader payment_details: top? - - def payment_details=: (top) -> top - - def initialize: ( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - ?credit_details: top, - ?debit_details: top, - ?payment_details: top - ) -> void - - def to_hash: -> { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - end - type statement_type = :INITIAL | :PERIOD_END | :FINAL module StatementType @@ -336,86 +268,13 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::FinancialAccounts::Statement::statement_type] end - type ytd_totals = - { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - - class YtdTotals < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: Integer - - attr_accessor cash_advances: Integer - - attr_accessor credits: Integer - - attr_accessor debits: Integer - - attr_accessor fees: Integer - - attr_accessor interest: Integer - - attr_accessor payments: Integer - - attr_accessor purchases: Integer - - attr_reader credit_details: top? - - def credit_details=: (top) -> top - - attr_reader debit_details: top? - - def debit_details=: (top) -> top - - attr_reader payment_details: top? - - def payment_details=: (top) -> top - - def initialize: ( - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - ?credit_details: top, - ?debit_details: top, - ?payment_details: top - ) -> void - - def to_hash: -> { - balance_transfers: Integer, - cash_advances: Integer, - credits: Integer, - debits: Integer, - fees: Integer, - interest: Integer, - payments: Integer, - purchases: Integer, - credit_details: top, - debit_details: top, - payment_details: top - } - end - type interest_details = { actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::Statement::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, minimum_interest_charged: Integer? } @@ -423,13 +282,13 @@ module Lithic class InterestDetails < Lithic::Internal::Type::BaseModel attr_accessor actual_interest_charged: Integer? - attr_accessor daily_balance_amounts: Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts + attr_accessor daily_balance_amounts: Lithic::CategoryDetails - attr_accessor effective_apr: Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr + attr_accessor effective_apr: Lithic::CategoryDetails attr_accessor interest_calculation_method: Lithic::Models::FinancialAccounts::Statement::InterestDetails::interest_calculation_method - attr_accessor interest_for_period: Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod + attr_accessor interest_for_period: Lithic::CategoryDetails attr_accessor prime_rate: String? @@ -437,78 +296,24 @@ module Lithic def initialize: ( actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::Statement::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, ?minimum_interest_charged: Integer? ) -> void def to_hash: -> { actual_interest_charged: Integer?, - daily_balance_amounts: Lithic::FinancialAccounts::Statement::InterestDetails::DailyBalanceAmounts, - effective_apr: Lithic::FinancialAccounts::Statement::InterestDetails::EffectiveApr, + daily_balance_amounts: Lithic::CategoryDetails, + effective_apr: Lithic::CategoryDetails, interest_calculation_method: Lithic::Models::FinancialAccounts::Statement::InterestDetails::interest_calculation_method, - interest_for_period: Lithic::FinancialAccounts::Statement::InterestDetails::InterestForPeriod, + interest_for_period: Lithic::CategoryDetails, prime_rate: String?, minimum_interest_charged: Integer? } - type daily_balance_amounts = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - - class DailyBalanceAmounts < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String - - attr_accessor cash_advances: String - - attr_accessor purchases: String - - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void - - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end - - type effective_apr = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } - - class EffectiveApr < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String - - attr_accessor cash_advances: String - - attr_accessor purchases: String - - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void - - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end - type interest_calculation_method = :DAILY | :AVERAGE_DAILY module InterestCalculationMethod @@ -519,33 +324,43 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::FinancialAccounts::Statement::InterestDetails::interest_calculation_method] end + end - type interest_for_period = - { - balance_transfers: String, - cash_advances: String, - purchases: String - } + type payoff_details = + { + minimum_payment_months: String, + minimum_payment_total: String, + payoff_period_length_months: Integer, + payoff_period_monthly_payment_amount: Integer, + payoff_period_payment_total: Integer + } - class InterestForPeriod < Lithic::Internal::Type::BaseModel - attr_accessor balance_transfers: String + class PayoffDetails < Lithic::Internal::Type::BaseModel + attr_accessor minimum_payment_months: String - attr_accessor cash_advances: String + attr_accessor minimum_payment_total: String - attr_accessor purchases: String + attr_accessor payoff_period_length_months: Integer - def initialize: ( - balance_transfers: String, - cash_advances: String, - purchases: String - ) -> void + attr_accessor payoff_period_monthly_payment_amount: Integer - def to_hash: -> { - balance_transfers: String, - cash_advances: String, - purchases: String - } - end + attr_accessor payoff_period_payment_total: Integer + + def initialize: ( + minimum_payment_months: String, + minimum_payment_total: String, + payoff_period_length_months: Integer, + payoff_period_monthly_payment_amount: Integer, + payoff_period_payment_total: Integer + ) -> void + + def to_hash: -> { + minimum_payment_months: String, + minimum_payment_total: String, + payoff_period_length_months: Integer, + payoff_period_monthly_payment_amount: Integer, + payoff_period_payment_total: Integer + } end end end diff --git a/sig/lithic/models/financial_event.rbs b/sig/lithic/models/financial_event.rbs new file mode 100644 index 00000000..b822962d --- /dev/null +++ b/sig/lithic/models/financial_event.rbs @@ -0,0 +1,216 @@ +module Lithic + module Models + type financial_event = + { + token: String, + amount: Integer, + created: Time, + result: Lithic::Models::FinancialEvent::result, + type: Lithic::Models::FinancialEvent::type_ + } + + class FinancialEvent < Lithic::Internal::Type::BaseModel + attr_reader token: String? + + def token=: (String) -> String + + attr_reader amount: Integer? + + def amount=: (Integer) -> Integer + + attr_reader created: Time? + + def created=: (Time) -> Time + + attr_reader result: Lithic::Models::FinancialEvent::result? + + def result=: ( + Lithic::Models::FinancialEvent::result + ) -> Lithic::Models::FinancialEvent::result + + attr_reader type: Lithic::Models::FinancialEvent::type_? + + def type=: ( + Lithic::Models::FinancialEvent::type_ + ) -> Lithic::Models::FinancialEvent::type_ + + def initialize: ( + ?token: String, + ?amount: Integer, + ?created: Time, + ?result: Lithic::Models::FinancialEvent::result, + ?type: Lithic::Models::FinancialEvent::type_ + ) -> void + + def to_hash: -> { + token: String, + amount: Integer, + created: Time, + result: Lithic::Models::FinancialEvent::result, + type: Lithic::Models::FinancialEvent::type_ + } + + type result = :APPROVED | :DECLINED + + module Result + extend Lithic::Internal::Type::Enum + + APPROVED: :APPROVED + DECLINED: :DECLINED + + def self?.values: -> ::Array[Lithic::Models::FinancialEvent::result] + end + + type type_ = + :ACH_ORIGINATION_CANCELLED + | :ACH_ORIGINATION_INITIATED + | :ACH_ORIGINATION_PROCESSED + | :ACH_ORIGINATION_RELEASED + | :ACH_ORIGINATION_REJECTED + | :ACH_ORIGINATION_REVIEWED + | :ACH_ORIGINATION_SETTLED + | :ACH_RECEIPT_PROCESSED + | :ACH_RECEIPT_RELEASED + | :ACH_RECEIPT_SETTLED + | :ACH_RETURN_INITIATED + | :ACH_RETURN_PROCESSED + | :ACH_RETURN_REJECTED + | :ACH_RETURN_SETTLED + | :AUTHORIZATION + | :AUTHORIZATION_ADVICE + | :AUTHORIZATION_EXPIRY + | :AUTHORIZATION_REVERSAL + | :BALANCE_INQUIRY + | :BILLING_ERROR + | :BILLING_ERROR_REVERSAL + | :CARD_TO_CARD + | :CASH_BACK + | :CASH_BACK_REVERSAL + | :CLEARING + | :COLLECTION + | :CORRECTION_CREDIT + | :CORRECTION_DEBIT + | :CREDIT_AUTHORIZATION + | :CREDIT_AUTHORIZATION_ADVICE + | :CURRENCY_CONVERSION + | :CURRENCY_CONVERSION_REVERSAL + | :DISPUTE_WON + | :EXTERNAL_ACH_CANCELED + | :EXTERNAL_ACH_INITIATED + | :EXTERNAL_ACH_RELEASED + | :EXTERNAL_ACH_REVERSED + | :EXTERNAL_ACH_SETTLED + | :EXTERNAL_CHECK_CANCELED + | :EXTERNAL_CHECK_INITIATED + | :EXTERNAL_CHECK_RELEASED + | :EXTERNAL_CHECK_REVERSED + | :EXTERNAL_CHECK_SETTLED + | :EXTERNAL_TRANSFER_CANCELED + | :EXTERNAL_TRANSFER_INITIATED + | :EXTERNAL_TRANSFER_RELEASED + | :EXTERNAL_TRANSFER_REVERSED + | :EXTERNAL_TRANSFER_SETTLED + | :EXTERNAL_WIRE_CANCELED + | :EXTERNAL_WIRE_INITIATED + | :EXTERNAL_WIRE_RELEASED + | :EXTERNAL_WIRE_REVERSED + | :EXTERNAL_WIRE_SETTLED + | :FINANCIAL_AUTHORIZATION + | :FINANCIAL_CREDIT_AUTHORIZATION + | :INTEREST + | :INTEREST_REVERSAL + | :INTERNAL_ADJUSTMENT + | :LATE_PAYMENT + | :LATE_PAYMENT_REVERSAL + | :LOSS_WRITE_OFF + | :PROVISIONAL_CREDIT + | :PROVISIONAL_CREDIT_REVERSAL + | :SERVICE + | :RETURN + | :RETURN_REVERSAL + | :TRANSFER + | :TRANSFER_INSUFFICIENT_FUNDS + | :RETURNED_PAYMENT + | :RETURNED_PAYMENT_REVERSAL + | :LITHIC_NETWORK_PAYMENT + + module Type + extend Lithic::Internal::Type::Enum + + ACH_ORIGINATION_CANCELLED: :ACH_ORIGINATION_CANCELLED + ACH_ORIGINATION_INITIATED: :ACH_ORIGINATION_INITIATED + ACH_ORIGINATION_PROCESSED: :ACH_ORIGINATION_PROCESSED + ACH_ORIGINATION_RELEASED: :ACH_ORIGINATION_RELEASED + ACH_ORIGINATION_REJECTED: :ACH_ORIGINATION_REJECTED + ACH_ORIGINATION_REVIEWED: :ACH_ORIGINATION_REVIEWED + ACH_ORIGINATION_SETTLED: :ACH_ORIGINATION_SETTLED + ACH_RECEIPT_PROCESSED: :ACH_RECEIPT_PROCESSED + ACH_RECEIPT_RELEASED: :ACH_RECEIPT_RELEASED + ACH_RECEIPT_SETTLED: :ACH_RECEIPT_SETTLED + ACH_RETURN_INITIATED: :ACH_RETURN_INITIATED + ACH_RETURN_PROCESSED: :ACH_RETURN_PROCESSED + ACH_RETURN_REJECTED: :ACH_RETURN_REJECTED + ACH_RETURN_SETTLED: :ACH_RETURN_SETTLED + AUTHORIZATION: :AUTHORIZATION + AUTHORIZATION_ADVICE: :AUTHORIZATION_ADVICE + AUTHORIZATION_EXPIRY: :AUTHORIZATION_EXPIRY + AUTHORIZATION_REVERSAL: :AUTHORIZATION_REVERSAL + BALANCE_INQUIRY: :BALANCE_INQUIRY + BILLING_ERROR: :BILLING_ERROR + BILLING_ERROR_REVERSAL: :BILLING_ERROR_REVERSAL + CARD_TO_CARD: :CARD_TO_CARD + CASH_BACK: :CASH_BACK + CASH_BACK_REVERSAL: :CASH_BACK_REVERSAL + CLEARING: :CLEARING + COLLECTION: :COLLECTION + CORRECTION_CREDIT: :CORRECTION_CREDIT + CORRECTION_DEBIT: :CORRECTION_DEBIT + CREDIT_AUTHORIZATION: :CREDIT_AUTHORIZATION + CREDIT_AUTHORIZATION_ADVICE: :CREDIT_AUTHORIZATION_ADVICE + CURRENCY_CONVERSION: :CURRENCY_CONVERSION + CURRENCY_CONVERSION_REVERSAL: :CURRENCY_CONVERSION_REVERSAL + DISPUTE_WON: :DISPUTE_WON + EXTERNAL_ACH_CANCELED: :EXTERNAL_ACH_CANCELED + EXTERNAL_ACH_INITIATED: :EXTERNAL_ACH_INITIATED + EXTERNAL_ACH_RELEASED: :EXTERNAL_ACH_RELEASED + EXTERNAL_ACH_REVERSED: :EXTERNAL_ACH_REVERSED + EXTERNAL_ACH_SETTLED: :EXTERNAL_ACH_SETTLED + EXTERNAL_CHECK_CANCELED: :EXTERNAL_CHECK_CANCELED + EXTERNAL_CHECK_INITIATED: :EXTERNAL_CHECK_INITIATED + EXTERNAL_CHECK_RELEASED: :EXTERNAL_CHECK_RELEASED + EXTERNAL_CHECK_REVERSED: :EXTERNAL_CHECK_REVERSED + EXTERNAL_CHECK_SETTLED: :EXTERNAL_CHECK_SETTLED + EXTERNAL_TRANSFER_CANCELED: :EXTERNAL_TRANSFER_CANCELED + EXTERNAL_TRANSFER_INITIATED: :EXTERNAL_TRANSFER_INITIATED + EXTERNAL_TRANSFER_RELEASED: :EXTERNAL_TRANSFER_RELEASED + EXTERNAL_TRANSFER_REVERSED: :EXTERNAL_TRANSFER_REVERSED + EXTERNAL_TRANSFER_SETTLED: :EXTERNAL_TRANSFER_SETTLED + EXTERNAL_WIRE_CANCELED: :EXTERNAL_WIRE_CANCELED + EXTERNAL_WIRE_INITIATED: :EXTERNAL_WIRE_INITIATED + EXTERNAL_WIRE_RELEASED: :EXTERNAL_WIRE_RELEASED + EXTERNAL_WIRE_REVERSED: :EXTERNAL_WIRE_REVERSED + EXTERNAL_WIRE_SETTLED: :EXTERNAL_WIRE_SETTLED + FINANCIAL_AUTHORIZATION: :FINANCIAL_AUTHORIZATION + FINANCIAL_CREDIT_AUTHORIZATION: :FINANCIAL_CREDIT_AUTHORIZATION + INTEREST: :INTEREST + INTEREST_REVERSAL: :INTEREST_REVERSAL + INTERNAL_ADJUSTMENT: :INTERNAL_ADJUSTMENT + LATE_PAYMENT: :LATE_PAYMENT + LATE_PAYMENT_REVERSAL: :LATE_PAYMENT_REVERSAL + LOSS_WRITE_OFF: :LOSS_WRITE_OFF + PROVISIONAL_CREDIT: :PROVISIONAL_CREDIT + PROVISIONAL_CREDIT_REVERSAL: :PROVISIONAL_CREDIT_REVERSAL + SERVICE: :SERVICE + RETURN: :RETURN + RETURN_REVERSAL: :RETURN_REVERSAL + TRANSFER: :TRANSFER + TRANSFER_INSUFFICIENT_FUNDS: :TRANSFER_INSUFFICIENT_FUNDS + RETURNED_PAYMENT: :RETURNED_PAYMENT + RETURNED_PAYMENT_REVERSAL: :RETURNED_PAYMENT_REVERSAL + LITHIC_NETWORK_PAYMENT: :LITHIC_NETWORK_PAYMENT + + def self?.values: -> ::Array[Lithic::Models::FinancialEvent::type_] + end + end + end +end diff --git a/sig/lithic/models/financial_transaction.rbs b/sig/lithic/models/financial_transaction.rbs index 46927dab..7d9d4928 100644 --- a/sig/lithic/models/financial_transaction.rbs +++ b/sig/lithic/models/financial_transaction.rbs @@ -7,7 +7,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::FinancialTransaction::Event], + events: ::Array[Lithic::FinancialEvent], pending_amount: Integer, result: Lithic::Models::FinancialTransaction::result, settled_amount: Integer, @@ -26,7 +26,7 @@ module Lithic attr_accessor descriptor: String - attr_accessor events: ::Array[Lithic::FinancialTransaction::Event] + attr_accessor events: ::Array[Lithic::FinancialEvent] attr_accessor pending_amount: Integer @@ -44,7 +44,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::FinancialTransaction::Event], + events: ::Array[Lithic::FinancialEvent], pending_amount: Integer, result: Lithic::Models::FinancialTransaction::result, settled_amount: Integer, @@ -58,7 +58,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::FinancialTransaction::Event], + events: ::Array[Lithic::FinancialEvent], pending_amount: Integer, result: Lithic::Models::FinancialTransaction::result, settled_amount: Integer, @@ -79,219 +79,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::FinancialTransaction::category] end - type event = - { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::FinancialTransaction::Event::result, - type: Lithic::Models::FinancialTransaction::Event::type_ - } - - class Event < Lithic::Internal::Type::BaseModel - attr_reader token: String? - - def token=: (String) -> String - - attr_reader amount: Integer? - - def amount=: (Integer) -> Integer - - attr_reader created: Time? - - def created=: (Time) -> Time - - attr_reader result: Lithic::Models::FinancialTransaction::Event::result? - - def result=: ( - Lithic::Models::FinancialTransaction::Event::result - ) -> Lithic::Models::FinancialTransaction::Event::result - - attr_reader type: Lithic::Models::FinancialTransaction::Event::type_? - - def type=: ( - Lithic::Models::FinancialTransaction::Event::type_ - ) -> Lithic::Models::FinancialTransaction::Event::type_ - - def initialize: ( - ?token: String, - ?amount: Integer, - ?created: Time, - ?result: Lithic::Models::FinancialTransaction::Event::result, - ?type: Lithic::Models::FinancialTransaction::Event::type_ - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::FinancialTransaction::Event::result, - type: Lithic::Models::FinancialTransaction::Event::type_ - } - - type result = :APPROVED | :DECLINED - - module Result - extend Lithic::Internal::Type::Enum - - APPROVED: :APPROVED - DECLINED: :DECLINED - - def self?.values: -> ::Array[Lithic::Models::FinancialTransaction::Event::result] - end - - type type_ = - :ACH_ORIGINATION_CANCELLED - | :ACH_ORIGINATION_INITIATED - | :ACH_ORIGINATION_PROCESSED - | :ACH_ORIGINATION_RELEASED - | :ACH_ORIGINATION_REJECTED - | :ACH_ORIGINATION_REVIEWED - | :ACH_ORIGINATION_SETTLED - | :ACH_RECEIPT_PROCESSED - | :ACH_RECEIPT_RELEASED - | :ACH_RECEIPT_SETTLED - | :ACH_RETURN_INITIATED - | :ACH_RETURN_PROCESSED - | :ACH_RETURN_REJECTED - | :ACH_RETURN_SETTLED - | :AUTHORIZATION - | :AUTHORIZATION_ADVICE - | :AUTHORIZATION_EXPIRY - | :AUTHORIZATION_REVERSAL - | :BALANCE_INQUIRY - | :BILLING_ERROR - | :BILLING_ERROR_REVERSAL - | :CARD_TO_CARD - | :CASH_BACK - | :CASH_BACK_REVERSAL - | :CLEARING - | :COLLECTION - | :CORRECTION_CREDIT - | :CORRECTION_DEBIT - | :CREDIT_AUTHORIZATION - | :CREDIT_AUTHORIZATION_ADVICE - | :CURRENCY_CONVERSION - | :CURRENCY_CONVERSION_REVERSAL - | :DISPUTE_WON - | :EXTERNAL_ACH_CANCELED - | :EXTERNAL_ACH_INITIATED - | :EXTERNAL_ACH_RELEASED - | :EXTERNAL_ACH_REVERSED - | :EXTERNAL_ACH_SETTLED - | :EXTERNAL_CHECK_CANCELED - | :EXTERNAL_CHECK_INITIATED - | :EXTERNAL_CHECK_RELEASED - | :EXTERNAL_CHECK_REVERSED - | :EXTERNAL_CHECK_SETTLED - | :EXTERNAL_TRANSFER_CANCELED - | :EXTERNAL_TRANSFER_INITIATED - | :EXTERNAL_TRANSFER_RELEASED - | :EXTERNAL_TRANSFER_REVERSED - | :EXTERNAL_TRANSFER_SETTLED - | :EXTERNAL_WIRE_CANCELED - | :EXTERNAL_WIRE_INITIATED - | :EXTERNAL_WIRE_RELEASED - | :EXTERNAL_WIRE_REVERSED - | :EXTERNAL_WIRE_SETTLED - | :FINANCIAL_AUTHORIZATION - | :FINANCIAL_CREDIT_AUTHORIZATION - | :INTEREST - | :INTEREST_REVERSAL - | :INTERNAL_ADJUSTMENT - | :LATE_PAYMENT - | :LATE_PAYMENT_REVERSAL - | :LOSS_WRITE_OFF - | :PROVISIONAL_CREDIT - | :PROVISIONAL_CREDIT_REVERSAL - | :SERVICE - | :RETURN - | :RETURN_REVERSAL - | :TRANSFER - | :TRANSFER_INSUFFICIENT_FUNDS - | :RETURNED_PAYMENT - | :RETURNED_PAYMENT_REVERSAL - | :LITHIC_NETWORK_PAYMENT - - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED: :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED: :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED: :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED: :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED: :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED: :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED: :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED: :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED: :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED: :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED: :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED: :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED: :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED: :ACH_RETURN_SETTLED - AUTHORIZATION: :AUTHORIZATION - AUTHORIZATION_ADVICE: :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY: :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL: :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY: :BALANCE_INQUIRY - BILLING_ERROR: :BILLING_ERROR - BILLING_ERROR_REVERSAL: :BILLING_ERROR_REVERSAL - CARD_TO_CARD: :CARD_TO_CARD - CASH_BACK: :CASH_BACK - CASH_BACK_REVERSAL: :CASH_BACK_REVERSAL - CLEARING: :CLEARING - COLLECTION: :COLLECTION - CORRECTION_CREDIT: :CORRECTION_CREDIT - CORRECTION_DEBIT: :CORRECTION_DEBIT - CREDIT_AUTHORIZATION: :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE: :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION: :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL: :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON: :DISPUTE_WON - EXTERNAL_ACH_CANCELED: :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED: :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED: :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED: :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED: :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED: :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED: :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED: :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED: :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED: :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED: :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED: :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED: :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED: :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED: :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED: :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED: :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED: :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED: :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED: :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION: :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION: :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST: :INTEREST - INTEREST_REVERSAL: :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT: :INTERNAL_ADJUSTMENT - LATE_PAYMENT: :LATE_PAYMENT - LATE_PAYMENT_REVERSAL: :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF: :LOSS_WRITE_OFF - PROVISIONAL_CREDIT: :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL: :PROVISIONAL_CREDIT_REVERSAL - SERVICE: :SERVICE - RETURN: :RETURN - RETURN_REVERSAL: :RETURN_REVERSAL - TRANSFER: :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS: :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT: :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL: :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT: :LITHIC_NETWORK_PAYMENT - - def self?.values: -> ::Array[Lithic::Models::FinancialTransaction::Event::type_] - end - end - type result = :APPROVED | :DECLINED module Result diff --git a/sig/lithic/models/management_operation_list_params.rbs b/sig/lithic/models/management_operation_list_params.rbs index de7fb4dd..cb2091da 100644 --- a/sig/lithic/models/management_operation_list_params.rbs +++ b/sig/lithic/models/management_operation_list_params.rbs @@ -103,7 +103,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::ManagementOperationListParams::category] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -113,6 +114,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::ManagementOperationListParams::status] end diff --git a/sig/lithic/models/management_operation_transaction.rbs b/sig/lithic/models/management_operation_transaction.rbs index cfed009d..77d9a8b8 100644 --- a/sig/lithic/models/management_operation_transaction.rbs +++ b/sig/lithic/models/management_operation_transaction.rbs @@ -17,7 +17,7 @@ module Lithic result: Lithic::Models::ManagementOperationTransaction::result, settled_amount: Integer, transaction_series: Lithic::ManagementOperationTransaction::TransactionSeries?, - user_defined_id: String + user_defined_id: String? } class ManagementOperationTransaction < Lithic::Internal::Type::BaseModel @@ -79,9 +79,7 @@ module Lithic attr_accessor transaction_series: Lithic::ManagementOperationTransaction::TransactionSeries? - attr_reader user_defined_id: String? - - def user_defined_id=: (String) -> String + attr_accessor user_defined_id: String? def initialize: ( token: String, @@ -99,7 +97,7 @@ module Lithic ?result: Lithic::Models::ManagementOperationTransaction::result, ?settled_amount: Integer, ?transaction_series: Lithic::ManagementOperationTransaction::TransactionSeries?, - ?user_defined_id: String + ?user_defined_id: String? ) -> void def to_hash: -> { @@ -118,10 +116,11 @@ module Lithic result: Lithic::Models::ManagementOperationTransaction::result, settled_amount: Integer, transaction_series: Lithic::ManagementOperationTransaction::TransactionSeries?, - user_defined_id: String + user_defined_id: String? } - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -131,6 +130,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::ManagementOperationTransaction::status] end @@ -175,7 +175,7 @@ module Lithic memo: String, result: Lithic::Models::ManagementOperationTransaction::Event::result, type: Lithic::Models::ManagementOperationTransaction::Event::type_, - subtype: String + subtype: String? } class Event < Lithic::Internal::Type::BaseModel @@ -195,9 +195,7 @@ module Lithic attr_accessor type: Lithic::Models::ManagementOperationTransaction::Event::type_ - attr_reader subtype: String? - - def subtype=: (String) -> String + attr_accessor subtype: String? def initialize: ( token: String, @@ -208,7 +206,7 @@ module Lithic memo: String, result: Lithic::Models::ManagementOperationTransaction::Event::result, type: Lithic::Models::ManagementOperationTransaction::Event::type_, - ?subtype: String + ?subtype: String? ) -> void def to_hash: -> { @@ -220,7 +218,7 @@ module Lithic memo: String, result: Lithic::Models::ManagementOperationTransaction::Event::result, type: Lithic::Models::ManagementOperationTransaction::Event::type_, - subtype: String + subtype: String? } type detailed_result = :APPROVED | :INSUFFICIENT_FUNDS diff --git a/sig/lithic/models/merchant.rbs b/sig/lithic/models/merchant.rbs new file mode 100644 index 00000000..ea97b352 --- /dev/null +++ b/sig/lithic/models/merchant.rbs @@ -0,0 +1,50 @@ +module Lithic + module Models + type merchant = + { + acceptor_id: String, + acquiring_institution_id: String, + city: String, + country: String, + descriptor: String, + mcc: String, + state: String + } + + class Merchant < Lithic::Internal::Type::BaseModel + attr_accessor acceptor_id: String + + attr_accessor acquiring_institution_id: String + + attr_accessor city: String + + attr_accessor country: String + + attr_accessor descriptor: String + + attr_accessor mcc: String + + attr_accessor state: String + + def initialize: ( + acceptor_id: String, + acquiring_institution_id: String, + city: String, + country: String, + descriptor: String, + mcc: String, + state: String + ) -> void + + def to_hash: -> { + acceptor_id: String, + acquiring_institution_id: String, + city: String, + country: String, + descriptor: String, + mcc: String, + state: String + } + end + end +end diff --git a/sig/lithic/models/payment.rbs b/sig/lithic/models/payment.rbs index a616b415..f8d21b51 100644 --- a/sig/lithic/models/payment.rbs +++ b/sig/lithic/models/payment.rbs @@ -13,7 +13,7 @@ module Lithic method_: Lithic::Models::Payment::method_, method_attributes: Lithic::Models::Payment::method_attributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens?, result: Lithic::Models::Payment::result, settled_amount: Integer, source: Lithic::Models::Payment::source, @@ -49,7 +49,7 @@ module Lithic attr_accessor pending_amount: Integer - attr_accessor related_account_tokens: Lithic::Payment::RelatedAccountTokens + attr_accessor related_account_tokens: Lithic::Payment::RelatedAccountTokens? attr_accessor result: Lithic::Models::Payment::result @@ -88,7 +88,7 @@ module Lithic method_: Lithic::Models::Payment::method_, method_attributes: Lithic::Models::Payment::method_attributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens?, result: Lithic::Models::Payment::result, settled_amount: Integer, source: Lithic::Models::Payment::source, @@ -114,7 +114,7 @@ module Lithic method_: Lithic::Models::Payment::method_, method_attributes: Lithic::Models::Payment::method_attributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens?, result: Lithic::Models::Payment::result, settled_amount: Integer, source: Lithic::Models::Payment::source, @@ -278,6 +278,7 @@ module Lithic type detailed_result = :APPROVED + | :DECLINED | :FUNDS_INSUFFICIENT | :ACCOUNT_INVALID | :PROGRAM_TRANSACTION_LIMIT_EXCEEDED @@ -288,6 +289,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 @@ -483,7 +485,8 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::Payment::source] end - type status = :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED + type status = + :PENDING | :SETTLED | :DECLINED | :REVERSED | :CANCELED | :RETURNED module Status extend Lithic::Internal::Type::Enum @@ -493,6 +496,7 @@ module Lithic DECLINED: :DECLINED REVERSED: :REVERSED CANCELED: :CANCELED + RETURNED: :RETURNED def self?.values: -> ::Array[Lithic::Models::Payment::status] end diff --git a/sig/lithic/models/payment_return_params.rbs b/sig/lithic/models/payment_return_params.rbs new file mode 100644 index 00000000..284b9e52 --- /dev/null +++ b/sig/lithic/models/payment_return_params.rbs @@ -0,0 +1,46 @@ +module Lithic + module Models + type payment_return_params = + { + financial_account_token: String, + return_reason_code: String, + addenda: String?, + date_of_death: Date?, + memo: String? + } + & Lithic::Internal::Type::request_parameters + + class PaymentReturnParams < Lithic::Internal::Type::BaseModel + extend Lithic::Internal::Type::RequestParameters::Converter + include Lithic::Internal::Type::RequestParameters + + attr_accessor financial_account_token: String + + attr_accessor return_reason_code: String + + attr_accessor addenda: String? + + attr_accessor date_of_death: Date? + + attr_accessor memo: String? + + def initialize: ( + financial_account_token: String, + return_reason_code: String, + ?addenda: String?, + ?date_of_death: Date?, + ?memo: String?, + ?request_options: Lithic::request_opts + ) -> void + + def to_hash: -> { + financial_account_token: String, + return_reason_code: String, + addenda: String?, + date_of_death: Date?, + memo: String?, + request_options: Lithic::RequestOptions + } + end + end +end diff --git a/sig/lithic/models/statement_totals.rbs b/sig/lithic/models/statement_totals.rbs new file mode 100644 index 00000000..61695ffb --- /dev/null +++ b/sig/lithic/models/statement_totals.rbs @@ -0,0 +1,76 @@ +module Lithic + module Models + type statement_totals = + { + balance_transfers: Integer, + cash_advances: Integer, + credits: Integer, + debits: Integer, + fees: Integer, + interest: Integer, + payments: Integer, + purchases: Integer, + credit_details: top, + debit_details: top, + payment_details: top + } + + class StatementTotals < Lithic::Internal::Type::BaseModel + attr_accessor balance_transfers: Integer + + attr_accessor cash_advances: Integer + + attr_accessor credits: Integer + + attr_accessor debits: Integer + + attr_accessor fees: Integer + + attr_accessor interest: Integer + + attr_accessor payments: Integer + + attr_accessor purchases: Integer + + attr_reader credit_details: top? + + def credit_details=: (top) -> top + + attr_reader debit_details: top? + + def debit_details=: (top) -> top + + attr_reader payment_details: top? + + def payment_details=: (top) -> top + + def initialize: ( + balance_transfers: Integer, + cash_advances: Integer, + credits: Integer, + debits: Integer, + fees: Integer, + interest: Integer, + payments: Integer, + purchases: Integer, + ?credit_details: top, + ?debit_details: top, + ?payment_details: top + ) -> void + + def to_hash: -> { + balance_transfers: Integer, + cash_advances: Integer, + credits: Integer, + debits: Integer, + fees: Integer, + interest: Integer, + payments: Integer, + purchases: Integer, + credit_details: top, + debit_details: top, + payment_details: top + } + end + end +end diff --git a/sig/lithic/models/transaction.rbs b/sig/lithic/models/transaction.rbs index 206f6653..a0c19cd1 100644 --- a/sig/lithic/models/transaction.rbs +++ b/sig/lithic/models/transaction.rbs @@ -15,7 +15,7 @@ module Lithic cardholder_authentication: Lithic::Transaction::CardholderAuthentication?, created: Time, financial_account_token: String?, - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: Integer?, merchant_authorization_amount: Integer?, merchant_currency: String, @@ -57,7 +57,7 @@ module Lithic attr_accessor financial_account_token: String? - attr_accessor merchant: Lithic::Transaction::Merchant + attr_accessor merchant: Lithic::Merchant attr_accessor merchant_amount: Integer? @@ -101,7 +101,7 @@ module Lithic cardholder_authentication: Lithic::Transaction::CardholderAuthentication?, created: Time, financial_account_token: String?, - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: Integer?, merchant_authorization_amount: Integer?, merchant_currency: String, @@ -130,7 +130,7 @@ module Lithic cardholder_authentication: Lithic::Transaction::CardholderAuthentication?, created: Time, financial_account_token: String?, - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: Integer?, merchant_authorization_amount: Integer?, merchant_currency: String, @@ -344,53 +344,6 @@ module Lithic end end - type merchant = - { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } - - class Merchant < Lithic::Internal::Type::BaseModel - attr_accessor acceptor_id: String - - attr_accessor acquiring_institution_id: String - - attr_accessor city: String - - attr_accessor country: String - - attr_accessor descriptor: String - - attr_accessor mcc: String - - attr_accessor state: String - - def initialize: ( - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - ) -> void - - def to_hash: -> { - acceptor_id: String, - acquiring_institution_id: String, - city: String, - country: String, - descriptor: String, - mcc: String, - state: String - } - end - type network = :AMEX | :INTERLINK | :MAESTRO | :MASTERCARD | :UNKNOWN | :VISA diff --git a/sig/lithic/models/transactions/events/enhanced_data.rbs b/sig/lithic/models/transactions/events/enhanced_data.rbs index 54824539..4060b1f1 100644 --- a/sig/lithic/models/transactions/events/enhanced_data.rbs +++ b/sig/lithic/models/transactions/events/enhanced_data.rbs @@ -42,9 +42,9 @@ module Lithic { line_items: ::Array[Lithic::Transactions::Events::EnhancedData::Common::LineItem], tax: Lithic::Transactions::Events::EnhancedData::Common::Tax, - customer_reference_number: String, - merchant_reference_number: String, - order_date: Date + customer_reference_number: String?, + merchant_reference_number: String?, + order_date: Date? } class Common < Lithic::Internal::Type::BaseModel @@ -52,106 +52,84 @@ module Lithic attr_accessor tax: Lithic::Transactions::Events::EnhancedData::Common::Tax - attr_reader customer_reference_number: String? + attr_accessor customer_reference_number: String? - def customer_reference_number=: (String) -> String + attr_accessor merchant_reference_number: String? - attr_reader merchant_reference_number: String? - - def merchant_reference_number=: (String) -> String - - attr_reader order_date: Date? - - def order_date=: (Date) -> Date + attr_accessor order_date: Date? def initialize: ( line_items: ::Array[Lithic::Transactions::Events::EnhancedData::Common::LineItem], tax: Lithic::Transactions::Events::EnhancedData::Common::Tax, - ?customer_reference_number: String, - ?merchant_reference_number: String, - ?order_date: Date + ?customer_reference_number: String?, + ?merchant_reference_number: String?, + ?order_date: Date? ) -> void def to_hash: -> { line_items: ::Array[Lithic::Transactions::Events::EnhancedData::Common::LineItem], tax: Lithic::Transactions::Events::EnhancedData::Common::Tax, - customer_reference_number: String, - merchant_reference_number: String, - order_date: Date + customer_reference_number: String?, + merchant_reference_number: String?, + order_date: Date? } type line_item = { - amount: String, - description: String, - product_code: String, - quantity: String + amount: String?, + description: String?, + product_code: String?, + quantity: String? } class LineItem < Lithic::Internal::Type::BaseModel - attr_reader amount: String? - - def amount=: (String) -> String - - attr_reader description: String? + attr_accessor amount: String? - def description=: (String) -> String + attr_accessor description: String? - attr_reader product_code: String? + attr_accessor product_code: String? - def product_code=: (String) -> String - - attr_reader quantity: String? - - def quantity=: (String) -> String + attr_accessor quantity: String? def initialize: ( - ?amount: String, - ?description: String, - ?product_code: String, - ?quantity: String + ?amount: String?, + ?description: String?, + ?product_code: String?, + ?quantity: String? ) -> void def to_hash: -> { - amount: String, - description: String, - product_code: String, - quantity: String + amount: String?, + description: String?, + product_code: String?, + quantity: String? } end type tax = { - amount: Integer, - exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt, - merchant_tax_id: String + amount: Integer?, + exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt?, + merchant_tax_id: String? } class Tax < Lithic::Internal::Type::BaseModel - attr_reader amount: Integer? - - def amount=: (Integer) -> Integer - - attr_reader exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt? - - def exempt=: ( - Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt - ) -> Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt + attr_accessor amount: Integer? - attr_reader merchant_tax_id: String? + attr_accessor exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt? - def merchant_tax_id=: (String) -> String + attr_accessor merchant_tax_id: String? def initialize: ( - ?amount: Integer, - ?exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt, - ?merchant_tax_id: String + ?amount: Integer?, + ?exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt?, + ?merchant_tax_id: String? ) -> void def to_hash: -> { - amount: Integer, - exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt, - merchant_tax_id: String + amount: Integer?, + exempt: Lithic::Models::Transactions::Events::EnhancedData::Common::Tax::exempt?, + merchant_tax_id: String? } type exempt = :TAX_INCLUDED | :TAX_NOT_INCLUDED | :NOT_SUPPORTED @@ -172,10 +150,10 @@ module Lithic { amount_totals: Lithic::Transactions::Events::EnhancedData::Fleet::AmountTotals, fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel, - driver_number: String, - odometer: Integer, + driver_number: String?, + odometer: Integer?, service_type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type, - vehicle_number: String + vehicle_number: String? } class Fleet < Lithic::Internal::Type::BaseModel @@ -183,13 +161,9 @@ module Lithic attr_accessor fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel - attr_reader driver_number: String? + attr_accessor driver_number: String? - def driver_number=: (String) -> String - - attr_reader odometer: Integer? - - def odometer=: (Integer) -> Integer + attr_accessor odometer: Integer? attr_reader service_type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type? @@ -197,98 +171,78 @@ module Lithic Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type ) -> Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type - attr_reader vehicle_number: String? - - def vehicle_number=: (String) -> String + attr_accessor vehicle_number: String? def initialize: ( amount_totals: Lithic::Transactions::Events::EnhancedData::Fleet::AmountTotals, fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel, - ?driver_number: String, - ?odometer: Integer, + ?driver_number: String?, + ?odometer: Integer?, ?service_type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type, - ?vehicle_number: String + ?vehicle_number: String? ) -> void def to_hash: -> { amount_totals: Lithic::Transactions::Events::EnhancedData::Fleet::AmountTotals, fuel: Lithic::Transactions::Events::EnhancedData::Fleet::Fuel, - driver_number: String, - odometer: Integer, + driver_number: String?, + odometer: Integer?, service_type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::service_type, - vehicle_number: String + vehicle_number: String? } type amount_totals = - { discount: Integer, gross_sale: Integer, net_sale: Integer } + { discount: Integer?, gross_sale: Integer?, net_sale: Integer? } class AmountTotals < Lithic::Internal::Type::BaseModel - attr_reader discount: Integer? - - def discount=: (Integer) -> Integer - - attr_reader gross_sale: Integer? + attr_accessor discount: Integer? - def gross_sale=: (Integer) -> Integer + attr_accessor gross_sale: Integer? - attr_reader net_sale: Integer? - - def net_sale=: (Integer) -> Integer + attr_accessor net_sale: Integer? def initialize: ( - ?discount: Integer, - ?gross_sale: Integer, - ?net_sale: Integer + ?discount: Integer?, + ?gross_sale: Integer?, + ?net_sale: Integer? ) -> void def to_hash: -> { - discount: Integer, - gross_sale: Integer, - net_sale: Integer + discount: Integer?, + gross_sale: Integer?, + net_sale: Integer? } end type fuel = { - quantity: String, - type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_, - unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure, - unit_price: Integer + quantity: String?, + type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_?, + unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure?, + unit_price: Integer? } class Fuel < Lithic::Internal::Type::BaseModel - attr_reader quantity: String? - - def quantity=: (String) -> String - - attr_reader type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_? - - def type=: ( - Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_ - ) -> Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_ - - attr_reader unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure? + attr_accessor quantity: String? - def unit_of_measure=: ( - Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure - ) -> Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure + attr_accessor type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_? - attr_reader unit_price: Integer? + attr_accessor unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure? - def unit_price=: (Integer) -> Integer + attr_accessor unit_price: Integer? def initialize: ( - ?quantity: String, - ?type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_, - ?unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure, - ?unit_price: Integer + ?quantity: String?, + ?type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_?, + ?unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure?, + ?unit_price: Integer? ) -> void def to_hash: -> { - quantity: String, - type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_, - unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure, - unit_price: Integer + quantity: String?, + type: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::type_?, + unit_of_measure: Lithic::Models::Transactions::Events::EnhancedData::Fleet::Fuel::unit_of_measure?, + unit_price: Integer? } type type_ = diff --git a/sig/lithic/models/transfer.rbs b/sig/lithic/models/transfer.rbs index 38043e22..c335417a 100644 --- a/sig/lithic/models/transfer.rbs +++ b/sig/lithic/models/transfer.rbs @@ -7,7 +7,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Transfer::Event], + events: ::Array[Lithic::FinancialEvent], from_balance: ::Array[Lithic::Balance], pending_amount: Integer, result: Lithic::Models::Transfer::result, @@ -40,11 +40,11 @@ module Lithic def descriptor=: (String) -> String - attr_reader events: ::Array[Lithic::Transfer::Event]? + attr_reader events: ::Array[Lithic::FinancialEvent]? def events=: ( - ::Array[Lithic::Transfer::Event] - ) -> ::Array[Lithic::Transfer::Event] + ::Array[Lithic::FinancialEvent] + ) -> ::Array[Lithic::FinancialEvent] attr_reader from_balance: ::Array[Lithic::Balance]? @@ -84,7 +84,7 @@ module Lithic ?created: Time, ?currency: String, ?descriptor: String, - ?events: ::Array[Lithic::Transfer::Event], + ?events: ::Array[Lithic::FinancialEvent], ?from_balance: ::Array[Lithic::Balance], ?pending_amount: Integer, ?result: Lithic::Models::Transfer::result, @@ -100,7 +100,7 @@ module Lithic created: Time, currency: String, descriptor: String, - events: ::Array[Lithic::Transfer::Event], + events: ::Array[Lithic::FinancialEvent], from_balance: ::Array[Lithic::Balance], pending_amount: Integer, result: Lithic::Models::Transfer::result, @@ -120,219 +120,6 @@ module Lithic def self?.values: -> ::Array[Lithic::Models::Transfer::category] end - type event = - { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::Transfer::Event::result, - type: Lithic::Models::Transfer::Event::type_ - } - - class Event < Lithic::Internal::Type::BaseModel - attr_reader token: String? - - def token=: (String) -> String - - attr_reader amount: Integer? - - def amount=: (Integer) -> Integer - - attr_reader created: Time? - - def created=: (Time) -> Time - - attr_reader result: Lithic::Models::Transfer::Event::result? - - def result=: ( - Lithic::Models::Transfer::Event::result - ) -> Lithic::Models::Transfer::Event::result - - attr_reader type: Lithic::Models::Transfer::Event::type_? - - def type=: ( - Lithic::Models::Transfer::Event::type_ - ) -> Lithic::Models::Transfer::Event::type_ - - def initialize: ( - ?token: String, - ?amount: Integer, - ?created: Time, - ?result: Lithic::Models::Transfer::Event::result, - ?type: Lithic::Models::Transfer::Event::type_ - ) -> void - - def to_hash: -> { - token: String, - amount: Integer, - created: Time, - result: Lithic::Models::Transfer::Event::result, - type: Lithic::Models::Transfer::Event::type_ - } - - type result = :APPROVED | :DECLINED - - module Result - extend Lithic::Internal::Type::Enum - - APPROVED: :APPROVED - DECLINED: :DECLINED - - def self?.values: -> ::Array[Lithic::Models::Transfer::Event::result] - end - - type type_ = - :ACH_ORIGINATION_CANCELLED - | :ACH_ORIGINATION_INITIATED - | :ACH_ORIGINATION_PROCESSED - | :ACH_ORIGINATION_RELEASED - | :ACH_ORIGINATION_REJECTED - | :ACH_ORIGINATION_REVIEWED - | :ACH_ORIGINATION_SETTLED - | :ACH_RECEIPT_PROCESSED - | :ACH_RECEIPT_RELEASED - | :ACH_RECEIPT_SETTLED - | :ACH_RETURN_INITIATED - | :ACH_RETURN_PROCESSED - | :ACH_RETURN_REJECTED - | :ACH_RETURN_SETTLED - | :AUTHORIZATION - | :AUTHORIZATION_ADVICE - | :AUTHORIZATION_EXPIRY - | :AUTHORIZATION_REVERSAL - | :BALANCE_INQUIRY - | :BILLING_ERROR - | :BILLING_ERROR_REVERSAL - | :CARD_TO_CARD - | :CASH_BACK - | :CASH_BACK_REVERSAL - | :CLEARING - | :COLLECTION - | :CORRECTION_CREDIT - | :CORRECTION_DEBIT - | :CREDIT_AUTHORIZATION - | :CREDIT_AUTHORIZATION_ADVICE - | :CURRENCY_CONVERSION - | :CURRENCY_CONVERSION_REVERSAL - | :DISPUTE_WON - | :EXTERNAL_ACH_CANCELED - | :EXTERNAL_ACH_INITIATED - | :EXTERNAL_ACH_RELEASED - | :EXTERNAL_ACH_REVERSED - | :EXTERNAL_ACH_SETTLED - | :EXTERNAL_CHECK_CANCELED - | :EXTERNAL_CHECK_INITIATED - | :EXTERNAL_CHECK_RELEASED - | :EXTERNAL_CHECK_REVERSED - | :EXTERNAL_CHECK_SETTLED - | :EXTERNAL_TRANSFER_CANCELED - | :EXTERNAL_TRANSFER_INITIATED - | :EXTERNAL_TRANSFER_RELEASED - | :EXTERNAL_TRANSFER_REVERSED - | :EXTERNAL_TRANSFER_SETTLED - | :EXTERNAL_WIRE_CANCELED - | :EXTERNAL_WIRE_INITIATED - | :EXTERNAL_WIRE_RELEASED - | :EXTERNAL_WIRE_REVERSED - | :EXTERNAL_WIRE_SETTLED - | :FINANCIAL_AUTHORIZATION - | :FINANCIAL_CREDIT_AUTHORIZATION - | :INTEREST - | :INTEREST_REVERSAL - | :INTERNAL_ADJUSTMENT - | :LATE_PAYMENT - | :LATE_PAYMENT_REVERSAL - | :LOSS_WRITE_OFF - | :PROVISIONAL_CREDIT - | :PROVISIONAL_CREDIT_REVERSAL - | :SERVICE - | :RETURN - | :RETURN_REVERSAL - | :TRANSFER - | :TRANSFER_INSUFFICIENT_FUNDS - | :RETURNED_PAYMENT - | :RETURNED_PAYMENT_REVERSAL - | :LITHIC_NETWORK_PAYMENT - - module Type - extend Lithic::Internal::Type::Enum - - ACH_ORIGINATION_CANCELLED: :ACH_ORIGINATION_CANCELLED - ACH_ORIGINATION_INITIATED: :ACH_ORIGINATION_INITIATED - ACH_ORIGINATION_PROCESSED: :ACH_ORIGINATION_PROCESSED - ACH_ORIGINATION_RELEASED: :ACH_ORIGINATION_RELEASED - ACH_ORIGINATION_REJECTED: :ACH_ORIGINATION_REJECTED - ACH_ORIGINATION_REVIEWED: :ACH_ORIGINATION_REVIEWED - ACH_ORIGINATION_SETTLED: :ACH_ORIGINATION_SETTLED - ACH_RECEIPT_PROCESSED: :ACH_RECEIPT_PROCESSED - ACH_RECEIPT_RELEASED: :ACH_RECEIPT_RELEASED - ACH_RECEIPT_SETTLED: :ACH_RECEIPT_SETTLED - ACH_RETURN_INITIATED: :ACH_RETURN_INITIATED - ACH_RETURN_PROCESSED: :ACH_RETURN_PROCESSED - ACH_RETURN_REJECTED: :ACH_RETURN_REJECTED - ACH_RETURN_SETTLED: :ACH_RETURN_SETTLED - AUTHORIZATION: :AUTHORIZATION - AUTHORIZATION_ADVICE: :AUTHORIZATION_ADVICE - AUTHORIZATION_EXPIRY: :AUTHORIZATION_EXPIRY - AUTHORIZATION_REVERSAL: :AUTHORIZATION_REVERSAL - BALANCE_INQUIRY: :BALANCE_INQUIRY - BILLING_ERROR: :BILLING_ERROR - BILLING_ERROR_REVERSAL: :BILLING_ERROR_REVERSAL - CARD_TO_CARD: :CARD_TO_CARD - CASH_BACK: :CASH_BACK - CASH_BACK_REVERSAL: :CASH_BACK_REVERSAL - CLEARING: :CLEARING - COLLECTION: :COLLECTION - CORRECTION_CREDIT: :CORRECTION_CREDIT - CORRECTION_DEBIT: :CORRECTION_DEBIT - CREDIT_AUTHORIZATION: :CREDIT_AUTHORIZATION - CREDIT_AUTHORIZATION_ADVICE: :CREDIT_AUTHORIZATION_ADVICE - CURRENCY_CONVERSION: :CURRENCY_CONVERSION - CURRENCY_CONVERSION_REVERSAL: :CURRENCY_CONVERSION_REVERSAL - DISPUTE_WON: :DISPUTE_WON - EXTERNAL_ACH_CANCELED: :EXTERNAL_ACH_CANCELED - EXTERNAL_ACH_INITIATED: :EXTERNAL_ACH_INITIATED - EXTERNAL_ACH_RELEASED: :EXTERNAL_ACH_RELEASED - EXTERNAL_ACH_REVERSED: :EXTERNAL_ACH_REVERSED - EXTERNAL_ACH_SETTLED: :EXTERNAL_ACH_SETTLED - EXTERNAL_CHECK_CANCELED: :EXTERNAL_CHECK_CANCELED - EXTERNAL_CHECK_INITIATED: :EXTERNAL_CHECK_INITIATED - EXTERNAL_CHECK_RELEASED: :EXTERNAL_CHECK_RELEASED - EXTERNAL_CHECK_REVERSED: :EXTERNAL_CHECK_REVERSED - EXTERNAL_CHECK_SETTLED: :EXTERNAL_CHECK_SETTLED - EXTERNAL_TRANSFER_CANCELED: :EXTERNAL_TRANSFER_CANCELED - EXTERNAL_TRANSFER_INITIATED: :EXTERNAL_TRANSFER_INITIATED - EXTERNAL_TRANSFER_RELEASED: :EXTERNAL_TRANSFER_RELEASED - EXTERNAL_TRANSFER_REVERSED: :EXTERNAL_TRANSFER_REVERSED - EXTERNAL_TRANSFER_SETTLED: :EXTERNAL_TRANSFER_SETTLED - EXTERNAL_WIRE_CANCELED: :EXTERNAL_WIRE_CANCELED - EXTERNAL_WIRE_INITIATED: :EXTERNAL_WIRE_INITIATED - EXTERNAL_WIRE_RELEASED: :EXTERNAL_WIRE_RELEASED - EXTERNAL_WIRE_REVERSED: :EXTERNAL_WIRE_REVERSED - EXTERNAL_WIRE_SETTLED: :EXTERNAL_WIRE_SETTLED - FINANCIAL_AUTHORIZATION: :FINANCIAL_AUTHORIZATION - FINANCIAL_CREDIT_AUTHORIZATION: :FINANCIAL_CREDIT_AUTHORIZATION - INTEREST: :INTEREST - INTEREST_REVERSAL: :INTEREST_REVERSAL - INTERNAL_ADJUSTMENT: :INTERNAL_ADJUSTMENT - LATE_PAYMENT: :LATE_PAYMENT - LATE_PAYMENT_REVERSAL: :LATE_PAYMENT_REVERSAL - LOSS_WRITE_OFF: :LOSS_WRITE_OFF - PROVISIONAL_CREDIT: :PROVISIONAL_CREDIT - PROVISIONAL_CREDIT_REVERSAL: :PROVISIONAL_CREDIT_REVERSAL - SERVICE: :SERVICE - RETURN: :RETURN - RETURN_REVERSAL: :RETURN_REVERSAL - TRANSFER: :TRANSFER - TRANSFER_INSUFFICIENT_FUNDS: :TRANSFER_INSUFFICIENT_FUNDS - RETURNED_PAYMENT: :RETURNED_PAYMENT - RETURNED_PAYMENT_REVERSAL: :RETURNED_PAYMENT_REVERSAL - LITHIC_NETWORK_PAYMENT: :LITHIC_NETWORK_PAYMENT - - def self?.values: -> ::Array[Lithic::Models::Transfer::Event::type_] - end - end - type result = :APPROVED | :DECLINED module Result diff --git a/sig/lithic/resources/disputes.rbs b/sig/lithic/resources/disputes.rbs index 4fa85f92..02b2207b 100644 --- a/sig/lithic/resources/disputes.rbs +++ b/sig/lithic/resources/disputes.rbs @@ -8,12 +8,12 @@ module Lithic ?customer_filed_date: Time, ?customer_note: String, ?request_options: Lithic::request_opts - ) -> Lithic::Models::DisputeCreateResponse + ) -> Lithic::Dispute def retrieve: ( String dispute_token, ?request_options: Lithic::request_opts - ) -> Lithic::Models::DisputeRetrieveResponse + ) -> Lithic::Dispute def update: ( String dispute_token, @@ -22,7 +22,7 @@ module Lithic ?customer_note: String, ?reason: Lithic::Models::DisputeUpdateParams::reason, ?request_options: Lithic::request_opts - ) -> Lithic::Models::DisputeUpdateResponse + ) -> Lithic::Dispute def list: ( ?begin_: Time, @@ -33,12 +33,12 @@ module Lithic ?status: Lithic::Models::DisputeListParams::status, ?transaction_tokens: ::Array[String], ?request_options: Lithic::request_opts - ) -> Lithic::Internal::CursorPage[Lithic::Models::DisputeListResponse] + ) -> Lithic::Internal::CursorPage[Lithic::Dispute] def delete: ( String dispute_token, ?request_options: Lithic::request_opts - ) -> Lithic::Models::DisputeDeleteResponse + ) -> Lithic::Dispute def delete_evidence: ( String evidence_token, diff --git a/sig/lithic/resources/disputes_v2.rbs b/sig/lithic/resources/disputes_v2.rbs new file mode 100644 index 00000000..0c961b1c --- /dev/null +++ b/sig/lithic/resources/disputes_v2.rbs @@ -0,0 +1,24 @@ +module Lithic + module Resources + class DisputesV2 + def retrieve: ( + String dispute_token, + ?request_options: Lithic::request_opts + ) -> Lithic::DisputeV2 + + def list: ( + ?account_token: String, + ?begin_: Time, + ?card_token: String, + ?disputed_transaction_token: String, + ?end_: Time, + ?ending_before: String, + ?page_size: Integer, + ?starting_after: String, + ?request_options: Lithic::request_opts + ) -> Lithic::Internal::CursorPage[Lithic::DisputeV2] + + def initialize: (client: Lithic::Client) -> void + end + end +end diff --git a/sig/lithic/resources/external_bank_accounts.rbs b/sig/lithic/resources/external_bank_accounts.rbs index e46a1379..3f44fce6 100644 --- a/sig/lithic/resources/external_bank_accounts.rbs +++ b/sig/lithic/resources/external_bank_accounts.rbs @@ -68,6 +68,11 @@ module Lithic ?request_options: Lithic::request_opts ) -> Lithic::Models::ExternalBankAccountRetryPrenoteResponse + def unpause: ( + String external_bank_account_token, + ?request_options: Lithic::request_opts + ) -> Lithic::Models::ExternalBankAccountUnpauseResponse + def initialize: (client: Lithic::Client) -> void end end diff --git a/sig/lithic/resources/payments.rbs b/sig/lithic/resources/payments.rbs index 969f67f4..250031f9 100644 --- a/sig/lithic/resources/payments.rbs +++ b/sig/lithic/resources/payments.rbs @@ -39,6 +39,16 @@ module Lithic ?request_options: Lithic::request_opts ) -> Lithic::Models::PaymentRetryResponse + def return_: ( + String payment_token, + financial_account_token: String, + return_reason_code: String, + ?addenda: String?, + ?date_of_death: Date?, + ?memo: String?, + ?request_options: Lithic::request_opts + ) -> Lithic::Payment + def simulate_action: ( String payment_token, event_type: Lithic::Models::PaymentSimulateActionParams::event_type, diff --git a/test/lithic/resources/account_activity_test.rb b/test/lithic/resources/account_activity_test.rb index cb8ebb25..44082a21 100644 --- a/test/lithic/resources/account_activity_test.rb +++ b/test/lithic/resources/account_activity_test.rb @@ -37,7 +37,7 @@ def test_list created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityListResponse::Internal::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), financial_account_token: String, pending_amount: Integer, result: Lithic::Models::AccountActivityListResponse::Internal::Result, @@ -75,7 +75,7 @@ def test_list method_: Lithic::Payment::Method, method_attributes: Lithic::Payment::MethodAttributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens | nil, result: Lithic::Payment::Result, settled_amount: Integer, source: Lithic::Payment::Source, @@ -152,7 +152,7 @@ def test_retrieve_transaction created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), financial_account_token: String, pending_amount: Integer, result: Lithic::Models::AccountActivityRetrieveTransactionResponse::Internal::Result, @@ -190,7 +190,7 @@ def test_retrieve_transaction method_: Lithic::Payment::Method, method_attributes: Lithic::Payment::MethodAttributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens | nil, result: Lithic::Payment::Result, settled_amount: Integer, source: Lithic::Payment::Source, diff --git a/test/lithic/resources/auth_rules/v2_test.rb b/test/lithic/resources/auth_rules/v2_test.rb index b9402597..8c42ea5a 100644 --- a/test/lithic/resources/auth_rules/v2_test.rb +++ b/test/lithic/resources/auth_rules/v2_test.rb @@ -7,7 +7,7 @@ def test_create_required_params response = @lithic.auth_rules.v2.create( card_tokens: ["182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"], - parameters: {conditions: [{}]}, + parameters: {conditions: [{attribute: :MCC, operation: :IS_ONE_OF, value: "string"}]}, type: :CONDITIONAL_BLOCK ) diff --git a/test/lithic/resources/cards/financial_transactions_test.rb b/test/lithic/resources/cards/financial_transactions_test.rb index 412cb86a..8d319405 100644 --- a/test/lithic/resources/cards/financial_transactions_test.rb +++ b/test/lithic/resources/cards/financial_transactions_test.rb @@ -21,7 +21,7 @@ def test_retrieve_required_params created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), pending_amount: Integer, result: Lithic::FinancialTransaction::Result, settled_amount: Integer, @@ -52,7 +52,7 @@ def test_list created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), pending_amount: Integer, result: Lithic::FinancialTransaction::Result, settled_amount: Integer, diff --git a/test/lithic/resources/disputes_test.rb b/test/lithic/resources/disputes_test.rb index 9cf4dc8e..067040f1 100644 --- a/test/lithic/resources/disputes_test.rb +++ b/test/lithic/resources/disputes_test.rb @@ -12,7 +12,7 @@ def test_create_required_params ) assert_pattern do - response => Lithic::Models::DisputeCreateResponse + response => Lithic::Dispute end assert_pattern do @@ -28,12 +28,12 @@ def test_create_required_params network_reason_code: String | nil, prearbitration_date: Time | nil, primary_claim_id: String | nil, - reason: Lithic::Models::DisputeCreateResponse::Reason, + reason: Lithic::Dispute::Reason, representment_date: Time | nil, resolution_date: Time | nil, resolution_note: String | nil, - resolution_reason: Lithic::Models::DisputeCreateResponse::ResolutionReason | nil, - status: Lithic::Models::DisputeCreateResponse::Status, + resolution_reason: Lithic::Dispute::ResolutionReason | nil, + status: Lithic::Dispute::Status, transaction_token: String } end @@ -43,7 +43,7 @@ def test_retrieve response = @lithic.disputes.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") assert_pattern do - response => Lithic::Models::DisputeRetrieveResponse + response => Lithic::Dispute end assert_pattern do @@ -59,12 +59,12 @@ def test_retrieve network_reason_code: String | nil, prearbitration_date: Time | nil, primary_claim_id: String | nil, - reason: Lithic::Models::DisputeRetrieveResponse::Reason, + reason: Lithic::Dispute::Reason, representment_date: Time | nil, resolution_date: Time | nil, resolution_note: String | nil, - resolution_reason: Lithic::Models::DisputeRetrieveResponse::ResolutionReason | nil, - status: Lithic::Models::DisputeRetrieveResponse::Status, + resolution_reason: Lithic::Dispute::ResolutionReason | nil, + status: Lithic::Dispute::Status, transaction_token: String } end @@ -74,7 +74,7 @@ def test_update response = @lithic.disputes.update("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") assert_pattern do - response => Lithic::Models::DisputeUpdateResponse + response => Lithic::Dispute end assert_pattern do @@ -90,12 +90,12 @@ def test_update network_reason_code: String | nil, prearbitration_date: Time | nil, primary_claim_id: String | nil, - reason: Lithic::Models::DisputeUpdateResponse::Reason, + reason: Lithic::Dispute::Reason, representment_date: Time | nil, resolution_date: Time | nil, resolution_note: String | nil, - resolution_reason: Lithic::Models::DisputeUpdateResponse::ResolutionReason | nil, - status: Lithic::Models::DisputeUpdateResponse::Status, + resolution_reason: Lithic::Dispute::ResolutionReason | nil, + status: Lithic::Dispute::Status, transaction_token: String } end @@ -112,7 +112,7 @@ def test_list return if row.nil? assert_pattern do - row => Lithic::Models::DisputeListResponse + row => Lithic::Dispute end assert_pattern do @@ -128,12 +128,12 @@ def test_list network_reason_code: String | nil, prearbitration_date: Time | nil, primary_claim_id: String | nil, - reason: Lithic::Models::DisputeListResponse::Reason, + reason: Lithic::Dispute::Reason, representment_date: Time | nil, resolution_date: Time | nil, resolution_note: String | nil, - resolution_reason: Lithic::Models::DisputeListResponse::ResolutionReason | nil, - status: Lithic::Models::DisputeListResponse::Status, + resolution_reason: Lithic::Dispute::ResolutionReason | nil, + status: Lithic::Dispute::Status, transaction_token: String } end @@ -143,7 +143,7 @@ def test_delete response = @lithic.disputes.delete("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") assert_pattern do - response => Lithic::Models::DisputeDeleteResponse + response => Lithic::Dispute end assert_pattern do @@ -159,12 +159,12 @@ def test_delete network_reason_code: String | nil, prearbitration_date: Time | nil, primary_claim_id: String | nil, - reason: Lithic::Models::DisputeDeleteResponse::Reason, + reason: Lithic::Dispute::Reason, representment_date: Time | nil, resolution_date: Time | nil, resolution_note: String | nil, - resolution_reason: Lithic::Models::DisputeDeleteResponse::ResolutionReason | nil, - status: Lithic::Models::DisputeDeleteResponse::Status, + resolution_reason: Lithic::Dispute::ResolutionReason | nil, + status: Lithic::Dispute::Status, transaction_token: String } end diff --git a/test/lithic/resources/disputes_v2_test.rb b/test/lithic/resources/disputes_v2_test.rb new file mode 100644 index 00000000..5a795435 --- /dev/null +++ b/test/lithic/resources/disputes_v2_test.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class Lithic::Test::Resources::DisputesV2Test < Lithic::Test::ResourceTest + def test_retrieve + response = @lithic.disputes_v2.retrieve("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") + + assert_pattern do + response => Lithic::DisputeV2 + end + + assert_pattern do + response => { + token: String, + account_token: String, + card_token: String, + case_id: String | nil, + created: Time, + currency: String, + disposition: Lithic::DisputeV2::Disposition | nil, + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::DisputeV2::Event]), + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::DisputeV2::Network, + status: Lithic::DisputeV2::Status | nil, + transaction_series: Lithic::DisputeV2::TransactionSeries | nil, + updated: Time + } + end + end + + def test_list + response = @lithic.disputes_v2.list + + assert_pattern do + response => Lithic::Internal::CursorPage + end + + row = response.to_enum.first + return if row.nil? + + assert_pattern do + row => Lithic::DisputeV2 + end + + assert_pattern do + row => { + token: String, + account_token: String, + card_token: String, + case_id: String | nil, + created: Time, + currency: String, + disposition: Lithic::DisputeV2::Disposition | nil, + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::DisputeV2::Event]), + liability_allocation: Lithic::DisputeV2::LiabilityAllocation, + merchant: Lithic::Merchant, + network: Lithic::DisputeV2::Network, + status: Lithic::DisputeV2::Status | nil, + transaction_series: Lithic::DisputeV2::TransactionSeries | nil, + updated: Time + } + end + end +end diff --git a/test/lithic/resources/external_bank_accounts_test.rb b/test/lithic/resources/external_bank_accounts_test.rb index a653db00..079384db 100644 --- a/test/lithic/resources/external_bank_accounts_test.rb +++ b/test/lithic/resources/external_bank_accounts_test.rb @@ -230,4 +230,39 @@ def test_retry_prenote } end end + + def test_unpause + response = @lithic.external_bank_accounts.unpause("182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e") + + assert_pattern do + response => Lithic::Models::ExternalBankAccountUnpauseResponse + end + + assert_pattern do + response => { + token: String, + country: String, + created: Time, + currency: String, + last_four: String, + owner: String, + owner_type: Lithic::OwnerType, + routing_number: String, + state: Lithic::Models::ExternalBankAccountUnpauseResponse::State, + type: Lithic::Models::ExternalBankAccountUnpauseResponse::Type, + verification_attempts: Integer, + verification_method: Lithic::VerificationMethod, + verification_state: Lithic::Models::ExternalBankAccountUnpauseResponse::VerificationState, + account_token: String | nil, + address: Lithic::ExternalBankAccountAddress | nil, + company_id: String | nil, + dob: Date | nil, + doing_business_as: String | nil, + financial_account_token: String | nil, + name: String | nil, + user_defined_id: String | nil, + verification_failed_reason: String | nil + } + end + end end diff --git a/test/lithic/resources/financial_accounts/financial_transactions_test.rb b/test/lithic/resources/financial_accounts/financial_transactions_test.rb index bfebad74..b68b2153 100644 --- a/test/lithic/resources/financial_accounts/financial_transactions_test.rb +++ b/test/lithic/resources/financial_accounts/financial_transactions_test.rb @@ -21,7 +21,7 @@ def test_retrieve_required_params created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), pending_amount: Integer, result: Lithic::FinancialTransaction::Result, settled_amount: Integer, @@ -52,7 +52,7 @@ def test_list created: Time, currency: String, descriptor: String, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialTransaction::Event]), + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]), pending_amount: Integer, result: Lithic::FinancialTransaction::Result, settled_amount: Integer, diff --git a/test/lithic/resources/financial_accounts/loan_tapes_test.rb b/test/lithic/resources/financial_accounts/loan_tapes_test.rb index e896ccf6..f82e8ca6 100644 --- a/test/lithic/resources/financial_accounts/loan_tapes_test.rb +++ b/test/lithic/resources/financial_accounts/loan_tapes_test.rb @@ -24,19 +24,19 @@ def test_retrieve_required_params credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, interest_details: Lithic::FinancialAccounts::LoanTape::InterestDetails | nil, minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, + ytd_totals: Lithic::StatementTotals, tier: String | nil } end @@ -66,19 +66,19 @@ def test_list credit_limit: Integer, credit_product_token: String, date: Date, - day_totals: Lithic::FinancialAccounts::LoanTape::DayTotals, + day_totals: Lithic::StatementTotals, ending_balance: Integer, excess_credits: Integer, financial_account_token: String, interest_details: Lithic::FinancialAccounts::LoanTape::InterestDetails | nil, minimum_payment_balance: Lithic::FinancialAccounts::LoanTape::MinimumPaymentBalance, - payment_allocation: Lithic::FinancialAccounts::LoanTape::PaymentAllocation, - period_totals: Lithic::FinancialAccounts::LoanTape::PeriodTotals, + payment_allocation: Lithic::FinancialAccounts::CategoryBalances, + period_totals: Lithic::StatementTotals, previous_statement_balance: Lithic::FinancialAccounts::LoanTape::PreviousStatementBalance, starting_balance: Integer, updated: Time, version: Integer, - ytd_totals: Lithic::FinancialAccounts::LoanTape::YtdTotals, + ytd_totals: Lithic::StatementTotals, tier: String | nil } end diff --git a/test/lithic/resources/financial_accounts/statements_test.rb b/test/lithic/resources/financial_accounts/statements_test.rb index 8ea77d58..15d0038f 100644 --- a/test/lithic/resources/financial_accounts/statements_test.rb +++ b/test/lithic/resources/financial_accounts/statements_test.rb @@ -27,16 +27,17 @@ def test_retrieve_required_params ending_balance: Integer, financial_account_token: String, payment_due_date: Date | nil, - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::FinancialAccounts::Statement::StatementType, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, interest_details: Lithic::FinancialAccounts::Statement::InterestDetails | nil, next_payment_due_date: Date | nil, - next_statement_end_date: Date | nil + next_statement_end_date: Date | nil, + payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails | nil } end end @@ -68,16 +69,17 @@ def test_list ending_balance: Integer, financial_account_token: String, payment_due_date: Date | nil, - period_totals: Lithic::FinancialAccounts::Statement::PeriodTotals, + period_totals: Lithic::StatementTotals, starting_balance: Integer, statement_end_date: Date, statement_start_date: Date, statement_type: Lithic::FinancialAccounts::Statement::StatementType, updated: Time, - ytd_totals: Lithic::FinancialAccounts::Statement::YtdTotals, + ytd_totals: Lithic::StatementTotals, interest_details: Lithic::FinancialAccounts::Statement::InterestDetails | nil, next_payment_due_date: Date | nil, - next_statement_end_date: Date | nil + next_statement_end_date: Date | nil, + payoff_details: Lithic::FinancialAccounts::Statement::PayoffDetails | nil } end end diff --git a/test/lithic/resources/payments_test.rb b/test/lithic/resources/payments_test.rb index 830f5686..cd301d29 100644 --- a/test/lithic/resources/payments_test.rb +++ b/test/lithic/resources/payments_test.rb @@ -39,7 +39,7 @@ def test_retrieve method_: Lithic::Payment::Method, method_attributes: Lithic::Payment::MethodAttributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens | nil, result: Lithic::Payment::Result, settled_amount: Integer, source: Lithic::Payment::Source, @@ -81,7 +81,7 @@ def test_list method_: Lithic::Payment::Method, method_attributes: Lithic::Payment::MethodAttributes, pending_amount: Integer, - related_account_tokens: Lithic::Payment::RelatedAccountTokens, + related_account_tokens: Lithic::Payment::RelatedAccountTokens | nil, result: Lithic::Payment::Result, settled_amount: Integer, source: Lithic::Payment::Source, @@ -104,6 +104,46 @@ def test_retry_ end end + def test_return__required_params + response = + @lithic.payments.return_( + "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", + financial_account_token: "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", + return_reason_code: "R01" + ) + + assert_pattern do + response => Lithic::Payment + end + + assert_pattern do + response => { + token: String, + category: Lithic::Payment::Category, + created: Time, + descriptor: String, + direction: Lithic::Payment::Direction, + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::Payment::Event]), + family: Symbol, + financial_account_token: String, + method_: Lithic::Payment::Method, + method_attributes: Lithic::Payment::MethodAttributes, + pending_amount: Integer, + related_account_tokens: Lithic::Payment::RelatedAccountTokens | nil, + result: Lithic::Payment::Result, + settled_amount: Integer, + source: Lithic::Payment::Source, + status: Lithic::Payment::Status, + updated: Time, + currency: String | nil, + expected_release_date: Date | nil, + external_bank_account_token: String | nil, + type: Lithic::Payment::Type | nil, + user_defined_id: String | nil + } + end + end + def test_simulate_action_required_params response = @lithic.payments.simulate_action( diff --git a/test/lithic/resources/transactions_test.rb b/test/lithic/resources/transactions_test.rb index f4b6b5a3..b98d8b79 100644 --- a/test/lithic/resources/transactions_test.rb +++ b/test/lithic/resources/transactions_test.rb @@ -25,7 +25,7 @@ def test_retrieve cardholder_authentication: Lithic::Transaction::CardholderAuthentication | nil, created: Time, financial_account_token: String | nil, - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: Integer | nil, merchant_authorization_amount: Integer | nil, merchant_currency: String, @@ -71,7 +71,7 @@ def test_list cardholder_authentication: Lithic::Transaction::CardholderAuthentication | nil, created: Time, financial_account_token: String | nil, - merchant: Lithic::Transaction::Merchant, + merchant: Lithic::Merchant, merchant_amount: Integer | nil, merchant_authorization_amount: Integer | nil, merchant_currency: String, diff --git a/test/lithic/resources/transfers_test.rb b/test/lithic/resources/transfers_test.rb index 172bbd0c..585f69cb 100644 --- a/test/lithic/resources/transfers_test.rb +++ b/test/lithic/resources/transfers_test.rb @@ -22,7 +22,7 @@ def test_create_required_params created: Time | nil, currency: String | nil, descriptor: String | nil, - events: ^(Lithic::Internal::Type::ArrayOf[Lithic::Transfer::Event]) | nil, + events: ^(Lithic::Internal::Type::ArrayOf[Lithic::FinancialEvent]) | nil, from_balance: ^(Lithic::Internal::Type::ArrayOf[Lithic::Balance]) | nil, pending_amount: Integer | nil, result: Lithic::Transfer::Result | nil,