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

data/lib/lithic/resources/management_operations.rb

@@ -5,31 +5,23 @@ module Lithic
     class ManagementOperations
       # Create management operation
       #
-      # @param params [Lithic::Models::ManagementOperationCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount
-      #
-      #   @option params [Symbol, Lithic::Models::ManagementOperationCreateParams::Category] :category
-      #
-      #   @option params [Symbol, Lithic::Models::ManagementOperationCreateParams::Direction] :direction
-      #
-      #   @option params [Date] :effective_date
-      #
-      #   @option params [Symbol, Lithic::Models::ManagementOperationCreateParams::EventType] :event_type
-      #
-      #   @option params [String] :financial_account_token
-      #
-      #   @option params [String] :token
-      #
-      #   @option params [String] :memo
-      #
-      #   @option params [String] :subtype
-      #
-      #   @option params [String] :user_defined_id
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount:, category:, direction:, effective_date:, event_type:, financial_account_token:, token: nil, memo: nil, subtype: nil, user_defined_id: nil, request_options: {})
+      #
+      # @param amount [Integer]
+      # @param category [Symbol, Lithic::Models::ManagementOperationCreateParams::Category]
+      # @param direction [Symbol, Lithic::Models::ManagementOperationCreateParams::Direction]
+      # @param effective_date [Date]
+      # @param event_type [Symbol, Lithic::Models::ManagementOperationCreateParams::EventType]
+      # @param financial_account_token [String]
+      # @param token [String]
+      # @param memo [String]
+      # @param subtype [String]
+      # @param user_defined_id [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]
+      #
+      # @see Lithic::Models::ManagementOperationCreateParams
       def create(params)
         parsed, options = Lithic::Models::ManagementOperationCreateParams.dump_request(params)
         @client.request(
@@ -43,13 +35,14 @@ module Lithic
 
       # Get management operation
       #
-      # @param management_operation_token [String] Globally unique identifier for the management operation
-      #
-      # @param params [Lithic::Models::ManagementOperationRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(management_operation_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param management_operation_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]
+      #
+      # @see Lithic::Models::ManagementOperationRetrieveParams
       def retrieve(management_operation_token, params = {})
         @client.request(
           method: :get,
@@ -61,41 +54,29 @@ module Lithic
 
       # List management operations
       #
-      # @param params [Lithic::Models::ManagementOperationListParams, Hash{Symbol=>Object}] .
+      # @overload list(begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, starting_after: nil, status: 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.
+      # @param begin_ [Time]
+      # @param business_account_token [String]
+      # @param category [Symbol, Lithic::Models::ManagementOperationListParams::Category]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param financial_account_token [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::ManagementOperationListParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [String] :business_account_token
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::ManagementOperationTransaction>]
       #
-      #   @option params [Symbol, Lithic::Models::ManagementOperationListParams::Category] :category Management operation category to be returned.
-      #
-      #   @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 [String] :financial_account_token Globally unique identifier for the financial account. Accepted type dependent on
-      #     the program's use case.
-      #
-      #   @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 [Symbol, Lithic::Models::ManagementOperationListParams::Status] :status Management operation status to be returned.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
-      #
-      # @return [Lithic::CursorPage<Lithic::Models::ManagementOperationTransaction>]
+      # @see Lithic::Models::ManagementOperationListParams
       def list(params = {})
         parsed, options = Lithic::Models::ManagementOperationListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/management_operations",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::ManagementOperationTransaction,
           options: options
         )
@@ -103,17 +84,16 @@ module Lithic
 
       # Reverse a management operation
       #
-      # @param management_operation_token [String] Globally unique identifier for the management operation
-      #
-      # @param params [Lithic::Models::ManagementOperationReverseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Date] :effective_date
+      # @overload reverse(management_operation_token, effective_date:, memo: nil, request_options: {})
       #
-      #   @option params [String] :memo
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param management_operation_token [String]
+      # @param effective_date [Date]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ManagementOperationTransaction]
+      #
+      # @see Lithic::Models::ManagementOperationReverseParams
       def reverse(management_operation_token, params)
         parsed, options = Lithic::Models::ManagementOperationReverseParams.dump_request(params)
         @client.request(
@@ -125,6 +105,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/payments.rb

@@ -5,30 +5,22 @@ module Lithic
     class Payments
       # Initiates a payment between a financial account and an external bank account.
       #
-      # @param params [Lithic::Models::PaymentCreateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount
-      #
-      #   @option params [String] :external_bank_account_token
-      #
-      #   @option params [String] :financial_account_token
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentCreateParams::Method] :method_
-      #
-      #   @option params [Lithic::Models::PaymentCreateParams::MethodAttributes] :method_attributes
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentCreateParams::Type] :type
-      #
-      #   @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
-      #
-      #   @option params [String] :user_defined_id
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @overload create(amount:, external_bank_account_token:, financial_account_token:, method_:, method_attributes:, type:, token: nil, memo: nil, user_defined_id: nil, request_options: {})
+      #
+      # @param amount [Integer]
+      # @param external_bank_account_token [String]
+      # @param financial_account_token [String]
+      # @param method_ [Symbol, Lithic::Models::PaymentCreateParams::Method]
+      # @param method_attributes [Lithic::Models::PaymentCreateParams::MethodAttributes]
+      # @param type [Symbol, Lithic::Models::PaymentCreateParams::Type]
+      # @param token [String]
+      # @param memo [String]
+      # @param user_defined_id [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentCreateResponse]
+      #
+      # @see Lithic::Models::PaymentCreateParams
       def create(params)
         parsed, options = Lithic::Models::PaymentCreateParams.dump_request(params)
         @client.request(
@@ -42,13 +34,14 @@ module Lithic
 
       # Get the payment by token.
       #
-      # @param payment_token [String]
-      #
-      # @param params [Lithic::Models::PaymentRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(payment_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Payment]
+      #
+      # @see Lithic::Models::PaymentRetrieveParams
       def retrieve(payment_token, params = {})
         @client.request(
           method: :get,
@@ -60,44 +53,31 @@ module Lithic
 
       # List all the payments for the provided search criteria.
       #
-      # @param params [Lithic::Models::PaymentListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_token
-      #
-      #   @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] :business_account_token
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentListParams::Category] :category
-      #
-      #   @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 [String] :financial_account_token
-      #
-      #   @option params [Integer] :page_size Page size (for pagination).
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentListParams::Result] :result
-      #
-      #   @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.
+      # @overload list(account_token: nil, begin_: nil, business_account_token: nil, category: nil, end_: nil, ending_before: nil, financial_account_token: nil, page_size: nil, result: nil, starting_after: nil, status: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::PaymentListParams::Status] :status
+      # @param account_token [String]
+      # @param begin_ [Time]
+      # @param business_account_token [String]
+      # @param category [Symbol, Lithic::Models::PaymentListParams::Category]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param financial_account_token [String]
+      # @param page_size [Integer]
+      # @param result [Symbol, Lithic::Models::PaymentListParams::Result]
+      # @param starting_after [String]
+      # @param status [Symbol, Lithic::Models::PaymentListParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @return [Lithic::Internal::CursorPage<Lithic::Models::Payment>]
       #
-      # @return [Lithic::CursorPage<Lithic::Models::Payment>]
+      # @see Lithic::Models::PaymentListParams
       def list(params = {})
         parsed, options = Lithic::Models::PaymentListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/payments",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::Payment,
           options: options
         )
@@ -105,13 +85,14 @@ module Lithic
 
       # Retry an origination which has been returned.
       #
-      # @param payment_token [String]
-      #
-      # @param params [Lithic::Models::PaymentRetryParams, Hash{Symbol=>Object}] .
+      # @overload retry_(payment_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentRetryResponse]
+      #
+      # @see Lithic::Models::PaymentRetryParams
       def retry_(payment_token, params = {})
         @client.request(
           method: :post,
@@ -123,19 +104,17 @@ module Lithic
 
       # Simulate payment lifecycle event
       #
-      # @param payment_token [String]
-      #
-      # @param params [Lithic::Models::PaymentSimulateActionParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType] :event_type Event Type
+      # @overload simulate_action(payment_token, event_type:, decline_reason: nil, return_reason_code: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason] :decline_reason Decline reason
-      #
-      #   @option params [String] :return_reason_code Return Reason Code
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_token [String]
+      # @param event_type [Symbol, Lithic::Models::PaymentSimulateActionParams::EventType]
+      # @param decline_reason [Symbol, Lithic::Models::PaymentSimulateActionParams::DeclineReason]
+      # @param return_reason_code [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateActionResponse]
+      #
+      # @see Lithic::Models::PaymentSimulateActionParams
       def simulate_action(payment_token, params)
         parsed, options = Lithic::Models::PaymentSimulateActionParams.dump_request(params)
         @client.request(
@@ -149,21 +128,18 @@ module Lithic
 
       # Simulates a receipt of a Payment.
       #
-      # @param params [Lithic::Models::PaymentSimulateReceiptParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :token Payment token
-      #
-      #   @option params [Integer] :amount Amount
+      # @overload simulate_receipt(token:, amount:, financial_account_token:, receipt_type:, memo: nil, request_options: {})
       #
-      #   @option params [String] :financial_account_token Financial Account Token
-      #
-      #   @option params [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType] :receipt_type Receipt Type
-      #
-      #   @option params [String] :memo Memo
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param token [String]
+      # @param amount [Integer]
+      # @param financial_account_token [String]
+      # @param receipt_type [Symbol, Lithic::Models::PaymentSimulateReceiptParams::ReceiptType]
+      # @param memo [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReceiptResponse]
+      #
+      # @see Lithic::Models::PaymentSimulateReceiptParams
       def simulate_receipt(params)
         parsed, options = Lithic::Models::PaymentSimulateReceiptParams.dump_request(params)
         @client.request(
@@ -177,13 +153,14 @@ module Lithic
 
       # Simulates a release of a Payment.
       #
-      # @param params [Lithic::Models::PaymentSimulateReleaseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :payment_token Payment Token
+      # @overload simulate_release(payment_token:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReleaseResponse]
+      #
+      # @see Lithic::Models::PaymentSimulateReleaseParams
       def simulate_release(params)
         parsed, options = Lithic::Models::PaymentSimulateReleaseParams.dump_request(params)
         @client.request(
@@ -197,15 +174,15 @@ module Lithic
 
       # Simulates a return of a Payment.
       #
-      # @param params [Lithic::Models::PaymentSimulateReturnParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :payment_token Payment Token
-      #
-      #   @option params [String] :return_reason_code Return Reason Code
+      # @overload simulate_return(payment_token:, return_reason_code: nil, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param payment_token [String]
+      # @param return_reason_code [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::PaymentSimulateReturnResponse]
+      #
+      # @see Lithic::Models::PaymentSimulateReturnParams
       def simulate_return(params)
         parsed, options = Lithic::Models::PaymentSimulateReturnParams.dump_request(params)
         @client.request(
@@ -217,6 +194,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/reports/settlement/network_totals.rb

@@ -7,13 +7,14 @@ module Lithic
         class NetworkTotals
           # Retrieve a specific network total record by token. Not available in sandbox.
           #
-          # @param token [String] Token of the network total record to retrieve
+          # @overload retrieve(token, request_options: {})
           #
-          # @param params [Lithic::Models::Reports::Settlement::NetworkTotalRetrieveParams, Hash{Symbol=>Object}] .
-          #
-          #   @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::Reports::Settlement::NetworkTotalRetrieveResponse]
+          #
+          # @see Lithic::Models::Reports::Settlement::NetworkTotalRetrieveParams
           def retrieve(token, params = {})
             @client.request(
               method: :get,
@@ -25,50 +26,38 @@ module Lithic
 
           # List network total records with optional filters. Not available in sandbox.
           #
-          # @param params [Lithic::Models::Reports::Settlement::NetworkTotalListParams, Hash{Symbol=>Object}] .
-          #
-          #   @option params [Time] :begin_ Datetime in RFC 3339 format. Only entries created after the specified time will
-          #     be included. UTC time zone.
-          #
-          #   @option params [Time] :end_ Datetime 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 [String] :institution_id Institution ID to filter on.
-          #
-          #   @option params [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network] :network Network to filter on.
+          # @overload list(begin_: nil, end_: nil, ending_before: nil, institution_id: nil, network: nil, page_size: nil, report_date: nil, report_date_begin: nil, report_date_end: nil, settlement_institution_id: nil, starting_after: nil, request_options: {})
           #
-          #   @option params [Integer] :page_size Number of records per page.
+          # @param begin_ [Time]
+          # @param end_ [Time]
+          # @param ending_before [String]
+          # @param institution_id [String]
+          # @param network [Symbol, Lithic::Models::Reports::Settlement::NetworkTotalListParams::Network]
+          # @param page_size [Integer]
+          # @param report_date [Date]
+          # @param report_date_begin [Date]
+          # @param report_date_end [Date]
+          # @param settlement_institution_id [String]
+          # @param starting_after [String]
+          # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
           #
-          #   @option params [Date] :report_date Singular report date to filter on (YYYY-MM-DD). Cannot be populated in
-          #     conjunction with report_date_begin or report_date_end.
+          # @return [Lithic::Internal::CursorPage<Lithic::Models::Reports::Settlement::NetworkTotalListResponse>]
           #
-          #   @option params [Date] :report_date_begin Earliest report date to filter on, inclusive (YYYY-MM-DD).
-          #
-          #   @option params [Date] :report_date_end Latest report date to filter on, inclusive (YYYY-MM-DD).
-          #
-          #   @option params [String] :settlement_institution_id Settlement institution ID to filter on.
-          #
-          #   @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
-          #
-          # @return [Lithic::CursorPage<Lithic::Models::Reports::Settlement::NetworkTotalListResponse>]
+          # @see Lithic::Models::Reports::Settlement::NetworkTotalListParams
           def list(params = {})
             parsed, options = Lithic::Models::Reports::Settlement::NetworkTotalListParams.dump_request(params)
             @client.request(
               method: :get,
               path: "v1/reports/settlement/network_totals",
               query: parsed,
-              page: Lithic::CursorPage,
+              page: Lithic::Internal::CursorPage,
               model: Lithic::Models::Reports::Settlement::NetworkTotalListResponse,
               options: options
             )
           end
 
+          # @api private
+          #
           # @param client [Lithic::Client]
           def initialize(client:)
             @client = client

data/lib/lithic/resources/reports/settlement.rb

@@ -9,28 +9,24 @@ module Lithic
 
         # List details.
         #
-        # @param report_date [Date] Date of the settlement report to retrieve. Not available in sandbox.
+        # @overload list_details(report_date, ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        # @param params [Lithic::Models::Reports::SettlementListDetailsParams, Hash{Symbol=>Object}] .
+        # @param report_date [Date]
+        # @param ending_before [String]
+        # @param page_size [Integer]
+        # @param starting_after [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        #   @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.
+        # @return [Lithic::Internal::CursorPage<Lithic::Models::SettlementDetail>]
         #
-        #   @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
-        #
-        # @return [Lithic::CursorPage<Lithic::Models::SettlementDetail>]
+        # @see Lithic::Models::Reports::SettlementListDetailsParams
         def list_details(report_date, params = {})
           parsed, options = Lithic::Models::Reports::SettlementListDetailsParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["v1/reports/settlement/details/%1$s", report_date],
             query: parsed,
-            page: Lithic::CursorPage,
+            page: Lithic::Internal::CursorPage,
             model: Lithic::Models::SettlementDetail,
             options: options
           )
@@ -38,13 +34,14 @@ module Lithic
 
         # Get the settlement report for a specified report date. Not available in sandbox.
         #
-        # @param report_date [Date] Date of the settlement report to retrieve.
+        # @overload summary(report_date, request_options: {})
         #
-        # @param params [Lithic::Models::Reports::SettlementSummaryParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param report_date [Date]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::SettlementReport]
+        #
+        # @see Lithic::Models::Reports::SettlementSummaryParams
         def summary(report_date, params = {})
           @client.request(
             method: :get,
@@ -54,6 +51,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/reports.rb

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

data/lib/lithic/resources/responder_endpoints.rb

@@ -5,15 +5,15 @@ module Lithic
     class ResponderEndpoints
       # Enroll a responder endpoint
       #
-      # @param params [Lithic::Models::ResponderEndpointCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(type: nil, url: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type] :type The type of the endpoint.
-      #
-      #   @option params [String] :url The URL for the responder endpoint (must be http(s)).
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param type [Symbol, Lithic::Models::ResponderEndpointCreateParams::Type]
+      # @param url [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ResponderEndpointCreateResponse]
+      #
+      # @see Lithic::Models::ResponderEndpointCreateParams
       def create(params = {})
         parsed, options = Lithic::Models::ResponderEndpointCreateParams.dump_request(params)
         @client.request(
@@ -27,13 +27,14 @@ module Lithic
 
       # Disenroll a responder endpoint
       #
-      # @param params [Lithic::Models::ResponderEndpointDeleteParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type] :type The type of the endpoint.
+      # @overload delete(type:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param type [Symbol, Lithic::Models::ResponderEndpointDeleteParams::Type]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::ResponderEndpointDeleteParams
       def delete(params)
         parsed, options = Lithic::Models::ResponderEndpointDeleteParams.dump_request(params)
         @client.request(
@@ -47,13 +48,14 @@ module Lithic
 
       # Check the status of a responder endpoint
       #
-      # @param params [Lithic::Models::ResponderEndpointCheckStatusParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type] :type The type of the endpoint.
+      # @overload check_status(type:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param type [Symbol, Lithic::Models::ResponderEndpointCheckStatusParams::Type]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ResponderEndpointStatus]
+      #
+      # @see Lithic::Models::ResponderEndpointCheckStatusParams
       def check_status(params)
         parsed, options = Lithic::Models::ResponderEndpointCheckStatusParams.dump_request(params)
         @client.request(
@@ -65,6 +67,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client