trycourier 6.2.0 → 6.3.0

data/rbi/courier/models/journey_send_node.rbi

@@ -151,6 +151,9 @@ module Courier
         sig { params(template: String).void }
         attr_writer :template
 
+        # Recipient override for this send. Provide exactly one of `email_override`,
+        # `phone_number_override`, `user_id_override`, `slack`, or `ms_teams` — not a
+        # combination.
         sig { returns(T.nilable(Courier::JourneySendNode::Message::To)) }
         attr_reader :to
 
@@ -173,6 +176,9 @@ module Courier
           data: nil,
           delay: nil,
           template: nil,
+          # Recipient override for this send. Provide exactly one of `email_override`,
+          # `phone_number_override`, `user_id_override`, `slack`, or `ms_teams` — not a
+          # combination.
           to: nil
         )
         end
@@ -282,28 +288,93 @@ module Courier
           sig { params(email_override: String).void }
           attr_writer :email_override
 
+          # Send to a Microsoft Teams address directly, bypassing the recipient's stored
+          # profile. Requires exactly one target: `channel_id`, `channel_name` (with
+          # `team_id`), `user_id`, or `email`. `channel_name`, `user_id`, and `email` also
+          # need at least one of `service_url` or `tenant_id` — if you provide both, they
+          # must agree. `channel_id` doesn't require tenant context to publish, but provide
+          # `service_url` or `tenant_id` anyway: sends without either have failed at
+          # delivery in testing. `conversation_id` and `reply_to_activity_id`, available on
+          # the send API's `MsTeams` profile, aren't supported here yet.
+          sig { returns(T.nilable(Courier::JourneySendNodeToMsTeams)) }
+          attr_reader :ms_teams
+
+          sig do
+            params(ms_teams: Courier::JourneySendNodeToMsTeams::OrHash).void
+          end
+          attr_writer :ms_teams
+
           sig { returns(T.nilable(String)) }
           attr_reader :phone_number_override
 
           sig { params(phone_number_override: String).void }
           attr_writer :phone_number_override
 
+          # Send to a Slack address directly, bypassing the recipient's stored profile.
+          # Requires exactly one of `channel`, `user_id`, or `email`.
+          sig do
+            returns(
+              T.nilable(
+                T.any(
+                  Courier::JourneySendNodeToSlackChannel,
+                  Courier::JourneySendNodeToSlackUserID,
+                  Courier::JourneySendNodeToSlackEmail
+                )
+              )
+            )
+          end
+          attr_reader :slack
+
+          sig do
+            params(
+              slack:
+                T.any(
+                  Courier::JourneySendNodeToSlackChannel::OrHash,
+                  Courier::JourneySendNodeToSlackUserID::OrHash,
+                  Courier::JourneySendNodeToSlackEmail::OrHash
+                )
+            ).void
+          end
+          attr_writer :slack
+
           sig { returns(T.nilable(String)) }
           attr_reader :user_id_override
 
           sig { params(user_id_override: String).void }
           attr_writer :user_id_override
 
+          # Recipient override for this send. Provide exactly one of `email_override`,
+          # `phone_number_override`, `user_id_override`, `slack`, or `ms_teams` — not a
+          # combination.
           sig do
             params(
               email_override: String,
+              ms_teams: Courier::JourneySendNodeToMsTeams::OrHash,
               phone_number_override: String,
+              slack:
+                T.any(
+                  Courier::JourneySendNodeToSlackChannel::OrHash,
+                  Courier::JourneySendNodeToSlackUserID::OrHash,
+                  Courier::JourneySendNodeToSlackEmail::OrHash
+                ),
               user_id_override: String
             ).returns(T.attached_class)
           end
           def self.new(
             email_override: nil,
+            # Send to a Microsoft Teams address directly, bypassing the recipient's stored
+            # profile. Requires exactly one target: `channel_id`, `channel_name` (with
+            # `team_id`), `user_id`, or `email`. `channel_name`, `user_id`, and `email` also
+            # need at least one of `service_url` or `tenant_id` — if you provide both, they
+            # must agree. `channel_id` doesn't require tenant context to publish, but provide
+            # `service_url` or `tenant_id` anyway: sends without either have failed at
+            # delivery in testing. `conversation_id` and `reply_to_activity_id`, available on
+            # the send API's `MsTeams` profile, aren't supported here yet.
+            ms_teams: nil,
             phone_number_override: nil,
+            # Send to a Slack address directly, bypassing the recipient's stored profile.
+            # Requires exactly one of `channel`, `user_id`, or `email`.
+            slack: nil,
             user_id_override: nil
           )
           end
@@ -312,7 +383,14 @@ module Courier
             override.returns(
               {
                 email_override: String,
+                ms_teams: Courier::JourneySendNodeToMsTeams,
                 phone_number_override: String,
+                slack:
+                  T.any(
+                    Courier::JourneySendNodeToSlackChannel,
+                    Courier::JourneySendNodeToSlackUserID,
+                    Courier::JourneySendNodeToSlackEmail
+                  ),
                 user_id_override: String
               }
             )

data/rbi/courier/models/journey_send_node_to_ms_teams.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneySendNodeToMsTeams < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::JourneySendNodeToMsTeams, Courier::Internal::AnyHash)
+        end
+
+      # Bot Framework channel ID to send to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel_id
+
+      sig { params(channel_id: String).void }
+      attr_writer :channel_id
+
+      # Teams channel name to send to. Requires `team_id`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel_name
+
+      sig { params(channel_name: String).void }
+      attr_writer :channel_name
+
+      # Email address of the Teams user to send to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :email
+
+      sig { params(email: String).void }
+      attr_writer :email
+
+      # The regional Bot Framework host for this conversation, e.g.
+      # `https://smba.trafficmanager.net/amer`. A path segment naming the Microsoft
+      # tenant may follow it and is used to derive `tenant_id` when it is not supplied
+      # directly.
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
+
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      # Microsoft Teams team ID. Required alongside `channel_name`.
+      sig { returns(T.nilable(String)) }
+      attr_reader :team_id
+
+      sig { params(team_id: String).void }
+      attr_writer :team_id
+
+      # The Microsoft (Azure AD) tenant this send targets or authenticates against.
+      # Unrelated to `message.context.tenant_id`, which is the Courier customer's own
+      # multi-tenant context.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # Microsoft Teams user ID to send to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :user_id
+
+      sig { params(user_id: String).void }
+      attr_writer :user_id
+
+      # Send to a Microsoft Teams address directly, bypassing the recipient's stored
+      # profile. Requires exactly one target: `channel_id`, `channel_name` (with
+      # `team_id`), `user_id`, or `email`. `channel_name`, `user_id`, and `email` also
+      # need at least one of `service_url` or `tenant_id` — if you provide both, they
+      # must agree. `channel_id` doesn't require tenant context to publish, but provide
+      # `service_url` or `tenant_id` anyway: sends without either have failed at
+      # delivery in testing. `conversation_id` and `reply_to_activity_id`, available on
+      # the send API's `MsTeams` profile, aren't supported here yet.
+      sig do
+        params(
+          channel_id: String,
+          channel_name: String,
+          email: String,
+          service_url: String,
+          team_id: String,
+          tenant_id: String,
+          user_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Bot Framework channel ID to send to.
+        channel_id: nil,
+        # Teams channel name to send to. Requires `team_id`.
+        channel_name: nil,
+        # Email address of the Teams user to send to.
+        email: nil,
+        # The regional Bot Framework host for this conversation, e.g.
+        # `https://smba.trafficmanager.net/amer`. A path segment naming the Microsoft
+        # tenant may follow it and is used to derive `tenant_id` when it is not supplied
+        # directly.
+        service_url: nil,
+        # Microsoft Teams team ID. Required alongside `channel_name`.
+        team_id: nil,
+        # The Microsoft (Azure AD) tenant this send targets or authenticates against.
+        # Unrelated to `message.context.tenant_id`, which is the Courier customer's own
+        # multi-tenant context.
+        tenant_id: nil,
+        # Microsoft Teams user ID to send to.
+        user_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            channel_id: String,
+            channel_name: String,
+            email: String,
+            service_url: String,
+            team_id: String,
+            tenant_id: String,
+            user_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_send_node_to_slack.rbi

@@ -0,0 +1,26 @@
+# typed: strong
+
+module Courier
+  module Models
+    # Send to a Slack address directly, bypassing the recipient's stored profile.
+    # Requires exactly one of `channel`, `user_id`, or `email`.
+    module JourneySendNodeToSlack
+      extend Courier::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Courier::JourneySendNodeToSlackChannel,
+            Courier::JourneySendNodeToSlackUserID,
+            Courier::JourneySendNodeToSlackEmail
+          )
+        end
+
+      sig do
+        override.returns(T::Array[Courier::JourneySendNodeToSlack::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_send_node_to_slack_channel.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneySendNodeToSlackChannel < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneySendNodeToSlackChannel,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Slack channel to send to, by name or ID.
+      sig { returns(String) }
+      attr_accessor :channel
+
+      # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+      # Literal values are rejected — they'd be stored permanently with no way to rotate
+      # them. Omit to use the token on the recipient's stored Slack profile.
+      sig { returns(T.nilable(String)) }
+      attr_reader :access_token
+
+      sig { params(access_token: String).void }
+      attr_writer :access_token
+
+      sig do
+        params(channel: String, access_token: String).returns(T.attached_class)
+      end
+      def self.new(
+        # Slack channel to send to, by name or ID.
+        channel:,
+        # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+        # Literal values are rejected — they'd be stored permanently with no way to rotate
+        # them. Omit to use the token on the recipient's stored Slack profile.
+        access_token: nil
+      )
+      end
+
+      sig { override.returns({ channel: String, access_token: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_send_node_to_slack_email.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneySendNodeToSlackEmail < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneySendNodeToSlackEmail,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Email address of the Slack user to send to, resolved via the workspace
+      # directory.
+      sig { returns(String) }
+      attr_accessor :email
+
+      # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+      # Literal values are rejected — they'd be stored permanently with no way to rotate
+      # them. Omit to use the token on the recipient's stored Slack profile.
+      sig { returns(T.nilable(String)) }
+      attr_reader :access_token
+
+      sig { params(access_token: String).void }
+      attr_writer :access_token
+
+      sig do
+        params(email: String, access_token: String).returns(T.attached_class)
+      end
+      def self.new(
+        # Email address of the Slack user to send to, resolved via the workspace
+        # directory.
+        email:,
+        # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+        # Literal values are rejected — they'd be stored permanently with no way to rotate
+        # them. Omit to use the token on the recipient's stored Slack profile.
+        access_token: nil
+      )
+      end
+
+      sig { override.returns({ email: String, access_token: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/journey_send_node_to_slack_user_id.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Courier
+  module Models
+    class JourneySendNodeToSlackUserID < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::JourneySendNodeToSlackUserID,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Slack user ID to send to.
+      sig { returns(String) }
+      attr_accessor :user_id
+
+      # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+      # Literal values are rejected — they'd be stored permanently with no way to rotate
+      # them. Omit to use the token on the recipient's stored Slack profile.
+      sig { returns(T.nilable(String)) }
+      attr_reader :access_token
+
+      sig { params(access_token: String).void }
+      attr_writer :access_token
+
+      sig do
+        params(user_id: String, access_token: String).returns(T.attached_class)
+      end
+      def self.new(
+        # Slack user ID to send to.
+        user_id:,
+        # A runtime reference to a Slack access token, such as `{{data.slack_token}}`.
+        # Literal values are rejected — they'd be stored permanently with no way to rotate
+        # them. Omit to use the token on the recipient's stored Slack profile.
+        access_token: nil
+      )
+      end
+
+      sig { override.returns({ user_id: String, access_token: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/ms_teams.rbi

@@ -2,6 +2,8 @@
 
 module Courier
   module Models
+    # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+    # must agree.
     module MsTeams
       extend Courier::Internal::Type::Union
 

data/rbi/courier/models/ms_teams_base_properties.rbi

@@ -8,16 +8,26 @@ module Courier
           T.any(Courier::MsTeamsBaseProperties, Courier::Internal::AnyHash)
         end
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # Tenant context shared by every MS Teams send variant. Provide at least one of
+      # `tenant_id` or `service_url`. If you provide both, they must agree — a
+      # `service_url` pointing at a different Microsoft tenant than `tenant_id` is
+      # rejected.
       sig do
         params(service_url: String, tenant_id: String).returns(T.attached_class)
       end
-      def self.new(service_url:, tenant_id:)
+      def self.new(service_url: nil, tenant_id: nil)
       end
 
       sig { override.returns({ service_url: String, tenant_id: String }) }

data/rbi/courier/models/ms_teams_recipient.rbi

@@ -8,6 +8,8 @@ module Courier
           T.any(Courier::MsTeamsRecipient, Courier::Internal::AnyHash)
         end
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         returns(
           T.any(
@@ -34,7 +36,11 @@ module Courier
             )
         ).returns(T.attached_class)
       end
-      def self.new(ms_teams:)
+      def self.new(
+        # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+        # must agree.
+        ms_teams:
+      )
       end
 
       sig do

data/rbi/courier/models/send_to_ms_teams_channel_id.rbi

@@ -11,12 +11,21 @@ module Courier
       sig { returns(String) }
       attr_accessor :channel_id
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Sends directly to a Microsoft Teams channel by its Bot Framework ID. Still
+      # provide at least one of `tenant_id` or `service_url` — sends without either have
+      # failed Bot Framework authentication in testing.
       sig do
         params(
           channel_id: String,
@@ -24,7 +33,7 @@ module Courier
           tenant_id: String
         ).returns(T.attached_class)
       end
-      def self.new(channel_id:, service_url:, tenant_id:)
+      def self.new(channel_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do

data/rbi/courier/models/send_to_ms_teams_channel_name.rbi

@@ -11,32 +11,40 @@ module Courier
       sig { returns(String) }
       attr_accessor :channel_name
 
-      sig { returns(String) }
-      attr_accessor :service_url
-
       sig { returns(String) }
       attr_accessor :team_id
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
+
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
 
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
+
+      # `team_id` is required alongside `channel_name`. Also provide at least one of
+      # `tenant_id` or `service_url`; if you provide both, they must agree.
       sig do
         params(
           channel_name: String,
-          service_url: String,
           team_id: String,
+          service_url: String,
           tenant_id: String
         ).returns(T.attached_class)
       end
-      def self.new(channel_name:, service_url:, team_id:, tenant_id:)
+      def self.new(channel_name:, team_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do
         override.returns(
           {
             channel_name: String,
-            service_url: String,
             team_id: String,
+            service_url: String,
             tenant_id: String
           }
         )

data/rbi/courier/models/send_to_ms_teams_email.rbi

@@ -11,18 +11,26 @@ module Courier
       sig { returns(String) }
       attr_accessor :email
 
-      sig { returns(String) }
-      attr_accessor :service_url
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         params(email: String, service_url: String, tenant_id: String).returns(
           T.attached_class
         )
       end
-      def self.new(email:, service_url:, tenant_id:)
+      def self.new(email:, service_url: nil, tenant_id: nil)
       end
 
       sig do

data/rbi/courier/models/send_to_ms_teams_user_id.rbi

@@ -9,25 +9,33 @@ module Courier
         end
 
       sig { returns(String) }
-      attr_accessor :service_url
+      attr_accessor :user_id
 
-      sig { returns(String) }
-      attr_accessor :tenant_id
+      sig { returns(T.nilable(String)) }
+      attr_reader :service_url
 
-      sig { returns(String) }
-      attr_accessor :user_id
+      sig { params(service_url: String).void }
+      attr_writer :service_url
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :tenant_id
+
+      sig { params(tenant_id: String).void }
+      attr_writer :tenant_id
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
-        params(service_url: String, tenant_id: String, user_id: String).returns(
+        params(user_id: String, service_url: String, tenant_id: String).returns(
           T.attached_class
         )
       end
-      def self.new(service_url:, tenant_id:, user_id:)
+      def self.new(user_id:, service_url: nil, tenant_id: nil)
       end
 
       sig do
         override.returns(
-          { service_url: String, tenant_id: String, user_id: String }
+          { user_id: String, service_url: String, tenant_id: String }
         )
       end
       def to_hash

data/rbi/courier/models/user_profile.rbi

@@ -87,6 +87,8 @@ module Courier
       sig { returns(T.nilable(String)) }
       attr_accessor :middle_name
 
+      # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+      # must agree.
       sig do
         returns(
           T.nilable(
@@ -240,6 +242,8 @@ module Courier
         intercom: nil,
         locale: nil,
         middle_name: nil,
+        # Provide at least one of `tenant_id` or `service_url`. If you provide both, they
+        # must agree.
         ms_teams: nil,
         name: nil,
         nickname: nil,

data/rbi/courier/models.rbi

@@ -288,6 +288,16 @@ module Courier
 
   JourneySendNode = Courier::Models::JourneySendNode
 
+  JourneySendNodeToMsTeams = Courier::Models::JourneySendNodeToMsTeams
+
+  JourneySendNodeToSlack = Courier::Models::JourneySendNodeToSlack
+
+  JourneySendNodeToSlackChannel = Courier::Models::JourneySendNodeToSlackChannel
+
+  JourneySendNodeToSlackEmail = Courier::Models::JourneySendNodeToSlackEmail
+
+  JourneySendNodeToSlackUserID = Courier::Models::JourneySendNodeToSlackUserID
+
   JourneysInvokeRequest = Courier::Models::JourneysInvokeRequest
 
   JourneysInvokeResponse = Courier::Models::JourneysInvokeResponse