lithic 0.1.0.pre.alpha.17 → 0.1.0.pre.alpha.19

data/rbi/lib/lithic/models/three_ds/authentication_retrieve_response.rbi

@@ -228,25 +228,71 @@ module Lithic
             .returns(T.attached_class)
         end
         def self.new(
+          # Globally unique identifier for the 3DS authentication.
           token:,
+          # Type of account/card that is being used for the transaction. Maps to EMV 3DS
+          # field `acctType`.
           account_type:,
+          # Indicates the outcome of the 3DS authentication process.
           authentication_result:,
+          # Indicates whether the expiration date provided by the cardholder during checkout
+          # matches Lithic's record of the card's expiration date.
           card_expiry_check:,
+          # Globally unique identifier for the card on which the 3DS authentication has
+          # occurred.
           card_token:,
+          # Object containing data about the cardholder provided during the transaction.
           cardholder:,
+          # Channel in which the authentication occurs. Maps to EMV 3DS field deviceChannel.
           channel:,
+          # Date and time when the authentication was created in Lithic's system.
           created:,
+          # Object containing data about the merchant involved in the e-commerce
+          # transaction.
           merchant:,
+          # Either PAYMENT_AUTHENTICATION or NON_PAYMENT_AUTHENTICATION. For
+          # NON_PAYMENT_AUTHENTICATION, additional_data and transaction fields are not
+          # populated.
           message_category:,
+          # Indicates whether a challenge is requested for this transaction
+          #
+          # - `NO_PREFERENCE` - No Preference
+          # - `NO_CHALLENGE_REQUESTED` - No Challenge Requested
+          # - `CHALLENGE_PREFERENCE` - Challenge requested (3DS Requestor preference)
+          # - `CHALLENGE_MANDATE` - Challenge requested (Mandate)
+          # - `NO_CHALLENGE_RISK_ALREADY_ASSESSED` - No Challenge requested (Transactional
+          #   risk analysis is already performed)
+          # - `DATA_SHARE_ONLY` - No Challenge requested (Data Share Only)
+          # - `OTHER` - Other indicators not captured by above. These are rarely used
           three_ds_requestor_challenge_indicator:,
+          # Object containing additional data about the 3DS request that is beyond the EMV
+          # 3DS standard spec (e.g., specific fields that only certain card networks send
+          # but are not required across all 3DS requests).
           additional_data: nil,
+          # Object containing data about the app used in the e-commerce transaction. Present
+          # if the channel is 'APP_BASED'.
           app: nil,
+          # Type of authentication request - i.e., the type of transaction or interaction is
+          # causing the merchant to request an authentication. Maps to EMV 3DS field
+          # threeDSRequestorAuthenticationInd.
           authentication_request_type: nil,
+          # Object containing data about the browser used in the e-commerce transaction.
+          # Present if the channel is 'BROWSER'.
           browser: nil,
+          # Metadata about the challenge method and delivery.
           challenge_metadata: nil,
+          # Entity that orchestrates the challenge.
           challenge_orchestrated_by: nil,
+          # Entity that made the authentication decision.
           decision_made_by: nil,
+          # Type of 3DS Requestor Initiated (3RI) request i.e., a 3DS authentication that
+          # takes place at the initiation of the merchant rather than the cardholder. The
+          # most common example of this is where a merchant is authenticating before billing
+          # for a recurring transaction such as a pay TV subscription or a utility bill.
+          # Maps to EMV 3DS field threeRIInd.
           three_ri_request_type: nil,
+          # Object containing data about the e-commerce transaction for which the merchant
+          # is requesting authentication.
           transaction: nil
         ); end
         sig do
@@ -449,13 +495,28 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # Indicates whether the shipping address and billing address provided by the
+            # cardholder are the same. This value - and assessment of whether the addresses
+            # match - is provided directly in the 3DS request and is not determined by Lithic.
+            # Maps to EMV 3DS field addrMatch.
             address_match: nil,
+            # Object containing data on the billing address provided during the transaction.
             billing_address: nil,
+            # Email address that is either provided by the cardholder or is on file with the
+            # merchant in a 3RI request. Maps to EMV 3DS field email.
             email: nil,
+            # Name of the cardholder. Maps to EMV 3DS field cardholderName.
             name: nil,
+            # Home phone number provided by the cardholder. Maps to EMV 3DS fields
+            # homePhone.cc and homePhone.subscriber.
             phone_number_home: nil,
+            # Mobile/cell phone number provided by the cardholder. Maps to EMV 3DS fields
+            # mobilePhone.cc and mobilePhone.subscriber.
             phone_number_mobile: nil,
+            # Work phone number provided by the cardholder. Maps to EMV 3DS fields
+            # workPhone.cc and workPhone.subscriber.
             phone_number_work: nil,
+            # Object containing data on the shipping address provided during the transaction.
             shipping_address: nil
           ); end
           sig do
@@ -514,15 +575,20 @@ module Lithic
                 .returns(T.attached_class)
             end
             def self.new(
+              # First line of the street address provided by the cardholder.
               address1: nil,
+              # Second line of the street address provided by the cardholder.
               address2: nil,
+              # Third line of the street address provided by the cardholder.
               address3: nil,
+              # City of the address provided by the cardholder.
               city: nil,
+              # Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
+              # (e.g. USA)
               country: nil,
+              # Postal code (e.g., ZIP code) of the address provided by the cardholder
               postal_code: nil
-            )
-            end
-
+            ); end
             sig do
               override
                 .returns(
@@ -578,15 +644,20 @@ module Lithic
                 .returns(T.attached_class)
             end
             def self.new(
+              # First line of the street address provided by the cardholder.
               address1: nil,
+              # Second line of the street address provided by the cardholder.
               address2: nil,
+              # Third line of the street address provided by the cardholder.
               address3: nil,
+              # City of the address provided by the cardholder.
               city: nil,
+              # Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
+              # (e.g. USA)
               country: nil,
+              # Postal code (e.g., ZIP code) of the address provided by the cardholder
               postal_code: nil
-            )
-            end
-
+            ); end
             sig do
               override
                 .returns(
@@ -676,8 +747,22 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(id:, country:, mcc:, name:, risk_indicator:); end
-
+          def self.new(
+            # Merchant identifier as assigned by the acquirer. Maps to EMV 3DS field
+            # acquirerMerchantId.
+            id:,
+            # Country code of the merchant requesting 3DS authentication. Maps to EMV 3DS
+            # field merchantCountryCode.
+            country:,
+            # Merchant category code assigned to the merchant that describes its business
+            # activity type. Maps to EMV 3DS field mcc.
+            mcc:,
+            # Name of the merchant. Maps to EMV 3DS field merchantName.
+            name:,
+            # Object containing additional data indicating additional risk factors related to
+            # the e-commerce transaction.
+            risk_indicator:
+          ); end
           sig do
             override
               .returns(
@@ -790,14 +875,35 @@ module Lithic
                 .returns(T.attached_class)
             end
             def self.new(
+              # In transactions with electronic delivery, email address to which merchandise is
+              # delivered. Maps to EMV 3DS field deliveryEmailAddress.
               delivery_email_address: nil,
+              # The delivery time frame for the merchandise. Maps to EMV 3DS field
+              # deliveryTimeframe.
               delivery_time_frame: nil,
+              # In prepaid or gift card purchase transactions, purchase amount total in major
+              # units (e.g., a purchase of USD $205.10 would be 205). Maps to EMV 3DS field
+              # giftCardAmount.
               gift_card_amount: nil,
+              # In prepaid or gift card purchase transactions, count of individual prepaid or
+              # gift cards/codes purchased. Maps to EMV 3DS field giftCardCount.
               gift_card_count: nil,
+              # In prepaid or gift card purchase transactions, currency code of the gift card.
+              # Maps to EMV 3DS field giftCardCurr.
               gift_card_currency: nil,
+              # Indicates whether the purchase is for merchandise that is available now or at a
+              # future date. Maps to EMV 3DS field preOrderPurchaseInd.
               order_availability: nil,
+              # In pre-order purchase transactions, the expected date that the merchandise will
+              # be available. Maps to EMV 3DS field preOrderDate.
               pre_order_available_date: nil,
+              # Indicates whether the cardholder is reordering previously purchased merchandise.
+              # Maps to EMV 3DS field reorderItemsInd.
               reorder_items: nil,
+              # Shipping method that the cardholder chose for the transaction. If purchase
+              # includes one or more item, this indicator is used for the physical goods; if the
+              # purchase only includes digital goods, this indicator is used to describe the
+              # most expensive item purchased. Maps to EMV 3DS field shipIndicator.
               shipping_method: nil
             ); end
             sig do
@@ -1126,8 +1232,14 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(network_decision: nil, network_risk_score: nil); end
-
+          def self.new(
+            # Mastercard only: Indicates whether the network would have considered the
+            # authentication request to be low risk or not.
+            network_decision: nil,
+            # Mastercard only: Assessment by the network of the authentication risk level,
+            # with a higher value indicating a higher amount of risk.
+            network_risk_score: nil
+          ); end
           sig do
             override
               .returns(
@@ -1188,8 +1300,14 @@ module Lithic
           # Object containing data about the app used in the e-commerce transaction. Present
           # if the channel is 'APP_BASED'.
           sig { params(device_info: T.nilable(String), ip: String).returns(T.attached_class) }
-          def self.new(device_info: nil, ip: nil); end
-
+          def self.new(
+            # Device information gathered from the cardholder's device - JSON name/value pairs
+            # that is Base64url encoded. Maps to EMV 3DS field deviceInfo.
+            device_info: nil,
+            # External IP address used by the app generating the 3DS authentication request.
+            # Maps to EMV 3DS field appIp.
+            ip: nil
+          ); end
           sig { override.returns({device_info: T.nilable(String), ip: String}) }
           def to_hash; end
         end
@@ -1309,15 +1427,25 @@ module Lithic
               .returns(T.attached_class)
           end
           def self.new(
+            # IP address of the browser as returned by the HTTP headers to the 3DS requestor
+            # (e.g., merchant or digital wallet). Maps to EMV 3DS field browserIP.
             ip: nil,
+            # Indicates whether the cardholder's browser has the ability to execute Java. Maps
+            # to EMV 3DS field browserJavaEnabled.
             java_enabled: nil,
+            # Indicates whether the cardholder's browser has the ability to execute
+            # JavaScript. Maps to EMV 3DS field browserJavascriptEnabled.
             javascript_enabled: nil,
+            # Language of the cardholder's browser as defined in IETF BCP47. Maps to EMV 3DS
+            # field browserLanguage.
             language: nil,
+            # Time zone of the cardholder's browser offset in minutes between UTC and the
+            # cardholder browser's local time. The offset is positive if the local time is
+            # behind UTC and negative if it is ahead. Maps to EMV 3DS field browserTz.
             time_zone: nil,
+            # Content of the HTTP user-agent header. Maps to EMV 3DS field browserUserAgent.
             user_agent: nil
-          )
-          end
-
+          ); end
           sig do
             override
               .returns(
@@ -1355,8 +1483,12 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(method_type:, phone_number: nil); end
-
+          def self.new(
+            # The type of challenge method used for authentication.
+            method_type:,
+            # The phone number used for delivering the OTP. Relevant only for SMS_OTP method.
+            phone_number: nil
+          ); end
           sig do
             override
               .returns(
@@ -1605,8 +1737,22 @@ module Lithic
             )
               .returns(T.attached_class)
           end
-          def self.new(amount:, currency:, currency_exponent:, date_time:, type:); end
-
+          def self.new(
+            # Amount of the purchase in minor units of currency with all punctuation removed.
+            # Maps to EMV 3DS field purchaseAmount.
+            amount:,
+            # Currency of the purchase. Maps to EMV 3DS field purchaseCurrency.
+            currency:,
+            # Minor units of currency, as specified in ISO 4217 currency exponent. Maps to EMV
+            # 3DS field purchaseExponent.
+            currency_exponent:,
+            # Date and time when the authentication was generated by the merchant/acquirer's
+            # 3DS server. Maps to EMV 3DS field purchaseDate.
+            date_time:,
+            # Type of the transaction for which a 3DS authentication request is occurring.
+            # Maps to EMV 3DS field transType.
+            type:
+          ); end
           sig do
             override
               .returns(

data/rbi/lib/lithic/models/three_ds/authentication_simulate_otp_entry_params.rbi

@@ -24,8 +24,14 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(token:, otp:, request_options: {}); end
-
+        def self.new(
+          # A unique token returned as part of a /v1/three_ds_authentication/simulate call
+          # that resulted in PENDING_CHALLENGE authentication result.
+          token:,
+          # The OTP entered by the cardholder
+          otp:,
+          request_options: {}
+        ); end
         sig { override.returns({token: String, otp: String, request_options: Lithic::RequestOptions}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/three_ds/authentication_simulate_params.rbi

@@ -56,8 +56,16 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(merchant:, pan:, transaction:, card_expiry_check: nil, request_options: {}); end
-
+        def self.new(
+          merchant:,
+          # Sixteen digit card number.
+          pan:,
+          transaction:,
+          # When set will use the following values as part of the Simulated Authentication.
+          # When not set defaults to MATCH
+          card_expiry_check: nil,
+          request_options: {}
+        ); end
         sig do
           override
             .returns(
@@ -95,8 +103,21 @@ module Lithic
           attr_accessor :name
 
           sig { params(id: String, country: String, mcc: String, name: String).returns(T.attached_class) }
-          def self.new(id:, country:, mcc:, name:); end
-
+          def self.new(
+            # Unique identifier to identify the payment card acceptor. Corresponds to
+            # `merchant_acceptor_id` in authorization.
+            id:,
+            # Country of the address provided by the cardholder in ISO 3166-1 alpha-3 format
+            # (e.g. USA)
+            country:,
+            # Merchant category code for the transaction to be simulated. A four-digit number
+            # listed in ISO 18245. Supported merchant category codes can be found
+            # [here](https://docs.lithic.com/docs/transactions#merchant-category-codes-mccs).
+            mcc:,
+            # Merchant descriptor, corresponds to `descriptor` in authorization. If CHALLENGE
+            # keyword is included, Lithic will trigger a challenge.
+            name:
+          ); end
           sig { override.returns({id: String, country: String, mcc: String, name: String}) }
           def to_hash; end
         end
@@ -111,8 +132,12 @@ module Lithic
           attr_accessor :currency
 
           sig { params(amount: Integer, currency: String).returns(T.attached_class) }
-          def self.new(amount:, currency:); end
-
+          def self.new(
+            # Amount (in cents) to authenticate.
+            amount:,
+            # 3-character alphabetic ISO 4217 currency code.
+            currency:
+          ); end
           sig { override.returns({amount: Integer, currency: String}) }
           def to_hash; end
         end

data/rbi/lib/lithic/models/three_ds/authentication_simulate_response.rbi

@@ -13,8 +13,11 @@ module Lithic
         attr_writer :token
 
         sig { params(token: String).returns(T.attached_class) }
-        def self.new(token: nil); end
-
+        def self.new(
+          # A unique token to reference this transaction with later calls to void or clear
+          # the authorization.
+          token: nil
+        ); end
         sig { override.returns({token: String}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/three_ds/challenge_response.rbi

@@ -19,8 +19,15 @@ module Lithic
           params(token: String, challenge_response: Lithic::Models::ThreeDS::ChallengeResult::OrSymbol)
             .returns(T.attached_class)
         end
-        def self.new(token:, challenge_response:); end
-
+        def self.new(
+          # 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
+          token:,
+          # Whether the Cardholder has Approved or Declined the issued Challenge
+          challenge_response:
+        ); end
         sig { override.returns({token: String, challenge_response: Lithic::Models::ThreeDS::ChallengeResult::OrSymbol}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/three_ds/decisioning_retrieve_secret_response.rbi

@@ -12,8 +12,10 @@ module Lithic
         attr_writer :secret
 
         sig { params(secret: String).returns(T.attached_class) }
-        def self.new(secret: nil); end
-
+        def self.new(
+          # The 3DS Decisioning HMAC secret
+          secret: nil
+        ); end
         sig { override.returns({secret: String}) }
         def to_hash; end
       end

data/rbi/lib/lithic/models/tokenization.rbi

@@ -84,18 +84,35 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Globally unique identifier for a Tokenization
         token:,
+        # The account token associated with the card being tokenized.
         account_token:,
+        # The card token associated with the card being tokenized.
         card_token:,
+        # Date and time when the tokenization first occurred. UTC time zone.
         created_at:,
+        # The dynamic pan assigned to the token by the network.
         dpan:,
+        # The status of the tokenization request
         status:,
+        # The entity that requested the tokenization. Represents a Digital Wallet or
+        # merchant.
         token_requestor_name:,
+        # The network's unique reference for the tokenization.
         token_unique_reference:,
+        # The channel through which the tokenization was made.
         tokenization_channel:,
+        # Latest date and time when the tokenization was updated. UTC time zone.
         updated_at:,
+        # Specifies the digital card art displayed in the user’s digital wallet after
+        # tokenization. This will be null if the tokenization was created without an
+        # associated digital card art. See
+        # [Flexible Card Art Guide](https://docs.lithic.com/docs/about-digital-wallets#flexible-card-art).
         digital_card_art_token: nil,
+        # A list of events related to the tokenization.
         events: nil,
+        # The network's unique reference for the card that is tokenized.
         payment_account_reference_id: nil
       ); end
       sig do
@@ -215,8 +232,16 @@ module Lithic
           )
             .returns(T.attached_class)
         end
-        def self.new(token: nil, created_at: nil, result: nil, type: nil); end
-
+        def self.new(
+          # Globally unique identifier for a Tokenization Event
+          token: nil,
+          # Date and time when the tokenization event first occurred. UTC time zone.
+          created_at: nil,
+          # Enum representing the result of the tokenization event
+          result: nil,
+          # Enum representing the type of tokenization event that occurred
+          type: nil
+        ); end
         sig do
           override
             .returns(

data/rbi/lib/lithic/models/tokenization_decisioning_rotate_secret_response.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :secret
 
       sig { params(secret: String).returns(T.attached_class) }
-      def self.new(secret: nil); end
-
+      def self.new(
+        # The new Tokenization Decisioning HMAC secret
+        secret: nil
+      ); end
       sig { override.returns({secret: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/tokenization_list_params.rbi

@@ -80,13 +80,24 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # Filters for tokenizations associated with a specific account.
         account_token: nil,
+        # Filter for tokenizations created after this date.
         begin_: nil,
+        # Filters for tokenizations associated with a specific card.
         card_token: nil,
+        # Filter for tokenizations created before this date.
         end_: nil,
+        # 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.
         ending_before: nil,
+        # Page size (for pagination).
         page_size: nil,
+        # 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.
         starting_after: nil,
+        # Filter for tokenizations by tokenization channel. If this is not specified, only
+        # DIGITAL_WALLET tokenizations will be returned.
         tokenization_channel: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/tokenization_resend_activation_code_params.rbi

@@ -27,8 +27,13 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(activation_method_type: nil, request_options: {}); end
-
+      def self.new(
+        # 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"
+        activation_method_type: nil,
+        request_options: {}
+      ); end
       sig do
         override
           .returns(

data/rbi/lib/lithic/models/tokenization_secret.rbi

@@ -11,8 +11,10 @@ module Lithic
       attr_writer :secret
 
       sig { params(secret: String).returns(T.attached_class) }
-      def self.new(secret: nil); end
-
+      def self.new(
+        # The Tokenization Decisioning HMAC secret
+        secret: nil
+      ); end
       sig { override.returns({secret: String}) }
       def to_hash; end
     end

data/rbi/lib/lithic/models/tokenization_simulate_params.rbi

@@ -73,13 +73,24 @@ module Lithic
           .returns(T.attached_class)
       end
       def self.new(
+        # The three digit cvv for the card.
         cvv:,
+        # The expiration date of the card in 'MM/YY' format.
         expiration_date:,
+        # The sixteen digit card number.
         pan:,
+        # The source of the tokenization request.
         tokenization_source:,
+        # The account score (1-5) that represents how the Digital Wallet's view on how
+        # reputable an end user's account is.
         account_score: nil,
+        # The device score (1-5) that represents how the Digital Wallet's view on how
+        # reputable an end user's device is.
         device_score: nil,
+        # Optional field to specify the token requestor name for a merchant token
+        # simulation. Ignored when tokenization_source is not MERCHANT.
         entity: nil,
+        # The decision that the Digital Wallet's recommend
         wallet_recommended_decision: nil,
         request_options: {}
       ); end

data/rbi/lib/lithic/models/tokenization_update_digital_card_art_params.rbi

@@ -23,8 +23,14 @@ module Lithic
         )
           .returns(T.attached_class)
       end
-      def self.new(digital_card_art_token: nil, request_options: {}); end
-
+      def self.new(
+        # 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).
+        digital_card_art_token: nil,
+        request_options: {}
+      ); end
       sig { override.returns({digital_card_art_token: String, request_options: Lithic::RequestOptions}) }
       def to_hash; end
     end