trycourier 4.16.0 → 4.17.0

data/lib/courier.rb

@@ -72,6 +72,10 @@ require_relative "courier/models/notification_template_publish_request"
 require_relative "courier/models/notification_element_put_request"
 require_relative "courier/models/notification_template_update_request"
 require_relative "courier/models/notification_template_payload"
+require_relative "courier/models/preference_section_create_request"
+require_relative "courier/models/preference_section_replace_request"
+require_relative "courier/models/preference_topic_create_request"
+require_relative "courier/models/preference_topic_replace_request"
 require_relative "courier/models/routing_strategy_create_request"
 require_relative "courier/models/routing_strategy_replace_request"
 require_relative "courier/models/base_template_tenant_association"
@@ -275,7 +279,22 @@ require_relative "courier/models/pagerduty_recipient"
 require_relative "courier/models/paging"
 require_relative "courier/models/post_tenant_template_publish_response"
 require_relative "courier/models/preference"
+require_relative "courier/models/preference_section_archive_params"
+require_relative "courier/models/preference_section_create_params"
+require_relative "courier/models/preference_section_get_response"
+require_relative "courier/models/preference_section_list_params"
+require_relative "courier/models/preference_section_list_response"
+require_relative "courier/models/preference_section_publish_params"
+require_relative "courier/models/preference_section_replace_params"
+require_relative "courier/models/preference_section_retrieve_params"
+require_relative "courier/models/preference_sections/topic_archive_params"
+require_relative "courier/models/preference_sections/topic_create_params"
+require_relative "courier/models/preference_sections/topic_list_params"
+require_relative "courier/models/preference_sections/topic_replace_params"
+require_relative "courier/models/preference_sections/topic_retrieve_params"
 require_relative "courier/models/preference_status"
+require_relative "courier/models/preference_topic_get_response"
+require_relative "courier/models/preference_topic_list_response"
 require_relative "courier/models/profile_create_params"
 require_relative "courier/models/profile_create_response"
 require_relative "courier/models/profile_delete_params"
@@ -300,6 +319,7 @@ require_relative "courier/models/providers/catalog_list_params"
 require_relative "courier/models/providers/catalog_list_response"
 require_relative "courier/models/providers_catalog_entry"
 require_relative "courier/models/provider_update_params"
+require_relative "courier/models/publish_preferences_response"
 require_relative "courier/models/put_subscriptions_recipient"
 require_relative "courier/models/put_tenant_template_response"
 require_relative "courier/models/recipient_preferences"
@@ -408,6 +428,8 @@ require_relative "courier/resources/lists/subscriptions"
 require_relative "courier/resources/messages"
 require_relative "courier/resources/notifications"
 require_relative "courier/resources/notifications/checks"
+require_relative "courier/resources/preference_sections"
+require_relative "courier/resources/preference_sections/topics"
 require_relative "courier/resources/profiles"
 require_relative "courier/resources/profiles/lists"
 require_relative "courier/resources/providers"

data/rbi/courier/client.rbi

@@ -61,6 +61,9 @@ module Courier
     sig { returns(Courier::Resources::RoutingStrategies) }
     attr_reader :routing_strategies
 
+    sig { returns(Courier::Resources::PreferenceSections) }
+    attr_reader :preference_sections
+
     sig { returns(Courier::Resources::Profiles) }
     attr_reader :profiles
 

data/rbi/courier/models/preference_section_archive_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionArchiveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionArchiveParams,
+            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

data/rbi/courier/models/preference_section_create_params.rbi

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

data/rbi/courier/models/preference_section_create_request.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionCreateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionCreateRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Human-readable name for the section.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Whether the section defines custom routing for its topics.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :has_custom_routing
+
+      # Default channels for the section. Defaults to empty if omitted.
+      sig do
+        returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
+      end
+      attr_accessor :routing_options
+
+      # Request body for creating a preference section.
+      sig do
+        params(
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Human-readable name for the section.
+        name:,
+        # Whether the section defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the section. Defaults to empty if omitted.
+        routing_options: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            has_custom_routing: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_section_get_response.rbi

@@ -0,0 +1,106 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionGetResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionGetResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The preference section id.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # ISO-8601 timestamp of when the section was created.
+      sig { returns(String) }
+      attr_accessor :created
+
+      # Whether the section defines custom routing for its topics.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_custom_routing
+
+      # Human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Default channels for the section. May be empty.
+      sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
+      attr_accessor :routing_options
+
+      # The topics contained in this section.
+      sig { returns(T::Array[Courier::PreferenceTopicGetResponse]) }
+      attr_accessor :topics
+
+      # Id of the creator.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :creator
+
+      # ISO-8601 timestamp of the last update.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :updated
+
+      # Id of the last updater.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :updater
+
+      # A preference section in your workspace, including its topics.
+      sig do
+        params(
+          id: String,
+          created: String,
+          has_custom_routing: T::Boolean,
+          name: String,
+          routing_options: T::Array[Courier::ChannelClassification::OrSymbol],
+          topics: T::Array[Courier::PreferenceTopicGetResponse::OrHash],
+          creator: T.nilable(String),
+          updated: T.nilable(String),
+          updater: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The preference section id.
+        id:,
+        # ISO-8601 timestamp of when the section was created.
+        created:,
+        # Whether the section defines custom routing for its topics.
+        has_custom_routing:,
+        # Human-readable name.
+        name:,
+        # Default channels for the section. May be empty.
+        routing_options:,
+        # The topics contained in this section.
+        topics:,
+        # Id of the creator.
+        creator: nil,
+        # ISO-8601 timestamp of the last update.
+        updated: nil,
+        # Id of the last updater.
+        updater: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created: String,
+            has_custom_routing: T::Boolean,
+            name: String,
+            routing_options:
+              T::Array[Courier::ChannelClassification::TaggedSymbol],
+            topics: T::Array[Courier::PreferenceTopicGetResponse],
+            creator: T.nilable(String),
+            updated: T.nilable(String),
+            updater: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_section_list_params.rbi

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

data/rbi/courier/models/preference_section_list_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Courier::PreferenceSectionGetResponse]) }
+      attr_accessor :results
+
+      # The workspace's preference sections, each with its topics.
+      sig do
+        params(
+          results: T::Array[Courier::PreferenceSectionGetResponse::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(results:)
+      end
+
+      sig do
+        override.returns(
+          { results: T::Array[Courier::PreferenceSectionGetResponse] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_section_publish_params.rbi

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

data/rbi/courier/models/preference_section_replace_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionReplaceParams < Courier::Models::PreferenceSectionReplaceRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionReplaceParams,
+            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

data/rbi/courier/models/preference_section_replace_request.rbi

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionReplaceRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionReplaceRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Human-readable name for the section.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Whether the section defines custom routing for its topics.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :has_custom_routing
+
+      # Default channels for the section. Omit to clear.
+      sig do
+        returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
+      end
+      attr_accessor :routing_options
+
+      # Request body for replacing a preference section. Full document replacement;
+      # missing optional fields are cleared.
+      sig do
+        params(
+          name: String,
+          has_custom_routing: T.nilable(T::Boolean),
+          routing_options:
+            T.nilable(T::Array[Courier::ChannelClassification::OrSymbol])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Human-readable name for the section.
+        name:,
+        # Whether the section defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the section. Omit to clear.
+        routing_options: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            name: String,
+            has_custom_routing: T.nilable(T::Boolean),
+            routing_options:
+              T.nilable(T::Array[Courier::ChannelClassification::OrSymbol])
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_section_retrieve_params.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceSectionRetrieveParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceSectionRetrieveParams,
+            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

data/rbi/courier/models/preference_sections/topic_archive_params.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    module PreferenceSections
+      class TopicArchiveParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::PreferenceSections::TopicArchiveParams,
+              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/preference_sections/topic_create_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module PreferenceSections
+      class TopicCreateParams < Courier::Models::PreferenceTopicCreateRequest
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::PreferenceSections::TopicCreateParams,
+              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/preference_sections/topic_list_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Courier
+  module Models
+    module PreferenceSections
+      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::PreferenceSections::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