trycourier 4.21.0 → 4.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f4dccb5834ee91963f2ed28cf943aebb50d899bf774a84ed87189fe523b1eeba
-  data.tar.gz: 8630a527df2d788a325a9643a76aa4d8d26258c20e77ec9d2b52b939374b4f36
+  metadata.gz: 309ea61f0125b25e2bbafb9fc11e87220259bd66b2af26971ccb657a60f24b7c
+  data.tar.gz: 529a8bf37ffa589a91591aff67e192fe4429263ab008d0f156cdf8aca00e7933
 SHA512:
-  metadata.gz: a3ae8f118cc4b01a50bd327fb2cd17b7790aa5863fff758c0a012c83273597a89a877f8ef307cec1820556ef808b65f7e6ee3206bbcc2a2be8b06516aad32daf
-  data.tar.gz: 0544e5259f039217d1666a2272926d9bca77faa8896012f50d18bd0d042b52408384af662a8f5a1df43b4d25b94f54429babf438d5e96fd2a50d40615609a906
+  metadata.gz: cf7596a35ed847033067727fe8699e6a22fd57e927f560b8e81fb43618bc32ca5166d571782a478ba48d6b6bed7ef16878bcc842d78fb3804c81754f169d7e8e
+  data.tar.gz: f807364e550ef500ae2a837aa7fcd657d6163dd6b71b67cd303c15e09d6f308240c08470cf69b15fcdfa96e91e818d19f65a0f2ad5518881e21b33c6fe2d96d0

data/CHANGELOG.md

@@ -1,5 +1,29 @@
 # Changelog
 
+## 4.23.0 (2026-07-29)
+
+Full Changelog: [v4.22.0...v4.23.0](https://github.com/trycourier/courier-ruby/compare/v4.22.0...v4.23.0)
+
+### Features
+
+* **broadcasts:** document Broadcasts CRUD REST API ([#170](https://github.com/trycourier/courier-ruby/issues/170)) ([122e598](https://github.com/trycourier/courier-ruby/commit/122e5984cc48c30473a81fd3003c4fd899fc1cc6))
+
+## 4.22.0 (2026-07-29)
+
+Full Changelog: [v4.21.0...v4.22.0](https://github.com/trycourier/courier-ruby/compare/v4.21.0...v4.22.0)
+
+### Features
+
+* Document DELETE/PUT restore for inbox messages (C-19268) ([#175](https://github.com/trycourier/courier-ruby/issues/175)) ([36c1d01](https://github.com/trycourier/courier-ruby/commit/36c1d0116770621edfefe94781e72a8061e43781))
+* spec: rename and reorder the API reference sections ([#179](https://github.com/trycourier/courier-ruby/issues/179)) ([997010e](https://github.com/trycourier/courier-ruby/commit/997010e32d3e0aed0ac138c67a8383ba1f99d416))
+
+
+### Documentation
+
+* **openapi:** describe user topic-preference fields explicitly ([#172](https://github.com/trycourier/courier-ruby/issues/172)) ([c540bdb](https://github.com/trycourier/courier-ruby/commit/c540bdb855f180d850feeabf1a30ed4394092b50))
+* **openapi:** document Idempotency-Key header on idempotent POST endpoints ([#176](https://github.com/trycourier/courier-ruby/issues/176)) ([b76b6bb](https://github.com/trycourier/courier-ruby/commit/b76b6bbbd0e856d486037d7d140b2d934eb150ea))
+* **openapi:** rewrite operation descriptions for agents and SEO ([#174](https://github.com/trycourier/courier-ruby/issues/174)) ([8a8c25b](https://github.com/trycourier/courier-ruby/commit/8a8c25b54b9a8db2cd906ab09ac8729423fa35b8))
+
 ## 4.21.0 (2026-07-23)
 
 Full Changelog: [v4.20.0...v4.21.0](https://github.com/trycourier/courier-ruby/compare/v4.20.0...v4.21.0)

data/lib/courier/client.rb

@@ -18,60 +18,101 @@ module Courier
     # @return [String]
     attr_reader :api_key
 
+    # Send a message to one or more recipients — users, lists, audiences, or tenants —
+    # across every channel you have configured.
     # @return [Courier::Resources::Send]
     attr_reader :send_
 
+    # Define filter-based groups whose membership Courier recalculates as user
+    # profiles change.
     # @return [Courier::Resources::Audiences]
     attr_reader :audiences
 
+    # Configure the channel providers Courier delivers through, and browse the
+    # provider types it supports.
     # @return [Courier::Resources::Providers]
     attr_reader :providers
 
+    # Read the audit trail of configuration and access changes in your workspace.
     # @return [Courier::Resources::AuditEvents]
     attr_reader :audit_events
 
+    # Issue scoped, short-lived JWTs so client-side SDKs — Inbox, Preferences, and the
+    # embedded designer — can call Courier as a single user. Server-side requests
+    # authenticate with your workspace API key instead.
     # @return [Courier::Resources::Auth]
     attr_reader :auth
 
+    # Invoke a stored automation template or an ad hoc automation defined in the
+    # request.
     # @return [Courier::Resources::Automations]
     attr_reader :automations
 
+    # Build, version, publish, invoke, and cancel multi-step notification workflows,
+    # along with the templates scoped to them.
     # @return [Courier::Resources::Journeys]
     attr_reader :journeys
 
+    # @return [Courier::Resources::Broadcasts]
+    attr_reader :broadcasts
+
+    # Manage the logos, colors, and layout that give the templates you send a
+    # consistent look.
     # @return [Courier::Resources::Brands]
     attr_reader :brands
 
     # @return [Courier::Resources::Digests]
     attr_reader :digests
 
+    # Record an inbound event that triggers the journeys and automations mapped to it.
     # @return [Courier::Resources::Inbound]
     attr_reader :inbound
 
+    # Manage static groups of users that you subscribe explicitly, and send to them by
+    # list id or list pattern.
     # @return [Courier::Resources::Lists]
     attr_reader :lists
 
+    # @return [Courier::Resources::Inbox]
+    attr_reader :inbox
+
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     # @return [Courier::Resources::Messages]
     attr_reader :messages
 
+    # Look up the messages Courier has accepted, inspect their delivery history and
+    # rendered output, and cancel, resend, or archive them.
     # @return [Courier::Resources::Requests]
     attr_reader :requests
 
+    # Create, update, version, publish, and localize notification templates and their
+    # content.
     # @return [Courier::Resources::Notifications]
     attr_reader :notifications
 
+    # Define reusable channel routing and failover strategies, and see which templates
+    # use them.
     # @return [Courier::Resources::RoutingStrategies]
     attr_reader :routing_strategies
 
+    # Manage the workspace catalog of subscription topics, the sections that group
+    # them, and publishing the preference page.
     # @return [Courier::Resources::WorkspacePreferences]
     attr_reader :workspace_preferences
 
+    # Store the contact information Courier delivers to for each user — email, phone
+    # number, push tokens, and any custom data you send to.
     # @return [Courier::Resources::Profiles]
     attr_reader :profiles
 
+    # Manage tenants — the organizations, teams, or accounts your users belong to —
+    # along with their users and default preferences.
     # @return [Courier::Resources::Tenants]
     attr_reader :tenants
 
+    # Store and retrieve the translation strings Courier uses to render localized
+    # template content.
     # @return [Courier::Resources::Translations]
     attr_reader :translations
 
@@ -146,10 +187,12 @@ module Courier
       @auth = Courier::Resources::Auth.new(client: self)
       @automations = Courier::Resources::Automations.new(client: self)
       @journeys = Courier::Resources::Journeys.new(client: self)
+      @broadcasts = Courier::Resources::Broadcasts.new(client: self)
       @brands = Courier::Resources::Brands.new(client: self)
       @digests = Courier::Resources::Digests.new(client: self)
       @inbound = Courier::Resources::Inbound.new(client: self)
       @lists = Courier::Resources::Lists.new(client: self)
+      @inbox = Courier::Resources::Inbox.new(client: self)
       @messages = Courier::Resources::Messages.new(client: self)
       @requests = Courier::Resources::Requests.new(client: self)
       @notifications = Courier::Resources::Notifications.new(client: self)

data/lib/courier/models/automations/invoke_invoke_ad_hoc_params.rb

@@ -38,13 +38,25 @@ module Courier
         #   @return [String, nil]
         optional :template, String, nil?: true
 
-        # @!method initialize(automation:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(automation:, brand: nil, data: nil, profile: nil, recipient: nil, template: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param automation [Courier::Models::Automations::InvokeInvokeAdHocParams::Automation]
         #   @param brand [String, nil]
         #   @param data [Hash{Symbol=>Object}, nil]
         #   @param profile [Hash{Symbol=>Object}, nil]
         #   @param recipient [String, nil]
         #   @param template [String, nil]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
 
         class Automation < Courier::Internal::Type::BaseModel

data/lib/courier/models/automations/invoke_invoke_by_template_params.rb

@@ -38,13 +38,25 @@ module Courier
         #   @return [String, nil]
         optional :template, String, nil?: true
 
-        # @!method initialize(template_id:, recipient:, brand: nil, data: nil, profile: nil, template: nil, request_options: {})
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_idempotency_expiration
+        #
+        #   @return [String, nil]
+        optional :x_idempotency_expiration, String
+
+        # @!method initialize(template_id:, recipient:, brand: nil, data: nil, profile: nil, template: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
         #   @param template_id [String]
         #   @param recipient [String, nil]
         #   @param brand [String, nil]
         #   @param data [Hash{Symbol=>Object}, nil]
         #   @param profile [Hash{Symbol=>Object}, nil]
         #   @param template [String, nil]
+        #   @param idempotency_key [String]
+        #   @param x_idempotency_expiration [String]
         #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/courier/models/brand_create_params.rb

@@ -27,11 +27,23 @@ module Courier
       #   @return [Courier::Models::BrandSnippets, nil]
       optional :snippets, -> { Courier::BrandSnippets }, nil?: true
 
-      # @!method initialize(name:, settings:, id: nil, snippets: nil, request_options: {})
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute x_idempotency_expiration
+      #
+      #   @return [String, nil]
+      optional :x_idempotency_expiration, String
+
+      # @!method initialize(name:, settings:, id: nil, snippets: nil, idempotency_key: nil, x_idempotency_expiration: nil, request_options: {})
       #   @param name [String]
       #   @param settings [Courier::Models::BrandSettings]
       #   @param id [String, nil]
       #   @param snippets [Courier::Models::BrandSnippets, nil]
+      #   @param idempotency_key [String]
+      #   @param x_idempotency_expiration [String]
       #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/courier/models/broadcast.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#create
+    class Broadcast < Courier::Internal::Type::BaseModel
+      # @!attribute id
+      #   The broadcast ID (bst\_ prefix).
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute channel
+      #   The broadcast's delivery channel.
+      #
+      #   @return [Symbol, Courier::Models::Broadcast::Channel]
+      required :channel, enum: -> { Courier::Broadcast::Channel }
+
+      # @!attribute created_at
+      #   ISO 8601 timestamp when the broadcast was created.
+      #
+      #   @return [String]
+      required :created_at, String
+
+      # @!attribute created_by
+      #   Actor that created the broadcast.
+      #
+      #   @return [String]
+      required :created_by, String
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute status
+      #   Lifecycle status of the broadcast.
+      #
+      #   @return [Symbol, Courier::Models::Broadcast::Status]
+      required :status, enum: -> { Courier::Broadcast::Status }
+
+      # @!attribute updated_at
+      #   ISO 8601 timestamp of the last update.
+      #
+      #   @return [String]
+      required :updated_at, String
+
+      # @!attribute updated_by
+      #   Actor that last updated the broadcast.
+      #
+      #   @return [String]
+      required :updated_by, String
+
+      # @!attribute archived_at
+      #   ISO 8601 timestamp when the broadcast was archived, if archived.
+      #
+      #   @return [String, nil]
+      optional :archived_at, String, nil?: true
+
+      # @!attribute archived_by
+      #   Actor that archived the broadcast, if archived.
+      #
+      #   @return [String, nil]
+      optional :archived_by, String, nil?: true
+
+      # @!attribute schedule
+      #   The delivery schedule and recipient targeting for a broadcast.
+      #
+      #   @return [Courier::Models::BroadcastSchedule, nil]
+      optional :schedule, -> { Courier::BroadcastSchedule }, nil?: true
+
+      # @!method initialize(id:, channel:, created_at:, created_by:, name:, status:, updated_at:, updated_by:, archived_at: nil, archived_by: nil, schedule: nil)
+      #   A broadcast — a single-channel message delivered to a known set of recipients (a
+      #   list or audience).
+      #
+      #   @param id [String] The broadcast ID (bst\_ prefix).
+      #
+      #   @param channel [Symbol, Courier::Models::Broadcast::Channel] The broadcast's delivery channel.
+      #
+      #   @param created_at [String] ISO 8601 timestamp when the broadcast was created.
+      #
+      #   @param created_by [String] Actor that created the broadcast.
+      #
+      #   @param name [String] Human-readable name.
+      #
+      #   @param status [Symbol, Courier::Models::Broadcast::Status] Lifecycle status of the broadcast.
+      #
+      #   @param updated_at [String] ISO 8601 timestamp of the last update.
+      #
+      #   @param updated_by [String] Actor that last updated the broadcast.
+      #
+      #   @param archived_at [String, nil] ISO 8601 timestamp when the broadcast was archived, if archived.
+      #
+      #   @param archived_by [String, nil] Actor that archived the broadcast, if archived.
+      #
+      #   @param schedule [Courier::Models::BroadcastSchedule, nil] The delivery schedule and recipient targeting for a broadcast.
+
+      # The broadcast's delivery channel.
+      #
+      # @see Courier::Models::Broadcast#channel
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        EMAIL = :email
+        SMS = :sms
+        PUSH = :push
+        INBOX = :inbox
+        SLACK = :slack
+        MSTEAMS = :msteams
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Lifecycle status of the broadcast.
+      #
+      # @see Courier::Models::Broadcast#status
+      module Status
+        extend Courier::Internal::Type::Enum
+
+        DRAFT = :draft
+        SCHEDULED = :scheduled
+        SENDING = :sending
+        SENT = :sent
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/broadcast_archive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#archive
+    class BroadcastArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_cancel_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#cancel
+    class BroadcastCancelParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#create
+    class BroadcastCreateParams < Courier::Models::CreateBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_duplicate_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#duplicate
+    class BroadcastDuplicateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#list
+    class BroadcastListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute cursor
+      #   Opaque pagination cursor from a previous response. Omit for the first page.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute limit
+      #   Maximum number of results per page.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/courier/models/broadcast_list_response.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#list
+    class BroadcastListResponse < Courier::Internal::Type::BaseModel
+      # @!attribute paging
+      #
+      #   @return [Courier::Models::Paging]
+      required :paging, -> { Courier::Paging }
+
+      # @!attribute results
+      #
+      #   @return [Array<Courier::Models::Broadcast>]
+      required :results, -> { Courier::Internal::Type::ArrayOf[Courier::Broadcast] }
+
+      # @!method initialize(paging:, results:)
+      #   Paginated list of broadcasts.
+      #
+      #   @param paging [Courier::Models::Paging]
+      #   @param results [Array<Courier::Models::Broadcast>]
+    end
+  end
+end

data/lib/courier/models/broadcast_put_content_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#put_content
+    class BroadcastPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_retrieve_content_params.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#retrieve_content
+    class BroadcastRetrieveContentParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!attribute version
+      #   Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
+      #   `draft`.
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(broadcast_id:, version: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::BroadcastRetrieveContentParams} for more details.
+      #
+      #   @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}]
+    end
+  end
+end

data/lib/courier/models/broadcast_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#retrieve
+    class BroadcastRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/courier/models/broadcast_schedule.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class BroadcastSchedule < Courier::Internal::Type::BaseModel
+      # @!attribute recipient_id
+      #   ID of the target list or audience.
+      #
+      #   @return [String]
+      required :recipient_id, String
+
+      # @!attribute recipient_type
+      #   Whether the broadcast targets a list or an audience.
+      #
+      #   @return [Symbol, Courier::Models::BroadcastSchedule::RecipientType]
+      required :recipient_type, enum: -> { Courier::BroadcastSchedule::RecipientType }
+
+      # @!attribute scheduled_to
+      #   Wall-clock timestamp of the scheduled send, no timezone offset (e.g.
+      #   "2026-07-21T20:00:00").
+      #
+      #   @return [String, nil]
+      optional :scheduled_to, String, nil?: true
+
+      # @!attribute timezone
+      #   IANA timezone for the scheduled send (e.g. America/New_York).
+      #
+      #   @return [String, nil]
+      optional :timezone, String, nil?: true
+
+      # @!method initialize(recipient_id:, recipient_type:, scheduled_to: nil, timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::BroadcastSchedule} for more details.
+      #
+      #   The delivery schedule and recipient targeting for a broadcast.
+      #
+      #   @param recipient_id [String] ID of the target list or audience.
+      #
+      #   @param recipient_type [Symbol, Courier::Models::BroadcastSchedule::RecipientType] Whether the broadcast targets a list or an audience.
+      #
+      #   @param scheduled_to [String, nil] Wall-clock timestamp of the scheduled send, no timezone offset (e.g. "2026-07-21
+      #
+      #   @param timezone [String, nil] IANA timezone for the scheduled send (e.g. America/New_York).
+
+      # Whether the broadcast targets a list or an audience.
+      #
+      # @see Courier::Models::BroadcastSchedule#recipient_type
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        LIST = :list
+        AUDIENCE = :audience
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/courier/models/broadcast_schedule_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#schedule
+    class BroadcastScheduleParams < Courier::Models::ScheduleBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      # @!attribute broadcast_id
+      #
+      #   @return [String]
+      required :broadcast_id, String
+
+      # @!method initialize(broadcast_id:, request_options: {})
+      #   @param broadcast_id [String]
+      #   @param request_options [Courier::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end