RubyGems - openai - Versions diffs - 0.92.0 → 0.93.0 - Mend

openai 0.92.0 → 0.93.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1311) hide show

data/sig/openai/models/admin/organization/projects/groups/role_retrieve_response.rbs CHANGED Viewed

@@ -21,30 +21,66 @@ module OpenAI
               }
             class RoleRetrieveResponse < OpenAI::Internal::Type::BaseModel
+              # Identifier for the role.
               attr_accessor id: String
+              # Principals from which the role assignment is inherited, when available.
               attr_accessor assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse::AssignmentSource]?
+              # When the role was created.
               attr_accessor created_at: Integer?
+              # Identifier of the actor who created the role.
               attr_accessor created_by: String?
+              # User details for the actor that created the role, when available.
               attr_accessor created_by_user_obj: ::Hash[Symbol, top]?
+              # Description of the role.
               attr_accessor description: String?
+              # Arbitrary metadata stored on the role.
               attr_accessor metadata: ::Hash[Symbol, top]?
+              # Name of the role.
               attr_accessor name: String
+              # Permissions associated with the role.
               attr_accessor permissions: ::Array[String]
+              # Whether the role is predefined by OpenAI.
               attr_accessor predefined_role: bool
+              # Resource type the role applies to.
               attr_accessor resource_type: String
+              # When the role was last updated.
               attr_accessor updated_at: Integer?
+              # @param id
+              #   Identifier for the role.
+              # @param assignment_sources
+              #   Principals from which the role assignment is inherited, when available.
+              # @param created_at
+              #   When the role was created.
+              # @param created_by
+              #   Identifier of the actor who created the role.
+              # @param created_by_user_obj
+              #   User details for the actor that created the role, when available.
+              # @param description
+              #   Description of the role.
+              # @param metadata
+              #   Arbitrary metadata stored on the role.
+              # @param name
+              #   Name of the role.
+              # @param permissions
+              #   Permissions associated with the role.
+              # @param predefined_role
+              #   Whether the role is predefined by OpenAI.
+              # @param resource_type
+              #   Resource type the role applies to.
+              # @param updated_at
+              #   When the role was last updated.
               def initialize: (
                 id: String,
                 assignment_sources: ::Array[OpenAI::Models::Admin::Organization::Projects::Groups::RoleRetrieveResponse::AssignmentSource]?,

data/sig/openai/models/admin/organization/projects/hosted_tool_permission_update_params.rbs CHANGED Viewed

@@ -20,16 +20,31 @@ module OpenAI
             attr_accessor project_id: String
+            # The code interpreter permission update.
             attr_accessor code_interpreter: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::CodeInterpreter?
+            # The file search permission update.
             attr_accessor file_search: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::FileSearch?
+            # The image generation permission update.
             attr_accessor image_generation: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::ImageGeneration?
+            # The MCP permission update.
             attr_accessor mcp: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::Mcp?
+            # The web search permission update.
             attr_accessor web_search: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::WebSearch?
+            # @param code_interpreter
+            #   The code interpreter permission update.
+            # @param file_search
+            #   The file search permission update.
+            # @param image_generation
+            #   The image generation permission update.
+            # @param mcp
+            #   The MCP permission update.
+            # @param web_search
+            #   The web search permission update.
             def initialize: (
               project_id: String,
               ?code_interpreter: OpenAI::Admin::Organization::Projects::HostedToolPermissionUpdateParams::CodeInterpreter?,
@@ -53,8 +68,11 @@ module OpenAI
             type code_interpreter = { enabled: bool }
             class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+              # Whether to enable the hosted tool for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether to enable the hosted tool for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -63,8 +81,11 @@ module OpenAI
             type file_search = { enabled: bool }
             class FileSearch < OpenAI::Internal::Type::BaseModel
+              # Whether to enable the hosted tool for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether to enable the hosted tool for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -73,8 +94,11 @@ module OpenAI
             type image_generation = { enabled: bool }
             class ImageGeneration < OpenAI::Internal::Type::BaseModel
+              # Whether to enable the hosted tool for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether to enable the hosted tool for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -83,8 +107,11 @@ module OpenAI
             type mcp = { enabled: bool }
             class Mcp < OpenAI::Internal::Type::BaseModel
+              # Whether to enable the hosted tool for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether to enable the hosted tool for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -93,8 +120,11 @@ module OpenAI
             type web_search = { enabled: bool }
             class WebSearch < OpenAI::Internal::Type::BaseModel
+              # Whether to enable the hosted tool for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether to enable the hosted tool for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }

data/sig/openai/models/admin/organization/projects/model_permission_update_params.rbs CHANGED Viewed

@@ -17,10 +17,16 @@ module OpenAI
             attr_accessor project_id: String
+            # The model permissions mode to apply.
             attr_accessor mode: OpenAI::Models::Admin::Organization::Projects::ModelPermissionUpdateParams::mode
+            # The model IDs included in this permissions policy.
             attr_accessor model_ids: ::Array[String]
+            # @param mode
+            #   The model permissions mode to apply.
+            # @param model_ids
+            #   The model IDs included in this permissions policy.
             def initialize: (
               project_id: String,
               mode: OpenAI::Models::Admin::Organization::Projects::ModelPermissionUpdateParams::mode,

data/sig/openai/models/admin/organization/projects/project_api_key.rbs CHANGED Viewed

@@ -19,24 +19,50 @@ module OpenAI
             }
           class ProjectAPIKey < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
+            # The Unix timestamp (in seconds) of when the API key was created
             attr_accessor created_at: Integer
+            # The Unix timestamp (in seconds) of when the API key was last used.
             attr_accessor last_used_at: Integer?
+            # The name of the API key
             attr_accessor name: String
+            # The object type, which is always `organization.project.api_key`
             attr_accessor object: :"organization.project.api_key"
             attr_accessor owner: OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner
+            # Whether the API key's owner currently has effective access to the project.
             attr_accessor owner_project_access: OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::owner_project_access
+            # The redacted value of the API key
             attr_accessor redacted_value: String
+            # The Unix timestamp (in seconds) when the API key expires, or null if it does not
+            # expire.
             attr_accessor expires_at: Integer?
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the API key was created
+            # @param last_used_at
+            #   The Unix timestamp (in seconds) of when the API key was last used.
+            # @param name
+            #   The name of the API key
+            # @param owner_project_access
+            #   Whether the API key's owner currently has effective access to the project.
+            # @param redacted_value
+            #   The redacted value of the API key
+            # @param expires_at
+            #   The Unix timestamp (in seconds) when the API key expires, or null if it does not
+            #   expire.
+            # @param object
+            #   The object type, which is always `organization.project.api_key`
             def initialize: (
               id: String,
               created_at: Integer,
@@ -69,24 +95,36 @@ module OpenAI
               }
             class Owner < OpenAI::Internal::Type::BaseModel
+              # The service account that owns a project API key.
               attr_reader service_account: OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount?
+              # The service account that owns a project API key.
               def service_account=: (
                 OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount
               ) -> OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount
+              # `user` or `service_account`
               attr_reader type: OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::type_?
+              # `user` or `service_account`
               def type=: (
                 OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::type_
               ) -> OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::type_
+              # The user that owns a project API key.
               attr_reader user: OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::User?
+              # The user that owns a project API key.
               def user=: (
                 OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::User
               ) -> OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::User
+              # @param service_account
+              #   The service account that owns a project API key.
+              # @param type
+              #   `user` or `service_account`
+              # @param user
+              #   The user that owns a project API key.
               def initialize: (
                 ?service_account: OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount,
                 ?type: OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::type_,
@@ -103,14 +141,26 @@ module OpenAI
                 { id: String, created_at: Integer, name: String, role: String }
               class ServiceAccount < OpenAI::Internal::Type::BaseModel
+                # The identifier, which can be referenced in API endpoints
                 attr_accessor id: String
+                # The Unix timestamp (in seconds) of when the service account was created.
                 attr_accessor created_at: Integer
+                # The name of the service account.
                 attr_accessor name: String
+                # The service account's project role.
                 attr_accessor role: String
+                # @param id
+                #   The identifier, which can be referenced in API endpoints
+                # @param created_at
+                #   The Unix timestamp (in seconds) of when the service account was created.
+                # @param name
+                #   The name of the service account.
+                # @param role
+                #   The service account's project role.
                 def initialize: (
                   id: String,
                   created_at: Integer,
@@ -147,16 +197,31 @@ module OpenAI
                 }
               class User < OpenAI::Internal::Type::BaseModel
+                # The identifier, which can be referenced in API endpoints
                 attr_accessor id: String
+                # The Unix timestamp (in seconds) of when the user was created.
                 attr_accessor created_at: Integer
+                # The email address of the user.
                 attr_accessor email: String
+                # The name of the user.
                 attr_accessor name: String
+                # The user's project role.
                 attr_accessor role: String
+                # @param id
+                #   The identifier, which can be referenced in API endpoints
+                # @param created_at
+                #   The Unix timestamp (in seconds) of when the user was created.
+                # @param email
+                #   The email address of the user.
+                # @param name
+                #   The name of the user.
+                # @param role
+                #   The user's project role.
                 def initialize: (
                   id: String,
                   created_at: Integer,

data/sig/openai/models/admin/organization/projects/project_data_retention.rbs CHANGED Viewed

@@ -12,10 +12,16 @@ module OpenAI
             }
           class ProjectDataRetention < OpenAI::Internal::Type::BaseModel
+            # The object type, which is always `project.data_retention`.
             attr_accessor object: :"project.data_retention"
+            # The configured project data retention type.
             attr_accessor type: OpenAI::Models::Admin::Organization::Projects::ProjectDataRetention::type_
+            # @param type
+            #   The configured project data retention type.
+            # @param object
+            #   The object type, which is always `project.data_retention`.
             def initialize: (
               type: OpenAI::Models::Admin::Organization::Projects::ProjectDataRetention::type_,
               ?object: :"project.data_retention"

data/sig/openai/models/admin/organization/projects/project_group.rbs CHANGED Viewed

@@ -16,18 +16,36 @@ module OpenAI
             }
           class ProjectGroup < OpenAI::Internal::Type::BaseModel
+            # Unix timestamp (in seconds) when the group was granted project access.
             attr_accessor created_at: Integer
+            # Identifier of the group that has access to the project.
             attr_accessor group_id: String
+            # Display name of the group.
             attr_accessor group_name: String
+            # The type of the group.
             attr_accessor group_type: OpenAI::Models::Admin::Organization::Projects::ProjectGroup::group_type
+            # Always `project.group`.
             attr_accessor object: :"project.group"
+            # Identifier of the project.
             attr_accessor project_id: String
+            # @param created_at
+            #   Unix timestamp (in seconds) when the group was granted project access.
+            # @param group_id
+            #   Identifier of the group that has access to the project.
+            # @param group_name
+            #   Display name of the group.
+            # @param group_type
+            #   The type of the group.
+            # @param project_id
+            #   Identifier of the project.
+            # @param object
+            #   Always `project.group`.
             def initialize: (
               created_at: Integer,
               group_id: String,

data/sig/openai/models/admin/organization/projects/project_hosted_tool_permissions.rbs CHANGED Viewed

@@ -15,16 +15,31 @@ module OpenAI
             }
           class ProjectHostedToolPermissions < OpenAI::Internal::Type::BaseModel
+            # Permission state for a single hosted tool on a project.
             attr_accessor code_interpreter: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::CodeInterpreter
+            # Permission state for a single hosted tool on a project.
             attr_accessor file_search: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::FileSearch
+            # Permission state for a single hosted tool on a project.
             attr_accessor image_generation: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::ImageGeneration
+            # Permission state for a single hosted tool on a project.
             attr_accessor mcp: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::Mcp
+            # Permission state for a single hosted tool on a project.
             attr_accessor web_search: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::WebSearch
+            # @param code_interpreter
+            #   Permission state for a single hosted tool on a project.
+            # @param file_search
+            #   Permission state for a single hosted tool on a project.
+            # @param image_generation
+            #   Permission state for a single hosted tool on a project.
+            # @param mcp
+            #   Permission state for a single hosted tool on a project.
+            # @param web_search
+            #   Permission state for a single hosted tool on a project.
             def initialize: (
               code_interpreter: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::CodeInterpreter,
               file_search: OpenAI::Admin::Organization::Projects::ProjectHostedToolPermissions::FileSearch,
@@ -44,8 +59,11 @@ module OpenAI
             type code_interpreter = { enabled: bool }
             class CodeInterpreter < OpenAI::Internal::Type::BaseModel
+              # Whether the hosted tool is enabled for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether the hosted tool is enabled for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -54,8 +72,11 @@ module OpenAI
             type file_search = { enabled: bool }
             class FileSearch < OpenAI::Internal::Type::BaseModel
+              # Whether the hosted tool is enabled for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether the hosted tool is enabled for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -64,8 +85,11 @@ module OpenAI
             type image_generation = { enabled: bool }
             class ImageGeneration < OpenAI::Internal::Type::BaseModel
+              # Whether the hosted tool is enabled for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether the hosted tool is enabled for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -74,8 +98,11 @@ module OpenAI
             type mcp = { enabled: bool }
             class Mcp < OpenAI::Internal::Type::BaseModel
+              # Whether the hosted tool is enabled for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether the hosted tool is enabled for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }
@@ -84,8 +111,11 @@ module OpenAI
             type web_search = { enabled: bool }
             class WebSearch < OpenAI::Internal::Type::BaseModel
+              # Whether the hosted tool is enabled for the project.
               attr_accessor enabled: bool
+              # @param enabled
+              #   Whether the hosted tool is enabled for the project.
               def initialize: (enabled: bool) -> void
               def to_hash: -> { enabled: bool }

data/sig/openai/models/admin/organization/projects/project_model_permissions.rbs CHANGED Viewed

@@ -13,12 +13,21 @@ module OpenAI
             }
           class ProjectModelPermissions < OpenAI::Internal::Type::BaseModel
+            # Whether the project uses an allowlist or a denylist.
             attr_accessor mode: OpenAI::Models::Admin::Organization::Projects::ProjectModelPermissions::mode
+            # The model IDs included in the model permissions policy.
             attr_accessor model_ids: ::Array[String]
+            # The object type, which is always `project.model_permissions`.
             attr_accessor object: :"project.model_permissions"
+            # @param mode
+            #   Whether the project uses an allowlist or a denylist.
+            # @param model_ids
+            #   The model IDs included in the model permissions policy.
+            # @param object
+            #   The object type, which is always `project.model_permissions`.
             def initialize: (
               mode: OpenAI::Models::Admin::Organization::Projects::ProjectModelPermissions::mode,
               model_ids: ::Array[String],

data/sig/openai/models/admin/organization/projects/project_model_permissions_deleted.rbs CHANGED Viewed

@@ -9,10 +9,16 @@ module OpenAI
             { deleted: bool, ?object: :"project.model_permissions.deleted" }
           class ProjectModelPermissionsDeleted < OpenAI::Internal::Type::BaseModel
+            # Whether the project model permissions were deleted.
             attr_accessor deleted: bool
+            # The object type, which is always `project.model_permissions.deleted`.
             attr_accessor object: :"project.model_permissions.deleted"
+            # @param deleted
+            #   Whether the project model permissions were deleted.
+            # @param object
+            #   The object type, which is always `project.model_permissions.deleted`.
             def initialize: (
               deleted: bool,
               ?object: :"project.model_permissions.deleted"

data/sig/openai/models/admin/organization/projects/project_rate_limit.rbs CHANGED Viewed

@@ -19,32 +19,63 @@ module OpenAI
             }
           class ProjectRateLimit < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints.
             attr_accessor id: String
+            # The maximum requests per minute.
             attr_accessor max_requests_per_1_minute: Integer
+            # The maximum tokens per minute.
             attr_accessor max_tokens_per_1_minute: Integer
+            # The model this rate limit applies to.
             attr_accessor model: String
+            # The object type, which is always `project.rate_limit`
             attr_accessor object: :"project.rate_limit"
+            # The maximum batch input tokens per day. Only present for relevant models.
             attr_reader batch_1_day_max_input_tokens: Integer?
+            # The maximum batch input tokens per day. Only present for relevant models.
             def batch_1_day_max_input_tokens=: (Integer) -> Integer
+            # The maximum audio megabytes per minute. Only present for relevant models.
             attr_reader max_audio_megabytes_per_1_minute: Integer?
+            # The maximum audio megabytes per minute. Only present for relevant models.
             def max_audio_megabytes_per_1_minute=: (Integer) -> Integer
+            # The maximum images per minute. Only present for relevant models.
             attr_reader max_images_per_1_minute: Integer?
+            # The maximum images per minute. Only present for relevant models.
             def max_images_per_1_minute=: (Integer) -> Integer
+            # The maximum requests per day. Only present for relevant models.
             attr_reader max_requests_per_1_day: Integer?
+            # The maximum requests per day. Only present for relevant models.
             def max_requests_per_1_day=: (Integer) -> Integer
+            # @param id
+            #   The identifier, which can be referenced in API endpoints.
+            # @param max_requests_per_1_minute
+            #   The maximum requests per minute.
+            # @param max_tokens_per_1_minute
+            #   The maximum tokens per minute.
+            # @param model
+            #   The model this rate limit applies to.
+            # @param batch_1_day_max_input_tokens
+            #   The maximum batch input tokens per day. Only present for relevant models.
+            # @param max_audio_megabytes_per_1_minute
+            #   The maximum audio megabytes per minute. Only present for relevant models.
+            # @param max_images_per_1_minute
+            #   The maximum images per minute. Only present for relevant models.
+            # @param max_requests_per_1_day
+            #   The maximum requests per day. Only present for relevant models.
+            # @param object
+            #   The object type, which is always `project.rate_limit`
             def initialize: (
               id: String,
               max_requests_per_1_minute: Integer,

data/sig/openai/models/admin/organization/projects/project_service_account.rbs CHANGED Viewed

@@ -15,16 +15,31 @@ module OpenAI
             }
           class ProjectServiceAccount < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
+            # The Unix timestamp (in seconds) of when the service account was created
             attr_accessor created_at: Integer
+            # The name of the service account
             attr_accessor name: String
+            # The object type, which is always `organization.project.service_account`
             attr_accessor object: :"organization.project.service_account"
+            # `owner`, `member`, or `none`
             attr_accessor role: OpenAI::Models::Admin::Organization::Projects::ProjectServiceAccount::role
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the service account was created
+            # @param name
+            #   The name of the service account
+            # @param role
+            #   `owner`, `member`, or `none`
+            # @param object
+            #   The object type, which is always `organization.project.service_account`
             def initialize: (
               id: String,
               created_at: Integer,

data/sig/openai/models/admin/organization/projects/project_spend_alert.rbs CHANGED Viewed

@@ -16,18 +16,36 @@ module OpenAI
             }
           class ProjectSpendAlert < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints.
             attr_accessor id: String
+            # The currency for the threshold amount.
             attr_accessor currency: OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::currency
+            # The time interval for evaluating spend against the threshold.
             attr_accessor interval: OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::interval
+            # Email notification settings for a spend alert.
             attr_accessor notification_channel: OpenAI::Admin::Organization::Projects::ProjectSpendAlert::NotificationChannel
+            # The object type, which is always `project.spend_alert`.
             attr_accessor object: :"project.spend_alert"
+            # The alert threshold amount, in cents.
             attr_accessor threshold_amount: Integer
+            # @param id
+            #   The identifier, which can be referenced in API endpoints.
+            # @param currency
+            #   The currency for the threshold amount.
+            # @param interval
+            #   The time interval for evaluating spend against the threshold.
+            # @param notification_channel
+            #   Email notification settings for a spend alert.
+            # @param threshold_amount
+            #   The alert threshold amount, in cents.
+            # @param object
+            #   The object type, which is always `project.spend_alert`.
             def initialize: (
               id: String,
               currency: OpenAI::Models::Admin::Organization::Projects::ProjectSpendAlert::currency,
@@ -74,12 +92,21 @@ module OpenAI
               }
             class NotificationChannel < OpenAI::Internal::Type::BaseModel
+              # Email addresses that receive the spend alert notification.
               attr_accessor recipients: ::Array[String]
+              # The notification channel type. Currently only `email` is supported.
               attr_accessor type: :email
+              # Optional subject prefix for alert emails.
               attr_accessor subject_prefix: String?
+              # @param recipients
+              #   Email addresses that receive the spend alert notification.
+              # @param subject_prefix
+              #   Optional subject prefix for alert emails.
+              # @param type
+              #   The notification channel type. Currently only `email` is supported.
               def initialize: (
                 recipients: ::Array[String],
                 ?subject_prefix: String?,