trycourier 4.16.0 → 4.17.0

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

@@ -0,0 +1,27 @@
+module Courier
+  module Models
+    module PreferenceSections
+      type topic_create_params =
+        { section_id: String } & Courier::Internal::Type::request_parameters
+
+      class TopicCreateParams < Courier::Models::PreferenceTopicCreateRequest
+        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/preference_sections/topic_list_params.rbs

@@ -0,0 +1,25 @@
+module Courier
+  module Models
+    module PreferenceSections
+      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/preference_sections/topic_replace_params.rbs

@@ -0,0 +1,34 @@
+module Courier
+  module Models
+    module PreferenceSections
+      type topic_replace_params =
+        { section_id: String, topic_id: String }
+        & Courier::Internal::Type::request_parameters
+
+      class TopicReplaceParams < Courier::Models::PreferenceTopicReplaceRequest
+        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/preference_sections/topic_retrieve_params.rbs

@@ -0,0 +1,30 @@
+module Courier
+  module Models
+    module PreferenceSections
+      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/preference_topic_create_request.rbs

@@ -0,0 +1,68 @@
+module Courier
+  module Models
+    type preference_topic_create_request =
+      {
+        default_status: Courier::Models::PreferenceTopicCreateRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::PreferenceTopicCreateRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+    class PreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
+      attr_accessor default_status: Courier::Models::PreferenceTopicCreateRequest::default_status
+
+      attr_accessor name: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::PreferenceTopicCreateRequest::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::PreferenceTopicCreateRequest::default_status,
+        name: String,
+        ?allowed_preferences: ::Array[Courier::Models::PreferenceTopicCreateRequest::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::PreferenceTopicCreateRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::PreferenceTopicCreateRequest::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::PreferenceTopicCreateRequest::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::PreferenceTopicCreateRequest::allowed_preference]
+      end
+    end
+  end
+end

data/sig/courier/models/preference_topic_get_response.rbs

@@ -0,0 +1,93 @@
+module Courier
+  module Models
+    type preference_topic_get_response =
+      {
+        id: String,
+        allowed_preferences: ::Array[Courier::Models::PreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::PreferenceTopicGetResponse::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 PreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::PreferenceTopicGetResponse::allowed_preference]
+
+      attr_accessor created: String
+
+      attr_accessor default_status: Courier::Models::PreferenceTopicGetResponse::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::PreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::PreferenceTopicGetResponse::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::PreferenceTopicGetResponse::allowed_preference],
+        created: String,
+        default_status: Courier::Models::PreferenceTopicGetResponse::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::PreferenceTopicGetResponse::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::PreferenceTopicGetResponse::default_status]
+      end
+    end
+  end
+end

data/sig/courier/models/preference_topic_list_response.rbs

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

data/sig/courier/models/preference_topic_replace_request.rbs

@@ -0,0 +1,68 @@
+module Courier
+  module Models
+    type preference_topic_replace_request =
+      {
+        default_status: Courier::Models::PreferenceTopicReplaceRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::PreferenceTopicReplaceRequest::allowed_preference]?,
+        include_unsubscribe_header: bool?,
+        routing_options: ::Array[Courier::Models::channel_classification]?,
+        topic_data: ::Hash[Symbol, top]?
+      }
+
+    class PreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
+      attr_accessor default_status: Courier::Models::PreferenceTopicReplaceRequest::default_status
+
+      attr_accessor name: String
+
+      attr_accessor allowed_preferences: ::Array[Courier::Models::PreferenceTopicReplaceRequest::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::PreferenceTopicReplaceRequest::default_status,
+        name: String,
+        ?allowed_preferences: ::Array[Courier::Models::PreferenceTopicReplaceRequest::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::PreferenceTopicReplaceRequest::default_status,
+        name: String,
+        allowed_preferences: ::Array[Courier::Models::PreferenceTopicReplaceRequest::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::PreferenceTopicReplaceRequest::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::PreferenceTopicReplaceRequest::allowed_preference]
+      end
+    end
+  end
+end

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.rbs

@@ -361,8 +361,38 @@ module Courier
 
   class Preference = Courier::Models::Preference
 
+  class PreferenceSectionArchiveParams = Courier::Models::PreferenceSectionArchiveParams
+
+  class PreferenceSectionCreateParams = Courier::Models::PreferenceSectionCreateParams
+
+  class PreferenceSectionCreateRequest = Courier::Models::PreferenceSectionCreateRequest
+
+  class PreferenceSectionGetResponse = Courier::Models::PreferenceSectionGetResponse
+
+  class PreferenceSectionListParams = Courier::Models::PreferenceSectionListParams
+
+  class PreferenceSectionListResponse = Courier::Models::PreferenceSectionListResponse
+
+  class PreferenceSectionPublishParams = Courier::Models::PreferenceSectionPublishParams
+
+  class PreferenceSectionReplaceParams = Courier::Models::PreferenceSectionReplaceParams
+
+  class PreferenceSectionReplaceRequest = Courier::Models::PreferenceSectionReplaceRequest
+
+  class PreferenceSectionRetrieveParams = Courier::Models::PreferenceSectionRetrieveParams
+
+  module PreferenceSections = Courier::Models::PreferenceSections
+
   module PreferenceStatus = Courier::Models::PreferenceStatus
 
+  class PreferenceTopicCreateRequest = Courier::Models::PreferenceTopicCreateRequest
+
+  class PreferenceTopicGetResponse = Courier::Models::PreferenceTopicGetResponse
+
+  class PreferenceTopicListResponse = Courier::Models::PreferenceTopicListResponse
+
+  class PreferenceTopicReplaceRequest = Courier::Models::PreferenceTopicReplaceRequest
+
   class ProfileCreateParams = Courier::Models::ProfileCreateParams
 
   class ProfileDeleteParams = Courier::Models::ProfileDeleteParams
@@ -391,6 +421,8 @@ module Courier
 
   class ProviderUpdateParams = Courier::Models::ProviderUpdateParams
 
+  class PublishPreferencesResponse = Courier::Models::PublishPreferencesResponse
+
   class PutSubscriptionsRecipient = Courier::Models::PutSubscriptionsRecipient
 
   class PutTenantTemplateRequest = Courier::Models::PutTenantTemplateRequest

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

@@ -0,0 +1,49 @@
+module Courier
+  module Resources
+    class PreferenceSections
+      class Topics
+        def create: (
+          String section_id,
+          default_status: Courier::Models::PreferenceTopicCreateRequest::default_status,
+          name: String,
+          ?allowed_preferences: ::Array[Courier::Models::PreferenceTopicCreateRequest::allowed_preference]?,
+          ?include_unsubscribe_header: bool?,
+          ?routing_options: ::Array[Courier::Models::channel_classification]?,
+          ?topic_data: ::Hash[Symbol, top]?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::PreferenceTopicGetResponse
+
+        def retrieve: (
+          String topic_id,
+          section_id: String,
+          ?request_options: Courier::request_opts
+        ) -> Courier::PreferenceTopicGetResponse
+
+        def list: (
+          String section_id,
+          ?request_options: Courier::request_opts
+        ) -> Courier::PreferenceTopicListResponse
+
+        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::PreferenceTopicReplaceRequest::default_status,
+          name: String,
+          ?allowed_preferences: ::Array[Courier::Models::PreferenceTopicReplaceRequest::allowed_preference]?,
+          ?include_unsubscribe_header: bool?,
+          ?routing_options: ::Array[Courier::Models::channel_classification]?,
+          ?topic_data: ::Hash[Symbol, top]?,
+          ?request_options: Courier::request_opts
+        ) -> Courier::PreferenceTopicGetResponse
+
+        def initialize: (client: Courier::Client) -> void
+      end
+    end
+  end
+end

data/sig/courier/resources/preference_sections.rbs

@@ -0,0 +1,42 @@
+module Courier
+  module Resources
+    class PreferenceSections
+      attr_reader topics: Courier::Resources::PreferenceSections::Topics
+
+      def create: (
+        name: String,
+        ?has_custom_routing: bool?,
+        ?routing_options: ::Array[Courier::Models::channel_classification]?,
+        ?request_options: Courier::request_opts
+      ) -> Courier::PreferenceSectionGetResponse
+
+      def retrieve: (
+        String section_id,
+        ?request_options: Courier::request_opts
+      ) -> Courier::PreferenceSectionGetResponse
+
+      def list: (
+        ?request_options: Courier::request_opts
+      ) -> Courier::PreferenceSectionListResponse
+
+      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::PreferenceSectionGetResponse
+
+      def initialize: (client: Courier::Client) -> void
+    end
+  end
+end