trycourier 4.22.0 → 4.24.0

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/journey_send_node.rbi

@@ -63,8 +63,8 @@ module Courier
       # Send to the recipient. A send node sources its content from EXACTLY ONE of
       # `message.template` (a single notification template) or `experiment` (an A/B
       # split across weighted template variants) — supplying both, or neither, is
-      # rejected. Optionally override the recipient address, delay the send, or attach
-      # `data`.
+      # rejected. Optionally override the recipient address, send as a tenant, delay the
+      # send, or attach `data`.
       sig do
         params(
           message: Courier::JourneySendNode::Message::OrHash,
@@ -119,6 +119,18 @@ module Courier
             T.any(Courier::JourneySendNode::Message, Courier::Internal::AnyHash)
           end
 
+        # Tenant context for this send. Set it to deliver on behalf of one of your
+        # customers, so the message uses that tenant's brand and settings.
+        sig { returns(T.nilable(Courier::JourneySendNode::Message::Context)) }
+        attr_reader :context
+
+        sig do
+          params(
+            context: Courier::JourneySendNode::Message::Context::OrHash
+          ).void
+        end
+        attr_writer :context
+
         sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
         attr_reader :data
 
@@ -147,18 +159,28 @@ module Courier
 
         sig do
           params(
+            context: Courier::JourneySendNode::Message::Context::OrHash,
             data: T::Hash[Symbol, T.anything],
             delay: Courier::JourneySendNode::Message::Delay::OrHash,
             template: String,
             to: Courier::JourneySendNode::Message::To::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(data: nil, delay: nil, template: nil, to: nil)
+        def self.new(
+          # Tenant context for this send. Set it to deliver on behalf of one of your
+          # customers, so the message uses that tenant's brand and settings.
+          context: nil,
+          data: nil,
+          delay: nil,
+          template: nil,
+          to: nil
+        )
         end
 
         sig do
           override.returns(
             {
+              context: Courier::JourneySendNode::Message::Context,
               data: T::Hash[Symbol, T.anything],
               delay: Courier::JourneySendNode::Message::Delay,
               template: String,
@@ -169,6 +191,53 @@ module Courier
         def to_hash
         end
 
+        class Context < Courier::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Courier::JourneySendNode::Message::Context,
+                Courier::Internal::AnyHash
+              )
+            end
+
+          # The tenant to send as. Accepts either a literal tenant id (`acme-tenant`) or a
+          # whole-string mustache reference to a value the run already holds —
+          # `{{data.tenant_id}}` from the invocation payload, or `{{f1.body.tenant_id}}`
+          # from the response of an earlier fetch node with id `f1`. A reference is resolved
+          # separately on every run, so a single journey can deliver as many tenants. Two
+          # forms are rejected with `400`: mid-string interpolation such as
+          # `tenant-{{data.region}}`, and any value beginning with `refs.`, which is
+          # reserved for internal use. A reference that resolves to nothing at run time does
+          # not stop the run — the message is still sent, with no tenant context — so make
+          # sure the referenced value is always present. `GET` returns the value in the same
+          # form it was supplied.
+          sig { returns(String) }
+          attr_accessor :tenant_id
+
+          # Tenant context for this send. Set it to deliver on behalf of one of your
+          # customers, so the message uses that tenant's brand and settings.
+          sig { params(tenant_id: String).returns(T.attached_class) }
+          def self.new(
+            # The tenant to send as. Accepts either a literal tenant id (`acme-tenant`) or a
+            # whole-string mustache reference to a value the run already holds —
+            # `{{data.tenant_id}}` from the invocation payload, or `{{f1.body.tenant_id}}`
+            # from the response of an earlier fetch node with id `f1`. A reference is resolved
+            # separately on every run, so a single journey can deliver as many tenants. Two
+            # forms are rejected with `400`: mid-string interpolation such as
+            # `tenant-{{data.region}}`, and any value beginning with `refs.`, which is
+            # reserved for internal use. A reference that resolves to nothing at run time does
+            # not stop the run — the message is still sent, with no tenant context — so make
+            # sure the referenced value is always present. `GET` returns the value in the same
+            # form it was supplied.
+            tenant_id:
+          )
+          end
+
+          sig { override.returns({ tenant_id: String }) }
+          def to_hash
+          end
+        end
+
         class Delay < Courier::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

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

data/rbi/courier/models/send_broadcast_request.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module Courier
+  module Models
+    class SendBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::SendBroadcastRequest, 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::SendBroadcastRequest::RecipientType::OrSymbol) }
+      attr_accessor :recipient_type
+
+      # Request body for sending a broadcast immediately.
+      sig do
+        params(
+          recipient_id: String,
+          recipient_type: Courier::SendBroadcastRequest::RecipientType::OrSymbol
+        ).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:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            recipient_id: String,
+            recipient_type:
+              Courier::SendBroadcastRequest::RecipientType::OrSymbol
+          }
+        )
+      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::SendBroadcastRequest::RecipientType)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LIST =
+          T.let(
+            :list,
+            Courier::SendBroadcastRequest::RecipientType::TaggedSymbol
+          )
+        AUDIENCE =
+          T.let(
+            :audience,
+            Courier::SendBroadcastRequest::RecipientType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Courier::SendBroadcastRequest::RecipientType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/update_broadcast_request.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Courier
+  module Models
+    class UpdateBroadcastRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::UpdateBroadcastRequest, Courier::Internal::AnyHash)
+        end
+
+      # New human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Request body for updating a broadcast. Only the name is mutable.
+      sig { params(name: String).returns(T.attached_class) }
+      def self.new(
+        # New human-readable name.
+        name:
+      )
+      end
+
+      sig { override.returns({ name: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -77,6 +77,35 @@ 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
@@ -91,6 +120,8 @@ module Courier
 
   Check = Courier::Models::Check
 
+  CreateBroadcastRequest = Courier::Models::CreateBroadcastRequest
+
   CreateJourneyRequest = Courier::Models::CreateJourneyRequest
 
   DefaultPreferences = Courier::Models::DefaultPreferences
@@ -149,8 +180,6 @@ module Courier
 
   InboundTrackEventParams = Courier::Models::InboundTrackEventParams
 
-  Inbox = Courier::Models::Inbox
-
   Intercom = Courier::Models::Intercom
 
   IntercomRecipient = Courier::Models::IntercomRecipient
@@ -452,6 +481,10 @@ module Courier
 
   Rule = Courier::Models::Rule
 
+  ScheduleBroadcastRequest = Courier::Models::ScheduleBroadcastRequest
+
+  SendBroadcastRequest = Courier::Models::SendBroadcastRequest
+
   SendDirectMessage = Courier::Models::SendDirectMessage
 
   SendMessageParams = Courier::Models::SendMessageParams
@@ -514,6 +547,8 @@ module Courier
 
   TranslationUpdateParams = Courier::Models::TranslationUpdateParams
 
+  UpdateBroadcastRequest = Courier::Models::UpdateBroadcastRequest
+
   UserProfile = Courier::Models::UserProfile
 
   UserProfileFirebaseToken = Courier::Models::UserProfileFirebaseToken