trycourier 4.22.0 → 4.23.0

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

data/rbi/courier/models/broadcast_update_params.rbi

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

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Courier
+  module Models
+    class CreateBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::CreateBroadcastRequest, Courier::Internal::AnyHash)
+        end
+
+      # The single delivery channel for this broadcast.
+      sig { returns(Courier::CreateBroadcastRequest::Channel::OrSymbol) }
+      attr_accessor :channel
+
+      # Human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Request body for creating a broadcast.
+      sig do
+        params(
+          channel: Courier::CreateBroadcastRequest::Channel::OrSymbol,
+          name: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The single delivery channel for this broadcast.
+        channel:,
+        # Human-readable name.
+        name:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            channel: Courier::CreateBroadcastRequest::Channel::OrSymbol,
+            name: String
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The single delivery channel for this broadcast.
+      module Channel
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::CreateBroadcastRequest::Channel)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL =
+          T.let(:email, Courier::CreateBroadcastRequest::Channel::TaggedSymbol)
+        SMS =
+          T.let(:sms, Courier::CreateBroadcastRequest::Channel::TaggedSymbol)
+        PUSH =
+          T.let(:push, Courier::CreateBroadcastRequest::Channel::TaggedSymbol)
+        INBOX =
+          T.let(:inbox, Courier::CreateBroadcastRequest::Channel::TaggedSymbol)
+        SLACK =
+          T.let(:slack, Courier::CreateBroadcastRequest::Channel::TaggedSymbol)
+        MSTEAMS =
+          T.let(
+            :msteams,
+            Courier::CreateBroadcastRequest::Channel::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::CreateBroadcastRequest::Channel::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/schedule_broadcast_request.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ScheduleBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ScheduleBroadcastRequest, 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 do
+        returns(Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol)
+      end
+      attr_accessor :recipient_type
+
+      # Wall-clock timestamp of the future send, no timezone offset (e.g.
+      # "2026-07-21T20:00:00"). The zone is given by `timezone`.
+      sig { returns(String) }
+      attr_accessor :scheduled_to
+
+      # IANA timezone for the scheduled send (e.g. America/New_York).
+      sig { returns(T.nilable(String)) }
+      attr_reader :timezone
+
+      sig { params(timezone: String).void }
+      attr_writer :timezone
+
+      # Request body for scheduling a broadcast for a future send.
+      sig do
+        params(
+          recipient_id: String,
+          recipient_type:
+            Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol,
+          scheduled_to: String,
+          timezone: 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 future send, no timezone offset (e.g.
+        # "2026-07-21T20:00:00"). The zone is given by `timezone`.
+        scheduled_to:,
+        # IANA timezone for the scheduled send (e.g. America/New_York).
+        timezone: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipient_id: String,
+            recipient_type:
+              Courier::ScheduleBroadcastRequest::RecipientType::OrSymbol,
+            scheduled_to: String,
+            timezone: 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::ScheduleBroadcastRequest::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(
+            :list,
+            Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+          )
+        AUDIENCE =
+          T.let(
+            :audience,
+            Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::ScheduleBroadcastRequest::RecipientType::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end