lithic 0.18.0 → 0.19.0

data/rbi/lithic/models/auth_rules/velocity_limit_period.rbi

@@ -28,7 +28,7 @@ module Lithic
             end
 
           # The size of the trailing window to calculate Spend Velocity over in seconds. The
-          # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
+          # minimum value is 10 seconds, and the maximum value is 7776000 seconds (90 days).
           sig { returns(Integer) }
           attr_accessor :duration
 
@@ -40,7 +40,7 @@ module Lithic
           end
           def self.new(
             # The size of the trailing window to calculate Spend Velocity over in seconds. The
-            # minimum value is 10 seconds, and the maximum value is 2678400 seconds (31 days).
+            # minimum value is 10 seconds, and the maximum value is 7776000 seconds (90 days).
             duration:,
             type: :CUSTOM
           )

data/rbi/lithic/models/book_transfer_create_params.rbi

@@ -197,6 +197,11 @@ module Lithic
             :PROGRAM_FUNDING,
             Lithic::BookTransferCreateParams::Category::TaggedSymbol
           )
+        PROGRAM_TRANSFER =
+          T.let(
+            :PROGRAM_TRANSFER,
+            Lithic::BookTransferCreateParams::Category::TaggedSymbol
+          )
         TRANSFER =
           T.let(
             :TRANSFER,
@@ -311,6 +316,11 @@ module Lithic
             :BILL_PAYMENT,
             Lithic::BookTransferCreateParams::Type::TaggedSymbol
           )
+        PAYMENT_FEE =
+          T.let(
+            :PAYMENT_FEE,
+            Lithic::BookTransferCreateParams::Type::TaggedSymbol
+          )
         CASH_BACK =
           T.let(
             :CASH_BACK,
@@ -377,6 +387,16 @@ module Lithic
             :COLLECTION,
             Lithic::BookTransferCreateParams::Type::TaggedSymbol
           )
+        LITHIC_PROGRAM_TRANSFER =
+          T.let(
+            :LITHIC_PROGRAM_TRANSFER,
+            Lithic::BookTransferCreateParams::Type::TaggedSymbol
+          )
+        BANK_PROGRAM_TRANSFER =
+          T.let(
+            :BANK_PROGRAM_TRANSFER,
+            Lithic::BookTransferCreateParams::Type::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/lithic/models/book_transfer_list_params.rbi

@@ -216,6 +216,11 @@ module Lithic
             :PROGRAM_FUNDING,
             Lithic::BookTransferListParams::Category::TaggedSymbol
           )
+        PROGRAM_TRANSFER =
+          T.let(
+            :PROGRAM_TRANSFER,
+            Lithic::BookTransferListParams::Category::TaggedSymbol
+          )
         TRANSFER =
           T.let(
             :TRANSFER,

data/rbi/lithic/models/book_transfer_response.rbi

@@ -219,6 +219,11 @@ module Lithic
             :PROGRAM_FUNDING,
             Lithic::BookTransferResponse::Category::TaggedSymbol
           )
+        PROGRAM_TRANSFER =
+          T.let(
+            :PROGRAM_TRANSFER,
+            Lithic::BookTransferResponse::Category::TaggedSymbol
+          )
         TRANSFER =
           T.let(:TRANSFER, Lithic::BookTransferResponse::Category::TaggedSymbol)
 
@@ -512,6 +517,11 @@ module Lithic
               :BILL_PAYMENT,
               Lithic::BookTransferResponse::Event::Type::TaggedSymbol
             )
+          PAYMENT_FEE =
+            T.let(
+              :PAYMENT_FEE,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
           CASH_BACK =
             T.let(
               :CASH_BACK,
@@ -587,6 +597,16 @@ module Lithic
               :COLLECTION,
               Lithic::BookTransferResponse::Event::Type::TaggedSymbol
             )
+          LITHIC_PROGRAM_TRANSFER =
+            T.let(
+              :LITHIC_PROGRAM_TRANSFER,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
+          BANK_PROGRAM_TRANSFER =
+            T.let(
+              :BANK_PROGRAM_TRANSFER,
+              Lithic::BookTransferResponse::Event::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/lithic/models/card_authorization.rbi

@@ -59,12 +59,13 @@ module Lithic
       sig { returns(String) }
       attr_accessor :cardholder_currency
 
-      # The portion of the transaction requested as cash back by the cardholder, and
-      # does not include any acquirer fees. The amount field includes the purchase
-      # amount, the requested cash back amount, and any acquirer fees.
+      # The amount of cash requested by the cardholder, in the cardholder billing
+      # currency's smallest unit. For purchase-with-cashback transactions this is the
+      # cashback portion only; for ATM transactions this is the full amount. This amount
+      # includes all acquirer fees.
       #
-      # If no cash back was requested, the value of this field will be 0, and the field
-      # will always be present.
+      # If no cash was requested, the value of this field will be 0, and the field will
+      # always be present.
       sig { returns(Integer) }
       attr_accessor :cash_amount
 
@@ -328,12 +329,13 @@ module Lithic
         # Deprecated, use `amounts`. 3-character alphabetic ISO 4217 code for cardholder's
         # billing currency.
         cardholder_currency:,
-        # The portion of the transaction requested as cash back by the cardholder, and
-        # does not include any acquirer fees. The amount field includes the purchase
-        # amount, the requested cash back amount, and any acquirer fees.
+        # The amount of cash requested by the cardholder, in the cardholder billing
+        # currency's smallest unit. For purchase-with-cashback transactions this is the
+        # cashback portion only; for ATM transactions this is the full amount. This amount
+        # includes all acquirer fees.
         #
-        # If no cash back was requested, the value of this field will be 0, and the field
-        # will always be present.
+        # If no cash was requested, the value of this field will be 0, and the field will
+        # always be present.
         cash_amount:,
         # Date and time when the transaction first occurred in UTC.
         created:,

data/rbi/lithic/models/embed_session_generated_webhook_event.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class EmbedSessionGeneratedWebhookEvent < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Lithic::EmbedSessionGeneratedWebhookEvent,
+            Lithic::Internal::AnyHash
+          )
+        end
+
+      # The token of the account associated with the card
+      sig { returns(String) }
+      attr_accessor :account_token
+
+      # The token of the card associated with the embed session
+      sig { returns(String) }
+      attr_accessor :card_token
+
+      # Details about the request that generated the embed session
+      sig { returns(Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails) }
+      attr_reader :device_details
+
+      sig do
+        params(
+          device_details:
+            Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails::OrHash
+        ).void
+      end
+      attr_writer :device_details
+
+      # The type of event
+      sig { returns(Symbol) }
+      attr_accessor :event_type
+
+      # The identifier shared by webhook events for the same embed session.
+      sig { returns(String) }
+      attr_accessor :session_id
+
+      # The type of embed session that was generated
+      sig do
+        returns(
+          Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::TaggedSymbol
+        )
+      end
+      attr_accessor :session_type
+
+      sig do
+        params(
+          account_token: String,
+          card_token: String,
+          device_details:
+            Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails::OrHash,
+          session_id: String,
+          session_type:
+            Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::OrSymbol,
+          event_type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The token of the account associated with the card
+        account_token:,
+        # The token of the card associated with the embed session
+        card_token:,
+        # Details about the request that generated the embed session
+        device_details:,
+        # The identifier shared by webhook events for the same embed session.
+        session_id:,
+        # The type of embed session that was generated
+        session_type:,
+        # The type of event
+        event_type: :"embed.session_generated"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_token: String,
+            card_token: String,
+            device_details:
+              Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails,
+            event_type: Symbol,
+            session_id: String,
+            session_type:
+              Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DeviceDetails < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::EmbedSessionGeneratedWebhookEvent::DeviceDetails,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # The IP address recorded for the request that generated the event
+        sig { returns(String) }
+        attr_accessor :ip_address
+
+        # Details about the request that generated the embed session
+        sig { params(ip_address: String).returns(T.attached_class) }
+        def self.new(
+          # The IP address recorded for the request that generated the event
+          ip_address:
+        )
+        end
+
+        sig { override.returns({ ip_address: String }) }
+        def to_hash
+        end
+      end
+
+      # The type of embed session that was generated
+      module SessionType
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Lithic::EmbedSessionGeneratedWebhookEvent::SessionType
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        CARD_EMBED =
+          T.let(
+            :CARD_EMBED,
+            Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::TaggedSymbol
+          )
+        PIN_SETTING_EMBED =
+          T.let(
+            :PIN_SETTING_EMBED,
+            Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::EmbedSessionGeneratedWebhookEvent::SessionType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/embed_viewed_webhook_event.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class EmbedViewedWebhookEvent < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::EmbedViewedWebhookEvent, Lithic::Internal::AnyHash)
+        end
+
+      # The token of the account associated with the card
+      sig { returns(String) }
+      attr_accessor :account_token
+
+      # The token of the card whose details were revealed
+      sig { returns(String) }
+      attr_accessor :card_token
+
+      # Details about the request that revealed the card detail
+      sig { returns(Lithic::EmbedViewedWebhookEvent::DeviceDetails) }
+      attr_reader :device_details
+
+      sig do
+        params(
+          device_details: Lithic::EmbedViewedWebhookEvent::DeviceDetails::OrHash
+        ).void
+      end
+      attr_writer :device_details
+
+      # The type of card detail that was revealed
+      sig { returns(Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol) }
+      attr_accessor :embed_type
+
+      # The type of event
+      sig { returns(Symbol) }
+      attr_accessor :event_type
+
+      # The identifier shared by webhook events for the same embed session.
+      sig { returns(String) }
+      attr_accessor :session_id
+
+      sig do
+        params(
+          account_token: String,
+          card_token: String,
+          device_details:
+            Lithic::EmbedViewedWebhookEvent::DeviceDetails::OrHash,
+          embed_type: Lithic::EmbedViewedWebhookEvent::EmbedType::OrSymbol,
+          session_id: String,
+          event_type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The token of the account associated with the card
+        account_token:,
+        # The token of the card whose details were revealed
+        card_token:,
+        # Details about the request that revealed the card detail
+        device_details:,
+        # The type of card detail that was revealed
+        embed_type:,
+        # The identifier shared by webhook events for the same embed session.
+        session_id:,
+        # The type of event
+        event_type: :"embed.viewed"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_token: String,
+            card_token: String,
+            device_details: Lithic::EmbedViewedWebhookEvent::DeviceDetails,
+            embed_type:
+              Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol,
+            event_type: Symbol,
+            session_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class DeviceDetails < Lithic::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Lithic::EmbedViewedWebhookEvent::DeviceDetails,
+              Lithic::Internal::AnyHash
+            )
+          end
+
+        # The IP address recorded for the request that generated the event
+        sig { returns(String) }
+        attr_accessor :ip_address
+
+        # Details about the request that revealed the card detail
+        sig { params(ip_address: String).returns(T.attached_class) }
+        def self.new(
+          # The IP address recorded for the request that generated the event
+          ip_address:
+        )
+        end
+
+        sig { override.returns({ ip_address: String }) }
+        def to_hash
+        end
+      end
+
+      # The type of card detail that was revealed
+      module EmbedType
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::EmbedViewedWebhookEvent::EmbedType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PAN =
+          T.let(:PAN, Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol)
+        CVV =
+          T.let(:CVV, Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol)
+        EXP_MONTH =
+          T.let(
+            :EXP_MONTH,
+            Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol
+          )
+        EXP_YEAR =
+          T.let(
+            :EXP_YEAR,
+            Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Lithic::EmbedViewedWebhookEvent::EmbedType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/event.rbi

@@ -18,7 +18,7 @@ module Lithic
       # The type of event that occurred. Possible values:
       #
       # - account_holder_document.updated: Occurs when an account holder's document
-      #   upload status has been updated
+      #   upload status has been updated.
       # - account_holder.created: Occurs when a new account_holder is created.
       # - account_holder.updated: Occurs when an account_holder is updated.
       # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -82,10 +82,25 @@ module Lithic
       # This event will be deprecated in the future. We recommend using
       # `tokenization.updated` instead.
       #
-      # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
+      # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
+      #   dispute filed through the Chargebacks API (`/v1/disputes`).
+      #
+      # This event is not emitted for Managed Disputes.
+      #
       # - dispute_transaction.created: Occurs when a new dispute transaction is created
-      # - dispute_transaction.updated: Occurs when a dispute transaction is updated
-      # - dispute.updated: Occurs when a dispute is updated.
+      #   for a Managed Disputes case.
+      # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
+      #   Disputes case is updated.
+      # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
+      #   (`/v1/disputes`) is created or updated.
+      #
+      # This event is not emitted for Managed Disputes. Use
+      # `dispute_transaction.created` and `dispute_transaction.updated` instead.
+      #
+      # - embed.session_generated: Occurs when a card embed session is successfully
+      #   generated.
+      # - embed.viewed: Occurs when a card detail is successfully revealed through an
+      #   embed.
       # - external_bank_account.created: Occurs when an external bank account is
       #   created.
       # - external_bank_account.updated: Occurs when an external bank account is
@@ -107,12 +122,12 @@ module Lithic
       # - payment_transaction.updated: Occurs when a payment transaction is updated.
       # - settlement_report.updated: Occurs when a settlement report is created or
       #   updated.
-      # - statements.created: Occurs when a statement has been created
+      # - statements.created: Occurs when a statement has been created.
       # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
       #   event. Upon receiving this request, the Card Program should issue its own
       #   challenge to the cardholder. After a cardholder challenge is successfully
       #   completed, the Card Program needs to respond back to Lithic by call to
-      #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
+      #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
       #   Then the cardholder must navigate back to the merchant checkout flow to
       #   complete the transaction. Some merchants will include an `app_requestor_url`
       #   for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -153,7 +168,7 @@ module Lithic
         # The type of event that occurred. Possible values:
         #
         # - account_holder_document.updated: Occurs when an account holder's document
-        #   upload status has been updated
+        #   upload status has been updated.
         # - account_holder.created: Occurs when a new account_holder is created.
         # - account_holder.updated: Occurs when an account_holder is updated.
         # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -217,10 +232,25 @@ module Lithic
         # This event will be deprecated in the future. We recommend using
         # `tokenization.updated` instead.
         #
-        # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
+        # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
+        #   dispute filed through the Chargebacks API (`/v1/disputes`).
+        #
+        # This event is not emitted for Managed Disputes.
+        #
         # - dispute_transaction.created: Occurs when a new dispute transaction is created
-        # - dispute_transaction.updated: Occurs when a dispute transaction is updated
-        # - dispute.updated: Occurs when a dispute is updated.
+        #   for a Managed Disputes case.
+        # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
+        #   Disputes case is updated.
+        # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
+        #   (`/v1/disputes`) is created or updated.
+        #
+        # This event is not emitted for Managed Disputes. Use
+        # `dispute_transaction.created` and `dispute_transaction.updated` instead.
+        #
+        # - embed.session_generated: Occurs when a card embed session is successfully
+        #   generated.
+        # - embed.viewed: Occurs when a card detail is successfully revealed through an
+        #   embed.
         # - external_bank_account.created: Occurs when an external bank account is
         #   created.
         # - external_bank_account.updated: Occurs when an external bank account is
@@ -242,12 +272,12 @@ module Lithic
         # - payment_transaction.updated: Occurs when a payment transaction is updated.
         # - settlement_report.updated: Occurs when a settlement report is created or
         #   updated.
-        # - statements.created: Occurs when a statement has been created
+        # - statements.created: Occurs when a statement has been created.
         # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
         #   event. Upon receiving this request, the Card Program should issue its own
         #   challenge to the cardholder. After a cardholder challenge is successfully
         #   completed, the Card Program needs to respond back to Lithic by call to
-        #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
+        #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
         #   Then the cardholder must navigate back to the merchant checkout flow to
         #   complete the transaction. Some merchants will include an `app_requestor_url`
         #   for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -284,7 +314,7 @@ module Lithic
       # The type of event that occurred. Possible values:
       #
       # - account_holder_document.updated: Occurs when an account holder's document
-      #   upload status has been updated
+      #   upload status has been updated.
       # - account_holder.created: Occurs when a new account_holder is created.
       # - account_holder.updated: Occurs when an account_holder is updated.
       # - account_holder.verification: Occurs when an asynchronous account_holder's
@@ -348,10 +378,25 @@ module Lithic
       # This event will be deprecated in the future. We recommend using
       # `tokenization.updated` instead.
       #
-      # - dispute_evidence.upload_failed: Occurs when a dispute evidence upload fails.
+      # - dispute_evidence.upload_failed: Occurs when an evidence upload fails for a
+      #   dispute filed through the Chargebacks API (`/v1/disputes`).
+      #
+      # This event is not emitted for Managed Disputes.
+      #
       # - dispute_transaction.created: Occurs when a new dispute transaction is created
-      # - dispute_transaction.updated: Occurs when a dispute transaction is updated
-      # - dispute.updated: Occurs when a dispute is updated.
+      #   for a Managed Disputes case.
+      # - dispute_transaction.updated: Occurs when a dispute transaction for a Managed
+      #   Disputes case is updated.
+      # - dispute.updated: Occurs when a dispute filed through the Chargebacks API
+      #   (`/v1/disputes`) is created or updated.
+      #
+      # This event is not emitted for Managed Disputes. Use
+      # `dispute_transaction.created` and `dispute_transaction.updated` instead.
+      #
+      # - embed.session_generated: Occurs when a card embed session is successfully
+      #   generated.
+      # - embed.viewed: Occurs when a card detail is successfully revealed through an
+      #   embed.
       # - external_bank_account.created: Occurs when an external bank account is
       #   created.
       # - external_bank_account.updated: Occurs when an external bank account is
@@ -373,12 +418,12 @@ module Lithic
       # - payment_transaction.updated: Occurs when a payment transaction is updated.
       # - settlement_report.updated: Occurs when a settlement report is created or
       #   updated.
-      # - statements.created: Occurs when a statement has been created
+      # - statements.created: Occurs when a statement has been created.
       # - three_ds_authentication.challenge: The `three_ds_authentication.challenge`
       #   event. Upon receiving this request, the Card Program should issue its own
       #   challenge to the cardholder. After a cardholder challenge is successfully
       #   completed, the Card Program needs to respond back to Lithic by call to
-      #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/post_v1-three-ds-decisioning-challenge-response).
+      #   [/v1/three_ds_decisioning/challenge_response](https://docs.lithic.com/reference/postthreedschallengeresponse).
       #   Then the cardholder must navigate back to the merchant checkout flow to
       #   complete the transaction. Some merchants will include an `app_requestor_url`
       #   for app-based purchases; Lithic recommends triggering a redirect to that URL
@@ -530,6 +575,13 @@ module Lithic
           )
         DISPUTE_UPDATED =
           T.let(:"dispute.updated", Lithic::Event::EventType::TaggedSymbol)
+        EMBED_SESSION_GENERATED =
+          T.let(
+            :"embed.session_generated",
+            Lithic::Event::EventType::TaggedSymbol
+          )
+        EMBED_VIEWED =
+          T.let(:"embed.viewed", Lithic::Event::EventType::TaggedSymbol)
         EXTERNAL_BANK_ACCOUNT_CREATED =
           T.let(
             :"external_bank_account.created",