trycourier 4.17.0 → 4.18.0

data/rbi/courier/models/{preference_topic_get_response.rbi → workspace_preference_topic_get_response.rbi}

@@ -2,10 +2,13 @@
 
 module Courier
   module Models
-    class PreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
-          T.any(Courier::PreferenceTopicGetResponse, Courier::Internal::AnyHash)
+          T.any(
+            Courier::WorkspacePreferenceTopicGetResponse,
+            Courier::Internal::AnyHash
+          )
         end
 
       # The preference topic id.
@@ -16,7 +19,7 @@ module Courier
       sig do
         returns(
           T::Array[
-            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
           ]
         )
       end
@@ -29,7 +32,7 @@ module Courier
       # The default subscription status applied when a recipient has not set their own.
       sig do
         returns(
-          Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+          Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
         )
       end
       attr_accessor :default_status
@@ -68,11 +71,11 @@ module Courier
           id: String,
           allowed_preferences:
             T::Array[
-              Courier::PreferenceTopicGetResponse::AllowedPreference::OrSymbol
+              Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::OrSymbol
             ],
           created: String,
           default_status:
-            Courier::PreferenceTopicGetResponse::DefaultStatus::OrSymbol,
+            Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::OrSymbol,
           include_unsubscribe_header: T::Boolean,
           name: String,
           routing_options: T::Array[Courier::ChannelClassification::OrSymbol],
@@ -114,11 +117,11 @@ module Courier
             id: String,
             allowed_preferences:
               T::Array[
-                Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+                Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
               ],
             created: String,
             default_status:
-              Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol,
+              Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol,
             include_unsubscribe_header: T::Boolean,
             name: String,
             routing_options:
@@ -141,7 +144,7 @@ module Courier
           T.type_alias do
             T.all(
               Symbol,
-              Courier::PreferenceTopicGetResponse::AllowedPreference
+              Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference
             )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -149,18 +152,18 @@ module Courier
         SNOOZE =
           T.let(
             :snooze,
-            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
           )
         CHANNEL_PREFERENCES =
           T.let(
             :channel_preferences,
-            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+              Courier::WorkspacePreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
             ]
           )
         end
@@ -174,30 +177,33 @@ module Courier
 
         TaggedSymbol =
           T.type_alias do
-            T.all(Symbol, Courier::PreferenceTopicGetResponse::DefaultStatus)
+            T.all(
+              Symbol,
+              Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus
+            )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         OPTED_OUT =
           T.let(
             :OPTED_OUT,
-            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
           )
         OPTED_IN =
           T.let(
             :OPTED_IN,
-            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
           )
         REQUIRED =
           T.let(
             :REQUIRED,
-            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+              Courier::WorkspacePreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
             ]
           )
         end

data/rbi/courier/models/workspace_preference_topic_list_response.rbi

@@ -0,0 +1,36 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WorkspacePreferenceTopicListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::WorkspacePreferenceTopicListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Courier::WorkspacePreferenceTopicGetResponse]) }
+      attr_accessor :results
+
+      # Topics contained in a workspace preference.
+      sig do
+        params(
+          results:
+            T::Array[Courier::WorkspacePreferenceTopicGetResponse::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(results:)
+      end
+
+      sig do
+        override.returns(
+          { results: T::Array[Courier::WorkspacePreferenceTopicGetResponse] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/{preference_topic_replace_request.rbi → workspace_preference_topic_replace_request.rbi}

@@ -2,18 +2,20 @@
 
 module Courier
   module Models
-    class PreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
-            Courier::PreferenceTopicReplaceRequest,
+            Courier::WorkspacePreferenceTopicReplaceRequest,
             Courier::Internal::AnyHash
           )
         end
 
       # The default subscription status applied when a recipient has not set their own.
       sig do
-        returns(Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol)
+        returns(
+          Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::OrSymbol
+        )
       end
       attr_accessor :default_status
 
@@ -26,7 +28,7 @@ module Courier
         returns(
           T.nilable(
             T::Array[
-              Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+              Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
             ]
           )
         )
@@ -52,12 +54,12 @@ module Courier
       sig do
         params(
           default_status:
-            Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+            Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
           name: String,
           allowed_preferences:
             T.nilable(
               T::Array[
-                Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+                Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
               ]
             ),
           include_unsubscribe_header: T.nilable(T::Boolean),
@@ -86,12 +88,12 @@ module Courier
         override.returns(
           {
             default_status:
-              Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+              Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
             name: String,
             allowed_preferences:
               T.nilable(
                 T::Array[
-                  Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+                  Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
                 ]
               ),
             include_unsubscribe_header: T.nilable(T::Boolean),
@@ -110,30 +112,33 @@ module Courier
 
         TaggedSymbol =
           T.type_alias do
-            T.all(Symbol, Courier::PreferenceTopicReplaceRequest::DefaultStatus)
+            T.all(
+              Symbol,
+              Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus
+            )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
 
         OPTED_OUT =
           T.let(
             :OPTED_OUT,
-            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
           )
         OPTED_IN =
           T.let(
             :OPTED_IN,
-            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
           )
         REQUIRED =
           T.let(
             :REQUIRED,
-            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+            Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+              Courier::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
             ]
           )
         end
@@ -149,7 +154,7 @@ module Courier
           T.type_alias do
             T.all(
               Symbol,
-              Courier::PreferenceTopicReplaceRequest::AllowedPreference
+              Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference
             )
           end
         OrSymbol = T.type_alias { T.any(Symbol, String) }
@@ -157,18 +162,18 @@ module Courier
         SNOOZE =
           T.let(
             :snooze,
-            Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
           )
         CHANNEL_PREFERENCES =
           T.let(
             :channel_preferences,
-            Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+            Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
           )
 
         sig do
           override.returns(
             T::Array[
-              Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+              Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
             ]
           )
         end

data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_archive_params.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    module PreferenceSections
+    module WorkspacePreferences
       class TopicArchiveParams < Courier::Internal::Type::BaseModel
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
@@ -10,7 +10,7 @@ module Courier
         OrHash =
           T.type_alias do
             T.any(
-              Courier::PreferenceSections::TopicArchiveParams,
+              Courier::WorkspacePreferences::TopicArchiveParams,
               Courier::Internal::AnyHash
             )
           end

data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_create_params.rbi

@@ -2,15 +2,15 @@
 
 module Courier
   module Models
-    module PreferenceSections
-      class TopicCreateParams < Courier::Models::PreferenceTopicCreateRequest
+    module WorkspacePreferences
+      class TopicCreateParams < Courier::Models::WorkspacePreferenceTopicCreateRequest
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
             T.any(
-              Courier::PreferenceSections::TopicCreateParams,
+              Courier::WorkspacePreferences::TopicCreateParams,
               Courier::Internal::AnyHash
             )
           end

data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_list_params.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    module PreferenceSections
+    module WorkspacePreferences
       class TopicListParams < Courier::Internal::Type::BaseModel
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
@@ -10,7 +10,7 @@ module Courier
         OrHash =
           T.type_alias do
             T.any(
-              Courier::PreferenceSections::TopicListParams,
+              Courier::WorkspacePreferences::TopicListParams,
               Courier::Internal::AnyHash
             )
           end

data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_replace_params.rbi

@@ -2,15 +2,15 @@
 
 module Courier
   module Models
-    module PreferenceSections
-      class TopicReplaceParams < Courier::Models::PreferenceTopicReplaceRequest
+    module WorkspacePreferences
+      class TopicReplaceParams < Courier::Models::WorkspacePreferenceTopicReplaceRequest
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
 
         OrHash =
           T.type_alias do
             T.any(
-              Courier::PreferenceSections::TopicReplaceParams,
+              Courier::WorkspacePreferences::TopicReplaceParams,
               Courier::Internal::AnyHash
             )
           end

data/rbi/courier/models/{preference_sections → workspace_preferences}/topic_retrieve_params.rbi

@@ -2,7 +2,7 @@
 
 module Courier
   module Models
-    module PreferenceSections
+    module WorkspacePreferences
       class TopicRetrieveParams < Courier::Internal::Type::BaseModel
         extend Courier::Internal::Type::RequestParameters::Converter
         include Courier::Internal::Type::RequestParameters
@@ -10,7 +10,7 @@ module Courier
         OrHash =
           T.type_alias do
             T.any(
-              Courier::PreferenceSections::TopicRetrieveParams,
+              Courier::WorkspacePreferences::TopicRetrieveParams,
               Courier::Internal::AnyHash
             )
           end

data/rbi/courier/models.rbi

@@ -87,6 +87,10 @@ module Courier
 
   BulkRunJobParams = Courier::Models::BulkRunJobParams
 
+  CancelJourneyRequest = Courier::Models::CancelJourneyRequest
+
+  CancelJourneyResponse = Courier::Models::CancelJourneyResponse
+
   Channel = Courier::Models::Channel
 
   ChannelClassification = Courier::Models::ChannelClassification
@@ -171,6 +175,8 @@ module Courier
 
   JourneyArchiveParams = Courier::Models::JourneyArchiveParams
 
+  JourneyCancelParams = Courier::Models::JourneyCancelParams
+
   JourneyConditionAtom =
     T.let(
       Courier::Models::JourneyConditionAtom,
@@ -191,6 +197,10 @@ module Courier
 
   JourneyExitNode = Courier::Models::JourneyExitNode
 
+  JourneyExperiment = Courier::Models::JourneyExperiment
+
+  JourneyExperimentVariant = Courier::Models::JourneyExperimentVariant
+
   JourneyFetchGetDeleteNode = Courier::Models::JourneyFetchGetDeleteNode
 
   JourneyFetchPostPutNode = Courier::Models::JourneyFetchPostPutNode
@@ -381,44 +391,8 @@ module Courier
 
   Preference = Courier::Models::Preference
 
-  PreferenceSectionArchiveParams =
-    Courier::Models::PreferenceSectionArchiveParams
-
-  PreferenceSectionCreateParams = Courier::Models::PreferenceSectionCreateParams
-
-  PreferenceSectionCreateRequest =
-    Courier::Models::PreferenceSectionCreateRequest
-
-  PreferenceSectionGetResponse = Courier::Models::PreferenceSectionGetResponse
-
-  PreferenceSectionListParams = Courier::Models::PreferenceSectionListParams
-
-  PreferenceSectionListResponse = Courier::Models::PreferenceSectionListResponse
-
-  PreferenceSectionPublishParams =
-    Courier::Models::PreferenceSectionPublishParams
-
-  PreferenceSectionReplaceParams =
-    Courier::Models::PreferenceSectionReplaceParams
-
-  PreferenceSectionReplaceRequest =
-    Courier::Models::PreferenceSectionReplaceRequest
-
-  PreferenceSectionRetrieveParams =
-    Courier::Models::PreferenceSectionRetrieveParams
-
-  PreferenceSections = Courier::Models::PreferenceSections
-
   PreferenceStatus = Courier::Models::PreferenceStatus
 
-  PreferenceTopicCreateRequest = Courier::Models::PreferenceTopicCreateRequest
-
-  PreferenceTopicGetResponse = Courier::Models::PreferenceTopicGetResponse
-
-  PreferenceTopicListResponse = Courier::Models::PreferenceTopicListResponse
-
-  PreferenceTopicReplaceRequest = Courier::Models::PreferenceTopicReplaceRequest
-
   ProfileCreateParams = Courier::Models::ProfileCreateParams
 
   ProfileDeleteParams = Courier::Models::ProfileDeleteParams
@@ -571,4 +545,47 @@ module Courier
   WebhookRecipient = Courier::Models::WebhookRecipient
 
   WidgetBackground = Courier::Models::WidgetBackground
+
+  WorkspacePreferenceArchiveParams =
+    Courier::Models::WorkspacePreferenceArchiveParams
+
+  WorkspacePreferenceCreateParams =
+    Courier::Models::WorkspacePreferenceCreateParams
+
+  WorkspacePreferenceCreateRequest =
+    Courier::Models::WorkspacePreferenceCreateRequest
+
+  WorkspacePreferenceGetResponse =
+    Courier::Models::WorkspacePreferenceGetResponse
+
+  WorkspacePreferenceListParams = Courier::Models::WorkspacePreferenceListParams
+
+  WorkspacePreferenceListResponse =
+    Courier::Models::WorkspacePreferenceListResponse
+
+  WorkspacePreferencePublishParams =
+    Courier::Models::WorkspacePreferencePublishParams
+
+  WorkspacePreferenceReplaceParams =
+    Courier::Models::WorkspacePreferenceReplaceParams
+
+  WorkspacePreferenceReplaceRequest =
+    Courier::Models::WorkspacePreferenceReplaceRequest
+
+  WorkspacePreferenceRetrieveParams =
+    Courier::Models::WorkspacePreferenceRetrieveParams
+
+  WorkspacePreferences = Courier::Models::WorkspacePreferences
+
+  WorkspacePreferenceTopicCreateRequest =
+    Courier::Models::WorkspacePreferenceTopicCreateRequest
+
+  WorkspacePreferenceTopicGetResponse =
+    Courier::Models::WorkspacePreferenceTopicGetResponse
+
+  WorkspacePreferenceTopicListResponse =
+    Courier::Models::WorkspacePreferenceTopicListResponse
+
+  WorkspacePreferenceTopicReplaceRequest =
+    Courier::Models::WorkspacePreferenceTopicReplaceRequest
 end

data/rbi/courier/resources/journeys.rbi

@@ -101,6 +101,31 @@ module Courier
       )
       end
 
+      # Cancel journey runs. The request body must include EXACTLY ONE of
+      # `cancelation_token` (cancels every run associated with the token) or `run_id`
+      # (cancels a single tenant-scoped run). Supplying both or neither returns a `400`.
+      # A `run_id` that does not match a run for the tenant returns `404`. Cancelation
+      # is idempotent: a run that has already finished (`PROCESSED`/`ERROR`) or was
+      # already `CANCELED` is left unchanged and its current status is returned.
+      sig do
+        params(
+          cancel_journey_request:
+            T.any(
+              Courier::CancelJourneyRequest::ByCancelationToken::OrHash,
+              Courier::CancelJourneyRequest::ByRunID::OrHash
+            ),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::CancelJourneyResponse::Variants)
+      end
+      def cancel(
+        # Request body for `POST /journeys/cancel`. Provide EXACTLY ONE of
+        # `cancelation_token` (cancels every run associated with the token) or `run_id`
+        # (cancels a single tenant-scoped run).
+        cancel_journey_request:,
+        request_options: {}
+      )
+      end
+
       # Invoke a journey by id or alias to start a new run. The response includes a
       # `runId` identifying the run.
       sig do

data/rbi/courier/resources/notifications/checks.rbi

@@ -4,7 +4,7 @@ module Courier
   module Resources
     class Notifications
       class Checks
-        # Replace the checks for a notification template submission.
+        # Replace the submission checks for a notification template.
         sig do
           params(
             submission_id: String,
@@ -24,7 +24,7 @@ module Courier
         )
         end
 
-        # Retrieve the checks for a notification template submission.
+        # Retrieve the submission checks for a notification template.
         sig do
           params(
             submission_id: String,
@@ -41,7 +41,7 @@ module Courier
         )
         end
 
-        # Cancel a notification template submission.
+        # Cancel a submission for a notification template.
         sig do
           params(
             submission_id: String,