trycourier 4.8.0 → 4.9.0

data/rbi/courier/models/notification_template_update_request.rbi

@@ -0,0 +1,103 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateUpdateRequest < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateUpdateRequest,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      # Full document shape used in POST and PUT request bodies, and returned inside the
+      # GET response envelope.
+      sig { returns(Courier::NotificationTemplatePayload) }
+      attr_reader :notification
+
+      sig do
+        params(notification: Courier::NotificationTemplatePayload::OrHash).void
+      end
+      attr_writer :notification
+
+      # Template state after update. Case-insensitive input, normalized to uppercase in
+      # the response. Defaults to "DRAFT".
+      sig do
+        returns(
+          T.nilable(Courier::NotificationTemplateUpdateRequest::State::OrSymbol)
+        )
+      end
+      attr_reader :state
+
+      sig do
+        params(
+          state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
+        ).void
+      end
+      attr_writer :state
+
+      # Request body for replacing a notification template. Same shape as create. All
+      # fields required (PUT = full replacement).
+      sig do
+        params(
+          notification: Courier::NotificationTemplatePayload::OrHash,
+          state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Full document shape used in POST and PUT request bodies, and returned inside the
+        # GET response envelope.
+        notification:,
+        # Template state after update. Case-insensitive input, normalized to uppercase in
+        # the response. Defaults to "DRAFT".
+        state: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            notification: Courier::NotificationTemplatePayload,
+            state: Courier::NotificationTemplateUpdateRequest::State::OrSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Template state after update. Case-insensitive input, normalized to uppercase in
+      # the response. Defaults to "DRAFT".
+      module State
+        extend Courier::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Courier::NotificationTemplateUpdateRequest::State)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DRAFT =
+          T.let(
+            :DRAFT,
+            Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+          )
+        PUBLISHED =
+          T.let(
+            :PUBLISHED,
+            Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Courier::NotificationTemplateUpdateRequest::State::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/notification_template_version_list_response.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Courier
+  module Models
+    class NotificationTemplateVersionListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::NotificationTemplateVersionListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::VersionNode]) }
+      attr_accessor :versions
+
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          versions: T::Array[Courier::VersionNode::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, versions:)
+      end
+
+      sig do
+        override.returns(
+          { paging: Courier::Paging, versions: T::Array[Courier::VersionNode] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/provider.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module Courier
+  module Models
+    class Provider < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Courier::Provider, Courier::Internal::AnyHash) }
+
+      # A unique identifier for the provider configuration.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Unix timestamp (ms) of when the provider was created.
+      sig { returns(Integer) }
+      attr_accessor :created
+
+      # The provider key (e.g. "sendgrid", "twilio", "slack").
+      sig { returns(String) }
+      attr_accessor :provider
+
+      # Provider-specific settings (snake_case keys on the wire).
+      sig { returns(T::Hash[Symbol, T.anything]) }
+      attr_accessor :settings
+
+      # Display title. Defaults to "Default Configuration" when not explicitly set.
+      sig { returns(String) }
+      attr_accessor :title
+
+      # Optional alias for this configuration.
+      sig { returns(T.nilable(String)) }
+      attr_reader :alias_
+
+      sig { params(alias_: String).void }
+      attr_writer :alias_
+
+      # Unix timestamp (ms) of when the provider was last updated.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :updated
+
+      # A configured provider in the workspace.
+      sig do
+        params(
+          id: String,
+          created: Integer,
+          provider: String,
+          settings: T::Hash[Symbol, T.anything],
+          title: String,
+          alias_: String,
+          updated: T.nilable(Integer)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique identifier for the provider configuration.
+        id:,
+        # Unix timestamp (ms) of when the provider was created.
+        created:,
+        # The provider key (e.g. "sendgrid", "twilio", "slack").
+        provider:,
+        # Provider-specific settings (snake_case keys on the wire).
+        settings:,
+        # Display title. Defaults to "Default Configuration" when not explicitly set.
+        title:,
+        # Optional alias for this configuration.
+        alias_: nil,
+        # Unix timestamp (ms) of when the provider was last updated.
+        updated: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created: Integer,
+            provider: String,
+            settings: T::Hash[Symbol, T.anything],
+            title: String,
+            alias_: String,
+            updated: T.nilable(Integer)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/provider_create_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ProviderCreateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ProviderCreateParams, Courier::Internal::AnyHash)
+        end
+
+      # The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+      # known Courier provider — see the catalog endpoint for valid keys.
+      sig { returns(String) }
+      attr_accessor :provider
+
+      # Optional alias for this configuration.
+      sig { returns(T.nilable(String)) }
+      attr_reader :alias_
+
+      sig { params(alias_: String).void }
+      attr_writer :alias_
+
+      # Provider-specific settings (snake_case keys). Defaults to an empty object when
+      # omitted. Use the catalog endpoint to discover required fields for a given
+      # provider — omitting a required field returns a 400 validation error.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :settings
+
+      sig { params(settings: T::Hash[Symbol, T.anything]).void }
+      attr_writer :settings
+
+      # Optional display title. Omit to use "Default Configuration".
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
+
+      sig { params(title: String).void }
+      attr_writer :title
+
+      sig do
+        params(
+          provider: String,
+          alias_: String,
+          settings: T::Hash[Symbol, T.anything],
+          title: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The provider key identifying the type (e.g. "sendgrid", "twilio"). Must be a
+        # known Courier provider — see the catalog endpoint for valid keys.
+        provider:,
+        # Optional alias for this configuration.
+        alias_: nil,
+        # Provider-specific settings (snake_case keys). Defaults to an empty object when
+        # omitted. Use the catalog endpoint to discover required fields for a given
+        # provider — omitting a required field returns a 400 validation error.
+        settings: nil,
+        # Optional display title. Omit to use "Default Configuration".
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            provider: String,
+            alias_: String,
+            settings: T::Hash[Symbol, T.anything],
+            title: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/provider_delete_params.rbi

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

data/rbi/courier/models/provider_list_params.rbi

@@ -0,0 +1,43 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ProviderListParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ProviderListParams, Courier::Internal::AnyHash)
+        end
+
+      # Opaque cursor for fetching the next page.
+      sig { returns(T.nilable(String)) }
+      attr_reader :cursor
+
+      sig { params(cursor: String).void }
+      attr_writer :cursor
+
+      sig do
+        params(
+          cursor: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Opaque cursor for fetching the next page.
+        cursor: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { cursor: String, request_options: Courier::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/provider_list_response.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ProviderListResponse < Courier::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Courier::Models::ProviderListResponse,
+            Courier::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Courier::Paging) }
+      attr_reader :paging
+
+      sig { params(paging: Courier::Paging::OrHash).void }
+      attr_writer :paging
+
+      sig { returns(T::Array[Courier::Provider]) }
+      attr_accessor :results
+
+      # Paginated list of provider configurations.
+      sig do
+        params(
+          paging: Courier::Paging::OrHash,
+          results: T::Array[Courier::Provider::OrHash]
+        ).returns(T.attached_class)
+      end
+      def self.new(paging:, results:)
+      end
+
+      sig do
+        override.returns(
+          { paging: Courier::Paging, results: T::Array[Courier::Provider] }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/provider_retrieve_params.rbi

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

data/rbi/courier/models/provider_update_params.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Courier
+  module Models
+    class ProviderUpdateParams < Courier::Internal::Type::BaseModel
+      extend Courier::Internal::Type::RequestParameters::Converter
+      include Courier::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Courier::ProviderUpdateParams, Courier::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The provider key identifying the type.
+      sig { returns(String) }
+      attr_accessor :provider
+
+      # Updated alias. Omit to clear.
+      sig { returns(T.nilable(String)) }
+      attr_reader :alias_
+
+      sig { params(alias_: String).void }
+      attr_writer :alias_
+
+      # Provider-specific settings (snake_case keys). Replaces the full settings object
+      # — omitted settings fields are removed. Use the catalog endpoint to check
+      # required fields.
+      sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+      attr_reader :settings
+
+      sig { params(settings: T::Hash[Symbol, T.anything]).void }
+      attr_writer :settings
+
+      # Updated display title.
+      sig { returns(T.nilable(String)) }
+      attr_reader :title
+
+      sig { params(title: String).void }
+      attr_writer :title
+
+      sig do
+        params(
+          id: String,
+          provider: String,
+          alias_: String,
+          settings: T::Hash[Symbol, T.anything],
+          title: String,
+          request_options: Courier::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # The provider key identifying the type.
+        provider:,
+        # Updated alias. Omit to clear.
+        alias_: nil,
+        # Provider-specific settings (snake_case keys). Replaces the full settings object
+        # — omitted settings fields are removed. Use the catalog endpoint to check
+        # required fields.
+        settings: nil,
+        # Updated display title.
+        title: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            provider: String,
+            alias_: String,
+            settings: T::Hash[Symbol, T.anything],
+            title: String,
+            request_options: Courier::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/courier/models/providers/catalog_list_params.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Providers
+      class CatalogListParams < Courier::Internal::Type::BaseModel
+        extend Courier::Internal::Type::RequestParameters::Converter
+        include Courier::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Providers::CatalogListParams,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        # Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+        # `email`, `sms`, `push`).
+        sig { returns(T.nilable(String)) }
+        attr_reader :channel
+
+        sig { params(channel: String).void }
+        attr_writer :channel
+
+        # Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+        sig { returns(T.nilable(String)) }
+        attr_reader :keys
+
+        sig { params(keys: String).void }
+        attr_writer :keys
+
+        # Case-insensitive substring match against the provider display name.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(
+            channel: String,
+            keys: String,
+            name: String,
+            request_options: Courier::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Exact match (case-insensitive) against the provider channel taxonomy (e.g.
+          # `email`, `sms`, `push`).
+          channel: nil,
+          # Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
+          keys: nil,
+          # Case-insensitive substring match against the provider display name.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              channel: String,
+              keys: String,
+              name: String,
+              request_options: Courier::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/courier/models/providers/catalog_list_response.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Courier
+  module Models
+    module Providers
+      class CatalogListResponse < Courier::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Courier::Models::Providers::CatalogListResponse,
+              Courier::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Courier::Paging) }
+        attr_reader :paging
+
+        sig { params(paging: Courier::Paging::OrHash).void }
+        attr_writer :paging
+
+        sig { returns(T::Array[Courier::ProvidersCatalogEntry]) }
+        attr_accessor :results
+
+        # Paginated list of available provider types with their configuration schemas.
+        sig do
+          params(
+            paging: Courier::Paging::OrHash,
+            results: T::Array[Courier::ProvidersCatalogEntry::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(paging:, results:)
+        end
+
+        sig do
+          override.returns(
+            {
+              paging: Courier::Paging,
+              results: T::Array[Courier::ProvidersCatalogEntry]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end