lithic 0.21.0 → 0.22.0

data/lib/lithic/resources/financial_accounts/installment_plans/statements.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class InstallmentPlans
+        class Statements
+          # Get a specific statement snapshot for a given installment plan.
+          #
+          # @overload retrieve(statement_token, financial_account_token:, installment_plan_token:, request_options: {})
+          #
+          # @param statement_token [String] Globally unique identifier for statement.
+          #
+          # @param financial_account_token [String] Globally unique identifier for financial account.
+          #
+          # @param installment_plan_token [String] Globally unique identifier for installment plan.
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement]
+          #
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::StatementRetrieveParams
+          def retrieve(statement_token, params)
+            parsed, options =
+              Lithic::FinancialAccounts::InstallmentPlans::StatementRetrieveParams.dump_request(params)
+            financial_account_token =
+              parsed.delete(:financial_account_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            installment_plan_token =
+              parsed.delete(:installment_plan_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: [
+                "v1/financial_accounts/%1$s/installment_plans/%2$s/statements/%3$s",
+                financial_account_token,
+                installment_plan_token,
+                statement_token
+              ],
+              model: Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams} for
+          # more details.
+          #
+          # List the statement snapshots for a given installment plan.
+          #
+          # @overload list(installment_plan_token, financial_account_token:, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
+          #
+          # @param installment_plan_token [String] Path param: Globally unique identifier for installment plan.
+          #
+          # @param financial_account_token [String] Path param: Globally unique identifier for financial account.
+          #
+          # @param begin_ [Date] Query param: Date string in RFC 3339 format. Only entries created after the spec
+          #
+          # @param end_ [Date] Query param: Date string in RFC 3339 format. Only entries created before the spe
+          #
+          # @param ending_before [String] Query param: A cursor representing an item's token before which a page of result
+          #
+          # @param page_size [Integer] Query param: Page size (for pagination).
+          #
+          # @param starting_after [String] Query param: A cursor representing an item's token after which a page of results
+          #
+          # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams::State, nil] Query param: Only snapshots in which the plan was in this state will be included
+          #
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement>]
+          #
+          # @see Lithic::Models::FinancialAccounts::InstallmentPlans::StatementListParams
+          def list(installment_plan_token, params)
+            parsed, options = Lithic::FinancialAccounts::InstallmentPlans::StatementListParams.dump_request(params)
+            query = Lithic::Internal::Util.encode_query_params(parsed)
+            financial_account_token =
+              parsed.delete(:financial_account_token) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: [
+                "v1/financial_accounts/%1$s/installment_plans/%2$s/statements",
+                financial_account_token,
+                installment_plan_token
+              ],
+              query: query.transform_keys(begin_: "begin", end_: "end"),
+              page: Lithic::Internal::CursorPage,
+              model: Lithic::FinancialAccounts::InstallmentPlans::InstallmentPlanStatement,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Lithic::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts/installment_plans.rb

@@ -4,6 +4,9 @@ module Lithic
   module Resources
     class FinancialAccounts
       class InstallmentPlans
+        # @return [Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements]
+        attr_reader :statements
+
         # Get a specific installment plan for a given financial account.
         #
         # @overload retrieve(installment_plan_token, financial_account_token:, request_options: {})
@@ -75,6 +78,7 @@ module Lithic
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client
+          @statements = Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements.new(client: client)
         end
       end
     end

data/lib/lithic/resources/transactions.rb

@@ -131,7 +131,7 @@ module Lithic
       # [update account](https://docs.lithic.com/reference/patchaccountbytoken)
       # endpoint.
       #
-      # @overload simulate_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
+      # @overload simulate_authorization(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, settlement_currency: nil, status: nil, request_options: {})
       #
       # @param amount [Integer] Amount (in cents) to authorize. For credit authorizations and financial credit a
       #
@@ -139,6 +139,8 @@ module Lithic
       #
       # @param pan [String] Sixteen digit card number.
       #
+      # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       # @param merchant_acceptor_city [String] Merchant acceptor city
@@ -151,12 +153,14 @@ module Lithic
       #
       # @param merchant_amount [Integer] Amount of the transaction to be simulated in currency specified in merchant_curr
       #
-      # @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
+      # @param merchant_currency [String] 3-character alphabetic ISO 4217 currency code for the merchant amount. Only used
       #
       # @param partial_approval_capable [Boolean] Set to true if the terminal is capable of partial approval otherwise false.
       #
       # @param pin [String] Simulate entering a PIN. If omitted, PIN check will not be performed.
       #
+      # @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] Type of event to simulate.
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -244,7 +248,7 @@ module Lithic
       # Simulates a credit authorization advice from the card network. This message
       # indicates that the network approved a credit authorization on your behalf.
       #
-      # @overload simulate_credit_authorization_advice(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
+      # @overload simulate_credit_authorization_advice(amount:, descriptor:, pan:, billing_currency: nil, mcc: nil, merchant_acceptor_city: nil, merchant_acceptor_country: nil, merchant_acceptor_id: nil, merchant_acceptor_state: nil, request_options: {})
       #
       # @param amount [Integer] Amount (in cents). Any value entered will be converted into a negative amount in
       #
@@ -252,6 +256,8 @@ module Lithic
       #
       # @param pan [String] Sixteen digit card number.
       #
+      # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
       # @param mcc [String] Merchant category code for the transaction to be simulated. A four-digit number
       #
       # @param merchant_acceptor_city [String] Merchant acceptor city
@@ -278,11 +284,14 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::TransactionSimulateReturnParams} for more details.
+      #
       # Returns, or refunds, an amount back to a card. Returns simulated via this
       # endpoint clear immediately, without prior authorization, and result in a
       # `SETTLED` transaction status.
       #
-      # @overload simulate_return(amount:, descriptor:, pan:, request_options: {})
+      # @overload simulate_return(amount:, descriptor:, pan:, billing_currency: nil, settlement_currency: nil, request_options: {})
       #
       # @param amount [Integer] Amount (in cents) to authorize.
       #
@@ -290,6 +299,10 @@ module Lithic
       #
       # @param pan [String] Sixteen digit card number.
       #
+      # @param billing_currency [String] 3-character alphabetic ISO 4217 currency code for the cardholder billing amount.
+      #
+      # @param settlement_currency [String] 3-character alphabetic ISO 4217 currency code for the settlement amount. Permitt
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateReturnResponse]

data/lib/lithic/resources/webhooks.rb

@@ -37,6 +37,24 @@ module Lithic
         Lithic::Internal::Type::Converter.coerce(Lithic::Models::ParsedWebhookEvent, parsed)
       end
 
+      # @param payload [String] The raw webhook payload as a string
+      #
+      # @param headers [Hash{String=>String}] The raw HTTP headers that came with the payload
+      #
+      # @param key [String, nil] The webhook signing key
+      #
+      # @return [Lithic::Models::AccountHolderCreatedWebhookEvent, Lithic::Models::ParsedWebhookEvent::KYBPayload, Lithic::Models::ParsedWebhookEvent::KYCPayload, Lithic::Models::ParsedWebhookEvent::LegacyPayload, Lithic::Models::AccountHolderVerificationWebhookEvent, Lithic::Models::AccountHolderDocumentUpdatedWebhookEvent, Lithic::Models::CardAuthorizationApprovalRequestWebhookEvent, Lithic::Models::CardAuthorizationChallengeWebhookEvent, Lithic::Models::CardAuthorizationChallengeResponseWebhookEvent, Lithic::Models::AuthRulesBacktestReportCreatedWebhookEvent, Lithic::Models::BalanceUpdatedWebhookEvent, Lithic::Models::BookTransferTransactionCreatedWebhookEvent, Lithic::Models::BookTransferTransactionUpdatedWebhookEvent, Lithic::Models::CardCreatedWebhookEvent, Lithic::Models::CardConvertedWebhookEvent, Lithic::Models::CardPinUpdatedWebhookEvent, Lithic::Models::CardRenewedWebhookEvent, Lithic::Models::CardReissuedWebhookEvent, Lithic::Models::CardShippedWebhookEvent, Lithic::Models::CardUpdatedWebhookEvent, Lithic::Models::CardTransactionUpdatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataCreatedWebhookEvent, Lithic::Models::CardTransactionEnhancedDataUpdatedWebhookEvent, Lithic::Models::ClaimCreatedWebhookEvent, Lithic::Models::ClaimUpdatedWebhookEvent, Lithic::Models::ClaimDocumentUploadedWebhookEvent, Lithic::Models::ClaimDocumentAcceptedWebhookEvent, Lithic::Models::ClaimDocumentRejectedWebhookEvent, Lithic::Models::DigitalWalletTokenizationApprovalRequestWebhookEvent, Lithic::Models::DigitalWalletTokenizationResultWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::DigitalWalletTokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::DigitalWalletTokenizationUpdatedWebhookEvent, Lithic::Models::DisputeUpdatedWebhookEvent, Lithic::Models::DisputeEvidenceUploadFailedWebhookEvent, Lithic::Models::EmbedSessionGeneratedWebhookEvent, Lithic::Models::EmbedViewedWebhookEvent, Lithic::Models::ExternalBankAccountCreatedWebhookEvent, Lithic::Models::ExternalBankAccountUpdatedWebhookEvent, Lithic::Models::ExternalPaymentCreatedWebhookEvent, Lithic::Models::ExternalPaymentUpdatedWebhookEvent, Lithic::Models::FinancialAccountCreatedWebhookEvent, Lithic::Models::FinancialAccountUpdatedWebhookEvent, Lithic::Models::FundingEventCreatedWebhookEvent, Lithic::Models::LoanTapeCreatedWebhookEvent, Lithic::Models::LoanTapeUpdatedWebhookEvent, Lithic::Models::ManagementOperationCreatedWebhookEvent, Lithic::Models::ManagementOperationUpdatedWebhookEvent, Lithic::Models::InternalTransactionCreatedWebhookEvent, Lithic::Models::InternalTransactionUpdatedWebhookEvent, Lithic::Models::NetworkTotalCreatedWebhookEvent, Lithic::Models::NetworkTotalUpdatedWebhookEvent, Lithic::Models::PaymentTransactionCreatedWebhookEvent, Lithic::Models::PaymentTransactionUpdatedWebhookEvent, Lithic::Models::SettlementReportUpdatedWebhookEvent, Lithic::Models::StatementsCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationCreatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationChallengeWebhookEvent, Lithic::Models::TokenizationApprovalRequestWebhookEvent, Lithic::Models::TokenizationResultWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeWebhookEvent, Lithic::Models::TokenizationTwoFactorAuthenticationCodeSentWebhookEvent, Lithic::Models::TokenizationUpdatedWebhookEvent, Lithic::Models::ThreeDSAuthenticationApprovalRequestWebhookEvent, Lithic::Models::DisputeTransactionCreatedWebhookEvent, Lithic::Models::DisputeTransactionUpdatedWebhookEvent]
+      def parsed(payload, headers:, key: @client.webhook_secret)
+        if key.nil?
+          raise ArgumentError.new("Cannot verify a webhook without a key on either the client's webhook_secret or passed in as an argument")
+        end
+
+        ::StandardWebhooks::Webhook.new(key).verify(payload, headers)
+
+        parsed = JSON.parse(payload, symbolize_names: true)
+        Lithic::Internal::Type::Converter.coerce(Lithic::Models::ParsedWebhookEvent, parsed)
+      end
+
       # Verifies the signature of a webhook payload using the Standard Webhooks specification.
       #
       # @param payload [String] The raw webhook payload as a string

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.21.0"
+  VERSION = "0.22.0"
 end

data/lib/lithic.rb

@@ -120,6 +120,9 @@ require_relative "lithic/models/api_status"
 require_relative "lithic/models/auth_rules/ach_payment_update_action"
 require_relative "lithic/models/auth_rules/auth_rule"
 require_relative "lithic/models/auth_rules/auth_rule_condition"
+require_relative "lithic/models/auth_rules/auth_rule_entities"
+require_relative "lithic/models/auth_rules/auth_rule_entities_response"
+require_relative "lithic/models/auth_rules/auth_rule_entity"
 require_relative "lithic/models/auth_rules/auth_rule_version"
 require_relative "lithic/models/auth_rules/backtest_stats"
 require_relative "lithic/models/auth_rules/card_transaction_update_action"
@@ -129,7 +132,6 @@ require_relative "lithic/models/auth_rules/conditional_ach_payment_update_action
 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_authorization_adjustment_parameters"
-require_relative "lithic/models/auth_rules/conditional_block_parameters"
 require_relative "lithic/models/auth_rules/conditional_card_transaction_update_action_parameters"
 require_relative "lithic/models/auth_rules/conditional_operation"
 require_relative "lithic/models/auth_rules/conditional_tokenization_action_parameters"
@@ -157,6 +159,7 @@ require_relative "lithic/models/auth_rules/v2_retrieve_features_response"
 require_relative "lithic/models/auth_rules/v2_retrieve_params"
 require_relative "lithic/models/auth_rules/v2_retrieve_report_params"
 require_relative "lithic/models/auth_rules/v2_retrieve_report_response"
+require_relative "lithic/models/auth_rules/v2_update_entities_params"
 require_relative "lithic/models/auth_rules/v2_update_params"
 require_relative "lithic/models/auth_rules/velocity_limit_params"
 require_relative "lithic/models/auth_rules/velocity_limit_period"
@@ -331,6 +334,9 @@ require_relative "lithic/models/financial_accounts/financial_transaction_retriev
 require_relative "lithic/models/financial_accounts/installment_plan"
 require_relative "lithic/models/financial_accounts/installment_plan_list_params"
 require_relative "lithic/models/financial_accounts/installment_plan_retrieve_params"
+require_relative "lithic/models/financial_accounts/installment_plans/installment_plan_statement"
+require_relative "lithic/models/financial_accounts/installment_plans/statement_list_params"
+require_relative "lithic/models/financial_accounts/installment_plans/statement_retrieve_params"
 require_relative "lithic/models/financial_accounts/interest_tier_schedule_create_params"
 require_relative "lithic/models/financial_accounts/interest_tier_schedule_delete_params"
 require_relative "lithic/models/financial_accounts/interest_tier_schedule_list_params"
@@ -562,6 +568,7 @@ require_relative "lithic/resources/financial_accounts/balances"
 require_relative "lithic/resources/financial_accounts/credit_configuration"
 require_relative "lithic/resources/financial_accounts/financial_transactions"
 require_relative "lithic/resources/financial_accounts/installment_plans"
+require_relative "lithic/resources/financial_accounts/installment_plans/statements"
 require_relative "lithic/resources/financial_accounts/interest_tier_schedule"
 require_relative "lithic/resources/financial_accounts/loan_tape_configuration"
 require_relative "lithic/resources/financial_accounts/loan_tapes"

data/rbi/lithic/models/account_holder_create_params.rbi

@@ -406,7 +406,8 @@ module Lithic
             attr_accessor :last_name
 
             # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            # and KYC workflows.
             sig { returns(T.nilable(Lithic::Address)) }
             attr_reader :address
 
@@ -464,7 +465,8 @@ module Lithic
               # Individual's last name, as it appears on government-issued identity documents.
               last_name:,
               # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-              # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+              # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+              # and KYC workflows.
               address: nil,
               # Individual's date of birth, as an RFC 3339 date.
               dob: nil,
@@ -516,7 +518,8 @@ module Lithic
             attr_accessor :last_name
 
             # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-            # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+            # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+            # and KYC workflows.
             sig { returns(T.nilable(Lithic::Address)) }
             attr_reader :address
 
@@ -580,7 +583,8 @@ module Lithic
               # Individual's last name, as it appears on government-issued identity documents.
               last_name:,
               # Individual's current address - PO boxes, UPS drops, and FedEx drops are not
-              # acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.
+              # acceptable; APO/FPO are acceptable. Only USA addresses are supported for the KYB
+              # and KYC workflows.
               address: nil,
               # Individual's date of birth, as an RFC 3339 date.
               dob: nil,