lithic 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

data/lib/lithic/resources/accounts.rb

@@ -5,17 +5,18 @@ module Lithic
     class Accounts
       # Get account configuration such as spend limits.
       #
-      # @param account_token [String] Globally unique identifier for account.
+      # @overload retrieve(account_token, request_options: {})
       #
-      # @param params [Lithic::Models::AccountRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Account]
+      #
+      # @see Lithic::Models::AccountRetrieveParams
       def retrieve(account_token, params = {})
         @client.request(
           method: :get,
-          path: ["v1/accounts/%0s", account_token],
+          path: ["v1/accounts/%1$s", account_token],
           model: Lithic::Models::Account,
           options: params[:request_options]
         )
@@ -25,39 +26,24 @@ module Lithic
       #   accounts that are part of the program managed by this API key. Accounts that are
       #   in the `PAUSED` state will not be able to transact or create new cards.
       #
-      # @param account_token [String] Globally unique identifier for account.
-      #
-      # @param params [Lithic::Models::AccountUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :daily_spend_limit Amount (in cents) for the account's daily spend limit (e.g. 100000 would be a
-      #     $1,000 limit). By default the daily spend limit is set to $1,250.
-      #
-      #   @option params [Integer] :lifetime_spend_limit Amount (in cents) for the account's lifetime spend limit (e.g. 100000 would be a
-      #     $1,000 limit). Once this limit is reached, no transactions will be accepted on
-      #     any card created for this account until the limit is updated. Note that a spend
-      #     limit of 0 is effectively no limit, and should only be used to reset or remove a
-      #     prior limit. Only a limit of 1 or above will result in declined transactions due
-      #     to checks against the account limit. This behavior differs from the daily spend
-      #     limit and the monthly spend limit.
+      # @overload update(account_token, daily_spend_limit: nil, lifetime_spend_limit: nil, monthly_spend_limit: nil, state: nil, verification_address: nil, request_options: {})
       #
-      #   @option params [Integer] :monthly_spend_limit Amount (in cents) for the account's monthly spend limit (e.g. 100000 would be a
-      #     $1,000 limit). By default the monthly spend limit is set to $5,000.
-      #
-      #   @option params [Symbol, Lithic::Models::AccountUpdateParams::State] :state Account states.
-      #
-      #   @option params [Lithic::Models::AccountUpdateParams::VerificationAddress] :verification_address Address used during Address Verification Service (AVS) checks during
-      #     transactions if enabled via Auth Rules. This field is deprecated as AVS checks
-      #     are no longer supported by Authorization Rules. The field will be removed from
-      #     the schema in a future release.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_token [String]
+      # @param daily_spend_limit [Integer]
+      # @param lifetime_spend_limit [Integer]
+      # @param monthly_spend_limit [Integer]
+      # @param state [Symbol, Lithic::Models::AccountUpdateParams::State]
+      # @param verification_address [Lithic::Models::AccountUpdateParams::VerificationAddress]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Account]
+      #
+      # @see Lithic::Models::AccountUpdateParams
       def update(account_token, params = {})
         parsed, options = Lithic::Models::AccountUpdateParams.dump_request(params)
         @client.request(
           method: :patch,
-          path: ["v1/accounts/%0s", account_token],
+          path: ["v1/accounts/%1$s", account_token],
           body: parsed,
           model: Lithic::Models::Account,
           options: options
@@ -66,25 +52,18 @@ module Lithic
 
       # List account configurations.
       #
-      # @param params [Lithic::Models::AccountListParams, Hash{Symbol=>Object}] .
+      # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      #   @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 [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.
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
-      #
-      #   @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 [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::Account>]
+      #
+      # @see Lithic::Models::AccountListParams
       def list(params = {})
         parsed, options = Lithic::Models::AccountListParams.dump_request(params)
         @client.request(
@@ -103,22 +82,25 @@ module Lithic
       #   configured, and has spent $600 in the last 24 hours, the available spend limit
       #   returned would be $400.
       #
-      # @param account_token [String] Globally unique identifier for account.
-      #
-      # @param params [Lithic::Models::AccountRetrieveSpendLimitsParams, Hash{Symbol=>Object}] .
+      # @overload retrieve_spend_limits(account_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AccountSpendLimits]
+      #
+      # @see Lithic::Models::AccountRetrieveSpendLimitsParams
       def retrieve_spend_limits(account_token, params = {})
         @client.request(
           method: :get,
-          path: ["v1/accounts/%0s/spend_limits", account_token],
+          path: ["v1/accounts/%1$s/spend_limits", account_token],
           model: Lithic::Models::AccountSpendLimits,
           options: params[:request_options]
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/aggregate_balances.rb

@@ -6,13 +6,14 @@ module Lithic
       # Get the aggregated balance across all end-user accounts by financial account
       #   type
       #
-      # @param params [Lithic::Models::AggregateBalanceListParams, Hash{Symbol=>Object}] .
+      # @overload list(financial_account_type: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType] :financial_account_type Get the aggregate balance for a given Financial Account type.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param financial_account_type [Symbol, Lithic::Models::AggregateBalanceListParams::FinancialAccountType]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::SinglePage<Lithic::Models::AggregateBalance>]
+      #
+      # @see Lithic::Models::AggregateBalanceListParams
       def list(params = {})
         parsed, options = Lithic::Models::AggregateBalanceListParams.dump_request(params)
         @client.request(
@@ -25,6 +26,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/auth_rules/v2/backtests.rb

@@ -31,22 +31,21 @@ module Lithic
           #   configurations. If a historical transaction does not feature the required inputs
           #   to evaluate the rule, then it will not be included in the final backtest report.
           #
-          # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+          # @overload create(auth_rule_token, end_: nil, start: nil, request_options: {})
           #
-          # @param params [Lithic::Models::AuthRules::V2::BacktestCreateParams, Hash{Symbol=>Object}] .
-          #
-          #   @option params [Time] :end_ The end time of the backtest.
-          #
-          #   @option params [Time] :start The start time of the backtest.
-          #
-          #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+          # @param auth_rule_token [String]
+          # @param end_ [Time]
+          # @param start [Time]
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Lithic::Models::AuthRules::V2::BacktestCreateResponse]
+          #
+          # @see Lithic::Models::AuthRules::V2::BacktestCreateParams
           def create(auth_rule_token, params = {})
             parsed, options = Lithic::Models::AuthRules::V2::BacktestCreateParams.dump_request(params)
             @client.request(
               method: :post,
-              path: ["v2/auth_rules/%0s/backtests", auth_rule_token],
+              path: ["v2/auth_rules/%1$s/backtests", auth_rule_token],
               body: parsed,
               model: Lithic::Models::AuthRules::V2::BacktestCreateResponse,
               options: options
@@ -72,15 +71,15 @@ module Lithic
           #   currently activated in the Auth Stream, regardless of which version of the rule
           #   was active in the Auth Stream at the time a backtest is requested.
           #
-          # @param auth_rule_backtest_token [String] Globally unique identifier for an Auth Rule backtest.
+          # @overload retrieve(auth_rule_backtest_token, auth_rule_token:, request_options: {})
           #
-          # @param params [Lithic::Models::AuthRules::V2::BacktestRetrieveParams, Hash{Symbol=>Object}] .
-          #
-          #   @option params [String] :auth_rule_token Globally unique identifier for the Auth Rule.
-          #
-          #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+          # @param auth_rule_backtest_token [String]
+          # @param auth_rule_token [String]
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
           # @return [Lithic::Models::AuthRules::V2::BacktestResults]
+          #
+          # @see Lithic::Models::AuthRules::V2::BacktestRetrieveParams
           def retrieve(auth_rule_backtest_token, params)
             parsed, options = Lithic::Models::AuthRules::V2::BacktestRetrieveParams.dump_request(params)
             auth_rule_token =
@@ -89,12 +88,14 @@ module Lithic
               end
             @client.request(
               method: :get,
-              path: ["v2/auth_rules/%0s/backtests/%1s", auth_rule_token, auth_rule_backtest_token],
+              path: ["v2/auth_rules/%1$s/backtests/%2$s", auth_rule_token, auth_rule_backtest_token],
               model: Lithic::Models::AuthRules::V2::BacktestResults,
               options: options
             )
           end
 
+          # @api private
+          #
           # @param client [Lithic::Client]
           def initialize(client:)
             @client = client

data/lib/lithic/resources/auth_rules/v2.rb

@@ -9,25 +9,20 @@ module Lithic
 
         # Creates a new V2 authorization rule in draft mode
         #
-        # @param params [Lithic::Models::AuthRules::V2CreateParams, Hash{Symbol=>Object}] .
+        # @overload create(account_tokens:, card_tokens:, program_level:, name: nil, parameters: nil, type: nil, excluded_card_tokens: nil, request_options: {})
         #
-        #   @option params [Array<String>] :account_tokens Account tokens to which the Auth Rule applies.
-        #
-        #   @option params [Array<String>] :card_tokens Card tokens to which the Auth Rule applies.
-        #
-        #   @option params [Boolean] :program_level Whether the Auth Rule applies to all authorizations on the card program.
-        #
-        #   @option params [String, nil] :name Auth Rule Name
-        #
-        #   @option params [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams] :parameters Parameters for the Auth Rule
-        #
-        #   @option params [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type] :type The type of Auth Rule
-        #
-        #   @option params [Array<String>] :excluded_card_tokens Card tokens to which the Auth Rule does not apply.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param account_tokens [Array<String>]
+        # @param card_tokens [Array<String>]
+        # @param program_level [Boolean]
+        # @param name [String, nil]
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams]
+        # @param type [Symbol, Lithic::Models::AuthRules::V2CreateParams::Type]
+        # @param excluded_card_tokens [Array<String>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2CreateResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2CreateParams
         def create(params)
           parsed, options = Lithic::Models::AuthRules::V2CreateParams.dump_request(params)
           @client.request(
@@ -41,17 +36,18 @@ module Lithic
 
         # Fetches a V2 authorization rule by its token
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2RetrieveParams, Hash{Symbol=>Object}] .
+        # @overload retrieve(auth_rule_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2RetrieveResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2RetrieveParams
         def retrieve(auth_rule_token, params = {})
           @client.request(
             method: :get,
-            path: ["v2/auth_rules/%0s", auth_rule_token],
+            path: ["v2/auth_rules/%1$s", auth_rule_token],
             model: Lithic::Models::AuthRules::V2RetrieveResponse,
             options: params[:request_options]
           )
@@ -63,34 +59,25 @@ module Lithic
         #   is provided, this will replace existing associations with the provided list of
         #   entities.
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2UpdateParams, Hash{Symbol=>Object}] .
+        # @overload update(auth_rule_token, account_tokens: nil, name: nil, state: nil, card_tokens: nil, excluded_card_tokens: nil, program_level: nil, request_options: {})
         #
-        #   @option params [Array<String>] :account_tokens Account tokens to which the Auth Rule applies.
-        #
-        #   @option params [String, nil] :name Auth Rule Name
-        #
-        #   @option params [Symbol, Lithic::Models::AuthRules::V2UpdateParams::State] :state The desired state of the Auth Rule.
-        #
-        #     Note that only deactivating an Auth Rule through this endpoint is supported at
-        #     this time. If you need to (re-)activate an Auth Rule the /promote endpoint
-        #     should be used to promote a draft to the currently active version.
-        #
-        #   @option params [Array<String>] :card_tokens Card tokens to which the Auth Rule applies.
-        #
-        #   @option params [Array<String>] :excluded_card_tokens Card tokens to which the Auth Rule does not apply.
-        #
-        #   @option params [Boolean] :program_level Whether the Auth Rule applies to all authorizations on the card program.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param account_tokens [Array<String>]
+        # @param name [String, nil]
+        # @param state [Symbol, Lithic::Models::AuthRules::V2UpdateParams::State]
+        # @param card_tokens [Array<String>]
+        # @param excluded_card_tokens [Array<String>]
+        # @param program_level [Boolean]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2UpdateResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2UpdateParams
         def update(auth_rule_token, params = {})
           parsed, options = Lithic::Models::AuthRules::V2UpdateParams.dump_request(params)
           @client.request(
             method: :patch,
-            path: ["v2/auth_rules/%0s", auth_rule_token],
+            path: ["v2/auth_rules/%1$s", auth_rule_token],
             body: parsed,
             model: Lithic::Models::AuthRules::V2UpdateResponse,
             options: options
@@ -99,23 +86,18 @@ module Lithic
 
         # Lists V2 authorization rules
         #
-        # @param params [Lithic::Models::AuthRules::V2ListParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :account_token Only return Authorization Rules that are bound to the provided account token.
-        #
-        #   @option params [String] :card_token Only return Authorization Rules that are bound to the provided card token.
+        # @overload list(account_token: nil, card_token: nil, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        #   @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.
-        #
-        #   @option params [Integer] :page_size Page size (for pagination).
-        #
-        #   @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 [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param account_token [String]
+        # @param card_token [String]
+        # @param ending_before [String]
+        # @param page_size [Integer]
+        # @param starting_after [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::CursorPage<Lithic::Models::AuthRules::V2ListResponse>]
+        #
+        # @see Lithic::Models::AuthRules::V2ListParams
         def list(params = {})
           parsed, options = Lithic::Models::AuthRules::V2ListParams.dump_request(params)
           @client.request(
@@ -130,17 +112,18 @@ module Lithic
 
         # Deletes a V2 authorization rule
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2DeleteParams, Hash{Symbol=>Object}] .
+        # @overload delete(auth_rule_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::AuthRules::V2DeleteParams
         def delete(auth_rule_token, params = {})
           @client.request(
             method: :delete,
-            path: ["v2/auth_rules/%0s", auth_rule_token],
+            path: ["v2/auth_rules/%1$s", auth_rule_token],
             model: NilClass,
             options: params[:request_options]
           )
@@ -151,26 +134,23 @@ module Lithic
         #
         #   Prefer using the `PATCH` method for this operation.
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2ApplyParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<String>] :account_tokens Account tokens to which the Auth Rule applies.
-        #
-        #   @option params [Array<String>] :card_tokens Card tokens to which the Auth Rule applies.
-        #
-        #   @option params [Boolean] :program_level Whether the Auth Rule applies to all authorizations on the card program.
+        # @overload apply(auth_rule_token, account_tokens:, card_tokens:, program_level:, excluded_card_tokens: nil, request_options: {})
         #
-        #   @option params [Array<String>] :excluded_card_tokens Card tokens to which the Auth Rule does not apply.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param account_tokens [Array<String>]
+        # @param card_tokens [Array<String>]
+        # @param program_level [Boolean]
+        # @param excluded_card_tokens [Array<String>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2ApplyResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2ApplyParams
         def apply(auth_rule_token, params)
           parsed, options = Lithic::Models::AuthRules::V2ApplyParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["v2/auth_rules/%0s/apply", auth_rule_token],
+            path: ["v2/auth_rules/%1$s/apply", auth_rule_token],
             body: parsed,
             model: Lithic::Models::AuthRules::V2ApplyResponse,
             options: options
@@ -182,20 +162,20 @@ module Lithic
         #   This can also be utilized to reset the draft parameters, causing a draft version
         #   to no longer be ran in shadow mode.
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2DraftParams, Hash{Symbol=>Object}] .
+        # @overload draft(auth_rule_token, parameters: nil, request_options: {})
         #
-        #   @option params [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil] :parameters Parameters for the Auth Rule
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param parameters [Lithic::Models::AuthRules::ConditionalBlockParameters, Lithic::Models::AuthRules::VelocityLimitParams, nil]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2DraftResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2DraftParams
         def draft(auth_rule_token, params = {})
           parsed, options = Lithic::Models::AuthRules::V2DraftParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["v2/auth_rules/%0s/draft", auth_rule_token],
+            path: ["v2/auth_rules/%1$s/draft", auth_rule_token],
             body: parsed,
             model: Lithic::Models::AuthRules::V2DraftResponse,
             options: options
@@ -205,17 +185,18 @@ module Lithic
         # Promotes the draft version of an authorization rule to the currently active
         #   version such that it is enforced in the authorization stream.
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
+        # @overload promote(auth_rule_token, request_options: {})
         #
-        # @param params [Lithic::Models::AuthRules::V2PromoteParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2PromoteResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2PromoteParams
         def promote(auth_rule_token, params = {})
           @client.request(
             method: :post,
-            path: ["v2/auth_rules/%0s/promote", auth_rule_token],
+            path: ["v2/auth_rules/%1$s/promote", auth_rule_token],
             model: Lithic::Models::AuthRules::V2PromoteResponse,
             options: params[:request_options]
           )
@@ -273,22 +254,25 @@ module Lithic
         #   between when Lithic's transaction processing systems have processed the
         #   transaction, and when a transaction will be included in the report.
         #
-        # @param auth_rule_token [String] Globally unique identifier for the Auth Rule.
-        #
-        # @param params [Lithic::Models::AuthRules::V2ReportParams, Hash{Symbol=>Object}] .
+        # @overload report(auth_rule_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param auth_rule_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::AuthRules::V2ReportResponse]
+        #
+        # @see Lithic::Models::AuthRules::V2ReportParams
         def report(auth_rule_token, params = {})
           @client.request(
             method: :post,
-            path: ["v2/auth_rules/%0s/report", auth_rule_token],
+            path: ["v2/auth_rules/%1$s/report", auth_rule_token],
             model: Lithic::Models::AuthRules::V2ReportResponse,
             options: params[:request_options]
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/auth_rules.rb

@@ -6,6 +6,8 @@ module Lithic
       # @return [Lithic::Resources::AuthRules::V2]
       attr_reader :v2
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/auth_stream_enrollment.rb

@@ -10,11 +10,13 @@ module Lithic
       #   [this page](https://docs.lithic.com/docs/auth-stream-access-asa#asa-webhook-verification)
       #   for more detail about verifying ASA webhooks.
       #
-      # @param params [Lithic::Models::AuthStreamEnrollmentRetrieveSecretParams, Hash{Symbol=>Object}] .
+      # @overload retrieve_secret(request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::AuthStreamSecret]
+      #
+      # @see Lithic::Models::AuthStreamEnrollmentRetrieveSecretParams
       def retrieve_secret(params = {})
         @client.request(
           method: :get,
@@ -29,11 +31,13 @@ module Lithic
       #   [`GET /auth_stream/secret`](https://docs.lithic.com/reference/getauthstreamsecret)
       #   request to retrieve the new secret key.
       #
-      # @param params [Lithic::Models::AuthStreamEnrollmentRotateSecretParams, Hash{Symbol=>Object}] .
+      # @overload rotate_secret(request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::AuthStreamEnrollmentRotateSecretParams
       def rotate_secret(params = {})
         @client.request(
           method: :post,
@@ -43,6 +47,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/balances.rb

@@ -5,20 +5,17 @@ module Lithic
     class Balances
       # Get the balances for a program, business, or a given end-user account
       #
-      # @param params [Lithic::Models::BalanceListParams, Hash{Symbol=>Object}] .
+      # @overload list(account_token: nil, balance_date: nil, business_account_token: nil, financial_account_type: nil, request_options: {})
       #
-      #   @option params [String] :account_token List balances for all financial accounts of a given account_token.
-      #
-      #   @option params [Time] :balance_date UTC date and time of the balances to retrieve. Defaults to latest available
-      #     balances
-      #
-      #   @option params [String] :business_account_token List balances for all financial accounts of a given business_account_token.
-      #
-      #   @option params [Symbol, Lithic::Models::BalanceListParams::FinancialAccountType] :financial_account_type List balances for a given Financial Account type.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param account_token [String]
+      # @param balance_date [Time]
+      # @param business_account_token [String]
+      # @param financial_account_type [Symbol, Lithic::Models::BalanceListParams::FinancialAccountType]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::SinglePage<Lithic::Models::Balance>]
+      #
+      # @see Lithic::Models::BalanceListParams
       def list(params = {})
         parsed, options = Lithic::Models::BalanceListParams.dump_request(params)
         @client.request(
@@ -31,6 +28,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client