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

data/lib/lithic/resources/three_ds/authentication.rb

@@ -6,13 +6,14 @@ module Lithic
       class Authentication
         # Get 3DS Authentication by token
         #
-        # @param three_ds_authentication_token [String] 3DS Authentication Token
+        # @overload retrieve(three_ds_authentication_token, request_options: {})
         #
-        # @param params [Lithic::Models::ThreeDS::AuthenticationRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param three_ds_authentication_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::ThreeDS::AuthenticationRetrieveResponse]
+        #
+        # @see Lithic::Models::ThreeDS::AuthenticationRetrieveParams
         def retrieve(three_ds_authentication_token, params = {})
           @client.request(
             method: :get,
@@ -27,20 +28,17 @@ module Lithic
         #   authentications requires your customer decisioning endpoint to be set up
         #   properly (respond with a valid JSON).
         #
-        # @param params [Lithic::Models::ThreeDS::AuthenticationSimulateParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant] :merchant
-        #
-        #   @option params [String] :pan Sixteen digit card number.
-        #
-        #   @option params [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction] :transaction
-        #
-        #   @option params [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck] :card_expiry_check When set will use the following values as part of the Simulated Authentication.
-        #     When not set defaults to MATCH
+        # @overload simulate(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param merchant [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Merchant]
+        # @param pan [String]
+        # @param transaction [Lithic::Models::ThreeDS::AuthenticationSimulateParams::Transaction]
+        # @param card_expiry_check [Symbol, Lithic::Models::ThreeDS::AuthenticationSimulateParams::CardExpiryCheck]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::ThreeDS::AuthenticationSimulateResponse]
+        #
+        # @see Lithic::Models::ThreeDS::AuthenticationSimulateParams
         def simulate(params)
           parsed, options = Lithic::Models::ThreeDS::AuthenticationSimulateParams.dump_request(params)
           @client.request(
@@ -57,16 +55,15 @@ module Lithic
         #   challenge must precede. Only a single attempt is supported; upon entering OTP,
         #   the challenge is either approved or declined.
         #
-        # @param params [Lithic::Models::ThreeDS::AuthenticationSimulateOtpEntryParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [String] :token A unique token returned as part of a /v1/three_ds_authentication/simulate call
-        #     that resulted in PENDING_CHALLENGE authentication result.
-        #
-        #   @option params [String] :otp The OTP entered by the cardholder
+        # @overload simulate_otp_entry(token:, otp:, request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param token [String]
+        # @param otp [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::ThreeDS::AuthenticationSimulateOtpEntryParams
         def simulate_otp_entry(params)
           parsed, options = Lithic::Models::ThreeDS::AuthenticationSimulateOtpEntryParams.dump_request(params)
           @client.request(
@@ -78,6 +75,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/three_ds/decisioning.rb

@@ -6,18 +6,15 @@ module Lithic
       class Decisioning
         # Card program's response to a 3DS Challenge Request (CReq)
         #
-        # @param params [Lithic::Models::ThreeDS::DecisioningChallengeResponseParams, Hash{Symbol=>Object}] .
+        # @overload challenge_response(token:, challenge_response:, request_options: {})
         #
-        #   @option params [String] :token Globally unique identifier for the 3DS authentication. This token is sent as
-        #     part of the initial 3DS Decisioning Request and as part of the 3DS Challenge
-        #     Event in the [ThreeDSAuthentication](#/components/schemas/ThreeDSAuthentication)
-        #     object
-        #
-        #   @option params [Symbol, Lithic::Models::ThreeDS::ChallengeResult] :challenge_response Whether the Cardholder has Approved or Declined the issued Challenge
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param token [String]
+        # @param challenge_response [Symbol, Lithic::Models::ThreeDS::ChallengeResult]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::ThreeDS::DecisioningChallengeResponseParams
         def challenge_response(params)
           parsed, options = Lithic::Models::ThreeDS::DecisioningChallengeResponseParams.dump_request(params)
           @client.request(
@@ -36,11 +33,13 @@ module Lithic
         #   [this page](https://docs.lithic.com/docs/3ds-decisioning#3ds-decisioning-hmac-secrets)
         #   for more detail about verifying 3DS Decisioning requests.
         #
-        # @param params [Lithic::Models::ThreeDS::DecisioningRetrieveSecretParams, Hash{Symbol=>Object}] .
+        # @overload retrieve_secret(request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::ThreeDS::DecisioningRetrieveSecretResponse]
+        #
+        # @see Lithic::Models::ThreeDS::DecisioningRetrieveSecretParams
         def retrieve_secret(params = {})
           @client.request(
             method: :get,
@@ -55,11 +54,13 @@ module Lithic
         #   [`GET /three_ds_decisioning/secret`](https://docs.lithic.com/reference/getthreedsdecisioningsecret)
         #   request to retrieve the new secret key.
         #
-        # @param params [Lithic::Models::ThreeDS::DecisioningRotateSecretParams, Hash{Symbol=>Object}] .
+        # @overload rotate_secret(request_options: {})
         #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
+        #
+        # @see Lithic::Models::ThreeDS::DecisioningRotateSecretParams
         def rotate_secret(params = {})
           @client.request(
             method: :post,
@@ -69,6 +70,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/three_ds.rb

@@ -9,6 +9,8 @@ module Lithic
       # @return [Lithic::Resources::ThreeDS::Decisioning]
       attr_reader :decisioning
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/tokenization_decisioning.rb

@@ -10,11 +10,13 @@ module Lithic
       #   [this page](https://docs.lithic.com/docs/events-api#verifying-webhooks) for more
       #   detail about verifying Tokenization Decisioning requests.
       #
-      # @param params [Lithic::Models::TokenizationDecisioningRetrieveSecretParams, Hash{Symbol=>Object}] .
+      # @overload retrieve_secret(request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TokenizationSecret]
+      #
+      # @see Lithic::Models::TokenizationDecisioningRetrieveSecretParams
       def retrieve_secret(params = {})
         @client.request(
           method: :get,
@@ -28,11 +30,13 @@ module Lithic
       #   Decisioning secret key will be deactivated 24 hours after a successful request
       #   to this endpoint.
       #
-      # @param params [Lithic::Models::TokenizationDecisioningRotateSecretParams, Hash{Symbol=>Object}] .
+      # @overload rotate_secret(request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TokenizationDecisioningRotateSecretResponse]
+      #
+      # @see Lithic::Models::TokenizationDecisioningRotateSecretParams
       def rotate_secret(params = {})
         @client.request(
           method: :post,
@@ -42,6 +46,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/tokenizations.rb

@@ -5,13 +5,14 @@ module Lithic
     class Tokenizations
       # Get tokenization
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload retrieve(tokenization_token, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationRetrieveParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TokenizationRetrieveResponse]
+      #
+      # @see Lithic::Models::TokenizationRetrieveParams
       def retrieve(tokenization_token, params = {})
         @client.request(
           method: :get,
@@ -23,37 +24,28 @@ module Lithic
 
       # List card tokenizations
       #
-      # @param params [Lithic::Models::TokenizationListParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :account_token Filters for tokenizations associated with a specific account.
-      #
-      #   @option params [Date] :begin_ Filter for tokenizations created after this date.
-      #
-      #   @option params [String] :card_token Filters for tokenizations associated with a specific card.
-      #
-      #   @option params [Date] :end_ Filter for tokenizations created before this date.
-      #
-      #   @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(account_token: nil, begin_: nil, card_token: nil, end_: nil, ending_before: nil, page_size: nil, starting_after: nil, tokenization_channel: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::TokenizationListParams::TokenizationChannel] :tokenization_channel Filter for tokenizations by tokenization channel. If this is not specified, only
-      #     DIGITAL_WALLET tokenizations will be returned.
+      # @param account_token [String]
+      # @param begin_ [Date]
+      # @param card_token [String]
+      # @param end_ [Date]
+      # @param ending_before [String]
+      # @param page_size [Integer]
+      # @param starting_after [String]
+      # @param tokenization_channel [Symbol, Lithic::Models::TokenizationListParams::TokenizationChannel]
+      # @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::Tokenization>]
       #
-      # @return [Lithic::CursorPage<Lithic::Models::Tokenization>]
+      # @see Lithic::Models::TokenizationListParams
       def list(params = {})
         parsed, options = Lithic::Models::TokenizationListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v1/tokenizations",
           query: parsed,
-          page: Lithic::CursorPage,
+          page: Lithic::Internal::CursorPage,
           model: Lithic::Models::Tokenization,
           options: options
         )
@@ -68,13 +60,14 @@ module Lithic
       #   active state, and transactions will be allowed. Reach out at
       #   [lithic.com/contact](https://lithic.com/contact) for more information.
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload activate(tokenization_token, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationActivateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TokenizationActivateParams
       def activate(tokenization_token, params = {})
         @client.request(
           method: :post,
@@ -94,13 +87,14 @@ module Lithic
       #   from its device. Reach out at [lithic.com/contact](https://lithic.com/contact)
       #   for more information.
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload deactivate(tokenization_token, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationDeactivateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TokenizationDeactivateParams
       def deactivate(tokenization_token, params = {})
         @client.request(
           method: :post,
@@ -119,13 +113,14 @@ module Lithic
       #   changed. Reach out at [lithic.com/contact](https://lithic.com/contact) for more
       #   information.
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload pause(tokenization_token, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationPauseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TokenizationPauseParams
       def pause(tokenization_token, params = {})
         @client.request(
           method: :post,
@@ -146,17 +141,15 @@ module Lithic
       #   cardholder must restart the provision process. Reach out at
       #   [lithic.com/contact](https://lithic.com/contact) for more information.
       #
-      # @param tokenization_token [String] Tokenization token
-      #
-      # @param params [Lithic::Models::TokenizationResendActivationCodeParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Symbol, Lithic::Models::TokenizationResendActivationCodeParams::ActivationMethodType] :activation_method_type The communication method that the user has selected to use to receive the
-      #     authentication code. Supported Values: Sms = "TEXT_TO_CARDHOLDER_NUMBER". Email
-      #     = "EMAIL_TO_CARDHOLDER_ADDRESS"
+      # @overload resend_activation_code(tokenization_token, activation_method_type: nil, request_options: {})
       #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param activation_method_type [Symbol, Lithic::Models::TokenizationResendActivationCodeParams::ActivationMethodType]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TokenizationResendActivationCodeParams
       def resend_activation_code(tokenization_token, params = {})
         parsed, options = Lithic::Models::TokenizationResendActivationCodeParams.dump_request(params)
         @client.request(
@@ -171,30 +164,21 @@ module Lithic
       # This endpoint is used to simulate a card's tokenization in the Digital Wallet
       #   and merchant tokenization ecosystem.
       #
-      # @param params [Lithic::Models::TokenizationSimulateParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :cvv The three digit cvv for the card.
-      #
-      #   @option params [String] :expiration_date The expiration date of the card in 'MM/YY' format.
-      #
-      #   @option params [String] :pan The sixteen digit card number.
-      #
-      #   @option params [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource] :tokenization_source The source of the tokenization request.
-      #
-      #   @option params [Integer] :account_score The account score (1-5) that represents how the Digital Wallet's view on how
-      #     reputable an end user's account is.
-      #
-      #   @option params [Integer] :device_score The device score (1-5) that represents how the Digital Wallet's view on how
-      #     reputable an end user's device is.
-      #
-      #   @option params [String] :entity Optional field to specify the token requestor name for a merchant token
-      #     simulation. Ignored when tokenization_source is not MERCHANT.
+      # @overload simulate(cvv:, expiration_date:, pan:, tokenization_source:, account_score: nil, device_score: nil, entity: nil, wallet_recommended_decision: nil, request_options: {})
       #
-      #   @option params [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision] :wallet_recommended_decision The decision that the Digital Wallet's recommend
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param cvv [String]
+      # @param expiration_date [String]
+      # @param pan [String]
+      # @param tokenization_source [Symbol, Lithic::Models::TokenizationSimulateParams::TokenizationSource]
+      # @param account_score [Integer]
+      # @param device_score [Integer]
+      # @param entity [String]
+      # @param wallet_recommended_decision [Symbol, Lithic::Models::TokenizationSimulateParams::WalletRecommendedDecision]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TokenizationSimulateResponse]
+      #
+      # @see Lithic::Models::TokenizationSimulateParams
       def simulate(params)
         parsed, options = Lithic::Models::TokenizationSimulateParams.dump_request(params)
         @client.request(
@@ -214,13 +198,14 @@ module Lithic
       #   active state, and transactions may resume. Reach out at
       #   [lithic.com/contact](https://lithic.com/contact) for more information.
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload unpause(tokenization_token, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationUnpauseParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
+      #
+      # @see Lithic::Models::TokenizationUnpauseParams
       def unpause(tokenization_token, params = {})
         @client.request(
           method: :post,
@@ -239,18 +224,15 @@ module Lithic
       #   the art referenced in the card object's `digital_card_art_token` field. Reach
       #   out at [lithic.com/contact](https://lithic.com/contact) for more information.
       #
-      # @param tokenization_token [String] Tokenization token
+      # @overload update_digital_card_art(tokenization_token, digital_card_art_token: nil, request_options: {})
       #
-      # @param params [Lithic::Models::TokenizationUpdateDigitalCardArtParams, Hash{Symbol=>Object}] .
-      #
-      #   @option params [String] :digital_card_art_token Specifies the digital card art to be displayed in the user’s digital wallet for
-      #     a tokenization. This artwork must be approved by the network and configured by
-      #     Lithic to use. See
-      #     [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
-      #
-      #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+      # @param tokenization_token [String]
+      # @param digital_card_art_token [String]
+      # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Lithic::Models::TokenizationUpdateDigitalCardArtResponse]
+      #
+      # @see Lithic::Models::TokenizationUpdateDigitalCardArtParams
       def update_digital_card_art(tokenization_token, params = {})
         parsed, options = Lithic::Models::TokenizationUpdateDigitalCardArtParams.dump_request(params)
         @client.request(
@@ -262,6 +244,8 @@ module Lithic
         )
       end
 
+      # @api private
+      #
       # @param client [Lithic::Client]
       def initialize(client:)
         @client = client

data/lib/lithic/resources/transactions/enhanced_commercial_data.rb

@@ -7,13 +7,14 @@ module Lithic
         # Get all L2/L3 enhanced commercial data associated with a transaction. Not
         #   available in sandbox.
         #
-        # @param transaction_token [String] The token of the transaction that the enhanced data is associated with.
+        # @overload retrieve(transaction_token, request_options: {})
         #
-        # @param params [Lithic::Models::Transactions::EnhancedCommercialDataRetrieveParams, Hash{Symbol=>Object}] .
-        #
-        #   @option params [Lithic::RequestOptions, Hash{Symbol=>Object}, nil] :request_options
+        # @param transaction_token [String]
+        # @param request_options [Lithic::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Lithic::Models::Transactions::EnhancedCommercialDataRetrieveResponse]
+        #
+        # @see Lithic::Models::Transactions::EnhancedCommercialDataRetrieveParams
         def retrieve(transaction_token, params = {})
           @client.request(
             method: :get,
@@ -23,6 +24,8 @@ module Lithic
           )
         end
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client

data/lib/lithic/resources/transactions/events/enhanced_commercial_data.rb

@@ -8,13 +8,14 @@ module Lithic
           # Get L2/L3 enhanced commercial data associated with a transaction event. Not
           #   available in sandbox.
           #
-          # @param event_token [String] The token of the transaction event that the enhanced data is associated with.
+          # @overload retrieve(event_token, request_options: {})
           #
-          # @param params [Lithic::Models::Transactions::Events::EnhancedCommercialDataRetrieveParams, Hash{Symbol=>Object}] .
-          #
-          #   @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::Transactions::Events::EnhancedData]
+          #
+          # @see Lithic::Models::Transactions::Events::EnhancedCommercialDataRetrieveParams
           def retrieve(event_token, params = {})
             @client.request(
               method: :get,
@@ -24,6 +25,8 @@ module Lithic
             )
           end
 
+          # @api private
+          #
           # @param client [Lithic::Client]
           def initialize(client:)
             @client = client

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

@@ -7,6 +7,8 @@ module Lithic
         # @return [Lithic::Resources::Transactions::Events::EnhancedCommercialData]
         attr_reader :enhanced_commercial_data
 
+        # @api private
+        #
         # @param client [Lithic::Client]
         def initialize(client:)
           @client = client