lithic 0.1.0.pre.alpha.16 → 0.1.0.pre.alpha.18

data/lib/lithic/resources/credit_products/prime_rates.rb

@@ -8,9 +8,12 @@ module Lithic
         #
         # @overload create(credit_product_token, effective_date:, rate:, request_options: {})
         #
-        # @param credit_product_token [String]
-        # @param effective_date [Date]
-        # @param rate [String]
+        # @param credit_product_token [String] Globally unique identifier for credit products.
+        #
+        # @param effective_date [Date] Date the rate goes into effect
+        #
+        # @param rate [String] The rate in decimal format
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
@@ -31,9 +34,12 @@ module Lithic
         #
         # @overload retrieve(credit_product_token, ending_before: nil, starting_after: nil, request_options: {})
         #
-        # @param credit_product_token [String]
-        # @param ending_before [Date]
-        # @param starting_after [Date]
+        # @param credit_product_token [String] Globally unique identifier for credit products.
+        #
+        # @param ending_before [Date] The effective date that the prime rates ends before
+        #
+        # @param starting_after [Date] The effective date that the prime rate starts after
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::CreditProducts::PrimeRateRetrieveResponse]

data/lib/lithic/resources/digital_card_art.rb

@@ -3,11 +3,16 @@
 module Lithic
   module Resources
     class DigitalCardArt
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::DigitalCardArtRetrieveParams} for more details.
+      #
       # Get digital card art by token.
       #
       # @overload retrieve(digital_card_art_token, request_options: {})
       #
-      # @param digital_card_art_token [String]
+      # @param digital_card_art_token [String] Specifies the digital card art to be displayed in the user’s digital wallet afte
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DigitalCardArtAPI]
@@ -22,13 +27,21 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::DigitalCardArtListParams} for more details.
+      #
       # List digital card art.
       #
       # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
       #
-      # @param ending_before [String]
-      # @param page_size [Integer]
-      # @param starting_after [String]
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::DigitalCardArtAPI>]

data/lib/lithic/resources/disputes.rb

@@ -7,11 +7,16 @@ module Lithic
       #
       # @overload create(amount:, reason:, transaction_token:, customer_filed_date: nil, customer_note: 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 amount [Integer] Amount to dispute
+      #
+      # @param reason [Symbol, Lithic::Models::DisputeCreateParams::Reason] Reason for dispute
+      #
+      # @param transaction_token [String] Transaction to dispute
+      #
+      # @param customer_filed_date [Time] Date the customer filed the dispute
+      #
+      # @param customer_note [String] Customer description of dispute
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
@@ -52,10 +57,15 @@ module Lithic
       # @overload update(dispute_token, amount: nil, customer_filed_date: nil, customer_note: nil, reason: 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 amount [Integer] Amount to dispute
+      #
+      # @param customer_filed_date [Time] Date the customer filed the dispute
+      #
+      # @param customer_note [String] Customer description of dispute
+      #
+      # @param reason [Symbol, Lithic::Models::DisputeUpdateParams::Reason] Reason for dispute
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::Dispute]
@@ -72,17 +82,31 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::DisputeListParams} for more details.
+      #
       # List disputes.
       #
       # @overload list(begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: nil, transaction_tokens: 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 begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
+      # @param status [Symbol, Lithic::Models::DisputeListParams::Status] List disputes of a specific status.
+      #
+      # @param transaction_tokens [Array<String>] Transaction tokens to filter by.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::Dispute>]
@@ -154,7 +178,9 @@ module Lithic
       # @overload initiate_evidence_upload(dispute_token, filename: nil, request_options: {})
       #
       # @param dispute_token [String]
-      # @param filename [String]
+      #
+      # @param filename [String] Filename of the evidence.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::DisputeEvidence]
@@ -171,16 +197,29 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::DisputeListEvidencesParams} for more details.
+      #
       # List evidence metadata for a dispute.
       #
       # @overload list_evidences(dispute_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: 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 begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::DisputeEvidence>]

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

@@ -4,14 +4,22 @@ module Lithic
   module Resources
     class Events
       class Subscriptions
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionCreateParams} for more details.
+        #
         # Create a new event subscription.
         #
         # @overload create(url:, description: nil, disabled: nil, event_types: nil, request_options: {})
         #
-        # @param url [String]
-        # @param description [String]
-        # @param disabled [Boolean]
-        # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>]
+        # @param url [String] URL to which event webhooks will be sent. URL must be a valid HTTPS address.
+        #
+        # @param description [String] Event subscription description.
+        #
+        # @param disabled [Boolean] Whether the event subscription is active (false) or inactive (true).
+        #
+        # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionCreateParams::EventType>] Indicates types of events that will be sent to this subscription. If left blank,
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::EventSubscription]
@@ -47,15 +55,24 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionUpdateParams} for more details.
+        #
         # Update an event subscription.
         #
         # @overload update(event_subscription_token, url:, description: nil, disabled: nil, event_types: 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 url [String] URL to which event webhooks will be sent. URL must be a valid HTTPS address.
+        #
+        # @param description [String] Event subscription description.
+        #
+        # @param disabled [Boolean] Whether the event subscription is active (false) or inactive (true).
+        #
+        # @param event_types [Array<Symbol, Lithic::Models::Events::SubscriptionUpdateParams::EventType>] Indicates types of events that will be sent to this subscription. If left blank,
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::EventSubscription]
@@ -72,13 +89,21 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionListParams} for more details.
+        #
         # List all the event subscriptions.
         #
         # @overload list(ending_before: nil, page_size: nil, starting_after: nil, request_options: {})
         #
-        # @param ending_before [String]
-        # @param page_size [Integer]
-        # @param starting_after [String]
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        # ...
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::CursorPage<Lithic::Models::EventSubscription>]
@@ -115,17 +140,31 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionListAttemptsParams} for more details.
+        #
         # List all the message attempts for a given event subscription.
         #
         # @overload list_attempts(event_subscription_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: 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 begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        # ...
+        #
+        # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        # ...
+        #
+        # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+        # ...
+        #
+        # @param page_size [Integer] Page size (for pagination).
+        #
+        # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+        # ...
+        #
         # @param status [Symbol, Lithic::Models::Events::SubscriptionListAttemptsParams::Status]
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Internal::CursorPage<Lithic::Models::MessageAttempt>]
@@ -143,13 +182,21 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionRecoverParams} for more details.
+        #
         # Resend all failed messages since a given time.
         #
         # @overload recover(event_subscription_token, begin_: nil, end_: nil, request_options: {})
         #
         # @param event_subscription_token [String]
-        # @param begin_ [Time]
-        # @param end_ [Time]
+        #
+        # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        # ...
+        #
+        # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
@@ -166,6 +213,9 @@ module Lithic
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {Lithic::Models::Events::SubscriptionReplayMissingParams} for more details.
+        #
         # Replays messages to the endpoint. Only messages that were created after `begin`
         # will be sent. Messages that were previously sent to the endpoint are not resent.
         # Message will be retried if endpoint responds with a non-2xx status code. See
@@ -175,8 +225,13 @@ module Lithic
         # @overload replay_missing(event_subscription_token, begin_: nil, end_: nil, request_options: {})
         #
         # @param event_subscription_token [String]
-        # @param begin_ [Time]
-        # @param end_ [Time]
+        #
+        # @param begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+        # ...
+        #
+        # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+        # ...
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
@@ -237,7 +292,9 @@ module Lithic
         # @overload send_simulated_example(event_subscription_token, event_type: nil, request_options: {})
         #
         # @param event_subscription_token [String]
-        # @param event_type [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType]
+        #
+        # @param event_type [Symbol, Lithic::Models::Events::SubscriptionSendSimulatedExampleParams::EventType] Event type to send example message for.
+        #
         # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]

data/lib/lithic/resources/events.rb

@@ -28,17 +28,31 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::EventListParams} for more details.
+      #
       # List all events.
       #
       # @overload list(begin_: nil, end_: nil, ending_before: nil, event_types: nil, page_size: nil, starting_after: nil, with_content: 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 begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param event_types [Array<Symbol, Lithic::Models::EventListParams::EventType>] Event types to filter events by.
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
+      # @param with_content [Boolean] Whether to include the event payload content in the response.
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::Event>]
@@ -56,17 +70,31 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::EventListAttemptsParams} for more details.
+      #
       # List all the message attempts for a given event.
       #
       # @overload list_attempts(event_token, begin_: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, status: 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 begin_ [Time] Date string in RFC 3339 format. Only entries created after the specified time wi
+      # ...
+      #
+      # @param end_ [Time] Date string in RFC 3339 format. Only entries created before the specified time w
+      # ...
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param status [Symbol, Lithic::Models::EventListAttemptsParams::Status]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::MessageAttempt>]

data/lib/lithic/resources/external_bank_accounts.rb

@@ -6,28 +6,52 @@ module Lithic
       # @return [Lithic::Resources::ExternalBankAccounts::MicroDeposits]
       attr_reader :micro_deposits
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::ExternalBankAccountCreateParams} for more details.
+      #
       # Creates an external bank account within a program or Lithic account.
       #
       # @overload create(account_number:, country:, currency:, financial_account_token:, owner:, owner_type:, routing_number:, type:, verification_method:, processor_token:, account_token: nil, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, user_defined_id: nil, verification_enforcement: nil, request_options: {})
       #
-      # @param account_number [String]
-      # @param country [String]
-      # @param currency [String]
-      # @param financial_account_token [String]
-      # @param owner [String]
-      # @param owner_type [Symbol, Lithic::Models::OwnerType]
-      # @param routing_number [String]
-      # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type]
-      # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod]
+      # @param account_number [String] Account Number
+      #
+      # @param country [String] The country that the bank account is located in using ISO 3166-1. We will only a
+      # ...
+      #
+      # @param currency [String] currency of the external account 3-character alphabetic ISO 4217 code
+      #
+      # @param financial_account_token [String] The financial account token of the operating account to fund the micro deposits
+      #
+      # @param owner [String] Legal Name of the business or individual who owns the external account. This wil
+      # ...
+      #
+      # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
+      #
+      # @param routing_number [String] Routing Number
+      #
+      # @param type [Symbol, Lithic::Models::ExternalBankAccountCreateParams::Type] Account Type
+      #
+      # @param verification_method [Symbol, Lithic::Models::ExternalBankAccountCreateParams::VerificationMethod] Verification Method
+      #
       # @param processor_token [String]
-      # @param account_token [String]
-      # @param address [Lithic::Models::ExternalBankAccountAddress]
-      # @param company_id [String]
-      # @param dob [Date]
-      # @param doing_business_as [String]
-      # @param name [String]
-      # @param user_defined_id [String]
+      #
+      # @param account_token [String] Indicates which Lithic account the external account is associated with. For exte
+      # ...
+      #
+      # @param address [Lithic::Models::ExternalBankAccountAddress] Address
+      #
+      # @param company_id [String] Optional field that helps identify bank accounts in receipts
+      #
+      # @param dob [Date] Date of Birth of the Individual that owns the external bank account
+      #
+      # @param doing_business_as [String] Doing Business As
+      #
+      # @param name [String] The nickname for this External Bank Account
+      #
+      # @param user_defined_id [String] User Defined ID
+      #
       # @param verification_enforcement [Boolean]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountCreateResponse]
@@ -63,20 +87,34 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::ExternalBankAccountUpdateParams} for more details.
+      #
       # Update the external bank account by token.
       #
       # @overload update(external_bank_account_token, address: nil, company_id: nil, dob: nil, doing_business_as: nil, name: nil, owner: nil, owner_type: nil, type: nil, user_defined_id: nil, request_options: {})
       #
       # @param external_bank_account_token [String]
-      # @param address [Lithic::Models::ExternalBankAccountAddress]
-      # @param company_id [String]
-      # @param dob [Date]
-      # @param doing_business_as [String]
-      # @param name [String]
-      # @param owner [String]
-      # @param owner_type [Symbol, Lithic::Models::OwnerType]
+      #
+      # @param address [Lithic::Models::ExternalBankAccountAddress] Address
+      #
+      # @param company_id [String] Optional field that helps identify bank accounts in receipts
+      #
+      # @param dob [Date] Date of Birth of the Individual that owns the external bank account
+      #
+      # @param doing_business_as [String] Doing Business As
+      #
+      # @param name [String] The nickname for this External Bank Account
+      #
+      # @param owner [String] Legal Name of the business or individual who owns the external account. This wil
+      # ...
+      #
+      # @param owner_type [Symbol, Lithic::Models::OwnerType] Owner Type
+      #
       # @param type [Symbol, Lithic::Models::ExternalBankAccountUpdateParams::Type]
-      # @param user_defined_id [String]
+      #
+      # @param user_defined_id [String] User Defined ID
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::ExternalBankAccountUpdateResponse]
@@ -93,19 +131,33 @@ module Lithic
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Lithic::Models::ExternalBankAccountListParams} for more details.
+      #
       # List all the external bank accounts for the provided search criteria.
       #
       # @overload list(account_token: nil, account_types: nil, countries: nil, ending_before: nil, owner_types: nil, page_size: nil, starting_after: nil, states: nil, verification_states: nil, request_options: {})
       #
       # @param account_token [String]
+      #
       # @param account_types [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::AccountType>]
+      #
       # @param countries [Array<String>]
-      # @param ending_before [String]
+      #
+      # @param ending_before [String] A cursor representing an item's token before which a page of results should end.
+      # ...
+      #
       # @param owner_types [Array<Symbol, Lithic::Models::OwnerType>]
-      # @param page_size [Integer]
-      # @param starting_after [String]
+      #
+      # @param page_size [Integer] Page size (for pagination).
+      #
+      # @param starting_after [String] A cursor representing an item's token after which a page of results should begin
+      # ...
+      #
       # @param states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::State>]
+      #
       # @param verification_states [Array<Symbol, Lithic::Models::ExternalBankAccountListParams::VerificationState>]
+      #
       # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Internal::CursorPage<Lithic::Models::ExternalBankAccountListResponse>]