trycourier 4.16.0 → 4.17.1

data/rbi/courier/client.rbi

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

data/rbi/courier/models/publish_preferences_response.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Courier
+  module Models
+    class PublishPreferencesResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Courier::PublishPreferencesResponse, Courier::Internal::AnyHash)
+        end
+
+      # Id of the published page snapshot.
+      sig { returns(String) }
+      attr_accessor :page_id
+
+      # ISO-8601 timestamp of the publish.
+      sig { returns(String) }
+      attr_accessor :published_at
+
+      # Monotonic published version (epoch milliseconds).
+      sig { returns(Float) }
+      attr_accessor :published_version
+
+      # Draft-mode hosted preferences page URL for previewing.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :preview_url
+
+      # Id of the publisher.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :published_by
+
+      # Result of publishing the workspace's preferences page.
+      sig do
+        params(
+          page_id: String,
+          published_at: String,
+          published_version: Float,
+          preview_url: T.nilable(String),
+          published_by: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Id of the published page snapshot.
+        page_id:,
+        # ISO-8601 timestamp of the publish.
+        published_at:,
+        # Monotonic published version (epoch milliseconds).
+        published_version:,
+        # Draft-mode hosted preferences page URL for previewing.
+        preview_url: nil,
+        # Id of the publisher.
+        published_by: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            page_id: String,
+            published_at: String,
+            published_version: Float,
+            preview_url: T.nilable(String),
+            published_by: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/workspace_preference_archive_params.rbi

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

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WorkspacePreferenceCreateParams < Courier::Models::WorkspacePreferenceCreateRequest
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::WorkspacePreferenceCreateParams,
+            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/workspace_preference_create_request.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WorkspacePreferenceCreateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::WorkspacePreferenceCreateRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Human-readable name for the workspace preference.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Whether the workspace preference defines custom routing for its topics.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :has_custom_routing
+
+      # Default channels for the workspace preference. 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 workspace preference.
+      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 workspace preference.
+        name:,
+        # 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.
+        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/workspace_preference_get_response.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WorkspacePreferenceGetResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::WorkspacePreferenceGetResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # The workspace preference id.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # ISO-8601 timestamp of when the workspace preference was created.
+      sig { returns(String) }
+      attr_accessor :created
+
+      # Whether the workspace preference 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 workspace preference. May be empty.
+      sig { returns(T::Array[Courier::ChannelClassification::TaggedSymbol]) }
+      attr_accessor :routing_options
+
+      # The topics contained in this workspace preference.
+      sig { returns(T::Array[Courier::WorkspacePreferenceTopicGetResponse]) }
+      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 workspace preference 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::WorkspacePreferenceTopicGetResponse::OrHash],
+          creator: T.nilable(String),
+          updated: T.nilable(String),
+          updater: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The workspace preference id.
+        id:,
+        # ISO-8601 timestamp of when the workspace preference was created.
+        created:,
+        # Whether the workspace preference defines custom routing for its topics.
+        has_custom_routing:,
+        # Human-readable name.
+        name:,
+        # Default channels for the workspace preference. May be empty.
+        routing_options:,
+        # The topics contained in this workspace preference.
+        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::WorkspacePreferenceTopicGetResponse],
+            creator: T.nilable(String),
+            updated: T.nilable(String),
+            updater: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/workspace_preference_list_params.rbi

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

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

data/rbi/courier/models/workspace_preference_publish_params.rbi

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

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

@@ -0,0 +1,62 @@
+# typed: strong
+
+module Courier
+  module Models
+    class WorkspacePreferenceReplaceRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::WorkspacePreferenceReplaceRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Human-readable name for the workspace preference.
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Whether the workspace preference defines custom routing for its topics.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :has_custom_routing
+
+      # Default channels for the workspace preference. Omit to clear.
+      sig do
+        returns(T.nilable(T::Array[Courier::ChannelClassification::OrSymbol]))
+      end
+      attr_accessor :routing_options
+
+      # Request body for replacing a workspace preference. 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 workspace preference.
+        name:,
+        # Whether the workspace preference defines custom routing for its topics.
+        has_custom_routing: nil,
+        # Default channels for the workspace preference. 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/workspace_preference_retrieve_params.rbi

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