trycourier 4.21.0 → 4.23.0

data/rbi/courier/models/journeys/template_publish_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(String) }
         attr_accessor :notification_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             template_id: String,
             notification_id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(template_id:, notification_id:, request_options: {})
+        def self.new(
+          template_id:,
+          notification_id:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               template_id: String,
               notification_id: String,
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/lists/subscription_add_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(T::Array[Courier::PutSubscriptionsRecipient]) }
         attr_accessor :recipients
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             list_id: String,
             recipients: T::Array[Courier::PutSubscriptionsRecipient::OrHash],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(list_id:, recipients:, request_options: {})
+        def self.new(
+          list_id:,
+          recipients:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               list_id: String,
               recipients: T::Array[Courier::PutSubscriptionsRecipient],
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/notification_create_params.rbi

@@ -11,15 +11,41 @@ module Courier
           T.any(Courier::NotificationCreateParams, Courier::Internal::AnyHash)
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/notification_publish_params.rbi

@@ -14,18 +14,42 @@ module Courier
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           id: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(
+        id:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Courier::RequestOptions }
+          {
+            id: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/courier/models/profile_create_params.rbi

@@ -17,14 +17,34 @@ module Courier
       sig { returns(T::Hash[Symbol, T.anything]) }
       attr_accessor :profile
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           user_id: String,
           profile: T::Hash[Symbol, T.anything],
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(user_id:, profile:, request_options: {})
+      def self.new(
+        user_id:,
+        profile:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
       sig do
@@ -32,6 +52,8 @@ module Courier
           {
             user_id: String,
             profile: T::Hash[Symbol, T.anything],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/profiles/list_subscribe_params.rbi

@@ -21,14 +21,34 @@ module Courier
         sig { returns(T::Array[Courier::SubscribeToListsRequestItem]) }
         attr_accessor :lists
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             user_id: String,
             lists: T::Array[Courier::SubscribeToListsRequestItem::OrHash],
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(user_id:, lists:, request_options: {})
+        def self.new(
+          user_id:,
+          lists:,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
+          request_options: {}
+        )
         end
 
         sig do
@@ -36,6 +56,8 @@ module Courier
             {
               user_id: String,
               lists: T::Array[Courier::SubscribeToListsRequestItem],
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )

data/rbi/courier/models/provider_create_params.rbi

@@ -39,12 +39,26 @@ module Courier
       sig { params(title: String).void }
       attr_writer :title
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           provider: String,
           alias_: String,
           settings: T::Hash[Symbol, T.anything],
           title: String,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -60,6 +74,8 @@ module Courier
         settings: nil,
         # Optional display title. Omit to use "Default Configuration".
         title: nil,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -71,6 +87,8 @@ module Courier
             alias_: String,
             settings: T::Hash[Symbol, T.anything],
             title: String,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/routing_strategy_create_params.rbi

@@ -14,15 +14,41 @@ module Courier
           )
         end
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
-        params(request_options: Courier::RequestOptions::OrHash).returns(
-          T.attached_class
-        )
+        params(
+          idempotency_key: String,
+          x_idempotency_expiration: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
       end
-      def self.new(request_options: {})
+      def self.new(
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
+        request_options: {}
+      )
       end
 
-      sig { override.returns({ request_options: Courier::RequestOptions }) }
+      sig do
+        override.returns(
+          {
+            idempotency_key: String,
+            x_idempotency_expiration: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
       def to_hash
       end
     end

data/rbi/courier/models/schedule_broadcast_request.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ScheduleBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ScheduleBroadcastRequest, Courier::Internal::AnyHash)
+        end
+
+      # ID of the target list or audience.
+      sig { returns(String) }
+      attr_accessor :recipient_id
+
+      # Whether the broadcast targets a list or an audience.
+      sig do
+        returns(Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol)
+      end
+      attr_accessor :recipient_type
+
+      # Wall-clock timestamp of the future send, no timezone offset (e.g.
+      # "2026-07-21T20:00:00"). The zone is given by `timezone`.
+      sig { returns(String) }
+      attr_accessor :scheduled_to
+
+      # IANA timezone for the scheduled send (e.g. America/New_York).
+      sig { returns(T.nilable(String)) }
+      attr_reader :timezone
+
+      sig { params(timezone: String).void }
+      attr_writer :timezone
+
+      # Request body for scheduling a broadcast for a future send.
+      sig do
+        params(
+          recipient_id: String,
+          recipient_type:
+            Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol,
+          scheduled_to: String,
+          timezone: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the target list or audience.
+        recipient_id:,
+        # Whether the broadcast targets a list or an audience.
+        recipient_type:,
+        # Wall-clock timestamp of the future send, no timezone offset (e.g.
+        # "2026-07-21T20:00:00"). The zone is given by `timezone`.
+        scheduled_to:,
+        # IANA timezone for the scheduled send (e.g. America/New_York).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipient_id: String,
+            recipient_type:
+              Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol,
+            scheduled_to: String,
+            timezone: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the broadcast targets a list or an audience.
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::ScheduleBroadcastRequest::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(
+            :list,
+            Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+          )
+        AUDIENCE =
+          T.let(
+            :audience,
+            Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/send_broadcast_request.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Courier
+  module Models
+    class SendBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::SendBroadcastRequest, Courier::Internal::AnyHash)
+        end
+
+      # ID of the target list or audience.
+      sig { returns(String) }
+      attr_accessor :recipient_id
+
+      # Whether the broadcast targets a list or an audience.
+      sig { returns(Courier::SendBroadcastRequest::RecipientType::OrSymbol) }
+      attr_accessor :recipient_type
+
+      # Request body for sending a broadcast immediately.
+      sig do
+        params(
+          recipient_id: String,
+          recipient_type: Courier::SendBroadcastRequest::RecipientType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # ID of the target list or audience.
+        recipient_id:,
+        # Whether the broadcast targets a list or an audience.
+        recipient_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipient_id: String,
+            recipient_type:
+              Courier::SendBroadcastRequest::RecipientType::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the broadcast targets a list or an audience.
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::SendBroadcastRequest::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(
+            :list,
+            Courier::SendBroadcastRequest::RecipientType::TaggedSymbol
+          )
+        AUDIENCE =
+          T.let(
+            :audience,
+            Courier::SendBroadcastRequest::RecipientType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::SendBroadcastRequest::RecipientType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/send_message_params.rbi

@@ -19,9 +19,23 @@ module Courier
       sig { params(message: Courier::SendMessageParams::Message::OrHash).void }
       attr_writer :message
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_idempotency_expiration
+
+      sig { params(x_idempotency_expiration: String).void }
+      attr_writer :x_idempotency_expiration
+
       sig do
         params(
           message: Courier::SendMessageParams::Message::OrHash,
+          idempotency_key: String,
+          x_idempotency_expiration: String,
           request_options: Courier::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -29,6 +43,8 @@ module Courier
         # The message property has the following primary top-level properties. They define
         # the destination and content of the message.
         message:,
+        idempotency_key: nil,
+        x_idempotency_expiration: nil,
         request_options: {}
       )
       end
@@ -37,6 +53,8 @@ module Courier
         override.returns(
           {
             message: Courier::SendMessageParams::Message,
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions
           }
         )

data/rbi/courier/models/update_broadcast_request.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class UpdateBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::UpdateBroadcastRequest, Courier::Internal::AnyHash)
+        end
+
+      # New human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Request body for updating a broadcast. Only the name is mutable.
+      sig { params(name: String).returns(T.attached_class) }
+      def self.new(
+        # New human-readable name.
+        name:
+      )
+      end
+
+      sig { override.returns({ name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/users/preference_bulk_update_params.rbi

@@ -29,6 +29,18 @@ module Courier
         sig { returns(T.nilable(String)) }
         attr_accessor :tenant_id
 
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_idempotency_expiration
+
+        sig { params(x_idempotency_expiration: String).void }
+        attr_writer :x_idempotency_expiration
+
         sig do
           params(
             user_id: String,
@@ -37,6 +49,8 @@ module Courier
                 Courier::Users::PreferenceBulkUpdateParams::Topic::OrHash
               ],
             tenant_id: T.nilable(String),
+            idempotency_key: String,
+            x_idempotency_expiration: String,
             request_options: Courier::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
@@ -47,6 +61,8 @@ module Courier
           topics:,
           # Update the preferences of a user for this specific tenant context.
           tenant_id: nil,
+          idempotency_key: nil,
+          x_idempotency_expiration: nil,
           request_options: {}
         )
         end
@@ -58,6 +74,8 @@ module Courier
               topics:
                 T::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
               tenant_id: T.nilable(String),
+              idempotency_key: String,
+              x_idempotency_expiration: String,
               request_options: Courier::RequestOptions
             }
           )