trycourier 4.18.2 → 4.19.0

data/rbi/courier/resources/workspace_preferences.rbi

@@ -12,6 +12,7 @@ module Courier
       sig do
         params(
           name: String,
+          description: T.nilable(String),
           has_custom_routing: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -21,6 +22,8 @@ module Courier
       def create(
         # Human-readable name for the workspace preference.
         name:,
+        # Optional description shown under the section on the hosted preferences page.
+        description: nil,
         # 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.
@@ -72,11 +75,23 @@ module Courier
       # 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
-        )
+        params(
+          brand_id: T.nilable(String),
+          description: T.nilable(String),
+          heading: T.nilable(String),
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(Courier::PublishPreferencesResponse)
       end
-      def publish(request_options: {})
+      def publish(
+        # Brand for the hosted page - "default" (workspace default brand), "none" (no
+        # brand), or a specific brand id. Defaults to "default".
+        brand_id: nil,
+        # Description shown under the heading on the hosted preferences page.
+        description: nil,
+        # Heading shown at the top of the hosted preferences page.
+        heading: nil,
+        request_options: {}
+      )
       end
 
       # Replace a workspace preference. Full document replacement; missing optional
@@ -85,6 +100,7 @@ module Courier
         params(
           section_id: String,
           name: String,
+          description: T.nilable(String),
           has_custom_routing: T.nilable(T::Boolean),
           routing_options:
             T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]),
@@ -96,6 +112,9 @@ module Courier
         section_id,
         # Human-readable name for the workspace preference.
         name:,
+        # Optional description shown under the section on the hosted preferences page.
+        # Omit to clear.
+        description: nil,
         # Whether the workspace preference defines custom routing for its topics.
         has_custom_routing: nil,
         # Default channels for the workspace preference. Omit to clear.

data/sig/courier/models/publish_preferences_request.rbs

@@ -0,0 +1,26 @@
+module Courier
+  module Models
+    type publish_preferences_request =
+      { brand_id: String?, description: String?, heading: String? }
+
+    class PublishPreferencesRequest < Courier::Internal::Type::BaseModel
+      attr_accessor brand_id: String?
+
+      attr_accessor description: String?
+
+      attr_accessor heading: String?
+
+      def initialize: (
+        ?brand_id: String?,
+        ?description: String?,
+        ?heading: String?
+      ) -> void
+
+      def to_hash: -> {
+        brand_id: String?,
+        description: String?,
+        heading: String?
+      }
+    end
+  end
+end

data/sig/courier/models/users/bulk_preference_topic.rbs

@@ -0,0 +1,48 @@
+module Courier
+  module Models
+    module Users
+      type bulk_preference_topic =
+        {
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        }
+
+      class BulkPreferenceTopic < Courier::Internal::Type::BaseModel
+        attr_accessor custom_routing: ::Array[Courier::Models::channel_classification]
+
+        attr_accessor has_custom_routing: bool
+
+        attr_accessor status: Courier::Models::Users::BulkPreferenceTopic::status
+
+        attr_accessor topic_id: String
+
+        def initialize: (
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        ) -> void
+
+        def to_hash: -> {
+          custom_routing: ::Array[Courier::Models::channel_classification],
+          has_custom_routing: bool,
+          status: Courier::Models::Users::BulkPreferenceTopic::status,
+          topic_id: String
+        }
+
+        type status = :OPTED_IN | :OPTED_OUT
+
+        module Status
+          extend Courier::Internal::Type::Enum
+
+          OPTED_IN: :OPTED_IN
+          OPTED_OUT: :OPTED_OUT
+
+          def self?.values: -> ::Array[Courier::Models::Users::BulkPreferenceTopic::status]
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_replace_params.rbs

@@ -0,0 +1,87 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_replace_params =
+        {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          tenant_id: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class PreferenceBulkReplaceParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic]
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          tenant_id: String?,
+          request_options: Courier::RequestOptions
+        }
+
+        type topic =
+          {
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+        class Topic < Courier::Internal::Type::BaseModel
+          attr_accessor status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status
+
+          attr_accessor topic_id: String
+
+          attr_reader custom_routing: ::Array[Courier::Models::channel_classification]?
+
+          def custom_routing=: (
+            ::Array[Courier::Models::channel_classification]
+          ) -> ::Array[Courier::Models::channel_classification]
+
+          attr_reader has_custom_routing: bool?
+
+          def has_custom_routing=: (bool) -> bool
+
+          def initialize: (
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            ?custom_routing: ::Array[Courier::Models::channel_classification],
+            ?has_custom_routing: bool
+          ) -> void
+
+          def to_hash: -> {
+            status: Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+          type status = :OPTED_IN | :OPTED_OUT
+
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN: :OPTED_IN
+            OPTED_OUT: :OPTED_OUT
+
+            def self?.values: -> ::Array[Courier::Models::Users::PreferenceBulkReplaceParams::Topic::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_replace_response.rbs

@@ -0,0 +1,27 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_replace_response =
+        {
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+      class PreferenceBulkReplaceResponse < Courier::Internal::Type::BaseModel
+        attr_accessor deleted: ::Array[String]
+
+        attr_accessor items: ::Array[Courier::Users::BulkPreferenceTopic]
+
+        def initialize: (
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        ) -> void
+
+        def to_hash: -> {
+          deleted: ::Array[String],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_update_params.rbs

@@ -0,0 +1,87 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_update_params =
+        {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          tenant_id: String?
+        }
+        & Courier::Internal::Type::request_parameters
+
+      class PreferenceBulkUpdateParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        attr_accessor user_id: String
+
+        attr_accessor topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic]
+
+        attr_accessor tenant_id: String?
+
+        def initialize: (
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          user_id: String,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          tenant_id: String?,
+          request_options: Courier::RequestOptions
+        }
+
+        type topic =
+          {
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+        class Topic < Courier::Internal::Type::BaseModel
+          attr_accessor status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status
+
+          attr_accessor topic_id: String
+
+          attr_reader custom_routing: ::Array[Courier::Models::channel_classification]?
+
+          def custom_routing=: (
+            ::Array[Courier::Models::channel_classification]
+          ) -> ::Array[Courier::Models::channel_classification]
+
+          attr_reader has_custom_routing: bool?
+
+          def has_custom_routing=: (bool) -> bool
+
+          def initialize: (
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            ?custom_routing: ::Array[Courier::Models::channel_classification],
+            ?has_custom_routing: bool
+          ) -> void
+
+          def to_hash: -> {
+            status: Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status,
+            topic_id: String,
+            custom_routing: ::Array[Courier::Models::channel_classification],
+            has_custom_routing: bool
+          }
+
+          type status = :OPTED_IN | :OPTED_OUT
+
+          module Status
+            extend Courier::Internal::Type::Enum
+
+            OPTED_IN: :OPTED_IN
+            OPTED_OUT: :OPTED_OUT
+
+            def self?.values: -> ::Array[Courier::Models::Users::PreferenceBulkUpdateParams::Topic::status]
+          end
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/users/preference_bulk_update_response.rbs

@@ -0,0 +1,39 @@
+module Courier
+  module Models
+    module Users
+      type preference_bulk_update_response =
+        {
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+      class PreferenceBulkUpdateResponse < Courier::Internal::Type::BaseModel
+        attr_accessor errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error]
+
+        attr_accessor items: ::Array[Courier::Users::BulkPreferenceTopic]
+
+        def initialize: (
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        ) -> void
+
+        def to_hash: -> {
+          errors: ::Array[Courier::Models::Users::PreferenceBulkUpdateResponse::Error],
+          items: ::Array[Courier::Users::BulkPreferenceTopic]
+        }
+
+        type error = { reason: String, topic_id: String }
+
+        class Error < Courier::Internal::Type::BaseModel
+          attr_accessor reason: String
+
+          attr_accessor topic_id: String
+
+          def initialize: (reason: String, topic_id: String) -> void
+
+          def to_hash: -> { reason: String, topic_id: String }
+        end
+      end
+    end
+  end
+end

data/sig/courier/models/workspace_preference_create_request.rbs

@@ -3,6 +3,7 @@ module Courier
     type workspace_preference_create_request =
       {
         name: String,
+        description: String?,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }
@@ -10,18 +11,22 @@ module Courier
     class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
       attr_accessor name: String
 
+      attr_accessor description: String?
+
       attr_accessor has_custom_routing: bool?
 
       attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
 
       def initialize: (
         name: String,
+        ?description: String?,
         ?has_custom_routing: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?
       ) -> void
 
       def to_hash: -> {
         name: String,
+        description: String?,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }

data/sig/courier/models/workspace_preference_get_response.rbs

@@ -9,6 +9,7 @@ module Courier
         routing_options: ::Array[Courier::Models::channel_classification],
         topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         creator: String?,
+        description: String?,
         updated: String?,
         updater: String?
       }
@@ -28,6 +29,8 @@ module Courier
 
       attr_accessor creator: String?
 
+      attr_accessor description: String?
+
       attr_accessor updated: String?
 
       attr_accessor updater: String?
@@ -40,6 +43,7 @@ module Courier
         routing_options: ::Array[Courier::Models::channel_classification],
         topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         ?creator: String?,
+        ?description: String?,
         ?updated: String?,
         ?updater: String?
       ) -> void
@@ -52,6 +56,7 @@ module Courier
         routing_options: ::Array[Courier::Models::channel_classification],
         topics: ::Array[Courier::WorkspacePreferenceTopicGetResponse],
         creator: String?,
+        description: String?,
         updated: String?,
         updater: String?
       }

data/sig/courier/models/workspace_preference_publish_params.rbs

@@ -3,7 +3,7 @@ module Courier
     type workspace_preference_publish_params =
       {  } & Courier::Internal::Type::request_parameters
 
-    class WorkspacePreferencePublishParams < Courier::Internal::Type::BaseModel
+    class WorkspacePreferencePublishParams < Courier::Models::PublishPreferencesRequest
       extend Courier::Internal::Type::RequestParameters::Converter
       include Courier::Internal::Type::RequestParameters
 

data/sig/courier/models/workspace_preference_replace_request.rbs

@@ -3,6 +3,7 @@ module Courier
     type workspace_preference_replace_request =
       {
         name: String,
+        description: String?,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }
@@ -10,18 +11,22 @@ module Courier
     class WorkspacePreferenceReplaceRequest < Courier::Internal::Type::BaseModel
       attr_accessor name: String
 
+      attr_accessor description: String?
+
       attr_accessor has_custom_routing: bool?
 
       attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
 
       def initialize: (
         name: String,
+        ?description: String?,
         ?has_custom_routing: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?
       ) -> void
 
       def to_hash: -> {
         name: String,
+        description: String?,
         has_custom_routing: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?
       }

data/sig/courier/models/workspace_preference_topic_create_request.rbs

@@ -5,6 +5,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
         name: String,
         allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        description: String?,
         include_unsubscribe_header: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?,
         topic_data: ::Hash[Symbol, top]?
@@ -17,6 +18,8 @@ module Courier
 
       attr_accessor allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?
 
+      attr_accessor description: String?
+
       attr_accessor include_unsubscribe_header: bool?
 
       attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
@@ -27,6 +30,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
         name: String,
         ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        ?description: String?,
         ?include_unsubscribe_header: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?,
         ?topic_data: ::Hash[Symbol, top]?
@@ -36,6 +40,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
         name: String,
         allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        description: String?,
         include_unsubscribe_header: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?,
         topic_data: ::Hash[Symbol, top]?

data/sig/courier/models/workspace_preference_topic_get_response.rbs

@@ -12,6 +12,7 @@ module Courier
         topic_data: ::Hash[Symbol, top],
         updated: String,
         creator: String?,
+        description: String?,
         updater: String?
       }
 
@@ -36,6 +37,8 @@ module Courier
 
       attr_accessor creator: String?
 
+      attr_accessor description: String?
+
       attr_accessor updater: String?
 
       def initialize: (
@@ -49,6 +52,7 @@ module Courier
         topic_data: ::Hash[Symbol, top],
         updated: String,
         ?creator: String?,
+        ?description: String?,
         ?updater: String?
       ) -> void
 
@@ -63,6 +67,7 @@ module Courier
         topic_data: ::Hash[Symbol, top],
         updated: String,
         creator: String?,
+        description: String?,
         updater: String?
       }
 

data/sig/courier/models/workspace_preference_topic_replace_request.rbs

@@ -5,6 +5,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
         name: String,
         allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        description: String?,
         include_unsubscribe_header: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?,
         topic_data: ::Hash[Symbol, top]?
@@ -17,6 +18,8 @@ module Courier
 
       attr_accessor allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?
 
+      attr_accessor description: String?
+
       attr_accessor include_unsubscribe_header: bool?
 
       attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
@@ -27,6 +30,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
         name: String,
         ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        ?description: String?,
         ?include_unsubscribe_header: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?,
         ?topic_data: ::Hash[Symbol, top]?
@@ -36,6 +40,7 @@ module Courier
         default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
         name: String,
         allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        description: String?,
         include_unsubscribe_header: bool?,
         routing_options: ::Array[Courier::Models::channel_classification]?,
         topic_data: ::Hash[Symbol, top]?

data/sig/courier/models.rbs

@@ -403,6 +403,8 @@ module Courier
 
   class ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  class PublishPreferencesRequest = Courier::Models::PublishPreferencesRequest
+
   class PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
 
   class PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient

data/sig/courier/resources/users/preferences.rbs

@@ -8,6 +8,20 @@ module Courier
           ?request_options: Courier::request_opts
         ) -> Courier::Models::Users::PreferenceRetrieveResponse
 
+        def bulk_replace: (
+          String user_id,
+          topics: ::Array[Courier::Users::PreferenceBulkReplaceParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Users::PreferenceBulkReplaceResponse
+
+        def bulk_update: (
+          String user_id,
+          topics: ::Array[Courier::Users::PreferenceBulkUpdateParams::Topic],
+          ?tenant_id: String?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::Models::Users::PreferenceBulkUpdateResponse
+
         def delete_topic: (
           String topic_id,
           user_id: String,

data/sig/courier/resources/workspace_preferences/topics.rbs

@@ -7,6 +7,7 @@ module Courier
           default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
           name: String,
           ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+          ?description: String?,
           ?include_unsubscribe_header: bool?,
           ?routing_options: ::Array[Courier::Models::channel_classification]?,
           ?topic_data: ::Hash[Symbol, top]?,
@@ -36,6 +37,7 @@ module Courier
           default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
           name: String,
           ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+          ?description: String?,
           ?include_unsubscribe_header: bool?,
           ?routing_options: ::Array[Courier::Models::channel_classification]?,
           ?topic_data: ::Hash[Symbol, top]?,

data/sig/courier/resources/workspace_preferences.rbs

@@ -5,6 +5,7 @@ module Courier
 
       def create: (
         name: String,
+        ?description: String?,
         ?has_custom_routing: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?,
         ?request_options: Courier::request_opts
@@ -25,12 +26,16 @@ module Courier
       ) -> nil
 
       def publish: (
+        ?brand_id: String?,
+        ?description: String?,
+        ?heading: String?,
         ?request_options: Courier::request_opts
       ) -> Courier::PublishPreferencesResponse
 
       def replace: (
         String section_id,
         name: String,
+        ?description: String?,
         ?has_custom_routing: bool?,
         ?routing_options: ::Array[Courier::Models::channel_classification]?,
         ?request_options: Courier::request_opts