trycourier 4.25.0 → 4.26.1

data/rbi/courier/resources/bulk.rbi

@@ -0,0 +1,102 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class Bulk
+      # Ingest user data into a Bulk Job.
+      #
+      # **Important**: For email-based bulk jobs, each user must include `profile.email`
+      # for provider routing to work correctly. The `to.email` field is not sufficient
+      # for email provider routing.
+      sig do
+        params(
+          job_id: String,
+          users: T::Array[Courier::InboundBulkMessageUser::OrHash],
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def add_users(
+        # A unique identifier representing the bulk job
+        job_id,
+        users:,
+        request_options: {}
+      )
+      end
+
+      # Creates a new bulk job for sending messages to multiple recipients.
+      #
+      # **Required**: `message.event` (event ID or notification ID)
+      #
+      # **Optional (V2 format)**: `message.template` (notification ID) or
+      # `message.content` (Elemental content) can be provided to override the
+      # notification associated with the event.
+      sig do
+        params(
+          message: Courier::InboundBulkMessage::OrHash,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Models::BulkCreateJobResponse)
+      end
+      def create_job(
+        # 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`
+        message:,
+        request_options: {}
+      )
+      end
+
+      # Get Bulk Job Users
+      sig do
+        params(
+          job_id: String,
+          cursor: T.nilable(String),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Models::BulkListUsersResponse)
+      end
+      def list_users(
+        # A unique identifier representing the bulk job
+        job_id,
+        # A unique identifier that allows for fetching the next set of users added to the
+        # bulk job
+        cursor: nil,
+        request_options: {}
+      )
+      end
+
+      # Get a bulk job
+      sig do
+        params(
+          job_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Models::BulkRetrieveJobResponse)
+      end
+      def retrieve_job(
+        # A unique identifier representing the bulk job
+        job_id,
+        request_options: {}
+      )
+      end
+
+      # Run a bulk job
+      sig do
+        params(
+          job_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def run_job(
+        # A unique identifier representing the bulk job
+        job_id,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/courier/resources/notifications.rbi

@@ -14,7 +14,7 @@ module Courier
       # Templates are created in draft state by default.
       sig do
         params(
-          notification: Courier::NotificationTemplatePayload::OrHash,
+          notification: Courier::NotificationTemplateWritePayload::OrHash,
           state: Courier::NotificationTemplateCreateRequest::State::OrSymbol,
           idempotency_key: String,
           x_idempotency_expiration: String,
@@ -22,8 +22,8 @@ module Courier
         ).returns(Courier::NotificationTemplateResponse)
       end
       def create(
-        # Body param: Core template fields used in POST and PUT request bodies (nested
-        # under a `notification` key) and returned at the top level in responses.
+        # Body param: Template fields accepted in POST and PUT request bodies, nested
+        # under a `notification` key.
         notification:,
         # Body param: Template state after creation. Case-insensitive input, normalized to
         # uppercase in the response. Defaults to "DRAFT".
@@ -259,7 +259,7 @@ module Courier
       sig do
         params(
           id: String,
-          notification: Courier::NotificationTemplatePayload::OrHash,
+          notification: Courier::NotificationTemplateWritePayload::OrHash,
           state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol,
           request_options: Courier::RequestOptions::OrHash
         ).returns(Courier::NotificationTemplateResponse)
@@ -267,8 +267,8 @@ module Courier
       def replace(
         # Template ID (nt\_ prefix).
         id,
-        # 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".

data/rbi/courier/resources/send.rbi

@@ -6,7 +6,8 @@ module Courier
     # across every channel you have configured.
     class Send
       # Sends a message to one or more recipients and returns a requestId. Courier
-      # routes it to email, SMS, push, chat, or in-app based on your rules.
+      # routes it to email, SMS, push, chat, or in-app based on your rules. Use the
+      # returned requestId to look up delivery status via the Messages API.
       sig do
         params(
           message: Courier::SendMessageParams::Message::OrHash,

data/sig/courier/client.rbs

@@ -26,6 +26,8 @@ module Courier
 
     attr_reader broadcasts: Courier::Resources::Broadcasts
 
+    attr_reader bulk: Courier::Resources::Bulk
+
     attr_reader brands: Courier::Resources::Brands
 
     attr_reader digests: Courier::Resources::Digests

data/sig/courier/models/bulk_add_users_params.rbs

@@ -0,0 +1,28 @@
+module Courier
+  module Models
+    type bulk_add_users_params =
+      { job_id: String, users: ::Array[Courier::InboundBulkMessageUser] }
+      & Courier::Internal::Type::request_parameters
+
+    class BulkAddUsersParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor job_id: String
+
+      attr_accessor users: ::Array[Courier::InboundBulkMessageUser]
+
+      def initialize: (
+        job_id: String,
+        users: ::Array[Courier::InboundBulkMessageUser],
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        users: ::Array[Courier::InboundBulkMessageUser],
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/bulk_create_job_params.rbs

@@ -0,0 +1,24 @@
+module Courier
+  module Models
+    type bulk_create_job_params =
+      { message: Courier::InboundBulkMessage }
+      & Courier::Internal::Type::request_parameters
+
+    class BulkCreateJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor message: Courier::InboundBulkMessage
+
+      def initialize: (
+        message: Courier::InboundBulkMessage,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        message: Courier::InboundBulkMessage,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/bulk_create_job_response.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type bulk_create_job_response = { job_id: String }
+
+    class BulkCreateJobResponse < Courier::Internal::Type::BaseModel
+      attr_accessor job_id: String
+
+      def initialize: (job_id: String) -> void
+
+      def to_hash: -> { job_id: String }
+    end
+  end
+end

data/sig/courier/models/bulk_list_users_params.rbs

@@ -0,0 +1,28 @@
+module Courier
+  module Models
+    type bulk_list_users_params =
+      { job_id: String, cursor: String? }
+      & Courier::Internal::Type::request_parameters
+
+    class BulkListUsersParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor job_id: String
+
+      attr_accessor cursor: String?
+
+      def initialize: (
+        job_id: String,
+        ?cursor: String?,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        cursor: String?,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/bulk_list_users_response.rbs

@@ -0,0 +1,65 @@
+module Courier
+  module Models
+    type bulk_list_users_response =
+      {
+        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
+        paging: Courier::Paging
+      }
+
+    class BulkListUsersResponse < Courier::Internal::Type::BaseModel
+      attr_accessor items: ::Array[Courier::Models::BulkListUsersResponse::Item]
+
+      attr_accessor paging: Courier::Paging
+
+      def initialize: (
+        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
+        paging: Courier::Paging
+      ) -> void
+
+      def to_hash: -> {
+        items: ::Array[Courier::Models::BulkListUsersResponse::Item],
+        paging: Courier::Paging
+      }
+
+      type item =
+        {
+          status: Courier::Models::BulkListUsersResponse::Item::status,
+          message_id: String?
+        }
+
+      class Item < Courier::Models::InboundBulkMessageUser
+        def status: -> Courier::Models::BulkListUsersResponse::Item::status
+
+        def status=: (
+          Courier::Models::BulkListUsersResponse::Item::status _
+        ) -> Courier::Models::BulkListUsersResponse::Item::status
+
+        def message_id: -> String?
+
+        def message_id=: (String? _) -> String?
+
+        def initialize: (
+          status: Courier::Models::BulkListUsersResponse::Item::status,
+          ?message_id: String?
+        ) -> void
+
+        def to_hash: -> {
+          status: Courier::Models::BulkListUsersResponse::Item::status,
+          message_id: String?
+        }
+
+        type status = :PENDING | :ENQUEUED | :ERROR
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          PENDING: :PENDING
+          ENQUEUED: :ENQUEUED
+          ERROR: :ERROR
+
+          def self?.values: -> ::Array[Courier::Models::BulkListUsersResponse::Item::status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/bulk_retrieve_job_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type bulk_retrieve_job_params =
+      { job_id: String } & Courier::Internal::Type::request_parameters
+
+    class BulkRetrieveJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor job_id: String
+
+      def initialize: (
+        job_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/bulk_retrieve_job_response.rbs

@@ -0,0 +1,66 @@
+module Courier
+  module Models
+    type bulk_retrieve_job_response =
+      { job: Courier::Models::BulkRetrieveJobResponse::Job }
+
+    class BulkRetrieveJobResponse < Courier::Internal::Type::BaseModel
+      attr_accessor job: Courier::Models::BulkRetrieveJobResponse::Job
+
+      def initialize: (
+        job: Courier::Models::BulkRetrieveJobResponse::Job
+      ) -> void
+
+      def to_hash: -> { job: Courier::Models::BulkRetrieveJobResponse::Job }
+
+      type job =
+        {
+          definition: Courier::InboundBulkMessage,
+          enqueued: Integer,
+          failures: Integer,
+          received: Integer,
+          status: Courier::Models::BulkRetrieveJobResponse::Job::status
+        }
+
+      class Job < Courier::Internal::Type::BaseModel
+        attr_accessor definition: Courier::InboundBulkMessage
+
+        attr_accessor enqueued: Integer
+
+        attr_accessor failures: Integer
+
+        attr_accessor received: Integer
+
+        attr_accessor status: Courier::Models::BulkRetrieveJobResponse::Job::status
+
+        def initialize: (
+          definition: Courier::InboundBulkMessage,
+          enqueued: Integer,
+          failures: Integer,
+          received: Integer,
+          status: Courier::Models::BulkRetrieveJobResponse::Job::status
+        ) -> void
+
+        def to_hash: -> {
+          definition: Courier::InboundBulkMessage,
+          enqueued: Integer,
+          failures: Integer,
+          received: Integer,
+          status: Courier::Models::BulkRetrieveJobResponse::Job::status
+        }
+
+        type status = :CREATED | :PROCESSING | :COMPLETED | :ERROR
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          CREATED: :CREATED
+          PROCESSING: :PROCESSING
+          COMPLETED: :COMPLETED
+          ERROR: :ERROR
+
+          def self?.values: -> ::Array[Courier::Models::BulkRetrieveJobResponse::Job::status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/bulk_run_job_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type bulk_run_job_params =
+      { job_id: String } & Courier::Internal::Type::request_parameters
+
+    class BulkRunJobParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor job_id: String
+
+      def initialize: (
+        job_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        job_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/inbound_bulk_message.rbs

@@ -0,0 +1,58 @@
+module Courier
+  module Models
+    type inbound_bulk_message =
+      {
+        event: String,
+        brand: String?,
+        content: Courier::Models::InboundBulkMessage::content?,
+        data: ::Hash[Symbol, top]?,
+        locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
+        override: ::Hash[Symbol, top]?,
+        template: String?
+      }
+
+    class InboundBulkMessage < Courier::Internal::Type::BaseModel
+      attr_accessor event: String
+
+      attr_accessor brand: String?
+
+      attr_accessor content: Courier::Models::InboundBulkMessage::content?
+
+      attr_accessor data: ::Hash[Symbol, top]?
+
+      attr_accessor locale: ::Hash[Symbol, ::Hash[Symbol, top]]?
+
+      attr_accessor override: ::Hash[Symbol, top]?
+
+      attr_accessor template: String?
+
+      def initialize: (
+        event: String,
+        ?brand: String?,
+        ?content: Courier::Models::InboundBulkMessage::content?,
+        ?data: ::Hash[Symbol, top]?,
+        ?locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
+        ?override: ::Hash[Symbol, top]?,
+        ?template: String?
+      ) -> void
+
+      def to_hash: -> {
+        event: String,
+        brand: String?,
+        content: Courier::Models::InboundBulkMessage::content?,
+        data: ::Hash[Symbol, top]?,
+        locale: ::Hash[Symbol, ::Hash[Symbol, top]]?,
+        override: ::Hash[Symbol, top]?,
+        template: String?
+      }
+
+      type content = Courier::ElementalContentSugar | Courier::ElementalContent
+
+      module Content
+        extend Courier::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Courier::Models::InboundBulkMessage::content]
+      end
+    end
+  end
+end

data/sig/courier/models/inbound_bulk_message_user.rbs

@@ -0,0 +1,42 @@
+module Courier
+  module Models
+    type inbound_bulk_message_user =
+      {
+        data: top,
+        preferences: Courier::RecipientPreferences?,
+        profile: ::Hash[Symbol, top]?,
+        recipient: String?,
+        to: Courier::UserRecipient?
+      }
+
+    class InboundBulkMessageUser < Courier::Internal::Type::BaseModel
+      attr_reader data: top?
+
+      def data=: (top) -> top
+
+      attr_accessor preferences: Courier::RecipientPreferences?
+
+      attr_accessor profile: ::Hash[Symbol, top]?
+
+      attr_accessor recipient: String?
+
+      attr_accessor to: Courier::UserRecipient?
+
+      def initialize: (
+        ?data: top,
+        ?preferences: Courier::RecipientPreferences?,
+        ?profile: ::Hash[Symbol, top]?,
+        ?recipient: String?,
+        ?to: Courier::UserRecipient?
+      ) -> void
+
+      def to_hash: -> {
+        data: top,
+        preferences: Courier::RecipientPreferences?,
+        profile: ::Hash[Symbol, top]?,
+        recipient: String?,
+        to: Courier::UserRecipient?
+      }
+    end
+  end
+end

data/sig/courier/models/notification_template_alias.rbs

@@ -0,0 +1,13 @@
+module Courier
+  module Models
+    type notification_template_alias = String | ::Array[String]
+
+    module NotificationTemplateAlias
+      extend Courier::Internal::Type::Union
+
+      def self?.variants: -> ::Array[Courier::Models::notification_template_alias]
+
+      StringArray: Courier::Internal::Type::Converter
+    end
+  end
+end

data/sig/courier/models/notification_template_create_request.rbs

@@ -2,12 +2,12 @@ module Courier
   module Models
     type notification_template_create_request =
       {
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         state: Courier::Models::NotificationTemplateCreateRequest::state
       }
 
     class NotificationTemplateCreateRequest < Courier::Internal::Type::BaseModel
-      attr_accessor notification: Courier::NotificationTemplatePayload
+      attr_accessor notification: Courier::NotificationTemplateWritePayload
 
       attr_reader state: Courier::Models::NotificationTemplateCreateRequest::state?
 
@@ -16,12 +16,12 @@ module Courier
       ) -> Courier::Models::NotificationTemplateCreateRequest::state
 
       def initialize: (
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         ?state: Courier::Models::NotificationTemplateCreateRequest::state
       ) -> void
 
       def to_hash: -> {
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         state: Courier::Models::NotificationTemplateCreateRequest::state
       }
 

data/sig/courier/models/notification_template_response.rbs

@@ -6,6 +6,7 @@ module Courier
         created: Integer,
         creator: String,
         state: Courier::Models::NotificationTemplateResponse::state,
+        alias_: Courier::Models::notification_template_alias,
         updated: Integer,
         updater: String
       }
@@ -29,6 +30,12 @@ module Courier
         Courier::Models::NotificationTemplateResponse::state _
       ) -> Courier::Models::NotificationTemplateResponse::state
 
+      def alias_: -> Courier::Models::notification_template_alias?
+
+      def alias_=: (
+        Courier::Models::notification_template_alias _
+      ) -> Courier::Models::notification_template_alias
+
       def updated: -> Integer?
 
       def updated=: (Integer _) -> Integer
@@ -42,6 +49,7 @@ module Courier
         created: Integer,
         creator: String,
         state: Courier::Models::NotificationTemplateResponse::state,
+        ?alias_: Courier::Models::notification_template_alias,
         ?updated: Integer,
         ?updater: String
       ) -> void
@@ -51,6 +59,7 @@ module Courier
         created: Integer,
         creator: String,
         state: Courier::Models::NotificationTemplateResponse::state,
+        alias_: Courier::Models::notification_template_alias,
         updated: Integer,
         updater: String
       }

data/sig/courier/models/notification_template_update_request.rbs

@@ -2,12 +2,12 @@ module Courier
   module Models
     type notification_template_update_request =
       {
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         state: Courier::Models::NotificationTemplateUpdateRequest::state
       }
 
     class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
-      attr_accessor notification: Courier::NotificationTemplatePayload
+      attr_accessor notification: Courier::NotificationTemplateWritePayload
 
       attr_reader state: Courier::Models::NotificationTemplateUpdateRequest::state?
 
@@ -16,12 +16,12 @@ module Courier
       ) -> Courier::Models::NotificationTemplateUpdateRequest::state
 
       def initialize: (
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         ?state: Courier::Models::NotificationTemplateUpdateRequest::state
       ) -> void
 
       def to_hash: -> {
-        notification: Courier::NotificationTemplatePayload,
+        notification: Courier::NotificationTemplateWritePayload,
         state: Courier::Models::NotificationTemplateUpdateRequest::state
       }
 

data/sig/courier/models/notification_template_write_payload.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type notification_template_write_payload = { alias_: String? }
+
+    class NotificationTemplateWritePayload < Courier::Models::NotificationTemplatePayload
+      def alias_: -> String?
+
+      def alias_=: (String? _) -> String?
+
+      def initialize: (?alias_: String?) -> void
+
+      def to_hash: -> { alias_: String? }
+    end
+  end
+end