trycourier 4.22.0 → 4.24.0

data/rbi/courier/resources/broadcasts.rbi

@@ -0,0 +1,201 @@
+# typed: strong
+
+module Courier
+  module Resources
+    # Create a one-off send to a list or audience, author its content, then send it
+    # immediately or schedule it for later.
+    class Broadcasts
+      # Create a broadcast. Provisions a private notification template for the broadcast
+      # and returns the new broadcast in the draft state. Exactly one channel is
+      # required.
+      sig do
+        params(
+          channel: Courier::CreateBroadcastRequest::Channel::OrSymbol,
+          name: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def create(
+        # The single delivery channel for this broadcast.
+        channel:,
+        # Human-readable name.
+        name:,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a broadcast by ID. Archived broadcasts return 404.
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def retrieve(broadcast_id, request_options: {})
+      end
+
+      # Update a broadcast's name. Content is edited via the broadcast's notification
+      # template, not this endpoint.
+      sig do
+        params(
+          broadcast_id: String,
+          name: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def update(
+        broadcast_id,
+        # New human-readable name.
+        name:,
+        request_options: {}
+      )
+      end
+
+      # List broadcasts in your workspace. Cursor-paginated; returns broadcasts
+      # newest-first.
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::BroadcastListResponse)
+      end
+      def list(
+        # Opaque pagination cursor from a previous response. Omit for the first page.
+        cursor: nil,
+        # Maximum number of results per page.
+        limit: nil,
+        request_options: {}
+      )
+      end
+
+      # Archive a broadcast. This is a soft delete — the archived broadcast is returned
+      # and no longer appears in list results.
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def archive(broadcast_id, request_options: {})
+      end
+
+      # Cancel a broadcast's pending schedule, returning it to the draft state. Only
+      # valid for a scheduled broadcast.
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def cancel(broadcast_id, request_options: {})
+      end
+
+      # Duplicate a broadcast (and its template) into a new draft named "{source name}
+      # (copy)".
+      sig do
+        params(
+          broadcast_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def duplicate(broadcast_id, request_options: {})
+      end
+
+      # Author the broadcast's content by replacing the draft elemental content of its
+      # private notification template. The draft is published automatically when the
+      # broadcast is sent or scheduled.
+      sig do
+        params(
+          broadcast_id: String,
+          content: Courier::NotificationContentPutRequest::Content::OrHash,
+          state: Courier::NotificationTemplateState::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationContentMutationResponse)
+      end
+      def put_content(
+        broadcast_id,
+        # Elemental content payload. The server defaults `version` when omitted.
+        content:,
+        # Template state. Defaults to `DRAFT`.
+        state: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve the broadcast's content — the elemental content of its private
+      # notification template. Defaults to the working draft, since broadcast content is
+      # authored as a draft until the broadcast is sent.
+      sig do
+        params(
+          broadcast_id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::NotificationContentGetResponse)
+      end
+      def retrieve_content(
+        broadcast_id,
+        # Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
+        # `draft`.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      # Schedule a broadcast for a future send to a list or audience. Publishes the
+      # broadcast template first. Not allowed once the broadcast is sending or sent. For
+      # an immediate send use POST /broadcasts/{broadcastId}/send.
+      sig do
+        params(
+          broadcast_id: String,
+          recipient_id: String,
+          recipient_type:
+            Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol,
+          scheduled_to: String,
+          timezone: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def schedule(
+        broadcast_id,
+        # 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,
+        request_options: {}
+      )
+      end
+
+      # Send a broadcast immediately to a list or audience. Publishes the broadcast
+      # template first. Not allowed once the broadcast is sending or sent.
+      sig do
+        params(
+          broadcast_id: String,
+          recipient_id: String,
+          recipient_type:
+            Courier::SendBroadcastRequest::RecipientType::OrSymbol,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::Broadcast)
+      end
+      def send_(
+        broadcast_id,
+        # ID of the target list or audience.
+        recipient_id:,
+        # Whether the broadcast targets a list or an audience.
+        recipient_type:,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/courier/client.rbs

@@ -24,6 +24,8 @@ module Courier
 
     attr_reader journeys: Courier::Resources::Journeys
 
+    attr_reader broadcasts: Courier::Resources::Broadcasts
+
     attr_reader brands: Courier::Resources::Brands
 
     attr_reader digests: Courier::Resources::Digests
@@ -32,8 +34,6 @@ module Courier
 
     attr_reader lists: Courier::Resources::Lists
 
-    attr_reader inbox: Courier::Resources::Inbox
-
     attr_reader messages: Courier::Resources::Messages
 
     attr_reader requests: Courier::Resources::Requests

data/sig/courier/models/broadcast.rbs

@@ -0,0 +1,98 @@
+module Courier
+  module Models
+    type broadcast =
+      {
+        id: String,
+        channel: Courier::Models::Broadcast::channel,
+        created_at: String,
+        created_by: String,
+        name: String,
+        status: Courier::Models::Broadcast::status,
+        updated_at: String,
+        updated_by: String,
+        archived_at: String?,
+        archived_by: String?,
+        schedule: Courier::BroadcastSchedule?
+      }
+
+    class Broadcast < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor channel: Courier::Models::Broadcast::channel
+
+      attr_accessor created_at: String
+
+      attr_accessor created_by: String
+
+      attr_accessor name: String
+
+      attr_accessor status: Courier::Models::Broadcast::status
+
+      attr_accessor updated_at: String
+
+      attr_accessor updated_by: String
+
+      attr_accessor archived_at: String?
+
+      attr_accessor archived_by: String?
+
+      attr_accessor schedule: Courier::BroadcastSchedule?
+
+      def initialize: (
+        id: String,
+        channel: Courier::Models::Broadcast::channel,
+        created_at: String,
+        created_by: String,
+        name: String,
+        status: Courier::Models::Broadcast::status,
+        updated_at: String,
+        updated_by: String,
+        ?archived_at: String?,
+        ?archived_by: String?,
+        ?schedule: Courier::BroadcastSchedule?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        channel: Courier::Models::Broadcast::channel,
+        created_at: String,
+        created_by: String,
+        name: String,
+        status: Courier::Models::Broadcast::status,
+        updated_at: String,
+        updated_by: String,
+        archived_at: String?,
+        archived_by: String?,
+        schedule: Courier::BroadcastSchedule?
+      }
+
+      type channel = :email | :sms | :push | :inbox | :slack | :msteams
+
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        EMAIL: :email
+        SMS: :sms
+        PUSH: :push
+        INBOX: :inbox
+        SLACK: :slack
+        MSTEAMS: :msteams
+
+        def self?.values: -> ::Array[Courier::Models::Broadcast::channel]
+      end
+
+      type status = :draft | :scheduled | :sending | :sent
+
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        DRAFT: :draft
+        SCHEDULED: :scheduled
+        SENDING: :sending
+        SENT: :sent
+
+        def self?.values: -> ::Array[Courier::Models::Broadcast::status]
+      end
+    end
+  end
+end

data/sig/courier/models/broadcast_archive_params.rbs

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

data/sig/courier/models/broadcast_cancel_params.rbs

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

data/sig/courier/models/broadcast_create_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type broadcast_create_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class BroadcastCreateParams < Courier::Models::CreateBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/broadcast_duplicate_params.rbs

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

data/sig/courier/models/broadcast_list_params.rbs

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

data/sig/courier/models/broadcast_list_response.rbs

@@ -0,0 +1,22 @@
+module Courier
+  module Models
+    type broadcast_list_response =
+      { paging: Courier::Paging, results: ::Array[Courier::Broadcast] }
+
+    class BroadcastListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor paging: Courier::Paging
+
+      attr_accessor results: ::Array[Courier::Broadcast]
+
+      def initialize: (
+        paging: Courier::Paging,
+        results: ::Array[Courier::Broadcast]
+      ) -> void
+
+      def to_hash: -> {
+        paging: Courier::Paging,
+        results: ::Array[Courier::Broadcast]
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_put_content_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_put_content_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_retrieve_content_params.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type broadcast_retrieve_content_params =
+      { broadcast_id: String, version: String }
+      & Courier::Internal::Type::request_parameters
+
+    class BroadcastRetrieveContentParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor broadcast_id: String
+
+      attr_reader version: String?
+
+      def version=: (String) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?version: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        version: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_retrieve_params.rbs

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

data/sig/courier/models/broadcast_schedule.rbs

@@ -0,0 +1,46 @@
+module Courier
+  module Models
+    type broadcast_schedule =
+      {
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        scheduled_to: String?,
+        timezone: String?
+      }
+
+    class BroadcastSchedule < Courier::Internal::Type::BaseModel
+      attr_accessor recipient_id: String
+
+      attr_accessor recipient_type: Courier::Models::BroadcastSchedule::recipient_type
+
+      attr_accessor scheduled_to: String?
+
+      attr_accessor timezone: String?
+
+      def initialize: (
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        ?scheduled_to: String?,
+        ?timezone: String?
+      ) -> void
+
+      def to_hash: -> {
+        recipient_id: String,
+        recipient_type: Courier::Models::BroadcastSchedule::recipient_type,
+        scheduled_to: String?,
+        timezone: String?
+      }
+
+      type recipient_type = :list | :audience
+
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST: :list
+        AUDIENCE: :audience
+
+        def self?.values: -> ::Array[Courier::Models::BroadcastSchedule::recipient_type]
+      end
+    end
+  end
+end

data/sig/courier/models/broadcast_schedule_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_schedule_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastScheduleParams < Courier::Models::ScheduleBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_send_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_send_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastSendParams < Courier::Models::SendBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/broadcast_update_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type broadcast_update_params =
+      { broadcast_id: String } & Courier::Internal::Type::request_parameters
+
+    class BroadcastUpdateParams < Courier::Models::UpdateBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def broadcast_id: -> String
+
+      def broadcast_id=: (String _) -> String
+
+      def initialize: (
+        broadcast_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        broadcast_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end