lithic 0.1.0.pre.alpha.3 → 0.1.0.pre.alpha.4

data/lib/lithic/resources/digital_card_art.rb

@@ -5,16 +5,14 @@ module Lithic
     class DigitalCardArt
       # Get digital card art by token.
       #
-      # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet
-      #   after tokenization. This artwork must be approved by Mastercard and configured
-      #   by Lithic to use. See
-      #   [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
+      # @overload retrieve(digital_card_art_token, request_options: {})
       #
-      # @param params [Lithic::Models::DigitalCardArtRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param digital_card_art_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DigitalCardArtAPI]
+      #
+      # @see Lithic::Models::DigitalCardArtRetrieveParams
       def retrieve(digital_card_art_token, params = {})
         @client.request(
           method: :get,
@@ -26,19 +24,16 @@ module Lithic
 
       # List digital card art.
       #
-      # @param params [Lithic::Models::DigitalCardArtListParams, Hash{Symbol=>Object}] .
-      #
-      #   @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).
+      # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      #   @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 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::DigitalCardArtAPI>]
+      #
+      # @see Lithic::Models::DigitalCardArtListParams
       def list(params = {})
         parsed, options = Lithic::Models::DigitalCardArtListParams.dump_request(params)
         @client.request(
@@ -51,6 +46,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/disputes.rb

@@ -5,21 +5,18 @@ module Lithic
     class Disputes
       # Initiate a dispute.
       #
-      # @param params [Lithic::Models::DisputeCreateParams, Hash{Symbol=>Object}] .
+      # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: nil, request_options: {})
       #
-      #   @option params [Integer] :amount Amount to dispute
-      #
-      #   @option params [Symbol, Lithic::Models::DisputeCreateParams::Reason] :reason Reason for dispute
-      #
-      #   @option params [String] :transaction_token Transaction to dispute
-      #
-      #   @option params [Time] :customer_filed_date Date the customer filed the dispute
-      #
-      #   @option params [String] :customer_note Customer description of dispute
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param amount [Integer]
+      # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason]
+      # @param transaction_token [String]
+      # @param customer_filed_date [Time]
+      # @param customer_note [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeCreateParams
       def create(params)
         parsed, options = Lithic::Models::DisputeCreateParams.dump_request(params)
         @client.request(
@@ -33,13 +30,14 @@ module Lithic
 
       # Get dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(dispute_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeRetrieveParams
       def retrieve(dispute_token, params = {})
         @client.request(
           method: :get,
@@ -51,21 +49,18 @@ module Lithic
 
       # Update dispute. Can only be modified if status is `NEW`.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeUpdateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Integer] :amount Amount to dispute
-      #
-      #   @option params [Time] :customer_filed_date Date the customer filed the dispute
-      #
-      #   @option params [String] :customer_note Customer description of dispute
+      # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::DisputeUpdateParams::Reason] :reason Reason for dispute
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param amount [Integer]
+      # @param customer_filed_date [Time]
+      # @param customer_note [String]
+      # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeUpdateParams
       def update(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeUpdateParams.dump_request(params)
         @client.request(
@@ -79,29 +74,20 @@ module Lithic
 
       # List disputes.
       #
-      # @param params [Lithic::Models::DisputeListParams, Hash{Symbol=>Object}] .
-      #
-      #   @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).
+      # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: nil, request_options: {})
       #
-      #   @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::DisputeListParams::Status] :status List disputes of a specific status.
-      #
-      #   @option params [Array<String>] :transaction_tokens Transaction tokens to filter by.
-      #
-      #   @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 status [Symbol, Lithic::Models::DisputeListParams::Status]
+      # @param transaction_tokens [Array<String>]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::Dispute>]
+      #
+      # @see Lithic::Models::DisputeListParams
       def list(params = {})
         parsed, options = Lithic::Models::DisputeListParams.dump_request(params)
         @client.request(
@@ -116,13 +102,14 @@ module Lithic
 
       # Withdraw dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeDeleteParams, Hash{Symbol=>Object}] .
+      # @overload delete(dispute_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
+      #
+      # @see Lithic::Models::DisputeDeleteParams
       def delete(dispute_token, params = {})
         @client.request(
           method: :delete,
@@ -135,15 +122,15 @@ module Lithic
       # Soft delete evidence for a dispute. Evidence will not be reviewed or submitted
       #   by Lithic after it is withdrawn.
       #
-      # @param evidence_token [String]
-      #
-      # @param params [Lithic::Models::DisputeDeleteEvidenceParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :dispute_token
+      # @overload delete_evidence(evidence_token, dispute_token:, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param evidence_token [String]
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeDeleteEvidenceParams
       def delete_evidence(evidence_token, params)
         parsed, options = Lithic::Models::DisputeDeleteEvidenceParams.dump_request(params)
         dispute_token =
@@ -164,15 +151,15 @@ module Lithic
       #   Uploaded documents must either be a `jpg`, `png` or `pdf` file, and each must be
       #   less than 5 GiB.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeInitiateEvidenceUploadParams, Hash{Symbol=>Object}] .
+      # @overload initiate_evidence_upload(dispute_token, filename: nil, request_options: {})
       #
-      #   @option params [String] :filename Filename of the evidence.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param dispute_token [String]
+      # @param filename [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeInitiateEvidenceUploadParams
       def initiate_evidence_upload(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeInitiateEvidenceUploadParams.dump_request(params)
         @client.request(
@@ -186,27 +173,19 @@ module Lithic
 
       # List evidence metadata for a dispute.
       #
-      # @param dispute_token [String]
-      #
-      # @param params [Lithic::Models::DisputeListEvidencesParams, Hash{Symbol=>Object}] .
+      # @overload list_evidences(dispute_token, 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 dispute_token [String]
+      # @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::DisputeEvidence>]
+      #
+      # @see Lithic::Models::DisputeListEvidencesParams
       def list_evidences(dispute_token, params = {})
         parsed, options = Lithic::Models::DisputeListEvidencesParams.dump_request(params)
         @client.request(
@@ -221,15 +200,15 @@ module Lithic
 
       # Get a dispute's evidence metadata.
       #
-      # @param evidence_token [String]
-      #
-      # @param params [Lithic::Models::DisputeRetrieveEvidenceParams, Hash{Symbol=>Object}] .
+      # @overload retrieve_evidence(evidence_token, dispute_token:, request_options: {})
       #
-      #   @option params [String] :dispute_token
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param evidence_token [String]
+      # @param dispute_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
+      #
+      # @see Lithic::Models::DisputeRetrieveEvidenceParams
       def retrieve_evidence(evidence_token, params)
         parsed, options = Lithic::Models::DisputeRetrieveEvidenceParams.dump_request(params)
         dispute_token =
@@ -244,6 +223,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/events/subscriptions.rb

@@ -6,20 +6,17 @@ module Lithic
       class Subscriptions
         # Create a new event subscription.
         #
-        # @param params [Lithic::Models::Events::SubscriptionCreateParams, Hash{Symbol=>Object}] .
+        # @overload create(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
         #
-        #   @option params [String] :url URL to which event webhooks will be sent. URL must be a valid HTTPS address.
-        #
-        #   @option params [String] :description Event subscription description.
-        #
-        #   @option params [Boolean] :disabled Whether the event subscription is active (false) or inactive (true).
-        #
-        #   @option params [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>] :event_types Indicates types of events that will be sent to this subscription. If left blank,
-        #     all types will be sent.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param url [String]
+        # @param description [String]
+        # @param disabled [Boolean]
+        # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::EventSubscription]
+        #
+        # @see Lithic::Models::Events::SubscriptionCreateParams
         def create(params)
           parsed, options = Lithic::Models::Events::SubscriptionCreateParams.dump_request(params)
           @client.request(
@@ -33,13 +30,14 @@ module Lithic
 
         # Get an event subscription.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionRetrieveParams, Hash{Symbol=>Object}] .
+        # @overload retrieve(event_subscription_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::EventSubscription]
+        #
+        # @see Lithic::Models::Events::SubscriptionRetrieveParams
         def retrieve(event_subscription_token, params = {})
           @client.request(
             method: :get,
@@ -51,22 +49,18 @@ module Lithic
 
         # Update an event subscription.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionUpdateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :url URL to which event webhooks will be sent. URL must be a valid HTTPS address.
+        # @overload update(event_subscription_token, url:, description: nil, disabled: nil, event_types: nil, request_options: {})
         #
-        #   @option params [String] :description Event subscription description.
-        #
-        #   @option params [Boolean] :disabled Whether the event subscription is active (false) or inactive (true).
-        #
-        #   @option params [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>] :event_types Indicates types of events that will be sent to this subscription. If left blank,
-        #     all types will be sent.
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param url [String]
+        # @param description [String]
+        # @param disabled [Boolean]
+        # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::EventSubscription]
+        #
+        # @see Lithic::Models::Events::SubscriptionUpdateParams
         def update(event_subscription_token, params)
           parsed, options = Lithic::Models::Events::SubscriptionUpdateParams.dump_request(params)
           @client.request(
@@ -80,19 +74,16 @@ module Lithic
 
         # List all the event subscriptions.
         #
-        # @param params [Lithic::Models::Events::SubscriptionListParams, Hash{Symbol=>Object}] .
-        #
-        #   @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.
+        # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @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::EventSubscription>]
+        #
+        # @see Lithic::Models::Events::SubscriptionListParams
         def list(params = {})
           parsed, options = Lithic::Models::Events::SubscriptionListParams.dump_request(params)
           @client.request(
@@ -107,13 +98,14 @@ module Lithic
 
         # Delete an event subscription.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionDeleteParams, Hash{Symbol=>Object}] .
+        # @overload delete(event_subscription_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::Events::SubscriptionDeleteParams
         def delete(event_subscription_token, params = {})
           @client.request(
             method: :delete,
@@ -125,29 +117,20 @@ module Lithic
 
         # List all the message attempts for a given event subscription.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionListAttemptsParams, Hash{Symbol=>Object}] .
-        #
-        #   @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).
+        # @overload list_attempts(event_subscription_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, request_options: {})
         #
-        #   @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::Events::SubscriptionListAttemptsParams::Status] :status
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param begin_ [Time]
+        # @param end_ [Time]
+        # @param ending_before [String]
+        # @param page_size [Integer]
+        # @param starting_after [String]
+        # @param status [Symbol, Lithic::Models::Events::SubscriptionListAttemptsParams::Status]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::CursorPage<Lithic::Models::MessageAttempt>]
+        #
+        # @see Lithic::Models::Events::SubscriptionListAttemptsParams
         def list_attempts(event_subscription_token, params = {})
           parsed, options = Lithic::Models::Events::SubscriptionListAttemptsParams.dump_request(params)
           @client.request(
@@ -162,19 +145,16 @@ module Lithic
 
         # Resend all failed messages since a given time.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionRecoverParams, Hash{Symbol=>Object}] .
-        #
-        #   @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.
+        # @overload recover(event_subscription_token, begin_: nil, end_: nil, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param begin_ [Time]
+        # @param end_ [Time]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::Events::SubscriptionRecoverParams
         def recover(event_subscription_token, params = {})
           parsed, options = Lithic::Models::Events::SubscriptionRecoverParams.dump_request(params)
           @client.request(
@@ -192,19 +172,16 @@ module Lithic
         #   [Retry Schedule](https://docs.lithic.com/docs/events-api#retry-schedule) for
         #   details.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionReplayMissingParams, Hash{Symbol=>Object}] .
+        # @overload replay_missing(event_subscription_token, begin_: nil, end_: 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 [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param begin_ [Time]
+        # @param end_ [Time]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::Events::SubscriptionReplayMissingParams
         def replay_missing(event_subscription_token, params = {})
           parsed, options = Lithic::Models::Events::SubscriptionReplayMissingParams.dump_request(params)
           @client.request(
@@ -218,13 +195,14 @@ module Lithic
 
         # Get the secret for an event subscription.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionRetrieveSecretParams, Hash{Symbol=>Object}] .
+        # @overload retrieve_secret(event_subscription_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::Events::SubscriptionRetrieveSecretResponse]
+        #
+        # @see Lithic::Models::Events::SubscriptionRetrieveSecretParams
         def retrieve_secret(event_subscription_token, params = {})
           @client.request(
             method: :get,
@@ -237,13 +215,14 @@ module Lithic
         # Rotate the secret for an event subscription. The previous secret will be valid
         #   for the next 24 hours.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionRotateSecretParams, Hash{Symbol=>Object}] .
+        # @overload rotate_secret(event_subscription_token, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::Events::SubscriptionRotateSecretParams
         def rotate_secret(event_subscription_token, params = {})
           @client.request(
             method: :post,
@@ -255,15 +234,15 @@ module Lithic
 
         # Send an example message for event.
         #
-        # @param event_subscription_token [String]
-        #
-        # @param params [Lithic::Models::Events::SubscriptionSendSimulatedExampleParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType] :event_type Event type to send example message for.
+        # @overload send_simulated_example(event_subscription_token, event_type: nil, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param event_subscription_token [String]
+        # @param event_type [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::Events::SubscriptionSendSimulatedExampleParams
         def send_simulated_example(event_subscription_token, params = {})
           parsed, options = Lithic::Models::Events::SubscriptionSendSimulatedExampleParams.dump_request(params)
           @client.request(
@@ -275,6 +254,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client