trycourier 4.22.0 → 4.23.0

data/lib/courier/models.rb

@@ -113,6 +113,34 @@ module Courier
 
   BrandUpdateParams = Courier::Models::BrandUpdateParams
 
+  Broadcast = Courier::Models::Broadcast
+
+  BroadcastArchiveParams = Courier::Models::BroadcastArchiveParams
+
+  BroadcastCancelParams = Courier::Models::BroadcastCancelParams
+
+  BroadcastCreateParams = Courier::Models::BroadcastCreateParams
+
+  BroadcastDuplicateParams = Courier::Models::BroadcastDuplicateParams
+
+  BroadcastListParams = Courier::Models::BroadcastListParams
+
+  BroadcastListResponse = Courier::Models::BroadcastListResponse
+
+  BroadcastPutContentParams = Courier::Models::BroadcastPutContentParams
+
+  BroadcastRetrieveContentParams = Courier::Models::BroadcastRetrieveContentParams
+
+  BroadcastRetrieveParams = Courier::Models::BroadcastRetrieveParams
+
+  BroadcastSchedule = Courier::Models::BroadcastSchedule
+
+  BroadcastScheduleParams = Courier::Models::BroadcastScheduleParams
+
+  BroadcastSendParams = Courier::Models::BroadcastSendParams
+
+  BroadcastUpdateParams = Courier::Models::BroadcastUpdateParams
+
   CancelJourneyRequest = Courier::Models::CancelJourneyRequest
 
   CancelJourneyResponse = Courier::Models::CancelJourneyResponse
@@ -127,6 +155,8 @@ module Courier
 
   Check = Courier::Models::Check
 
+  CreateBroadcastRequest = Courier::Models::CreateBroadcastRequest
+
   CreateJourneyRequest = Courier::Models::CreateJourneyRequest
 
   DefaultPreferences = Courier::Models::DefaultPreferences
@@ -474,6 +504,10 @@ module Courier
 
   Rule = Courier::Models::Rule
 
+  ScheduleBroadcastRequest = Courier::Models::ScheduleBroadcastRequest
+
+  SendBroadcastRequest = Courier::Models::SendBroadcastRequest
+
   SendDirectMessage = Courier::Models::SendDirectMessage
 
   SendMessageParams = Courier::Models::SendMessageParams
@@ -536,6 +570,8 @@ module Courier
 
   TranslationUpdateParams = Courier::Models::TranslationUpdateParams
 
+  UpdateBroadcastRequest = Courier::Models::UpdateBroadcastRequest
+
   UserProfile = Courier::Models::UserProfile
 
   UserProfileFirebaseToken = Courier::Models::UserProfileFirebaseToken

data/lib/courier/resources/broadcasts.rb

@@ -0,0 +1,290 @@
+# frozen_string_literal: true
+
+module Courier
+  module Resources
+    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.
+      #
+      # @overload create(channel:, name:, request_options: {})
+      #
+      # @param channel [Symbol, Courier::Models::CreateBroadcastRequest::Channel] The single delivery channel for this broadcast.
+      #
+      # @param name [String] Human-readable name.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastCreateParams
+      def create(params)
+        parsed, options = Courier::BroadcastCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "broadcasts",
+          body: parsed,
+          model: Courier::Broadcast,
+          options: options
+        )
+      end
+
+      # Retrieve a broadcast by ID. Archived broadcasts return 404.
+      #
+      # @overload retrieve(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastRetrieveParams
+      def retrieve(broadcast_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["broadcasts/%1$s", broadcast_id],
+          model: Courier::Broadcast,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a broadcast's name. Content is edited via the broadcast's notification
+      # template, not this endpoint.
+      #
+      # @overload update(broadcast_id, name:, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param name [String] New human-readable name.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastUpdateParams
+      def update(broadcast_id, params)
+        parsed, options = Courier::BroadcastUpdateParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["broadcasts/%1$s", broadcast_id],
+          body: parsed,
+          model: Courier::Broadcast,
+          options: options
+        )
+      end
+
+      # List broadcasts in your workspace. Cursor-paginated; returns broadcasts
+      # newest-first.
+      #
+      # @overload list(cursor: nil, limit: nil, request_options: {})
+      #
+      # @param cursor [String, nil] Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      # @param limit [Integer] Maximum number of results per page.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::BroadcastListResponse]
+      #
+      # @see Courier::Models::BroadcastListParams
+      def list(params = {})
+        parsed, options = Courier::BroadcastListParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "broadcasts",
+          query: query,
+          model: Courier::BroadcastListResponse,
+          options: options
+        )
+      end
+
+      # Archive a broadcast. This is a soft delete — the archived broadcast is returned
+      # and no longer appears in list results.
+      #
+      # @overload archive(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastArchiveParams
+      def archive(broadcast_id, params = {})
+        @client.request(
+          method: :delete,
+          path: ["broadcasts/%1$s", broadcast_id],
+          model: Courier::Broadcast,
+          options: params[:request_options]
+        )
+      end
+
+      # Cancel a broadcast's pending schedule, returning it to the draft state. Only
+      # valid for a scheduled broadcast.
+      #
+      # @overload cancel(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastCancelParams
+      def cancel(broadcast_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["broadcasts/%1$s/cancel", broadcast_id],
+          model: Courier::Broadcast,
+          options: params[:request_options]
+        )
+      end
+
+      # Duplicate a broadcast (and its template) into a new draft named "{source name}
+      # (copy)".
+      #
+      # @overload duplicate(broadcast_id, request_options: {})
+      #
+      # @param broadcast_id [String]
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastDuplicateParams
+      def duplicate(broadcast_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["broadcasts/%1$s/duplicate", broadcast_id],
+          model: Courier::Broadcast,
+          options: params[: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.
+      #
+      # @overload put_content(broadcast_id, content:, state: nil, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param content [Courier::Models::NotificationContentPutRequest::Content] Elemental content payload. The server defaults `version` when omitted.
+      #
+      # @param state [Symbol, Courier::Models::NotificationTemplateState] Template state. Defaults to `DRAFT`.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentMutationResponse]
+      #
+      # @see Courier::Models::BroadcastPutContentParams
+      def put_content(broadcast_id, params)
+        parsed, options = Courier::BroadcastPutContentParams.dump_request(params)
+        @client.request(
+          method: :put,
+          path: ["broadcasts/%1$s/content", broadcast_id],
+          body: parsed,
+          model: Courier::NotificationContentMutationResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::BroadcastRetrieveContentParams} for more details.
+      #
+      # 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.
+      #
+      # @overload retrieve_content(broadcast_id, version: nil, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param version [String] Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to `dr
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::NotificationContentGetResponse]
+      #
+      # @see Courier::Models::BroadcastRetrieveContentParams
+      def retrieve_content(broadcast_id, params = {})
+        parsed, options = Courier::BroadcastRetrieveContentParams.dump_request(params)
+        query = Courier::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: ["broadcasts/%1$s/content", broadcast_id],
+          query: query,
+          model: Courier::NotificationContentGetResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Courier::Models::BroadcastScheduleParams} for more details.
+      #
+      # 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.
+      #
+      # @overload schedule(broadcast_id, recipient_id:, recipient_type:, scheduled_to:, timezone: nil, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param recipient_id [String] ID of the target list or audience.
+      #
+      # @param recipient_type [Symbol, Courier::Models::ScheduleBroadcastRequest::RecipientType] Whether the broadcast targets a list or an audience.
+      #
+      # @param scheduled_to [String] Wall-clock timestamp of the future send, no timezone offset (e.g. "2026-07-21T20
+      #
+      # @param timezone [String] IANA timezone for the scheduled send (e.g. America/New_York).
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastScheduleParams
+      def schedule(broadcast_id, params)
+        parsed, options = Courier::BroadcastScheduleParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["broadcasts/%1$s/schedule", broadcast_id],
+          body: parsed,
+          model: Courier::Broadcast,
+          options: 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.
+      #
+      # @overload send_(broadcast_id, recipient_id:, recipient_type:, request_options: {})
+      #
+      # @param broadcast_id [String]
+      #
+      # @param recipient_id [String] ID of the target list or audience.
+      #
+      # @param recipient_type [Symbol, Courier::Models::SendBroadcastRequest::RecipientType] Whether the broadcast targets a list or an audience.
+      #
+      # @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Courier::Models::Broadcast]
+      #
+      # @see Courier::Models::BroadcastSendParams
+      def send_(broadcast_id, params)
+        parsed, options = Courier::BroadcastSendParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["broadcasts/%1$s/send", broadcast_id],
+          body: parsed,
+          model: Courier::Broadcast,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Courier::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/courier/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Courier
-  VERSION = "4.22.0"
+  VERSION = "4.23.0"
 end

data/lib/courier.rb

@@ -54,6 +54,11 @@ require_relative "courier/internal/transport/pooled_net_requester"
 require_relative "courier/client"
 require_relative "courier/models/elemental_base_node"
 require_relative "courier/models/brand_template"
+require_relative "courier/models/create_broadcast_request"
+require_relative "courier/models/notification_content_put_request"
+require_relative "courier/models/schedule_broadcast_request"
+require_relative "courier/models/send_broadcast_request"
+require_relative "courier/models/update_broadcast_request"
 require_relative "courier/models/base_check"
 require_relative "courier/models/subscription_topic_new"
 require_relative "courier/models/elemental_channel_node"
@@ -63,7 +68,6 @@ require_relative "courier/models/journeys_invoke_request"
 require_relative "courier/models/journey_publish_request"
 require_relative "courier/models/journey_template_create_request"
 require_relative "courier/models/journey_template_publish_request"
-require_relative "courier/models/notification_content_put_request"
 require_relative "courier/models/notification_locale_put_request"
 require_relative "courier/models/journey_template_replace_request"
 require_relative "courier/models/message_details"
@@ -124,6 +128,20 @@ require_relative "courier/models/brand_settings_in_app"
 require_relative "courier/models/brand_snippet"
 require_relative "courier/models/brand_snippets"
 require_relative "courier/models/brand_update_params"
+require_relative "courier/models/broadcast"
+require_relative "courier/models/broadcast_archive_params"
+require_relative "courier/models/broadcast_cancel_params"
+require_relative "courier/models/broadcast_create_params"
+require_relative "courier/models/broadcast_duplicate_params"
+require_relative "courier/models/broadcast_list_params"
+require_relative "courier/models/broadcast_list_response"
+require_relative "courier/models/broadcast_put_content_params"
+require_relative "courier/models/broadcast_retrieve_content_params"
+require_relative "courier/models/broadcast_retrieve_params"
+require_relative "courier/models/broadcast_schedule"
+require_relative "courier/models/broadcast_schedule_params"
+require_relative "courier/models/broadcast_send_params"
+require_relative "courier/models/broadcast_update_params"
 require_relative "courier/models/cancel_journey_response"
 require_relative "courier/models/channel"
 require_relative "courier/models/channel_classification"
@@ -423,6 +441,7 @@ require_relative "courier/resources/auth"
 require_relative "courier/resources/automations"
 require_relative "courier/resources/automations/invoke"
 require_relative "courier/resources/brands"
+require_relative "courier/resources/broadcasts"
 require_relative "courier/resources/digests"
 require_relative "courier/resources/digests/schedules"
 require_relative "courier/resources/inbound"

data/rbi/courier/client.rbi

@@ -48,6 +48,9 @@ module Courier
     sig { returns(Courier::Resources::Journeys) }
     attr_reader :journeys
 
+    sig { returns(Courier::Resources::Broadcasts) }
+    attr_reader :broadcasts
+
     # Manage the logos, colors, and layout that give the templates you send a
     # consistent look.
     sig { returns(Courier::Resources::Brands) }

data/rbi/courier/models/broadcast.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Broadcast < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Broadcast, Courier::Internal::AnyHash) }
+
+      # The broadcast ID (bst\_ prefix).
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The broadcast's delivery channel.
+      sig { returns(Courier::Broadcast::Channel::TaggedSymbol) }
+      attr_accessor :channel
+
+      # ISO 8601 timestamp when the broadcast was created.
+      sig { returns(String) }
+      attr_accessor :created_at
+
+      # Actor that created the broadcast.
+      sig { returns(String) }
+      attr_accessor :created_by
+
+      # Human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Lifecycle status of the broadcast.
+      sig { returns(Courier::Broadcast::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # ISO 8601 timestamp of the last update.
+      sig { returns(String) }
+      attr_accessor :updated_at
+
+      # Actor that last updated the broadcast.
+      sig { returns(String) }
+      attr_accessor :updated_by
+
+      # ISO 8601 timestamp when the broadcast was archived, if archived.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :archived_at
+
+      # Actor that archived the broadcast, if archived.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :archived_by
+
+      # The delivery schedule and recipient targeting for a broadcast.
+      sig { returns(T.nilable(Courier::BroadcastSchedule)) }
+      attr_reader :schedule
+
+      sig do
+        params(schedule: T.nilable(Courier::BroadcastSchedule::OrHash)).void
+      end
+      attr_writer :schedule
+
+      # A broadcast — a single-channel message delivered to a known set of recipients (a
+      # list or audience).
+      sig do
+        params(
+          id: String,
+          channel: Courier::Broadcast::Channel::OrSymbol,
+          created_at: String,
+          created_by: String,
+          name: String,
+          status: Courier::Broadcast::Status::OrSymbol,
+          updated_at: String,
+          updated_by: String,
+          archived_at: T.nilable(String),
+          archived_by: T.nilable(String),
+          schedule: T.nilable(Courier::BroadcastSchedule::OrHash)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The broadcast ID (bst\_ prefix).
+        id:,
+        # The broadcast's delivery channel.
+        channel:,
+        # ISO 8601 timestamp when the broadcast was created.
+        created_at:,
+        # Actor that created the broadcast.
+        created_by:,
+        # Human-readable name.
+        name:,
+        # Lifecycle status of the broadcast.
+        status:,
+        # ISO 8601 timestamp of the last update.
+        updated_at:,
+        # Actor that last updated the broadcast.
+        updated_by:,
+        # ISO 8601 timestamp when the broadcast was archived, if archived.
+        archived_at: nil,
+        # Actor that archived the broadcast, if archived.
+        archived_by: nil,
+        # The delivery schedule and recipient targeting for a broadcast.
+        schedule: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            channel: Courier::Broadcast::Channel::TaggedSymbol,
+            created_at: String,
+            created_by: String,
+            name: String,
+            status: Courier::Broadcast::Status::TaggedSymbol,
+            updated_at: String,
+            updated_by: String,
+            archived_at: T.nilable(String),
+            archived_by: T.nilable(String),
+            schedule: T.nilable(Courier::BroadcastSchedule)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The broadcast's delivery channel.
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Broadcast::Channel) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL = T.let(:email, Courier::Broadcast::Channel::TaggedSymbol)
+        SMS = T.let(:sms, Courier::Broadcast::Channel::TaggedSymbol)
+        PUSH = T.let(:push, Courier::Broadcast::Channel::TaggedSymbol)
+        INBOX = T.let(:inbox, Courier::Broadcast::Channel::TaggedSymbol)
+        SLACK = T.let(:slack, Courier::Broadcast::Channel::TaggedSymbol)
+        MSTEAMS = T.let(:msteams, Courier::Broadcast::Channel::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::Broadcast::Channel::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # Lifecycle status of the broadcast.
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Courier::Broadcast::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT = T.let(:draft, Courier::Broadcast::Status::TaggedSymbol)
+        SCHEDULED = T.let(:scheduled, Courier::Broadcast::Status::TaggedSymbol)
+        SENDING = T.let(:sending, Courier::Broadcast::Status::TaggedSymbol)
+        SENT = T.let(:sent, Courier::Broadcast::Status::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Courier::Broadcast::Status::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_archive_params.rbi

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

data/rbi/courier/models/broadcast_cancel_params.rbi

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

data/rbi/courier/models/broadcast_create_params.rbi

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