trycourier 4.22.0 → 4.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0af9de60ad16c83c8fd9376ca8b10f3647d7673932ad891b5570534a7b061b47
-  data.tar.gz: e978830eee9f6617bcc0871ad4741b1f33af873bfa5be4f9dcb1313aae343d52
+  metadata.gz: 309ea61f0125b25e2bbafb9fc11e87220259bd66b2af26971ccb657a60f24b7c
+  data.tar.gz: 529a8bf37ffa589a91591aff67e192fe4429263ab008d0f156cdf8aca00e7933
 SHA512:
-  metadata.gz: a00a9043cbbf7ed380707868a3949fcb99ad614224411458167a8bc5d818efe799a5938eeee91f019d88f6e37e794761262f4e7d608792961b76719348c99ee5
-  data.tar.gz: '08205fc11ce3a0f9bbf3ad3fa20b17f5f8640504ce79973848d162e8be66f7b684c1f8a3d63322c79c2a6952eaccaa9b49581a659a68892bf7af5fb2cf69e961'
+  metadata.gz: cf7596a35ed847033067727fe8699e6a22fd57e927f560b8e81fb43618bc32ca5166d571782a478ba48d6b6bed7ef16878bcc842d78fb3804c81754f169d7e8e
+  data.tar.gz: f807364e550ef500ae2a837aa7fcd657d6163dd6b71b67cd303c15e09d6f308240c08470cf69b15fcdfa96e91e818d19f65a0f2ad5518881e21b33c6fe2d96d0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # 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)

data/lib/courier/client.rb

@@ -53,6 +53,9 @@ module Courier
     # @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]
@@ -184,6 +187,7 @@ 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)

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

data/lib/courier/models/broadcast_send_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#send_
+    class BroadcastSendParams < Courier::Models::SendBroadcastRequest
+      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_update_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    # @see Courier::Resources::Broadcasts#update
+    class BroadcastUpdateParams < Courier::Models::UpdateBroadcastRequest
+      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/create_broadcast_request.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class CreateBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute channel
+      #   The single delivery channel for this broadcast.
+      #
+      #   @return [Symbol, Courier::Models::CreateBroadcastRequest::Channel]
+      required :channel, enum: -> { Courier::CreateBroadcastRequest::Channel }
+
+      # @!attribute name
+      #   Human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(channel:, name:)
+      #   Request body for creating a broadcast.
+      #
+      #   @param channel [Symbol, Courier::Models::CreateBroadcastRequest::Channel] The single delivery channel for this broadcast.
+      #
+      #   @param name [String] Human-readable name.
+
+      # The single delivery channel for this broadcast.
+      #
+      # @see Courier::Models::CreateBroadcastRequest#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
+    end
+  end
+end

data/lib/courier/models/schedule_broadcast_request.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class ScheduleBroadcastRequest < 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::ScheduleBroadcastRequest::RecipientType]
+      required :recipient_type, enum: -> { Courier::ScheduleBroadcastRequest::RecipientType }
+
+      # @!attribute scheduled_to
+      #   Wall-clock timestamp of the future send, no timezone offset (e.g.
+      #   "2026-07-21T20:00:00"). The zone is given by `timezone`.
+      #
+      #   @return [String]
+      required :scheduled_to, String
+
+      # @!attribute timezone
+      #   IANA timezone for the scheduled send (e.g. America/New_York).
+      #
+      #   @return [String, nil]
+      optional :timezone, String
+
+      # @!method initialize(recipient_id:, recipient_type:, scheduled_to:, timezone: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Courier::Models::ScheduleBroadcastRequest} for more details.
+      #
+      #   Request body for scheduling a broadcast for a future send.
+      #
+      #   @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).
+
+      # Whether the broadcast targets a list or an audience.
+      #
+      # @see Courier::Models::ScheduleBroadcastRequest#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/send_broadcast_request.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class SendBroadcastRequest < 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::SendBroadcastRequest::RecipientType]
+      required :recipient_type, enum: -> { Courier::SendBroadcastRequest::RecipientType }
+
+      # @!method initialize(recipient_id:, recipient_type:)
+      #   Request body for sending a broadcast immediately.
+      #
+      #   @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.
+
+      # Whether the broadcast targets a list or an audience.
+      #
+      # @see Courier::Models::SendBroadcastRequest#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/update_broadcast_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Courier
+  module Models
+    class UpdateBroadcastRequest < Courier::Internal::Type::BaseModel
+      # @!attribute name
+      #   New human-readable name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!method initialize(name:)
+      #   Request body for updating a broadcast. Only the name is mutable.
+      #
+      #   @param name [String] New human-readable name.
+    end
+  end
+end