trycourier 4.17.0 → 4.17.1

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

@@ -381,44 +381,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 +535,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/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,

data/rbi/courier/resources/{preference_sections → workspace_preferences}/topics.rbi

@@ -2,20 +2,21 @@
 
 module Courier
   module Resources
-    class PreferenceSections
+    class WorkspacePreferences
       class Topics
-        # Create a subscription preference topic inside a section. Fails with 404 if the
-        # section does not exist. The topic id is generated and returned.
+        # Create a subscription preference topic inside a workspace preference. Fails with
+        # 404 if the workspace preference does not exist. The topic id is generated and
+        # returned.
         sig do
           params(
             section_id: String,
             default_status:
-              Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+              Courier::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
             name: String,
             allowed_preferences:
               T.nilable(
                 T::Array[
-                  Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                  Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
                 ]
               ),
             include_unsubscribe_header: T.nilable(T::Boolean),
@@ -23,10 +24,10 @@ module Courier
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
             topic_data: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def create(
-          # Id of the preference section to create the topic in.
+          # Id of the workspace preference to create the topic in.
           section_id,
           # The default subscription status applied when a recipient has not set their own.
           default_status:,
@@ -45,39 +46,41 @@ module Courier
         )
         end
 
-        # Retrieve a topic within a section. Returns 404 if the section does not exist,
-        # the topic does not exist, or the topic belongs to a different section.
+        # Retrieve a topic within a workspace preference. Returns 404 if the workspace
+        # preference does not exist, the topic does not exist, or the topic belongs to a
+        # different workspace preference.
         sig do
           params(
             topic_id: String,
             section_id: String,
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def retrieve(
           # Id of the subscription preference topic.
           topic_id,
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id:,
           request_options: {}
         )
         end
 
-        # List the topics in a preference section.
+        # List the topics in a workspace preference.
         sig do
           params(
             section_id: String,
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicListResponse)
+          ).returns(Courier::WorkspacePreferenceTopicListResponse)
         end
         def list(
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id,
           request_options: {}
         )
         end
 
-        # Archive a topic and remove it from its section. Same 404 rules as GET.
+        # Archive a topic and remove it from its workspace preference. Same 404 rules as
+        # GET.
         sig do
           params(
             topic_id: String,
@@ -88,25 +91,25 @@ module Courier
         def archive(
           # Id of the subscription preference topic.
           topic_id,
-          # Id of the preference section.
+          # Id of the workspace preference.
           section_id:,
           request_options: {}
         )
         end
 
-        # Replace a topic within a section. Full document replacement; missing optional
-        # fields are cleared. Same 404 rules as GET.
+        # Replace a topic within a workspace preference. Full document replacement;
+        # missing optional fields are cleared. Same 404 rules as GET.
         sig do
           params(
             topic_id: String,
             section_id: String,
             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),
@@ -114,12 +117,12 @@ module Courier
               T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
             topic_data: T.nilable(T::Hash[Symbol, T.anything]),
             request_options: Courier::RequestOptions::OrHash
-          ).returns(Courier::PreferenceTopicGetResponse)
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
         end
         def replace(
           # Path param: Id of the subscription preference topic.
           topic_id,
-          # Path param: Id of the preference section.
+          # Path param: Id of the workspace preference.
           section_id:,
           # Body param: The default subscription status applied when a recipient has not set
           # their own.

data/rbi/courier/resources/{preference_sections.rbi → workspace_preferences.rbi}

@@ -2,12 +2,12 @@
 
 module Courier
   module Resources
-    class PreferenceSections
-      sig { returns(Courier::Resources::PreferenceSections::Topics) }
+    class WorkspacePreferences
+      sig { returns(Courier::Resources::WorkspacePreferences::Topics) }
       attr_reader :topics
 
-      # Create a preference section in your workspace. The section id is generated and
-      # returned. Topics are created inside a section via POST
+      # Create a workspace preference. The workspace preference id is generated and
+      # returned. Topics are created inside a workspace preference via POST
       # /preferences/sections/{section_id}/topics.
       sig do
         params(
@@ -16,45 +16,45 @@ module Courier
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def create(
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Defaults to empty if omitted.
+        # Default channels for the workspace preference. Defaults to empty if omitted.
         routing_options: nil,
         request_options: {}
       )
       end
 
-      # Retrieve a preference section by id, including its topics.
+      # Retrieve a workspace preference by id, including its topics.
       sig do
         params(
           section_id: String,
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def retrieve(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
         request_options: {}
       )
       end
 
-      # List the workspace's preference sections. Each section embeds its topics. Scoped
-      # to the workspace of the API key.
+      # List the workspace's preferences. Each workspace preference embeds its topics.
+      # Scoped to the workspace of the API key.
       sig do
         params(request_options: Courier::RequestOptions::OrHash).returns(
-          Courier::PreferenceSectionListResponse
+          Courier::WorkspacePreferenceListResponse
         )
       end
       def list(request_options: {})
       end
 
-      # Archive a preference section. The section must be empty: delete its topics
-      # first, otherwise the request fails with 409.
+      # Archive a workspace preference. The workspace preference must be empty: delete
+      # its topics first, otherwise the request fails with 409.
       sig do
         params(
           section_id: String,
@@ -62,15 +62,15 @@ module Courier
         ).void
       end
       def archive(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
         request_options: {}
       )
       end
 
-      # Publish the workspace's preferences page. Takes a snapshot of every section with
-      # its topics under a new published version, making the current state visible on
-      # the hosted preferences page (non-draft).
+      # Publish the workspace's preferences page. Takes a snapshot of every workspace
+      # preference with its topics under a new published version, making the current
+      # state visible on the hosted preferences page (non-draft).
       sig do
         params(request_options: Courier::RequestOptions::OrHash).returns(
           Courier::PublishPreferencesResponse
@@ -79,8 +79,8 @@ module Courier
       def publish(request_options: {})
       end
 
-      # Replace a preference section. Full document replacement; missing optional fields
-      # are cleared. Topics attached to the section are unaffected.
+      # Replace a workspace preference. Full document replacement; missing optional
+      # fields are cleared. Topics attached to the workspace preference are unaffected.
       sig do
         params(
           section_id: String,
@@ -89,16 +89,16 @@ module Courier
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
           request_options: Courier::RequestOptions::OrHash
-        ).returns(Courier::PreferenceSectionGetResponse)
+        ).returns(Courier::WorkspacePreferenceGetResponse)
       end
       def replace(
-        # Id of the preference section.
+        # Id of the workspace preference.
         section_id,
-        # Human-readable name for the section.
+        # Human-readable name for the workspace preference.
         name:,
-        # Whether the section defines custom routing for its topics.
+        # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
-        # Default channels for the section. Omit to clear.
+        # Default channels for the workspace preference. Omit to clear.
         routing_options: nil,
         request_options: {}
       )

data/sig/courier/client.rbs

@@ -42,7 +42,7 @@ module Courier
 
     attr_reader routing_strategies: Courier::Resources::RoutingStrategies
 
-    attr_reader preference_sections: Courier::Resources::PreferenceSections
+    attr_reader workspace_preferences: Courier::Resources::WorkspacePreferences
 
     attr_reader profiles: Courier::Resources::Profiles
 

data/sig/courier/models/{preference_section_retrieve_params.rbs → workspace_preference_archive_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_retrieve_params =
+    type workspace_preference_archive_params =
       { section_id: String } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/{preference_section_create_params.rbs → workspace_preference_create_params.rbs}

@@ -1,9 +1,9 @@
 module Courier
   module Models
-    type preference_section_create_params =
+    type workspace_preference_create_params =
       {  } & Courier::Internal::Type::request_parameters
 
-    class PreferenceSectionCreateParams < Courier::Models::PreferenceSectionCreateRequest
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/{preference_section_replace_request.rbs → workspace_preference_create_request.rbs}

@@ -1,13 +1,13 @@
 module Courier
   module Models
-    type preference_section_replace_request =
+    type workspace_preference_create_request =
       {
         name: String,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }
 
-    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
       attr_accessor name: String
 
       attr_accessor has_custom_routing: bool?