trycourier 4.16.0 → 4.17.1

data/rbi/courier/models/workspace_preferences/topic_list_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      class TopicListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::WorkspacePreferences::TopicListParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :section_id
+
+        sig do
+          params(
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(section_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { section_id: String, request_options: Courier::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/workspace_preferences/topic_replace_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    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::WorkspacePreferences::TopicReplaceParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :section_id
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        sig do
+          params(
+            section_id: String,
+            topic_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(section_id:, topic_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              section_id: String,
+              topic_id: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/workspace_preferences/topic_retrieve_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    module WorkspacePreferences
+      class TopicRetrieveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::WorkspacePreferences::TopicRetrieveParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :section_id
+
+        sig { returns(String) }
+        attr_accessor :topic_id
+
+        sig do
+          params(
+            section_id: String,
+            topic_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(section_id:, topic_id:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              section_id: String,
+              topic_id: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models.rbi

@@ -411,6 +411,8 @@ module Courier
 
   ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
+
   PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest
@@ -533,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/workspace_preferences/topics.rbi

@@ -0,0 +1,152 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class WorkspacePreferences
+      class Topics
+        # 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::WorkspacePreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::WorkspacePreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+                ]
+              ),
+            include_unsubscribe_header: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+            topic_data: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
+        end
+        def create(
+          # 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:,
+          # Human-readable name for the preference topic.
+          name:,
+          # Preference controls a recipient may customize for this topic. Defaults to empty
+          # if omitted.
+          allowed_preferences: nil,
+          # Whether to include a list-unsubscribe header on emails for this topic.
+          include_unsubscribe_header: nil,
+          # Default channels delivered for this topic. Defaults to empty if omitted.
+          routing_options: nil,
+          # Arbitrary metadata associated with the topic.
+          topic_data: nil,
+          request_options: {}
+        )
+        end
+
+        # 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::WorkspacePreferenceTopicGetResponse)
+        end
+        def retrieve(
+          # Id of the subscription preference topic.
+          topic_id,
+          # Id of the workspace preference.
+          section_id:,
+          request_options: {}
+        )
+        end
+
+        # List the topics in a workspace preference.
+        sig do
+          params(
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::WorkspacePreferenceTopicListResponse)
+        end
+        def list(
+          # Id of the workspace preference.
+          section_id,
+          request_options: {}
+        )
+        end
+
+        # Archive a topic and remove it from its workspace preference. Same 404 rules as
+        # GET.
+        sig do
+          params(
+            topic_id: String,
+            section_id: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).void
+        end
+        def archive(
+          # Id of the subscription preference topic.
+          topic_id,
+          # Id of the workspace preference.
+          section_id:,
+          request_options: {}
+        )
+        end
+
+        # 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::WorkspacePreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::WorkspacePreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+                ]
+              ),
+            include_unsubscribe_header: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+            topic_data: T.nilable(T::Hash[Symbol, T.anything]),
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(Courier::WorkspacePreferenceTopicGetResponse)
+        end
+        def replace(
+          # Path param: Id of the subscription preference topic.
+          topic_id,
+          # Path param: Id of the workspace preference.
+          section_id:,
+          # Body param: The default subscription status applied when a recipient has not set
+          # their own.
+          default_status:,
+          # Body param: Human-readable name for the preference topic.
+          name:,
+          # Body param: Preference controls a recipient may customize. Omit to clear.
+          allowed_preferences: nil,
+          # Body param: Whether to include a list-unsubscribe header on emails for this
+          # topic.
+          include_unsubscribe_header: nil,
+          # Body param: Default channels delivered for this topic. Omit to clear.
+          routing_options: nil,
+          # Body param: Arbitrary metadata associated with the topic. Omit to clear.
+          topic_data: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Courier::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/courier/resources/workspace_preferences.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Courier
+  module Resources
+    class WorkspacePreferences
+      sig { returns(Courier::Resources::WorkspacePreferences::Topics) }
+      attr_reader :topics
+
+      # 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(
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::WorkspacePreferenceGetResponse)
+      end
+      def create(
+        # Human-readable name for the workspace preference.
+        name:,
+        # Whether the workspace preference defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the workspace preference. Defaults to empty if omitted.
+        routing_options: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieve a workspace preference by id, including its topics.
+      sig do
+        params(
+          section_id: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::WorkspacePreferenceGetResponse)
+      end
+      def retrieve(
+        # Id of the workspace preference.
+        section_id,
+        request_options: {}
+      )
+      end
+
+      # 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::WorkspacePreferenceListResponse
+        )
+      end
+      def list(request_options: {})
+      end
+
+      # 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,
+          request_options: Courier::RequestOptions::OrHash
+        ).void
+      end
+      def archive(
+        # Id of the workspace preference.
+        section_id,
+        request_options: {}
+      )
+      end
+
+      # 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
+        )
+      end
+      def publish(request_options: {})
+      end
+
+      # 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,
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::WorkspacePreferenceGetResponse)
+      end
+      def replace(
+        # Id of the workspace preference.
+        section_id,
+        # Human-readable name for the workspace preference.
+        name:,
+        # Whether the workspace preference defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the workspace preference. Omit to clear.
+        routing_options: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Courier::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/sig/courier/client.rbs

@@ -42,6 +42,8 @@ module Courier
 
     attr_reader routing_strategies: Courier::Resources::RoutingStrategies
 
+    attr_reader workspace_preferences: Courier::Resources::WorkspacePreferences
+
     attr_reader profiles: Courier::Resources::Profiles
 
     attr_reader tenants: Courier::Resources::Tenants

data/sig/courier/models/publish_preferences_response.rbs

@@ -0,0 +1,40 @@
+module Courier
+  module Models
+    type publish_preferences_response =
+      {
+        page_id: String,
+        published_at: String,
+        published_version: Float,
+        preview_url: String?,
+        published_by: String?
+      }
+
+    class PublishPreferencesResponse < Courier::Internal::Type::BaseModel
+      attr_accessor page_id: String
+
+      attr_accessor published_at: String
+
+      attr_accessor published_version: Float
+
+      attr_accessor preview_url: String?
+
+      attr_accessor published_by: String?
+
+      def initialize: (
+        page_id: String,
+        published_at: String,
+        published_version: Float,
+        ?preview_url: String?,
+        ?published_by: String?
+      ) -> void
+
+      def to_hash: -> {
+        page_id: String,
+        published_at: String,
+        published_version: Float,
+        preview_url: String?,
+        published_by: String?
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_archive_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type workspace_preference_archive_params =
+      { section_id: String } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      attr_accessor section_id: String
+
+      def initialize: (
+        section_id: String,
+        ?request_options: Courier::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        section_id: String,
+        request_options: Courier::RequestOptions
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_create_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type workspace_preference_create_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_create_request.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type workspace_preference_create_request =
+      {
+        name: String,
+        has_custom_routing: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?
+      }
+
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
+      attr_accessor name: String
+
+      attr_accessor has_custom_routing: bool?
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
+
+      def initialize: (
+        name: String,
+        ?has_custom_routing: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        has_custom_routing: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_get_response.rbs

@@ -0,0 +1,60 @@
+module Courier
+  module Models
+    type workspace_preference_get_response =
+      {
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
+        creator: String?,
+        updated: String?,
+        updater: String?
+      }
+
+    class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created: String
+
+      attr_accessor has_custom_routing: bool
+
+      attr_accessor name: String
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]
+
+      attr_accessor topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse]
+
+      attr_accessor creator: String?
+
+      attr_accessor updated: String?
+
+      attr_accessor updater: String?
+
+      def initialize: (
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
+        ?creator: String?,
+        ?updated: String?,
+        ?updater: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        created: String,
+        has_custom_routing: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
+        creator: String?,
+        updated: String?,
+        updater: String?
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_list_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type workspace_preference_list_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Courier::request_opts) -> void
+
+      def to_hash: -> { request_options: Courier::RequestOptions }
+    end
+  end
+end