trycourier 4.25.0 → 4.26.1

data/rbi/courier/models/bulk_retrieve_job_response.rbi

@@ -0,0 +1,157 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BulkRetrieveJobResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::Models::BulkRetrieveJobResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Models::BulkRetrieveJobResponse::Job) }
+      attr_reader :job
+
+      sig do
+        params(job: Courier::Models::BulkRetrieveJobResponse::Job::OrHash).void
+      end
+      attr_writer :job
+
+      sig do
+        params(
+          job: Courier::Models::BulkRetrieveJobResponse::Job::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(job:)
+      end
+
+      sig do
+        override.returns({ job: Courier::Models::BulkRetrieveJobResponse::Job })
+      end
+      def to_hash
+      end
+
+      class Job < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Models::BulkRetrieveJobResponse::Job,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # Bulk message definition. Supports two formats:
+        #
+        # - V1 format: Requires `event` field (event ID or notification ID)
+        # - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+        #   content) in addition to `event`
+        sig { returns(Courier::InboundBulkMessage) }
+        attr_reader :definition
+
+        sig { params(definition: Courier::InboundBulkMessage::OrHash).void }
+        attr_writer :definition
+
+        sig { returns(Integer) }
+        attr_accessor :enqueued
+
+        sig { returns(Integer) }
+        attr_accessor :failures
+
+        sig { returns(Integer) }
+        attr_accessor :received
+
+        sig do
+          returns(
+            Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig do
+          params(
+            definition: Courier::InboundBulkMessage::OrHash,
+            enqueued: Integer,
+            failures: Integer,
+            received: Integer,
+            status:
+              Courier::Models::BulkRetrieveJobResponse::Job::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Bulk message definition. Supports two formats:
+          #
+          # - V1 format: Requires `event` field (event ID or notification ID)
+          # - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+          #   content) in addition to `event`
+          definition:,
+          enqueued:,
+          failures:,
+          received:,
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              definition: Courier::InboundBulkMessage,
+              enqueued: Integer,
+              failures: Integer,
+              received: Integer,
+              status:
+                Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Courier::Models::BulkRetrieveJobResponse::Job::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(
+              :CREATED,
+              Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+            )
+          PROCESSING =
+            T.let(
+              :PROCESSING,
+              Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+            )
+          COMPLETED =
+            T.let(
+              :COMPLETED,
+              Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+            )
+          ERROR =
+            T.let(
+              :ERROR,
+              Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Courier::Models::BulkRetrieveJobResponse::Job::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/bulk_run_job_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BulkRunJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BulkRunJobParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :job_id
+
+      sig do
+        params(
+          job_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(job_id:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { job_id: String, request_options: Courier::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/inbound_bulk_message.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Courier
+  module Models
+    class InboundBulkMessage < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::InboundBulkMessage, Courier::Internal::AnyHash)
+        end
+
+      # Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+      # "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+      # mapped to a notification.
+      sig { returns(String) }
+      attr_accessor :event
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand
+
+      # Elemental content (optional, for V2 format). When provided, this will be used
+      # instead of the notification associated with the `event` field.
+      sig do
+        returns(
+          T.nilable(
+            T.any(Courier::ElementalContentSugar, Courier::ElementalContent)
+          )
+        )
+      end
+      attr_accessor :content
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :data
+
+      sig { returns(T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]])) }
+      attr_accessor :locale
+
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :override
+
+      # Notification ID or template ID (optional, for V2 format). When provided, this
+      # will be used instead of the notification associated with the `event` field.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template
+
+      # Bulk message definition. Supports two formats:
+      #
+      # - V1 format: Requires `event` field (event ID or notification ID)
+      # - V2 format: Optionally use `template` (notification ID) or `content` (Elemental
+      #   content) in addition to `event`
+      sig do
+        params(
+          event: String,
+          brand: T.nilable(String),
+          content:
+            T.nilable(
+              T.any(
+                Courier::ElementalContentSugar::OrHash,
+                Courier::ElementalContent::OrHash
+              )
+            ),
+          data: T.nilable(T::Hash[Symbol, T.anything]),
+          locale: T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]]),
+          override: T.nilable(T::Hash[Symbol, T.anything]),
+          template: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Event ID or Notification ID (required). Can be either a Notification ID (e.g.,
+        # "FRH3QXM9E34W4RKP7MRC8NZ1T8V8") or a custom Event ID (e.g., "welcome-email")
+        # mapped to a notification.
+        event:,
+        brand: nil,
+        # Elemental content (optional, for V2 format). When provided, this will be used
+        # instead of the notification associated with the `event` field.
+        content: nil,
+        data: nil,
+        locale: nil,
+        override: nil,
+        # Notification ID or template ID (optional, for V2 format). When provided, this
+        # will be used instead of the notification associated with the `event` field.
+        template: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: String,
+            brand: T.nilable(String),
+            content:
+              T.nilable(
+                T.any(Courier::ElementalContentSugar, Courier::ElementalContent)
+              ),
+            data: T.nilable(T::Hash[Symbol, T.anything]),
+            locale: T.nilable(T::Hash[Symbol, T::Hash[Symbol, T.anything]]),
+            override: T.nilable(T::Hash[Symbol, T.anything]),
+            template: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Elemental content (optional, for V2 format). When provided, this will be used
+      # instead of the notification associated with the `event` field.
+      module Content
+        extend Courier::Internal::Type::Union
+
+        Variants =
+          T.type_alias do
+            T.any(Courier::ElementalContentSugar, Courier::ElementalContent)
+          end
+
+        sig do
+          override.returns(
+            T::Array[Courier::InboundBulkMessage::Content::Variants]
+          )
+        end
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/inbound_bulk_message_user.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Courier
+  module Models
+    class InboundBulkMessageUser < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::InboundBulkMessageUser, Courier::Internal::AnyHash)
+        end
+
+      # User-specific data that will be merged with message.data
+      sig { returns(T.nilable(T.anything)) }
+      attr_reader :data
+
+      sig { params(data: T.anything).void }
+      attr_writer :data
+
+      sig { returns(T.nilable(Courier::RecipientPreferences)) }
+      attr_reader :preferences
+
+      sig do
+        params(
+          preferences: T.nilable(Courier::RecipientPreferences::OrHash)
+        ).void
+      end
+      attr_writer :preferences
+
+      # User profile information. For email-based bulk jobs, `profile.email` is required
+      # for provider routing to determine if the message can be delivered. The email
+      # address should be provided here rather than in `to.email`.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :profile
+
+      # User ID (legacy field, use profile or to.user_id instead)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :recipient
+
+      # Optional recipient information. Note: For email provider routing, use
+      # `profile.email` instead of `to.email`. The `to` field is primarily used for
+      # recipient identification and data merging.
+      sig { returns(T.nilable(Courier::UserRecipient)) }
+      attr_reader :to
+
+      sig { params(to: T.nilable(Courier::UserRecipient::OrHash)).void }
+      attr_writer :to
+
+      sig do
+        params(
+          data: T.anything,
+          preferences: T.nilable(Courier::RecipientPreferences::OrHash),
+          profile: T.nilable(T::Hash[Symbol, T.anything]),
+          recipient: T.nilable(String),
+          to: T.nilable(Courier::UserRecipient::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # User-specific data that will be merged with message.data
+        data: nil,
+        preferences: nil,
+        # User profile information. For email-based bulk jobs, `profile.email` is required
+        # for provider routing to determine if the message can be delivered. The email
+        # address should be provided here rather than in `to.email`.
+        profile: nil,
+        # User ID (legacy field, use profile or to.user_id instead)
+        recipient: nil,
+        # Optional recipient information. Note: For email provider routing, use
+        # `profile.email` instead of `to.email`. The `to` field is primarily used for
+        # recipient identification and data merging.
+        to: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.anything,
+            preferences: T.nilable(Courier::RecipientPreferences),
+            profile: T.nilable(T::Hash[Symbol, T.anything]),
+            recipient: T.nilable(String),
+            to: T.nilable(Courier::UserRecipient)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_alias.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    # A template's send-time alias as returned by a read, omitted entirely when it has
+    # none. Usually a single string; an array for a template that resolves from
+    # several aliases, which writes through this API can no longer produce — only
+    # templates predating that restriction, or aliases attached outside this API, hold
+    # more than one.
+    module NotificationTemplateAlias
+      extend Courier::Internal::Type::Union
+
+      Variants = T.type_alias { T.any(String, T::Array[String]) }
+
+      sig do
+        override.returns(T::Array[Courier::NotificationTemplateAlias::Variants])
+      end
+      def self.variants
+      end
+
+      StringArray =
+        T.let(
+          Courier::Internal::Type::ArrayOf[String],
+          Courier::Internal::Type::Converter
+        )
+    end
+  end
+end

data/rbi/courier/models/notification_template_create_request.rbi

@@ -11,13 +11,15 @@ module Courier
           )
         end
 
-      # Core template fields used in POST and PUT request bodies (nested under a
-      # `notification` key) and returned at the top level in responses.
-      sig { returns(Courier::NotificationTemplatePayload) }
+      # Template fields accepted in POST and PUT request bodies, nested under a
+      # `notification` key.
+      sig { returns(Courier::NotificationTemplateWritePayload) }
       attr_reader :notification
 
       sig do
-        params(notification: Courier::NotificationTemplatePayload::OrHash).void
+        params(
+          notification: Courier::NotificationTemplateWritePayload::OrHash
+        ).void
       end
       attr_writer :notification
 
@@ -40,13 +42,13 @@ module Courier
       # Request body for creating a notification template.
       sig do
         params(
-          notification: Courier::NotificationTemplatePayload::OrHash,
+          notification: Courier::NotificationTemplateWritePayload::OrHash,
           state: Courier::NotificationTemplateCreateRequest::State::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
-        # Core template fields used in POST and PUT request bodies (nested under a
-        # `notification` key) and returned at the top level in responses.
+        # Template fields accepted in POST and PUT request bodies, nested under a
+        # `notification` key.
         notification:,
         # Template state after creation. Case-insensitive input, normalized to uppercase
         # in the response. Defaults to "DRAFT".
@@ -57,7 +59,7 @@ module Courier
       sig do
         override.returns(
           {
-            notification: Courier::NotificationTemplatePayload,
+            notification: Courier::NotificationTemplateWritePayload,
             state: Courier::NotificationTemplateCreateRequest::State::OrSymbol
           }
         )

data/rbi/courier/models/notification_template_response.rbi

@@ -29,6 +29,17 @@ module Courier
       end
       attr_accessor :state
 
+      # A template's send-time alias as returned by a read, omitted entirely when it has
+      # none. Usually a single string; an array for a template that resolves from
+      # several aliases, which writes through this API can no longer produce — only
+      # templates predating that restriction, or aliases attached outside this API, hold
+      # more than one.
+      sig { returns(T.nilable(Courier::NotificationTemplateAlias::Variants)) }
+      attr_reader :alias_
+
+      sig { params(alias_: Courier::NotificationTemplateAlias::Variants).void }
+      attr_writer :alias_
+
       # Epoch milliseconds of last update.
       sig { returns(T.nilable(Integer)) }
       attr_reader :updated
@@ -51,6 +62,7 @@ module Courier
           created: Integer,
           creator: String,
           state: Courier::NotificationTemplateResponse::State::OrSymbol,
+          alias_: Courier::NotificationTemplateAlias::Variants,
           updated: Integer,
           updater: String
         ).returns(T.attached_class)
@@ -64,6 +76,12 @@ module Courier
         creator:,
         # The template state. Always uppercase.
         state:,
+        # A template's send-time alias as returned by a read, omitted entirely when it has
+        # none. Usually a single string; an array for a template that resolves from
+        # several aliases, which writes through this API can no longer produce — only
+        # templates predating that restriction, or aliases attached outside this API, hold
+        # more than one.
+        alias_: nil,
         # Epoch milliseconds of last update.
         updated: nil,
         # User ID of the last updater.
@@ -78,6 +96,7 @@ module Courier
             created: Integer,
             creator: String,
             state: Courier::NotificationTemplateResponse::State::TaggedSymbol,
+            alias_: Courier::NotificationTemplateAlias::Variants,
             updated: Integer,
             updater: String
           }

data/rbi/courier/models/notification_template_update_request.rbi

@@ -11,13 +11,15 @@ module Courier
           )
         end
 
-      # Core template fields used in POST and PUT request bodies (nested under a
-      # `notification` key) and returned at the top level in responses.
-      sig { returns(Courier::NotificationTemplatePayload) }
+      # Template fields accepted in POST and PUT request bodies, nested under a
+      # `notification` key.
+      sig { returns(Courier::NotificationTemplateWritePayload) }
       attr_reader :notification
 
       sig do
-        params(notification: Courier::NotificationTemplatePayload::OrHash).void
+        params(
+          notification: Courier::NotificationTemplateWritePayload::OrHash
+        ).void
       end
       attr_writer :notification
 
@@ -38,16 +40,17 @@ module Courier
       attr_writer :state
 
       # Request body for replacing a notification template. Same shape as create. All
-      # fields required (PUT = full replacement).
+      # fields required (PUT = full replacement), except `alias`, whose omission means
+      # "leave the existing aliases alone".
       sig do
         params(
-          notification: Courier::NotificationTemplatePayload::OrHash,
+          notification: Courier::NotificationTemplateWritePayload::OrHash,
           state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
         ).returns(T.attached_class)
       end
       def self.new(
-        # Core template fields used in POST and PUT request bodies (nested under a
-        # `notification` key) and returned at the top level in responses.
+        # Template fields accepted in POST and PUT request bodies, nested under a
+        # `notification` key.
         notification:,
         # Template state after update. Case-insensitive input, normalized to uppercase in
         # the response. Defaults to "DRAFT".
@@ -58,7 +61,7 @@ module Courier
       sig do
         override.returns(
           {
-            notification: Courier::NotificationTemplatePayload,
+            notification: Courier::NotificationTemplateWritePayload,
             state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
           }
         )

data/rbi/courier/models/notification_template_write_payload.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateWritePayload < Courier::Models::NotificationTemplatePayload
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateWritePayload,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Send-time alias for this template — the value you pass as `event` to POST /send.
+      # Writes accept a single alias only. Optional, with three distinct meanings. Omit
+      # it to leave any existing aliases untouched. Send a string to make this the
+      # template's only alias — a template that already resolved from several aliases
+      # keeps just this one and the rest are detached. Send null to remove every alias
+      # from the template. An alias may not be claimed by another template — doing so
+      # returns 409 — and may not begin with "tenant/".
+      sig { returns(T.nilable(String)) }
+      attr_accessor :alias_
+
+      # Template fields accepted in POST and PUT request bodies, nested under a
+      # `notification` key.
+      sig { params(alias_: T.nilable(String)).returns(T.attached_class) }
+      def self.new(
+        # Send-time alias for this template — the value you pass as `event` to POST /send.
+        # Writes accept a single alias only. Optional, with three distinct meanings. Omit
+        # it to leave any existing aliases untouched. Send a string to make this the
+        # template's only alias — a template that already resolved from several aliases
+        # keeps just this one and the rest are detached. Send null to remove every alias
+        # from the template. An alias may not be claimed by another template — doing so
+        # returns 409 — and may not begin with "tenant/".
+        alias_: nil
+      )
+      end
+
+      sig { override.returns({ alias_: T.nilable(String) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -106,6 +106,16 @@ module Courier
 
   BroadcastUpdateParams = Courier::Models::BroadcastUpdateParams
 
+  BulkAddUsersParams = Courier::Models::BulkAddUsersParams
+
+  BulkCreateJobParams = Courier::Models::BulkCreateJobParams
+
+  BulkListUsersParams = Courier::Models::BulkListUsersParams
+
+  BulkRetrieveJobParams = Courier::Models::BulkRetrieveJobParams
+
+  BulkRunJobParams = Courier::Models::BulkRunJobParams
+
   CancelJourneyRequest = Courier::Models::CancelJourneyRequest
 
   CancelJourneyResponse = Courier::Models::CancelJourneyResponse
@@ -178,6 +188,10 @@ module Courier
 
   Icons = Courier::Models::Icons
 
+  InboundBulkMessage = Courier::Models::InboundBulkMessage
+
+  InboundBulkMessageUser = Courier::Models::InboundBulkMessageUser
+
   InboundTrackEventParams = Courier::Models::InboundTrackEventParams
 
   Intercom = Courier::Models::Intercom
@@ -378,6 +392,8 @@ module Courier
 
   Notifications = Courier::Models::Notifications
 
+  NotificationTemplateAlias = Courier::Models::NotificationTemplateAlias
+
   NotificationTemplateCreateRequest =
     Courier::Models::NotificationTemplateCreateRequest
 
@@ -398,6 +414,9 @@ module Courier
   NotificationTemplateVersionListResponse =
     Courier::Models::NotificationTemplateVersionListResponse
 
+  NotificationTemplateWritePayload =
+    Courier::Models::NotificationTemplateWritePayload
+
   Pagerduty = Courier::Models::Pagerduty
 
   PagerdutyRecipient = Courier::Models::PagerdutyRecipient