lithic 0.20.0 → 0.22.0

data/lib/lithic/resources/blockchain_recipients.rb

@@ -46,6 +46,29 @@ module Lithic
         )
       end
 
+      # Get a blockchain recipient by token
+      #
+      # Use this to poll the `verification_state` after registering an address: a
+      # recipient cannot receive a payout until screening completes and moves it out of
+      # `PENDING`
+      #
+      # @overload retrieve(blockchain_recipient_token, request_options: {})
+      #
+      # @param blockchain_recipient_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::BlockchainRecipient]
+      #
+      # @see Lithic::Models::BlockchainRecipientRetrieveParams
+      def retrieve(blockchain_recipient_token, params = {})
+        @client.request(
+          method: :get,
+          path: ["v1/blockchain_recipients/%1$s", blockchain_recipient_token],
+          model: Lithic::BlockchainRecipient,
+          options: params[:request_options]
+        )
+      end
+
       # @api private
       #
       # @param client [Lithic::Client]

data/lib/lithic/resources/cards.rb

@@ -15,7 +15,7 @@ module Lithic
       # Create a new virtual or physical card. Parameters `shipping_address` and
       # `product_id` only apply to physical cards.
       #
-      # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, idempotency_key: nil, request_options: {})
+      # @overload create(type:, account_token: nil, bulk_order_token: nil, card_program_token: nil, carrier: nil, digital_card_art_token: nil, exp_month: nil, exp_year: nil, memo: nil, pin: nil, product_id: nil, replacement_account_token: nil, replacement_comment: nil, replacement_for: nil, replacement_substatus: nil, shipping_address: nil, shipping_method: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, tags: nil, idempotency_key: nil, request_options: {})
       #
       # @param type [Symbol, Lithic::Models::CardCreateParams::Type] Body param: Card types:
       #
@@ -57,6 +57,8 @@ module Lithic
       #
       # @param state [Symbol, Lithic::Models::CardCreateParams::State] Body param: Card state values:
       #
+      # @param tags [Hash{Symbol=>String}] Body param: Key-value pairs to tag the card with. A replacement card does not in
+      #
       # @param idempotency_key [String] Header param: Idempotency key for the request
       #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
@@ -105,7 +107,7 @@ module Lithic
       # _Note: setting a card to a `CLOSED` state is a final action that cannot be
       # undone._
       #
-      # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, request_options: {})
+      # @overload update(card_token, comment: nil, digital_card_art_token: nil, memo: nil, network_program_token: nil, pin: nil, pin_status: nil, spend_limit: nil, spend_limit_duration: nil, state: nil, substatus: nil, tags: nil, request_options: {})
       #
       # @param card_token [String]
       #
@@ -129,6 +131,8 @@ module Lithic
       #
       # @param substatus [Symbol, Lithic::Models::CardUpdateParams::Substatus] Card state substatus values:
       #
+      # @param tags [Hash{Symbol=>String, nil}] Key-value pairs to merge into the card's tags. Supplied keys are added or overwr
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Card]
@@ -361,7 +365,8 @@ module Lithic
       # physically damaged). The PAN, expiry, and CVC2 will remain the same and the
       # original card can continue to be used until the new card is activated. Only
       # applies to cards of type `PHYSICAL`. A card can be reissued or renewed a total
-      # of 8 times.
+      # of 8 times. Returns `409` if the card is still ongoing manufacturing when using
+      # Thales as a manufacturer.
       #
       # @overload reissue(card_token, carrier: nil, product_id: nil, shipping_address: nil, shipping_method: nil, request_options: {})
       #
@@ -402,7 +407,8 @@ module Lithic
       # `PHYSICAL` card can be reissued or renewed a total of 8 times. For `VIRTUAL`,
       # the card will retain the same card token and PAN and receive an updated expiry
       # and CVC2 code. `product_id`, `shipping_method`, `shipping_address`, `carrier`
-      # are only relevant for renewing `PHYSICAL` cards.
+      # are only relevant for renewing `PHYSICAL` cards. Returns `409` if the card is
+      # still ongoing manufacturing when using Thales as a manufacturer.
       #
       # @overload renew(card_token, shipping_address:, carrier: nil, exp_month: nil, exp_year: nil, product_id: nil, shipping_method: nil, request_options: {})
       #

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+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: {})
+        #
+        # @param installment_plan_token [String] Globally unique identifier for installment plan.
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::InstallmentPlan]
+        #
+        # @see Lithic::Models::FinancialAccounts::InstallmentPlanRetrieveParams
+        def retrieve(installment_plan_token, params)
+          parsed, options = Lithic::FinancialAccounts::InstallmentPlanRetrieveParams.dump_request(params)
+          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",
+              financial_account_token,
+              installment_plan_token
+            ],
+            model: Lithic::FinancialAccounts::InstallmentPlan,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::FinancialAccounts::InstallmentPlanListParams} for more details.
+        #
+        # List the installment plans for a given financial account.
+        #
+        # @overload list(financial_account_token, ending_before: nil, page_size: nil, starting_after: nil, state: nil, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for financial account.
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        #
+        # @param state [Symbol, Lithic::Models::FinancialAccounts::InstallmentPlanListParams::State, nil] Only installment plans in this state will be included.
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::FinancialAccounts::InstallmentPlan>]
+        #
+        # @see Lithic::Models::FinancialAccounts::InstallmentPlanListParams
+        def list(financial_account_token, params = {})
+          parsed, options = Lithic::FinancialAccounts::InstallmentPlanListParams.dump_request(params)
+          query = Lithic::Internal::Util.encode_query_params(parsed)
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/installment_plans", financial_account_token],
+            query: query,
+            page: Lithic::Internal::CursorPage,
+            model: Lithic::FinancialAccounts::InstallmentPlan,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+          @statements = Lithic::Resources::FinancialAccounts::InstallmentPlans::Statements.new(client: client)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Lithic
+  module Resources
+    class FinancialAccounts
+      class OpenToBuy
+        # Get the funds available for card spend backed by a given Security Account, along
+        # with the balances that amount is derived from.
+        #
+        # Open to buy is the amount Lithic authorizes card spend against. It is not a
+        # stored balance, so it is recalculated on every request from the Security
+        # Account, the funds held against spend Lithic has already paid out to the
+        # networks on your behalf, and the spend that has not yet been collected. The
+        # accounts that feed the calculation depend on your program setup, so
+        # `summary.settled_funds` is `null` outside Commercial Charge.
+        #
+        # Supported for Commercial Charge, Dynamic Reserve, and Secured Charge programs.
+        # Returns `404` if `financial_account_token` is not a Security Account you own, or
+        # if your program setup does not use an open to buy calculation.
+        #
+        # @overload retrieve(financial_account_token, request_options: {})
+        #
+        # @param financial_account_token [String] Globally unique identifier for the Security Account to price
+        #
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Lithic::Models::FinancialAccounts::FinancialAccountsOpenToBuy]
+        #
+        # @see Lithic::Models::FinancialAccounts::OpenToBuyRetrieveParams
+        def retrieve(financial_account_token, params = {})
+          @client.request(
+            method: :get,
+            path: ["v1/financial_accounts/%1$s/open_to_buy", financial_account_token],
+            model: Lithic::FinancialAccounts::FinancialAccountsOpenToBuy,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Lithic::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/lithic/resources/financial_accounts.rb

@@ -6,6 +6,9 @@ module Lithic
       # @return [Lithic::Resources::FinancialAccounts::Balances]
       attr_reader :balances
 
+      # @return [Lithic::Resources::FinancialAccounts::OpenToBuy]
+      attr_reader :open_to_buy
+
       # @return [Lithic::Resources::FinancialAccounts::FinancialTransactions]
       attr_reader :financial_transactions
 
@@ -18,6 +21,9 @@ module Lithic
       # @return [Lithic::Resources::FinancialAccounts::LoanTapes]
       attr_reader :loan_tapes
 
+      # @return [Lithic::Resources::FinancialAccounts::InstallmentPlans]
+      attr_reader :installment_plans
+
       # @return [Lithic::Resources::FinancialAccounts::LoanTapeConfiguration]
       attr_reader :loan_tape_configuration
 
@@ -184,10 +190,12 @@ module Lithic
       def initialize(client:)
         @client = client
         @balances = Lithic::Resources::FinancialAccounts::Balances.new(client: client)
+        @open_to_buy = Lithic::Resources::FinancialAccounts::OpenToBuy.new(client: client)
         @financial_transactions = Lithic::Resources::FinancialAccounts::FinancialTransactions.new(client: client)
         @credit_configuration = Lithic::Resources::FinancialAccounts::CreditConfiguration.new(client: client)
         @statements = Lithic::Resources::FinancialAccounts::Statements.new(client: client)
         @loan_tapes = Lithic::Resources::FinancialAccounts::LoanTapes.new(client: client)
+        @installment_plans = Lithic::Resources::FinancialAccounts::InstallmentPlans.new(client: client)
         @loan_tape_configuration =
           Lithic::Resources::FinancialAccounts::LoanTapeConfiguration.new(client: client)
         @interest_tier_schedule = Lithic::Resources::FinancialAccounts::InterestTierSchedule.new(client: client)

data/lib/lithic/resources/payments.rb

@@ -6,7 +6,14 @@ module Lithic
       # Some parameter documentations has been truncated, see
       # {Lithic::Models::PaymentCreateParams} for more details.
       #
-      # Initiates a payment between a financial account and an external bank account.
+      # Initiates an ACH payment between a financial account and an external bank
+      # account.
+      #
+      # This endpoint originates on the ACH rail only. To send a stablecoin payout, use
+      # the
+      # [Create stablecoin payment](https://docs.lithic.com/reference/createstablecoinpayment)
+      # endpoint. Payments on every rail are read back through
+      # [List payments](https://docs.lithic.com/reference/searchpayments).
       #
       # @overload create(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, hold: nil, memo: nil, user_defined_id: nil, request_options: {})
       #
@@ -112,22 +119,83 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::PaymentCreateStablecoinParams} for more details.
+      #
+      # Initiates a stablecoin payout from a financial account to a registered
+      # blockchain recipient.
+      #
+      # The recipient must have been registered with
+      # [Create blockchain recipient](https://docs.lithic.com/reference/createblockchainrecipient)
+      # and have completed address screening — only a recipient in the `ENABLED`
+      # verification state can receive a payout. The destination address and chain come
+      # from the recipient, so they are not supplied here.
+      #
+      # Only payouts are initiated through this endpoint. Stablecoin pay-ins are
+      # credited from on-chain deposits to a financial account's deposit address and are
+      # not created through the API. Funds are placed on hold when the payout is
+      # initiated, and a payout that fails on chain reverses that hold. A payout cannot
+      # be cancelled once it has been submitted on chain.
+      #
+      # This endpoint is only available to stablecoin-enabled programs. Contact your
+      # customer success manager to learn more.
+      #
+      # @overload create_stablecoin(amount:, blockchain_recipient_token:, financial_account_token:, type:, token: nil, hold: nil, memo: nil, request_options: {})
+      #
+      # @param amount [Integer] Payout amount in cents
+      #
+      # @param blockchain_recipient_token [String] Token of the blockchain recipient to send the payout to. The recipient must be i
+      #
+      # @param financial_account_token [String] Token of the financial account the payout is funded from
+      #
+      # @param type [Symbol, Lithic::Models::PaymentCreateStablecoinParams::Type] Direction of the payment. Stablecoin supports payouts only
+      #
+      # @param token [String] Customer-provided token that will serve as an idempotency token. This token will
+      #
+      # @param hold [Lithic::Models::PaymentCreateStablecoinParams::Hold] Optional hold to settle when this payout is initiated
+      #
+      # @param memo [String] Memo recorded on the payout. Defaults to `Stablecoin payout on <chain>` when omi
+      #
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Lithic::Models::PaymentCreateStablecoinResponse]
+      #
+      # @see Lithic::Models::PaymentCreateStablecoinParams
+      def create_stablecoin(params)
+        parsed, options = Lithic::PaymentCreateStablecoinParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "v1/payments/stablecoin",
+          body: parsed,
+          model: Lithic::Models::PaymentCreateStablecoinResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::PaymentRetryParams} for more details.
+      #
       # Retry an origination which has been returned.
       #
-      # @overload retry_(payment_token, request_options: {})
+      # @overload retry_(payment_token, method_: nil, request_options: {})
       #
       # @param payment_token [String]
+      #
+      # @param method_ [Symbol, Lithic::Models::PaymentRetryParams::Method] Settlement speed to retry the payment at. Defaults to the original payment's met
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentRetryResponse]
       #
       # @see Lithic::Models::PaymentRetryParams
       def retry_(payment_token, params = {})
+        parsed, options = Lithic::PaymentRetryParams.dump_request(params)
         @client.request(
           method: :post,
           path: ["v1/payments/%1$s/retry", payment_token],
+          body: parsed,
           model: Lithic::Models::PaymentRetryResponse,
-          options: params[:request_options]
+          options: options
         )
       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.20.0"
+  VERSION = "0.22.0"
 end