trycourier 4.16.0 → 4.17.1

data/sig/courier/models/workspace_preference_list_response.rbs

@@ -0,0 +1,18 @@
+module Courier
+  module Models
+    type workspace_preference_list_response =
+      { results: ::Array[Courier::WorkspacePreferenceGetResponse] }
+
+    class WorkspacePreferenceListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor results: ::Array[Courier::WorkspacePreferenceGetResponse]
+
+      def initialize: (
+        results: ::Array[Courier::WorkspacePreferenceGetResponse]
+      ) -> void
+
+      def to_hash: -> {
+        results: ::Array[Courier::WorkspacePreferenceGetResponse]
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_publish_params.rbs

@@ -0,0 +1,15 @@
+module Courier
+  module Models
+    type workspace_preference_publish_params =
+      {  } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferencePublishParams < 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

data/sig/courier/models/workspace_preference_replace_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    type workspace_preference_replace_params =
+      { section_id: String } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceReplaceParams < Courier::Models::WorkspacePreferenceReplaceRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      def section_id: -> String
+
+      def section_id=: (String _) -> 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_replace_request.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    type workspace_preference_replace_request =
+      {
+        name: String,
+        has_custom_routing: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?
+      }
+
+    class WorkspacePreferenceReplaceRequest < 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_retrieve_params.rbs

@@ -0,0 +1,23 @@
+module Courier
+  module Models
+    type workspace_preference_retrieve_params =
+      { section_id: String } & Courier::Internal::Type::request_parameters
+
+    class WorkspacePreferenceRetrieveParams < 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_topic_create_request.rbs

@@ -0,0 +1,68 @@
+module Courier
+  module Models
+    type workspace_preference_topic_create_request =
+      {
+        default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+    class WorkspacePreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
+      attr_accessor default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status
+
+      attr_accessor name: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?
+
+      attr_accessor include_unsubscribe_header: bool?
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
+
+      attr_accessor topic_data: ::Hash[Symbol, top]?
+
+      def initialize: (
+        default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
+        name: String,
+        ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        ?include_unsubscribe_header: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?,
+        ?topic_data: ::Hash[Symbol, top]?
+      ) -> void
+
+      def to_hash: -> {
+        default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+      type default_status = :OPTED_OUT | :OPTED_IN | :REQUIRED
+
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        OPTED_OUT: :OPTED_OUT
+        OPTED_IN: :OPTED_IN
+        REQUIRED: :REQUIRED
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status]
+      end
+
+      type allowed_preference = :snooze | :channel_preferences
+
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        SNOOZE: :snooze
+        CHANNEL_PREFERENCES: :channel_preferences
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]
+      end
+    end
+  end
+end

data/sig/courier/models/workspace_preference_topic_get_response.rbs

@@ -0,0 +1,93 @@
+module Courier
+  module Models
+    type workspace_preference_topic_get_response =
+      {
+        id: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::WorkspacePreferenceTopicGetResponse::default_status,
+        include_unsubscribe_header: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topic_data: ::Hash[Symbol, top],
+        updated: String,
+        creator: String?,
+        updater: String?
+      }
+
+    class WorkspacePreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::allowed_preference]
+
+      attr_accessor created: String
+
+      attr_accessor default_status: Courier::Models::WorkspacePreferenceTopicGetResponse::default_status
+
+      attr_accessor include_unsubscribe_header: bool
+
+      attr_accessor name: String
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]
+
+      attr_accessor topic_data: ::Hash[Symbol, top]
+
+      attr_accessor updated: String
+
+      attr_accessor creator: String?
+
+      attr_accessor updater: String?
+
+      def initialize: (
+        id: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::WorkspacePreferenceTopicGetResponse::default_status,
+        include_unsubscribe_header: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topic_data: ::Hash[Symbol, top],
+        updated: String,
+        ?creator: String?,
+        ?updater: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::WorkspacePreferenceTopicGetResponse::default_status,
+        include_unsubscribe_header: bool,
+        name: String,
+        routing_options: ::Array[Courier::Models::channel_classification],
+        topic_data: ::Hash[Symbol, top],
+        updated: String,
+        creator: String?,
+        updater: String?
+      }
+
+      type allowed_preference = :snooze | :channel_preferences
+
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        SNOOZE: :snooze
+        CHANNEL_PREFERENCES: :channel_preferences
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::allowed_preference]
+      end
+
+      type default_status = :OPTED_OUT | :OPTED_IN | :REQUIRED
+
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        OPTED_OUT: :OPTED_OUT
+        OPTED_IN: :OPTED_IN
+        REQUIRED: :REQUIRED
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicGetResponse::default_status]
+      end
+    end
+  end
+end

data/sig/courier/models/workspace_preference_topic_list_response.rbs

@@ -0,0 +1,18 @@
+module Courier
+  module Models
+    type workspace_preference_topic_list_response =
+      { results: ::Array[Courier::WorkspacePreferenceTopicGetResponse] }
+
+    class WorkspacePreferenceTopicListResponse < Courier::Internal::Type::BaseModel
+      attr_accessor results: ::Array[Courier::WorkspacePreferenceTopicGetResponse]
+
+      def initialize: (
+        results: ::Array[Courier::WorkspacePreferenceTopicGetResponse]
+      ) -> void
+
+      def to_hash: -> {
+        results: ::Array[Courier::WorkspacePreferenceTopicGetResponse]
+      }
+    end
+  end
+end

data/sig/courier/models/workspace_preference_topic_replace_request.rbs

@@ -0,0 +1,68 @@
+module Courier
+  module Models
+    type workspace_preference_topic_replace_request =
+      {
+        default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+    class WorkspacePreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
+      attr_accessor default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status
+
+      attr_accessor name: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?
+
+      attr_accessor include_unsubscribe_header: bool?
+
+      attr_accessor routing_options: ::Array[Courier::Models::channel_classification]?
+
+      attr_accessor topic_data: ::Hash[Symbol, top]?
+
+      def initialize: (
+        default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
+        name: String,
+        ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        ?include_unsubscribe_header: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?,
+        ?topic_data: ::Hash[Symbol, top]?
+      ) -> void
+
+      def to_hash: -> {
+        default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+      type default_status = :OPTED_OUT | :OPTED_IN | :REQUIRED
+
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        OPTED_OUT: :OPTED_OUT
+        OPTED_IN: :OPTED_IN
+        REQUIRED: :REQUIRED
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status]
+      end
+
+      type allowed_preference = :snooze | :channel_preferences
+
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        SNOOZE: :snooze
+        CHANNEL_PREFERENCES: :channel_preferences
+
+        def self?.values: -> ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]
+      end
+    end
+  end
+end

data/sig/courier/models/workspace_preferences/topic_archive_params.rbs

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

data/sig/courier/models/workspace_preferences/topic_create_params.rbs

@@ -0,0 +1,27 @@
+module Courier
+  module Models
+    module WorkspacePreferences
+      type topic_create_params =
+        { section_id: String } & Courier::Internal::Type::request_parameters
+
+      class TopicCreateParams < Courier::Models::WorkspacePreferenceTopicCreateRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def section_id: -> String
+
+        def section_id=: (String _) -> 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
+end

data/sig/courier/models/workspace_preferences/topic_list_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    module WorkspacePreferences
+      type topic_list_params =
+        { section_id: String } & Courier::Internal::Type::request_parameters
+
+      class TopicListParams < 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
+end

data/sig/courier/models/workspace_preferences/topic_replace_params.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    module WorkspacePreferences
+      type topic_replace_params =
+        { section_id: String, topic_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TopicReplaceParams < Courier::Models::WorkspacePreferenceTopicReplaceRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        def section_id: -> String
+
+        def section_id=: (String _) -> String
+
+        def topic_id: -> String
+
+        def topic_id=: (String _) -> String
+
+        def initialize: (
+          section_id: String,
+          topic_id: String,
+          ?request_options: Courier::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          section_id: String,
+          topic_id: String,
+          request_options: Courier::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/courier/models/workspace_preferences/topic_retrieve_params.rbs

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

data/sig/courier/models.rbs

@@ -391,6 +391,8 @@ module Courier
 
   class ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  class PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
+
   class PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   class PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest
@@ -512,4 +514,34 @@ module Courier
   class WebhookRecipient = Courier::Models::WebhookRecipient
 
   class WidgetBackground = Courier::Models::WidgetBackground
+
+  class WorkspacePreferenceArchiveParams = Courier::Models::WorkspacePreferenceArchiveParams
+
+  class WorkspacePreferenceCreateParams = Courier::Models::WorkspacePreferenceCreateParams
+
+  class WorkspacePreferenceCreateRequest = Courier::Models::WorkspacePreferenceCreateRequest
+
+  class WorkspacePreferenceGetResponse = Courier::Models::WorkspacePreferenceGetResponse
+
+  class WorkspacePreferenceListParams = Courier::Models::WorkspacePreferenceListParams
+
+  class WorkspacePreferenceListResponse = Courier::Models::WorkspacePreferenceListResponse
+
+  class WorkspacePreferencePublishParams = Courier::Models::WorkspacePreferencePublishParams
+
+  class WorkspacePreferenceReplaceParams = Courier::Models::WorkspacePreferenceReplaceParams
+
+  class WorkspacePreferenceReplaceRequest = Courier::Models::WorkspacePreferenceReplaceRequest
+
+  class WorkspacePreferenceRetrieveParams = Courier::Models::WorkspacePreferenceRetrieveParams
+
+  module WorkspacePreferences = Courier::Models::WorkspacePreferences
+
+  class WorkspacePreferenceTopicCreateRequest = Courier::Models::WorkspacePreferenceTopicCreateRequest
+
+  class WorkspacePreferenceTopicGetResponse = Courier::Models::WorkspacePreferenceTopicGetResponse
+
+  class WorkspacePreferenceTopicListResponse = Courier::Models::WorkspacePreferenceTopicListResponse
+
+  class WorkspacePreferenceTopicReplaceRequest = Courier::Models::WorkspacePreferenceTopicReplaceRequest
 end

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

@@ -0,0 +1,49 @@
+module Courier
+  module Resources
+    class WorkspacePreferences
+      class Topics
+        def create: (
+          String section_id,
+          default_status: Courier::Models::WorkspacePreferenceTopicCreateRequest::default_status,
+          name: String,
+          ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicCreateRequest::allowed_preference]?,
+          ?include_unsubscribe_header: bool?,
+          ?routing_options: ::Array[Courier::Models::channel_classification]?,
+          ?topic_data: ::Hash[Symbol, top]?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::WorkspacePreferenceTopicGetResponse
+
+        def retrieve: (
+          String topic_id,
+          section_id: String,
+          ?request_options: Courier::request_opts
+        ) -> Courier::WorkspacePreferenceTopicGetResponse
+
+        def list: (
+          String section_id,
+          ?request_options: Courier::request_opts
+        ) -> Courier::WorkspacePreferenceTopicListResponse
+
+        def archive: (
+          String topic_id,
+          section_id: String,
+          ?request_options: Courier::request_opts
+        ) -> nil
+
+        def replace: (
+          String topic_id,
+          section_id: String,
+          default_status: Courier::Models::WorkspacePreferenceTopicReplaceRequest::default_status,
+          name: String,
+          ?allowed_preferences: ::Array[Courier::Models::WorkspacePreferenceTopicReplaceRequest::allowed_preference]?,
+          ?include_unsubscribe_header: bool?,
+          ?routing_options: ::Array[Courier::Models::channel_classification]?,
+          ?topic_data: ::Hash[Symbol, top]?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::WorkspacePreferenceTopicGetResponse
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/workspace_preferences.rbs

@@ -0,0 +1,42 @@
+module Courier
+  module Resources
+    class WorkspacePreferences
+      attr_reader topics: Courier::Resources::WorkspacePreferences::Topics
+
+      def create: (
+        name: String,
+        ?has_custom_routing: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::WorkspacePreferenceGetResponse
+
+      def retrieve: (
+        String section_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::WorkspacePreferenceGetResponse
+
+      def list: (
+        ?request_options: Courier::request_opts
+      ) -> Courier::WorkspacePreferenceListResponse
+
+      def archive: (
+        String section_id,
+        ?request_options: Courier::request_opts
+      ) -> nil
+
+      def publish: (
+        ?request_options: Courier::request_opts
+      ) -> Courier::PublishPreferencesResponse
+
+      def replace: (
+        String section_id,
+        name: String,
+        ?has_custom_routing: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::WorkspacePreferenceGetResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end