lithic 0.20.0 → 0.22.0

data/rbi/lithic/models/card_pin_updated_webhook_event.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module Lithic
+  module Models
+    class CardPinUpdatedWebhookEvent < Lithic::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Lithic::CardPinUpdatedWebhookEvent, Lithic::Internal::AnyHash)
+        end
+
+      # The token of the card whose PIN or PIN status was updated
+      sig { returns(String) }
+      attr_accessor :card_token
+
+      # The type of event that occurred.
+      sig { returns(Symbol) }
+      attr_accessor :event_type
+
+      # The card's PIN status after the update
+      sig do
+        returns(Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol)
+      end
+      attr_accessor :pin_status
+
+      # The reason for the PIN update:
+      #
+      # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
+      # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
+      #   `pin_status` is `OK`
+      # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
+      #   `OK`
+      # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
+      #   attempts; `pin_status` is `BLOCKED`
+      sig do
+        returns(Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol)
+      end
+      attr_accessor :status_reason
+
+      sig do
+        params(
+          card_token: String,
+          pin_status: Lithic::CardPinUpdatedWebhookEvent::PinStatus::OrSymbol,
+          status_reason:
+            Lithic::CardPinUpdatedWebhookEvent::StatusReason::OrSymbol,
+          event_type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The token of the card whose PIN or PIN status was updated
+        card_token:,
+        # The card's PIN status after the update
+        pin_status:,
+        # The reason for the PIN update:
+        #
+        # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
+        # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
+        #   `pin_status` is `OK`
+        # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
+        #   `OK`
+        # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
+        #   attempts; `pin_status` is `BLOCKED`
+        status_reason:,
+        # The type of event that occurred.
+        event_type: :"card.pin_updated"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            card_token: String,
+            event_type: Symbol,
+            pin_status:
+              Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol,
+            status_reason:
+              Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The card's PIN status after the update
+      module PinStatus
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::CardPinUpdatedWebhookEvent::PinStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OK =
+          T.let(
+            :OK,
+            Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
+          )
+        BLOCKED =
+          T.let(
+            :BLOCKED,
+            Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardPinUpdatedWebhookEvent::PinStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The reason for the PIN update:
+      #
+      # - `PIN_SET` - The PIN was set for the first time; `pin_status` is `OK`
+      # - `PIN_CHANGED` - The PIN was changed, including when changing a blocked PIN;
+      #   `pin_status` is `OK`
+      # - `PIN_UNBLOCKED` - The PIN was unblocked without changing it; `pin_status` is
+      #   `OK`
+      # - `EXCESSIVE_PIN_ATTEMPTS` - The PIN was blocked due to excessive incorrect PIN
+      #   attempts; `pin_status` is `BLOCKED`
+      module StatusReason
+        extend Lithic::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Lithic::CardPinUpdatedWebhookEvent::StatusReason)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PIN_SET =
+          T.let(
+            :PIN_SET,
+            Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+          )
+        PIN_CHANGED =
+          T.let(
+            :PIN_CHANGED,
+            Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+          )
+        PIN_UNBLOCKED =
+          T.let(
+            :PIN_UNBLOCKED,
+            Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+          )
+        EXCESSIVE_PIN_ATTEMPTS =
+          T.let(
+            :EXCESSIVE_PIN_ATTEMPTS,
+            Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Lithic::CardPinUpdatedWebhookEvent::StatusReason::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/lithic/models/card_update_params.rbi

@@ -145,6 +145,16 @@ module Lithic
       end
       attr_writer :substatus
 
+      # Key-value pairs to merge into the card's tags. Supplied keys are added or
+      # overwritten, a key with a `null` value is removed, and omitted keys remain
+      # unchanged. A card can have at most 50 tags, with keys up to 40 characters and
+      # values up to 500 characters
+      sig { returns(T.nilable(T::Hash[Symbol, T.nilable(String)])) }
+      attr_reader :tags
+
+      sig { params(tags: T::Hash[Symbol, T.nilable(String)]).void }
+      attr_writer :tags
+
       sig do
         params(
           card_token: String,
@@ -158,6 +168,7 @@ module Lithic
           spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
           state: Lithic::CardUpdateParams::State::OrSymbol,
           substatus: Lithic::CardUpdateParams::Substatus::OrSymbol,
+          tags: T::Hash[Symbol, T.nilable(String)],
           request_options: Lithic::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -238,6 +249,11 @@ module Lithic
         # - `OTHER` - The reason for the status does not fall into any of the above
         #   categories. A comment should be provided to specify the reason.
         substatus: nil,
+        # Key-value pairs to merge into the card's tags. Supplied keys are added or
+        # overwritten, a key with a `null` value is removed, and omitted keys remain
+        # unchanged. A card can have at most 50 tags, with keys up to 40 characters and
+        # values up to 500 characters
+        tags: nil,
         request_options: {}
       )
       end
@@ -256,6 +272,7 @@ module Lithic
             spend_limit_duration: Lithic::SpendLimitDuration::OrSymbol,
             state: Lithic::CardUpdateParams::State::OrSymbol,
             substatus: Lithic::CardUpdateParams::Substatus::OrSymbol,
+            tags: T::Hash[Symbol, T.nilable(String)],
             request_options: Lithic::RequestOptions
           }
         )

data/rbi/lithic/models/event.rbi

@@ -43,6 +43,8 @@ module Lithic
       # - card.converted: Occurs when a card is converted from virtual to physical
       #   cards.
       # - card.created: Occurs when a new card is created.
+      # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+      #   blocked due to excessive incorrect PIN attempts.
       # - card.reissued: Occurs when a card is reissued.
       # - card.renewed: Occurs when a card is renewed.
       # - card.shipped: Occurs when a card is shipped.
@@ -193,6 +195,8 @@ module Lithic
         # - card.converted: Occurs when a card is converted from virtual to physical
         #   cards.
         # - card.created: Occurs when a new card is created.
+        # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+        #   blocked due to excessive incorrect PIN attempts.
         # - card.reissued: Occurs when a card is reissued.
         # - card.renewed: Occurs when a card is renewed.
         # - card.shipped: Occurs when a card is shipped.
@@ -339,6 +343,8 @@ module Lithic
       # - card.converted: Occurs when a card is converted from virtual to physical
       #   cards.
       # - card.created: Occurs when a new card is created.
+      # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+      #   blocked due to excessive incorrect PIN attempts.
       # - card.reissued: Occurs when a card is reissued.
       # - card.renewed: Occurs when a card is renewed.
       # - card.shipped: Occurs when a card is shipped.
@@ -511,6 +517,8 @@ module Lithic
           T.let(:"card.converted", Lithic::Event::EventType::TaggedSymbol)
         CARD_CREATED =
           T.let(:"card.created", Lithic::Event::EventType::TaggedSymbol)
+        CARD_PIN_UPDATED =
+          T.let(:"card.pin_updated", Lithic::Event::EventType::TaggedSymbol)
         CARD_REISSUED =
           T.let(:"card.reissued", Lithic::Event::EventType::TaggedSymbol)
         CARD_RENEWED =

data/rbi/lithic/models/event_list_params.rbi

@@ -152,6 +152,8 @@ module Lithic
       # - card.converted: Occurs when a card is converted from virtual to physical
       #   cards.
       # - card.created: Occurs when a new card is created.
+      # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+      #   blocked due to excessive incorrect PIN attempts.
       # - card.reissued: Occurs when a card is reissued.
       # - card.renewed: Occurs when a card is renewed.
       # - card.shipped: Occurs when a card is shipped.
@@ -334,6 +336,11 @@ module Lithic
             :"card.created",
             Lithic::EventListParams::EventType::TaggedSymbol
           )
+        CARD_PIN_UPDATED =
+          T.let(
+            :"card.pin_updated",
+            Lithic::EventListParams::EventType::TaggedSymbol
+          )
         CARD_REISSUED =
           T.let(
             :"card.reissued",

data/rbi/lithic/models/event_subscription.rbi

@@ -100,6 +100,8 @@ module Lithic
       # - card.converted: Occurs when a card is converted from virtual to physical
       #   cards.
       # - card.created: Occurs when a new card is created.
+      # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+      #   blocked due to excessive incorrect PIN attempts.
       # - card.reissued: Occurs when a card is reissued.
       # - card.renewed: Occurs when a card is renewed.
       # - card.shipped: Occurs when a card is shipped.
@@ -282,6 +284,11 @@ module Lithic
             :"card.created",
             Lithic::EventSubscription::EventType::TaggedSymbol
           )
+        CARD_PIN_UPDATED =
+          T.let(
+            :"card.pin_updated",
+            Lithic::EventSubscription::EventType::TaggedSymbol
+          )
         CARD_REISSUED =
           T.let(
             :"card.reissued",

data/rbi/lithic/models/events/subscription_create_params.rbi

@@ -127,6 +127,8 @@ module Lithic
         # - card.converted: Occurs when a card is converted from virtual to physical
         #   cards.
         # - card.created: Occurs when a new card is created.
+        # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+        #   blocked due to excessive incorrect PIN attempts.
         # - card.reissued: Occurs when a card is reissued.
         # - card.renewed: Occurs when a card is renewed.
         # - card.shipped: Occurs when a card is shipped.
@@ -311,6 +313,11 @@ module Lithic
               :"card.created",
               Lithic::Events::SubscriptionCreateParams::EventType::TaggedSymbol
             )
+          CARD_PIN_UPDATED =
+            T.let(
+              :"card.pin_updated",
+              Lithic::Events::SubscriptionCreateParams::EventType::TaggedSymbol
+            )
           CARD_REISSUED =
             T.let(
               :"card.reissued",

data/rbi/lithic/models/events/subscription_send_simulated_example_params.rbi

@@ -153,6 +153,11 @@ module Lithic
               :"card.created",
               Lithic::Events::SubscriptionSendSimulatedExampleParams::EventType::TaggedSymbol
             )
+          CARD_PIN_UPDATED =
+            T.let(
+              :"card.pin_updated",
+              Lithic::Events::SubscriptionSendSimulatedExampleParams::EventType::TaggedSymbol
+            )
           CARD_REISSUED =
             T.let(
               :"card.reissued",

data/rbi/lithic/models/events/subscription_update_params.rbi

@@ -133,6 +133,8 @@ module Lithic
         # - card.converted: Occurs when a card is converted from virtual to physical
         #   cards.
         # - card.created: Occurs when a new card is created.
+        # - card.pin_updated: Occurs when a card's PIN is set, changed, unblocked, or
+        #   blocked due to excessive incorrect PIN attempts.
         # - card.reissued: Occurs when a card is reissued.
         # - card.renewed: Occurs when a card is renewed.
         # - card.shipped: Occurs when a card is shipped.
@@ -317,6 +319,11 @@ module Lithic
               :"card.created",
               Lithic::Events::SubscriptionUpdateParams::EventType::TaggedSymbol
             )
+          CARD_PIN_UPDATED =
+            T.let(
+              :"card.pin_updated",
+              Lithic::Events::SubscriptionUpdateParams::EventType::TaggedSymbol
+            )
           CARD_REISSUED =
             T.let(
               :"card.reissued",

data/rbi/lithic/models/external_payment.rbi

@@ -207,6 +207,11 @@ module Lithic
           )
         EXTERNAL_RTP =
           T.let(:EXTERNAL_RTP, Lithic::ExternalPayment::Category::TaggedSymbol)
+        EXTERNAL_STABLECOIN =
+          T.let(
+            :EXTERNAL_STABLECOIN,
+            Lithic::ExternalPayment::Category::TaggedSymbol
+          )
         EXTERNAL_TRANSFER =
           T.let(
             :EXTERNAL_TRANSFER,
@@ -522,6 +527,31 @@ module Lithic
               :EXTERNAL_RTP_RELEASED,
               Lithic::ExternalPayment::Event::Type::TaggedSymbol
             )
+          EXTERNAL_STABLECOIN_INITIATED =
+            T.let(
+              :EXTERNAL_STABLECOIN_INITIATED,
+              Lithic::ExternalPayment::Event::Type::TaggedSymbol
+            )
+          EXTERNAL_STABLECOIN_CANCELED =
+            T.let(
+              :EXTERNAL_STABLECOIN_CANCELED,
+              Lithic::ExternalPayment::Event::Type::TaggedSymbol
+            )
+          EXTERNAL_STABLECOIN_SETTLED =
+            T.let(
+              :EXTERNAL_STABLECOIN_SETTLED,
+              Lithic::ExternalPayment::Event::Type::TaggedSymbol
+            )
+          EXTERNAL_STABLECOIN_REVERSED =
+            T.let(
+              :EXTERNAL_STABLECOIN_REVERSED,
+              Lithic::ExternalPayment::Event::Type::TaggedSymbol
+            )
+          EXTERNAL_STABLECOIN_RELEASED =
+            T.let(
+              :EXTERNAL_STABLECOIN_RELEASED,
+              Lithic::ExternalPayment::Event::Type::TaggedSymbol
+            )
 
           sig do
             override.returns(

data/rbi/lithic/models/external_payment_create_params.rbi

@@ -149,6 +149,11 @@ module Lithic
             :EXTERNAL_RTP,
             Lithic::ExternalPaymentCreateParams::Category::TaggedSymbol
           )
+        EXTERNAL_STABLECOIN =
+          T.let(
+            :EXTERNAL_STABLECOIN,
+            Lithic::ExternalPaymentCreateParams::Category::TaggedSymbol
+          )
         EXTERNAL_TRANSFER =
           T.let(
             :EXTERNAL_TRANSFER,

data/rbi/lithic/models/external_payment_list_params.rbi

@@ -200,6 +200,11 @@ module Lithic
             :EXTERNAL_RTP,
             Lithic::ExternalPaymentListParams::Category::TaggedSymbol
           )
+        EXTERNAL_STABLECOIN =
+          T.let(
+            :EXTERNAL_STABLECOIN,
+            Lithic::ExternalPaymentListParams::Category::TaggedSymbol
+          )
         EXTERNAL_TRANSFER =
           T.let(
             :EXTERNAL_TRANSFER,