trycourier 4.16.0 → 4.17.0

data/rbi/courier/models/preference_sections/topic_replace_params.rbi

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

@@ -0,0 +1,48 @@
+# typed: strong
+
+module Courier
+  module Models
+    module PreferenceSections
+      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::PreferenceSections::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/preference_topic_create_request.rbi

@@ -0,0 +1,181 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceTopicCreateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceTopicCreateRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The default subscription status applied when a recipient has not set their own.
+      sig do
+        returns(Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol)
+      end
+      attr_accessor :default_status
+
+      # Human-readable name for the preference topic.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Preference controls a recipient may customize for this topic. Defaults to empty
+      # if omitted.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              Courier::PreferenceTopicCreateRequest::AllowedPreference::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_accessor :allowed_preferences
+
+      # Whether to include a list-unsubscribe header on emails for this topic.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_unsubscribe_header
+
+      # Default channels delivered for this topic. Defaults to empty if omitted.
+      sig do
+        returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
+      end
+      attr_accessor :routing_options
+
+      # Arbitrary metadata associated with the topic.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :topic_data
+
+      # Request body for creating a preference topic.
+      sig do
+        params(
+          default_status:
+            Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+          name: String,
+          allowed_preferences:
+            T.nilable(
+              T::Array[
+                Courier::PreferenceTopicCreateRequest::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])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            default_status:
+              Courier::PreferenceTopicCreateRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::PreferenceTopicCreateRequest::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])
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The default subscription status applied when a recipient has not set their own.
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::PreferenceTopicCreateRequest::DefaultStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OPTED_OUT =
+          T.let(
+            :OPTED_OUT,
+            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+          )
+        OPTED_IN =
+          T.let(
+            :OPTED_IN,
+            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+          )
+        REQUIRED =
+          T.let(
+            :REQUIRED,
+            Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicCreateRequest::DefaultStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A preference control a recipient may customize for a topic.
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Courier::PreferenceTopicCreateRequest::AllowedPreference
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SNOOZE =
+          T.let(
+            :snooze,
+            Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+          )
+        CHANNEL_PREFERENCES =
+          T.let(
+            :channel_preferences,
+            Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicCreateRequest::AllowedPreference::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_topic_get_response.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceTopicGetResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PreferenceTopicGetResponse, Courier::Internal::AnyHash)
+        end
+
+      # The preference topic id.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Preference controls a recipient may customize. May be empty.
+      sig do
+        returns(
+          T::Array[
+            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+          ]
+        )
+      end
+      attr_accessor :allowed_preferences
+
+      # ISO-8601 timestamp of when the topic was created.
+      sig { returns(String) }
+      attr_accessor :created
+
+      # The default subscription status applied when a recipient has not set their own.
+      sig do
+        returns(
+          Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+        )
+      end
+      attr_accessor :default_status
+
+      # Whether a list-unsubscribe header is included on emails for this topic.
+      sig { returns(T::Boolean) }
+      attr_accessor :include_unsubscribe_header
+
+      # Human-readable name.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Default channels delivered for this topic. May be empty.
+      sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
+      attr_accessor :routing_options
+
+      # Arbitrary metadata associated with the topic.
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :topic_data
+
+      # ISO-8601 timestamp of the last update.
+      sig { returns(String) }
+      attr_accessor :updated
+
+      # Id of the creator.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :creator
+
+      # Id of the last updater.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :updater
+
+      # A subscription preference topic in your workspace.
+      sig do
+        params(
+          id: String,
+          allowed_preferences:
+            T::Array[
+              Courier::PreferenceTopicGetResponse::AllowedPreference::OrSymbol
+            ],
+          created: String,
+          default_status:
+            Courier::PreferenceTopicGetResponse::DefaultStatus::OrSymbol,
+          include_unsubscribe_header: T::Boolean,
+          name: String,
+          routing_options: T::Array[Courier::ChannelClassification::OrSymbol],
+          topic_data: T::Hash[Symbol, T.anything],
+          updated: String,
+          creator: T.nilable(String),
+          updater: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The preference topic id.
+        id:,
+        # Preference controls a recipient may customize. May be empty.
+        allowed_preferences:,
+        # ISO-8601 timestamp of when the topic was created.
+        created:,
+        # The default subscription status applied when a recipient has not set their own.
+        default_status:,
+        # Whether a list-unsubscribe header is included on emails for this topic.
+        include_unsubscribe_header:,
+        # Human-readable name.
+        name:,
+        # Default channels delivered for this topic. May be empty.
+        routing_options:,
+        # Arbitrary metadata associated with the topic.
+        topic_data:,
+        # ISO-8601 timestamp of the last update.
+        updated:,
+        # Id of the creator.
+        creator: nil,
+        # Id of the last updater.
+        updater: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            allowed_preferences:
+              T::Array[
+                Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+              ],
+            created: String,
+            default_status:
+              Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol,
+            include_unsubscribe_header: T::Boolean,
+            name: String,
+            routing_options:
+              T::Array[Courier::ChannelClassification::TaggedSymbol],
+            topic_data: T::Hash[Symbol, T.anything],
+            updated: String,
+            creator: T.nilable(String),
+            updater: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # A preference control a recipient may customize for a topic.
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Courier::PreferenceTopicGetResponse::AllowedPreference
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SNOOZE =
+          T.let(
+            :snooze,
+            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+          )
+        CHANNEL_PREFERENCES =
+          T.let(
+            :channel_preferences,
+            Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicGetResponse::AllowedPreference::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # The default subscription status applied when a recipient has not set their own.
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::PreferenceTopicGetResponse::DefaultStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OPTED_OUT =
+          T.let(
+            :OPTED_OUT,
+            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+          )
+        OPTED_IN =
+          T.let(
+            :OPTED_IN,
+            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+          )
+        REQUIRED =
+          T.let(
+            :REQUIRED,
+            Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicGetResponse::DefaultStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_topic_list_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceTopicListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceTopicListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[Courier::PreferenceTopicGetResponse]) }
+      attr_accessor :results
+
+      # Topics contained in a preference section.
+      sig do
+        params(
+          results: T::Array[Courier::PreferenceTopicGetResponse::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(results:)
+      end
+
+      sig do
+        override.returns(
+          { results: T::Array[Courier::PreferenceTopicGetResponse] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/preference_topic_replace_request.rbi

@@ -0,0 +1,180 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PreferenceTopicReplaceRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::PreferenceTopicReplaceRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The default subscription status applied when a recipient has not set their own.
+      sig do
+        returns(Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol)
+      end
+      attr_accessor :default_status
+
+      # Human-readable name for the preference topic.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Preference controls a recipient may customize. Omit to clear.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              Courier::PreferenceTopicReplaceRequest::AllowedPreference::OrSymbol
+            ]
+          )
+        )
+      end
+      attr_accessor :allowed_preferences
+
+      # Whether to include a list-unsubscribe header on emails for this topic.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :include_unsubscribe_header
+
+      # Default channels delivered for this topic. Omit to clear.
+      sig do
+        returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
+      end
+      attr_accessor :routing_options
+
+      # Arbitrary metadata associated with the topic. Omit to clear.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_accessor :topic_data
+
+      # Request body for replacing a preference topic. Full document replacement;
+      # missing optional fields are cleared.
+      sig do
+        params(
+          default_status:
+            Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+          name: String,
+          allowed_preferences:
+            T.nilable(
+              T::Array[
+                Courier::PreferenceTopicReplaceRequest::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])
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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. Omit to clear.
+        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. Omit to clear.
+        routing_options: nil,
+        # Arbitrary metadata associated with the topic. Omit to clear.
+        topic_data: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            default_status:
+              Courier::PreferenceTopicReplaceRequest::DefaultStatus::OrSymbol,
+            name: String,
+            allowed_preferences:
+              T.nilable(
+                T::Array[
+                  Courier::PreferenceTopicReplaceRequest::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])
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # The default subscription status applied when a recipient has not set their own.
+      module DefaultStatus
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::PreferenceTopicReplaceRequest::DefaultStatus)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        OPTED_OUT =
+          T.let(
+            :OPTED_OUT,
+            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+          )
+        OPTED_IN =
+          T.let(
+            :OPTED_IN,
+            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+          )
+        REQUIRED =
+          T.let(
+            :REQUIRED,
+            Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicReplaceRequest::DefaultStatus::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A preference control a recipient may customize for a topic.
+      module AllowedPreference
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Courier::PreferenceTopicReplaceRequest::AllowedPreference
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SNOOZE =
+          T.let(
+            :snooze,
+            Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+          )
+        CHANNEL_PREFERENCES =
+          T.let(
+            :channel_preferences,
+            Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::PreferenceTopicReplaceRequest::AllowedPreference::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end