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

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,17 +30,18 @@ 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,
-            path: ["v1/event_subscriptions/%0s", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s", event_subscription_token],
             model: Lithic::Models::EventSubscription,
             options: params[:request_options]
           )
@@ -51,27 +49,23 @@ 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(
             method: :patch,
-            path: ["v1/event_subscriptions/%0s", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s", event_subscription_token],
             body: parsed,
             model: Lithic::Models::EventSubscription,
             options: options
@@ -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,17 +98,18 @@ 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,
-            path: ["v1/event_subscriptions/%0s", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s", event_subscription_token],
             model: NilClass,
             options: params[:request_options]
           )
@@ -125,34 +117,25 @@ 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(
             method: :get,
-            path: ["v1/event_subscriptions/%0s/attempts", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s/attempts", event_subscription_token],
             query: parsed,
             page: Lithic::CursorPage,
             model: Lithic::Models::MessageAttempt,
@@ -162,24 +145,21 @@ 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(
             method: :post,
-            path: ["v1/event_subscriptions/%0s/recover", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s/recover", event_subscription_token],
             query: parsed,
             model: NilClass,
             options: options
@@ -192,24 +172,21 @@ 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(
             method: :post,
-            path: ["v1/event_subscriptions/%0s/replay_missing", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s/replay_missing", event_subscription_token],
             query: parsed,
             model: NilClass,
             options: options
@@ -218,17 +195,18 @@ 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,
-            path: ["v1/event_subscriptions/%0s/secret", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s/secret", event_subscription_token],
             model: Lithic::Models::Events::SubscriptionRetrieveSecretResponse,
             options: params[:request_options]
           )
@@ -237,17 +215,18 @@ 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,
-            path: ["v1/event_subscriptions/%0s/secret/rotate", event_subscription_token],
+            path: ["v1/event_subscriptions/%1$s/secret/rotate", event_subscription_token],
             model: NilClass,
             options: params[:request_options]
           )
@@ -255,26 +234,28 @@ 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(
             method: :post,
-            path: ["v1/simulate/event_subscriptions/%0s/send_example", event_subscription_token],
+            path: ["v1/simulate/event_subscriptions/%1$s/send_example", event_subscription_token],
             body: parsed,
             model: NilClass,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/events.rb

@@ -8,17 +8,18 @@ module Lithic
 
       # Get an event.
       #
-      # @param event_token [String]
-      #
-      # @param params [Lithic::Models::EventRetrieveParams, Hash{Symbol=>Object}] .
+      # @overload retrieve(event_token, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param event_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Event]
+      #
+      # @see Lithic::Models::EventRetrieveParams
       def retrieve(event_token, params = {})
         @client.request(
           method: :get,
-          path: ["v1/events/%0s", event_token],
+          path: ["v1/events/%1$s", event_token],
           model: Lithic::Models::Event,
           options: params[:request_options]
         )
@@ -26,29 +27,20 @@ module Lithic
 
       # List all events.
       #
-      # @param params [Lithic::Models::EventListParams, 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 list(begin_: nil, end_: nil, ending_before: nil, event_types: nil, page_size: nil, starting_after: nil, with_content: 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 [Array<Symbol, Lithic::Models::EventListParams::EventType>] :event_types Event types to filter events by.
-      #
-      #   @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 [Boolean] :with_content Whether to include the event payload content in the response.
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param begin_ [Time]
+      # @param end_ [Time]
+      # @param ending_before [String]
+      # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param with_content [Boolean]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::Event>]
+      #
+      # @see Lithic::Models::EventListParams
       def list(params = {})
         parsed, options = Lithic::Models::EventListParams.dump_request(params)
         @client.request(
@@ -63,34 +55,25 @@ module Lithic
 
       # List all the message attempts for a given event.
       #
-      # @param event_token [String]
-      #
-      # @param params [Lithic::Models::EventListAttemptsParams, 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_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::EventListAttemptsParams::Status] :status
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param event_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::EventListAttemptsParams::Status]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::CursorPage<Lithic::Models::MessageAttempt>]
+      #
+      # @see Lithic::Models::EventListAttemptsParams
       def list_attempts(event_token, params = {})
         parsed, options = Lithic::Models::EventListAttemptsParams.dump_request(params)
         @client.request(
           method: :get,
-          path: ["v1/events/%0s/attempts", event_token],
+          path: ["v1/events/%1$s/attempts", event_token],
           query: parsed,
           page: Lithic::CursorPage,
           model: Lithic::Models::MessageAttempt,
@@ -98,6 +81,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/external_bank_accounts/micro_deposits.rb

@@ -6,26 +6,28 @@ module Lithic
       class MicroDeposits
         # Verify the external bank account by providing the micro deposit amounts.
         #
-        # @param external_bank_account_token [String]
-        #
-        # @param params [Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Array<Integer>] :micro_deposits
+        # @overload create(external_bank_account_token, micro_deposits:, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param external_bank_account_token [String]
+        # @param micro_deposits [Array<Integer>]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse]
+        #
+        # @see Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams
         def create(external_bank_account_token, params)
           parsed, options = Lithic::Models::ExternalBankAccounts::MicroDepositCreateParams.dump_request(params)
           @client.request(
             method: :post,
-            path: ["v1/external_bank_accounts/%0s/micro_deposits", external_bank_account_token],
+            path: ["v1/external_bank_accounts/%1$s/micro_deposits", external_bank_account_token],
             body: parsed,
             model: Lithic::Models::ExternalBankAccounts::MicroDepositCreateResponse,
             options: options
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client