lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.5

data/lib/lithic/resources/transactions.rb

@@ -12,13 +12,14 @@ module Lithic
       # Get a specific card transaction. All amounts are in the smallest unit of their
       #   respective currency (e.g., cents for USD).
       #
-      # @param transaction_token [String] Globally unique identifier for the transaction.
+      # @overload retrieve(transaction_token, request_options: {})
       #
-      # @param params [Lithic::Models::TransactionRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param transaction_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Transaction]
+      #
+      # @see Lithic::Models::TransactionRetrieveParams
       def retrieve(transaction_token, params = {})
         @client.request(
           method: :get,
@@ -31,41 +32,29 @@ module Lithic
       # List card transactions. All amounts are in the smallest unit of their respective
       #   currency (e.g., cents for USD) and inclusive of any acquirer fees.
       #
-      # @param params [Lithic::Models::TransactionListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_token Filters for transactions associated with a specific account.
-      #
-      #   @option params [Time] :begin_ Date string in RFC 3339 format. Only entries created after the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [String] :card_token Filters for transactions associated with a specific card.
-      #
-      #   @option params [Time] :end_ Date string in RFC 3339 format. Only entries created before the specified time
-      #     will be included. UTC time zone.
-      #
-      #   @option params [String] :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.
+      # @overload list(account_token: nil, begin_: nil, card_token: nil, end_: nil, ending_before: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
       #
-      #   @option params [Integer] :page_size Page size (for pagination).
+      # @param account_token [String]
+      # @param begin_ [Time]
+      # @param card_token [String]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param result [Symbol, Lithic::Models::TransactionListParams::Result]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::TransactionListParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Symbol, Lithic::Models::TransactionListParams::Result] :result Filters for transactions using transaction result field. Can filter by
-      #     `APPROVED`, and `DECLINED`.
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::Transaction>]
       #
-      #   @option params [String] :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.
-      #
-      #   @option params [Symbol, Lithic::Models::TransactionListParams::Status] :status Filters for transactions using transaction status field.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Lithic::CursorPage<Lithic::Models::Transaction>]
+      # @see Lithic::Models::TransactionListParams
       def list(params = {})
         parsed, options = Lithic::Models::TransactionListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/transactions",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::Transaction,
           options: options
         )
@@ -73,13 +62,14 @@ module Lithic
 
       # Expire authorization
       #
-      # @param transaction_token [String] The token of the transaction to expire.
+      # @overload expire_authorization(transaction_token, request_options: {})
       #
-      # @param params [Lithic::Models::TransactionExpireAuthorizationParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param transaction_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TransactionExpireAuthorizationParams
       def expire_authorization(transaction_token, params = {})
         @client.request(
           method: :post,
@@ -98,56 +88,23 @@ module Lithic
       #   [update account](https://docs.lithic.com/reference/patchaccountbytoken)
       #   endpoint.
       #
-      # @param params [Lithic::Models::TransactionSimulateAuthorizationParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Amount (in cents) to authorize. For credit authorizations and financial credit
-      #     authorizations, any value entered will be converted into a negative amount in
-      #     the simulated transaction. For example, entering 100 in this field will result
-      #     in a -100 amount in the transaction. For balance inquiries, this field must be
-      #     set to 0.
+      # @overload simulate_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, merchant_amount: nil, merchant_currency: nil, partial_approval_capable: nil, pin: nil, status: nil, request_options: {})
       #
-      #   @option params [String] :descriptor Merchant descriptor.
-      #
-      #   @option params [String] :pan Sixteen digit card number.
-      #
-      #   @option params [String] :mcc Merchant category code for the transaction to be simulated. A four-digit number
-      #     listed in ISO 18245. Supported merchant category codes can be found
-      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
-      #
-      #   @option params [String] :merchant_acceptor_id Unique identifier to identify the payment card acceptor.
-      #
-      #   @option params [Integer] :merchant_amount Amount of the transaction to be simulated in currency specified in
-      #     merchant_currency, including any acquirer fees.
-      #
-      #   @option params [String] :merchant_currency 3-character alphabetic ISO 4217 currency code. Note: Simulator only accepts USD,
-      #     GBP, EUR and defaults to GBP if another ISO 4217 code is provided
-      #
-      #   @option params [Boolean] :partial_approval_capable Set to true if the terminal is capable of partial approval otherwise false.
-      #     Partial approval is when part of a transaction is approved and another payment
-      #     must be used for the remainder.
-      #
-      #   @option params [String] :pin Simulate entering a PIN. If omitted, PIN check will not be performed.
-      #
-      #   @option params [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status] :status Type of event to simulate.
-      #
-      #     - `AUTHORIZATION` is a dual message purchase authorization, meaning a subsequent
-      #       clearing step is required to settle the transaction.
-      #     - `BALANCE_INQUIRY` is a $0 authorization requesting the balance held on the
-      #       card, and is most often observed when a cardholder requests to view a card's
-      #       balance at an ATM.
-      #     - `CREDIT_AUTHORIZATION` is a dual message request from a merchant to authorize
-      #       a refund, meaning a subsequent clearing step is required to settle the
-      #       transaction.
-      #     - `FINANCIAL_AUTHORIZATION` is a single message request from a merchant to debit
-      #       funds immediately (such as an ATM withdrawal), and no subsequent clearing is
-      #       required to settle the transaction.
-      #     - `FINANCIAL_CREDIT_AUTHORIZATION` is a single message request from a merchant
-      #       to credit funds immediately, and no subsequent clearing is required to settle
-      #       the transaction.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param descriptor [String]
+      # @param pan [String]
+      # @param mcc [String]
+      # @param merchant_acceptor_id [String]
+      # @param merchant_amount [Integer]
+      # @param merchant_currency [String]
+      # @param partial_approval_capable [Boolean]
+      # @param pin [String]
+      # @param status [Symbol, Lithic::Models::TransactionSimulateAuthorizationParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateAuthorizationResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateAuthorizationParams
       def simulate_authorization(params)
         parsed, options = Lithic::Models::TransactionSimulateAuthorizationParams.dump_request(params)
         @client.request(
@@ -163,16 +120,15 @@ module Lithic
       #   merchant acquirer. An authorization advice changes the pending amount of the
       #   transaction.
       #
-      # @param params [Lithic::Models::TransactionSimulateAuthorizationAdviceParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :token The transaction token returned from the /v1/simulate/authorize. response.
+      # @overload simulate_authorization_advice(token:, amount:, request_options: {})
       #
-      #   @option params [Integer] :amount Amount (in cents) to authorize. This amount will override the transaction's
-      #     amount that was originally set by /v1/simulate/authorize.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param token [String]
+      # @param amount [Integer]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateAuthorizationAdviceResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateAuthorizationAdviceParams
       def simulate_authorization_advice(params)
         parsed, options = Lithic::Models::TransactionSimulateAuthorizationAdviceParams.dump_request(params)
         @client.request(
@@ -191,23 +147,15 @@ module Lithic
       #   Transactions that have already cleared, either partially or fully, cannot be
       #   cleared again using this endpoint.
       #
-      # @param params [Lithic::Models::TransactionSimulateClearingParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :token The transaction token returned from the /v1/simulate/authorize response.
+      # @overload simulate_clearing(token:, amount: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Amount (in cents) to clear. Typically this will match the amount in the original
-      #     authorization, but can be higher or lower. The sign of this amount will
-      #     automatically match the sign of the original authorization's amount. For
-      #     example, entering 100 in this field will result in a -100 amount in the
-      #     transaction, if the original authorization is a credit authorization.
-      #
-      #     If `amount` is not set, the full amount of the transaction will be cleared.
-      #     Transactions that have already cleared, either partially or fully, cannot be
-      #     cleared again using this endpoint.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param token [String]
+      # @param amount [Integer]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateClearingResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateClearingParams
       def simulate_clearing(params)
         parsed, options = Lithic::Models::TransactionSimulateClearingParams.dump_request(params)
         @client.request(
@@ -222,25 +170,18 @@ module Lithic
       # Simulates a credit authorization advice from the card network. This message
       #   indicates that the network approved a credit authorization on your behalf.
       #
-      # @param params [Lithic::Models::TransactionSimulateCreditAuthorizationParams, Hash{Symbol=>Object}] .
+      # @overload simulate_credit_authorization(amount:, descriptor:, pan:, mcc: nil, merchant_acceptor_id: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Amount (in cents). Any value entered will be converted into a negative amount in
-      #     the simulated transaction. For example, entering 100 in this field will appear
-      #     as a -100 amount in the transaction.
-      #
-      #   @option params [String] :descriptor Merchant descriptor.
-      #
-      #   @option params [String] :pan Sixteen digit card number.
-      #
-      #   @option params [String] :mcc Merchant category code for the transaction to be simulated. A four-digit number
-      #     listed in ISO 18245. Supported merchant category codes can be found
-      #     [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
-      #
-      #   @option params [String] :merchant_acceptor_id Unique identifier to identify the payment card acceptor.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param descriptor [String]
+      # @param pan [String]
+      # @param mcc [String]
+      # @param merchant_acceptor_id [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateCreditAuthorizationResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateCreditAuthorizationParams
       def simulate_credit_authorization(params)
         parsed, options = Lithic::Models::TransactionSimulateCreditAuthorizationParams.dump_request(params)
         @client.request(
@@ -256,17 +197,16 @@ module Lithic
       #   endpoint clear immediately, without prior authorization, and result in a
       #   `SETTLED` transaction status.
       #
-      # @param params [Lithic::Models::TransactionSimulateReturnParams, Hash{Symbol=>Object}] .
+      # @overload simulate_return(amount:, descriptor:, pan:, request_options: {})
       #
-      #   @option params [Integer] :amount Amount (in cents) to authorize.
-      #
-      #   @option params [String] :descriptor Merchant descriptor.
-      #
-      #   @option params [String] :pan Sixteen digit card number.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param descriptor [String]
+      # @param pan [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateReturnResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateReturnParams
       def simulate_return(params)
         parsed, options = Lithic::Models::TransactionSimulateReturnParams.dump_request(params)
         @client.request(
@@ -282,13 +222,14 @@ module Lithic
       #   can be financial credit authorizations, or credit authorizations that have
       #   cleared.
       #
-      # @param params [Lithic::Models::TransactionSimulateReturnReversalParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :token The transaction token returned from the /v1/simulate/authorize response.
+      # @overload simulate_return_reversal(token:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateReturnReversalResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateReturnReversalParams
       def simulate_return_reversal(params)
         parsed, options = Lithic::Models::TransactionSimulateReturnReversalParams.dump_request(params)
         @client.request(
@@ -305,22 +246,16 @@ module Lithic
       #   transactions. _Simulating an authorization expiry on credit authorizations or
       #   credit authorization advice is not currently supported but will be added soon._
       #
-      # @param params [Lithic::Models::TransactionSimulateVoidParams, Hash{Symbol=>Object}] .
+      # @overload simulate_void(token:, amount: nil, type: nil, request_options: {})
       #
-      #   @option params [String] :token The transaction token returned from the /v1/simulate/authorize response.
-      #
-      #   @option params [Integer] :amount Amount (in cents) to void. Typically this will match the amount in the original
-      #     authorization, but can be less.
-      #
-      #   @option params [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type] :type Type of event to simulate. Defaults to `AUTHORIZATION_REVERSAL`.
-      #
-      #     - `AUTHORIZATION_EXPIRY` indicates authorization has expired and been reversed
-      #       by Lithic.
-      #     - `AUTHORIZATION_REVERSAL` indicates authorization was reversed by the merchant.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param token [String]
+      # @param amount [Integer]
+      # @param type [Symbol, Lithic::Models::TransactionSimulateVoidParams::Type]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TransactionSimulateVoidResponse]
+      #
+      # @see Lithic::Models::TransactionSimulateVoidParams
       def simulate_void(params)
         parsed, options = Lithic::Models::TransactionSimulateVoidParams.dump_request(params)
         @client.request(
@@ -332,6 +267,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/transfers.rb

@@ -6,25 +6,18 @@ module Lithic
       # Transfer funds between two financial accounts or between a financial account and
       #   card
       #
-      # @param params [Lithic::Models::TransferCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(amount:, from:, to:, token: nil, memo: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Amount to be transferred in the currency’s smallest unit (e.g., cents for USD).
-      #     This should always be a positive value.
-      #
-      #   @option params [String] :from Globally unique identifier for the financial account or card that will send the
-      #     funds. Accepted type dependent on the program's use case.
-      #
-      #   @option params [String] :to Globally unique identifier for the financial account or card that will receive
-      #     the funds. Accepted type dependent on the program's use case.
-      #
-      #   @option params [String] :token Customer-provided token that will serve as an idempotency token. This token will
-      #     become the transaction token.
-      #
-      #   @option params [String] :memo Optional descriptor for the transfer.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param from [String]
+      # @param to [String]
+      # @param token [String]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Transfer]
+      #
+      # @see Lithic::Models::TransferCreateParams
       def create(params)
         parsed, options = Lithic::Models::TransferCreateParams.dump_request(params)
         @client.request(
@@ -36,6 +29,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Lithic
-  VERSION = "0.1.0-alpha.3"
+  VERSION = "0.1.0-alpha.5"
 end

data/lib/lithic.rb

@@ -36,25 +36,25 @@ require "connection_pool"
 
 # Package files.
 require_relative "lithic/version"
-require_relative "lithic/util"
-require_relative "lithic/type/converter"
-require_relative "lithic/type/unknown"
-require_relative "lithic/type/boolean_model"
-require_relative "lithic/type/enum"
-require_relative "lithic/type/union"
-require_relative "lithic/type/array_of"
-require_relative "lithic/type/hash_of"
-require_relative "lithic/type/base_model"
-require_relative "lithic/type/base_page"
-require_relative "lithic/type/request_parameters"
-require_relative "lithic/type"
+require_relative "lithic/internal/util"
+require_relative "lithic/internal/type/converter"
+require_relative "lithic/internal/type/unknown"
+require_relative "lithic/internal/type/boolean_model"
+require_relative "lithic/internal/type/enum"
+require_relative "lithic/internal/type/union"
+require_relative "lithic/internal/type/array_of"
+require_relative "lithic/internal/type/hash_of"
+require_relative "lithic/internal/type/base_model"
+require_relative "lithic/internal/type/base_page"
+require_relative "lithic/internal/type/request_parameters"
+require_relative "lithic/internal"
 require_relative "lithic/request_options"
 require_relative "lithic/errors"
-require_relative "lithic/transport/base_client"
-require_relative "lithic/transport/pooled_net_requester"
+require_relative "lithic/internal/transport/base_client"
+require_relative "lithic/internal/transport/pooled_net_requester"
 require_relative "lithic/client"
-require_relative "lithic/cursor_page"
-require_relative "lithic/single_page"
+require_relative "lithic/internal/cursor_page"
+require_relative "lithic/internal/single_page"
 require_relative "lithic/models/payment"
 require_relative "lithic/models/three_ds/challenge_response"
 require_relative "lithic/models/account"

data/rbi/lib/lithic/client.rbi

@@ -1,7 +1,7 @@
 # typed: strong
 
 module Lithic
-  class Client < Lithic::Transport::BaseClient
+  class Client < Lithic::Internal::Transport::BaseClient
     DEFAULT_MAX_RETRIES = 2
 
     DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
@@ -96,7 +96,7 @@ module Lithic
 
     # Status of api
     sig do
-      params(request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Util::AnyHash)))
+      params(request_options: T.nilable(T.any(Lithic::RequestOptions, Lithic::Internal::AnyHash)))
         .returns(Lithic::Models::APIStatus)
     end
     def api_status(request_options: {})
@@ -110,9 +110,9 @@ module Lithic
     # Creates and returns a new client for interacting with the API.
     sig do
       params(
+        api_key: T.nilable(String),
         environment: NilClass,
         base_url: T.nilable(String),
-        api_key: T.nilable(String),
         max_retries: Integer,
         timeout: Float,
         initial_retry_delay: Float,
@@ -121,6 +121,8 @@ module Lithic
         .returns(T.attached_class)
     end
     def self.new(
+      # Defaults to `ENV["LITHIC_API_KEY"]`
+      api_key: ENV["LITHIC_API_KEY"],
       # Specifies the environment to use for the API.
       #
       #   Each environment maps to a different base URL:
@@ -130,8 +132,6 @@ module Lithic
       environment: nil,
       # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
       base_url: nil,
-      # Defaults to `ENV["LITHIC_API_KEY"]`
-      api_key: ENV["LITHIC_API_KEY"],
       # Max number of retries to attempt after a failed retryable request.
       max_retries: DEFAULT_MAX_RETRIES,
       timeout: DEFAULT_TIMEOUT_IN_SECONDS,