trycourier 4.22.0 → 4.24.0

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

data/rbi/courier/models/broadcast_duplicate_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastDuplicateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastDuplicateParams, 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_list_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastListParams, Courier::Internal::AnyHash)
+        end
+
+      # Opaque pagination cursor from a previous response. Omit for the first page.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cursor
+
+      # Maximum number of results per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      sig do
+        params(
+          cursor: T.nilable(String),
+          limit: Integer,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+
+      sig do
+        override.returns(
+          {
+            cursor: T.nilable(String),
+            limit: Integer,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_list_response.rbi

@@ -0,0 +1,39 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastListResponse, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::Broadcast]) }
+      attr_accessor :results
+
+      # Paginated list of broadcasts.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::Broadcast::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          { paging: Courier::Paging, results: T::Array[Courier::Broadcast] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_put_content_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastPutContentParams < Courier::Models::NotificationContentPutRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastPutContentParams, 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_retrieve_content_params.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastRetrieveContentParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::BroadcastRetrieveContentParams,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :broadcast_id
+
+      # Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
+      # `draft`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :version
+
+      sig { params(version: String).void }
+      attr_writer :version
+
+      sig do
+        params(
+          broadcast_id: String,
+          version: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        broadcast_id:,
+        # Accepts `draft`, `published`, or a version string (e.g. `v001`). Defaults to
+        # `draft`.
+        version: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            broadcast_id: String,
+            version: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_retrieve_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastRetrieveParams, 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_schedule.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastSchedule < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastSchedule, Courier::Internal::AnyHash)
+        end
+
+      # ID of the target list or audience.
+      sig { returns(String) }
+      attr_accessor :recipient_id
+
+      # Whether the broadcast targets a list or an audience.
+      sig { returns(Courier::BroadcastSchedule::RecipientType::TaggedSymbol) }
+      attr_accessor :recipient_type
+
+      # Wall-clock timestamp of the scheduled send, no timezone offset (e.g.
+      # "2026-07-21T20:00:00").
+      sig { returns(T.nilable(String)) }
+      attr_accessor :scheduled_to
+
+      # IANA timezone for the scheduled send (e.g. America/New_York).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :timezone
+
+      # The delivery schedule and recipient targeting for a broadcast.
+      sig do
+        params(
+          recipient_id: String,
+          recipient_type: Courier::BroadcastSchedule::RecipientType::OrSymbol,
+          scheduled_to: T.nilable(String),
+          timezone: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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 scheduled send, no timezone offset (e.g.
+        # "2026-07-21T20:00:00").
+        scheduled_to: nil,
+        # IANA timezone for the scheduled send (e.g. America/New_York).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipient_id: String,
+            recipient_type:
+              Courier::BroadcastSchedule::RecipientType::TaggedSymbol,
+            scheduled_to: T.nilable(String),
+            timezone: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Whether the broadcast targets a list or an audience.
+      module RecipientType
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::BroadcastSchedule::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(:list, Courier::BroadcastSchedule::RecipientType::TaggedSymbol)
+        AUDIENCE =
+          T.let(
+            :audience,
+            Courier::BroadcastSchedule::RecipientType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::BroadcastSchedule::RecipientType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/broadcast_schedule_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastScheduleParams < Courier::Models::ScheduleBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastScheduleParams, 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_send_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class BroadcastSendParams < Courier::Models::SendBroadcastRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::BroadcastSendParams, 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