openai 0.92.0 → 0.93.0

data/sig/openai/models/admin/organization/groups/user_delete_response.rbs

@@ -7,10 +7,16 @@ module OpenAI
             { deleted: bool, ?object: :"group.user.deleted" }
 
           class UserDeleteResponse < OpenAI::Internal::Type::BaseModel
+            # Whether the group membership was removed.
             attr_accessor deleted: bool
 
+            # Always `group.user.deleted`.
             attr_accessor object: :"group.user.deleted"
 
+            # @param deleted
+            #   Whether the group membership was removed.
+            # @param object
+            #   Always `group.user.deleted`.
             def initialize: (
               deleted: bool,
               ?object: :"group.user.deleted"

data/sig/openai/models/admin/organization/groups/user_list_params.rbs

@@ -18,20 +18,38 @@ module OpenAI
 
             attr_accessor group_id: String
 
+            # A cursor for use in pagination. Provide the ID of the last user from the
+            # previous list response to retrieve the next page.
             attr_reader after: String?
 
+            # A cursor for use in pagination. Provide the ID of the last user from the
+            # previous list response to retrieve the next page.
             def after=: (String) -> String
 
+            # A limit on the number of users to be returned. Limit can range between 0 and
+            # 1000, and the default is 100.
             attr_reader limit: Integer?
 
+            # A limit on the number of users to be returned. Limit can range between 0 and
+            # 1000, and the default is 100.
             def limit=: (Integer) -> Integer
 
+            # Specifies the sort order of users in the list.
             attr_reader order: OpenAI::Models::Admin::Organization::Groups::UserListParams::order?
 
+            # Specifies the sort order of users in the list.
             def order=: (
               OpenAI::Models::Admin::Organization::Groups::UserListParams::order
             ) -> OpenAI::Models::Admin::Organization::Groups::UserListParams::order
 
+            # @param after
+            #   A cursor for use in pagination. Provide the ID of the last user from the
+            #   previous list response to retrieve the next page.
+            # @param limit
+            #   A limit on the number of users to be returned. Limit can range between 0 and
+            #   1000, and the default is 100.
+            # @param order
+            #   Specifies the sort order of users in the list.
             def initialize: (
               group_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/groups/user_retrieve_response.rbs

@@ -14,18 +14,36 @@ module OpenAI
             }
 
           class UserRetrieveResponse < OpenAI::Internal::Type::BaseModel
+            # Identifier for the user.
             attr_accessor id: String
 
+            # Email address of the user, or `null` for users without an email.
             attr_accessor email: String?
 
+            # Whether the user is a service account.
             attr_accessor is_service_account: bool?
 
+            # Display name of the user.
             attr_accessor name: String
 
+            # URL of the user's profile picture, if available.
             attr_accessor picture: String?
 
+            # The type of user.
             attr_accessor user_type: OpenAI::Models::Admin::Organization::Groups::UserRetrieveResponse::user_type
 
+            # @param id
+            #   Identifier for the user.
+            # @param email
+            #   Email address of the user, or `null` for users without an email.
+            # @param is_service_account
+            #   Whether the user is a service account.
+            # @param name
+            #   Display name of the user.
+            # @param picture
+            #   URL of the user's profile picture, if available.
+            # @param user_type
+            #   The type of user.
             def initialize: (
               id: String,
               email: String?,

data/sig/openai/models/admin/organization/invite.rbs

@@ -16,24 +16,51 @@ module OpenAI
           }
 
         class Invite < 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 invite was sent.
           attr_accessor created_at: Integer
 
+          # The email address of the individual to whom the invite was sent
           attr_accessor email: String
 
+          # The object type, which is always `organization.invite`
           attr_accessor object: :"organization.invite"
 
+          # The projects that were granted membership upon acceptance of the invite.
           attr_accessor projects: ::Array[OpenAI::Admin::Organization::Invite::Project]
 
+          # `owner` or `reader`
           attr_accessor role: OpenAI::Models::Admin::Organization::Invite::role
 
+          # `accepted`,`expired`, or `pending`
           attr_accessor status: OpenAI::Models::Admin::Organization::Invite::status
 
+          # The Unix timestamp (in seconds) of when the invite was accepted.
           attr_accessor accepted_at: Integer?
 
+          # The Unix timestamp (in seconds) of when the invite expires.
           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 invite was sent.
+          # @param email
+          #   The email address of the individual to whom the invite was sent
+          # @param projects
+          #   The projects that were granted membership upon acceptance of the invite.
+          # @param role
+          #   `owner` or `reader`
+          # @param status
+          #   `accepted`,`expired`, or `pending`
+          # @param accepted_at
+          #   The Unix timestamp (in seconds) of when the invite was accepted.
+          # @param expires_at
+          #   The Unix timestamp (in seconds) of when the invite expires.
+          # @param object
+          #   The object type, which is always `organization.invite`
           def initialize: (
             id: String,
             created_at: Integer,
@@ -65,10 +92,16 @@ module OpenAI
             }
 
           class Project < OpenAI::Internal::Type::BaseModel
+            # Project's public ID
             attr_accessor id: String
 
+            # Project membership role
             attr_accessor role: OpenAI::Models::Admin::Organization::Invite::Project::role
 
+            # @param id
+            #   Project's public ID
+            # @param role
+            #   Project membership role
             def initialize: (
               id: String,
               role: OpenAI::Models::Admin::Organization::Invite::Project::role

data/sig/openai/models/admin/organization/invite_create_params.rbs

@@ -14,16 +14,35 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # Send an email to this address
           attr_accessor email: String
 
+          # `owner` or `reader`
           attr_accessor role: OpenAI::Models::Admin::Organization::InviteCreateParams::role
 
+          # An array of projects to which membership is granted at the same time the org
+          # invite is accepted. If omitted, the user will be invited to the default project
+          # for compatibility with legacy behavior. If empty list is passed, the user will
+          # not be invited to any projects, including the default one.
           attr_reader projects: ::Array[OpenAI::Admin::Organization::InviteCreateParams::Project]?
 
+          # An array of projects to which membership is granted at the same time the org
+          # invite is accepted. If omitted, the user will be invited to the default project
+          # for compatibility with legacy behavior. If empty list is passed, the user will
+          # not be invited to any projects, including the default one.
           def projects=: (
             ::Array[OpenAI::Admin::Organization::InviteCreateParams::Project]
           ) -> ::Array[OpenAI::Admin::Organization::InviteCreateParams::Project]
 
+          # @param email
+          #   Send an email to this address
+          # @param role
+          #   `owner` or `reader`
+          # @param projects
+          #   An array of projects to which membership is granted at the same time the org
+          #   invite is accepted. If omitted, the user will be invited to the default project
+          #   for compatibility with legacy behavior. If empty list is passed, the user will
+          #   not be invited to any projects, including the default one.
           def initialize: (
             email: String,
             role: OpenAI::Models::Admin::Organization::InviteCreateParams::role,
@@ -56,10 +75,16 @@ module OpenAI
             }
 
           class Project < OpenAI::Internal::Type::BaseModel
+            # Project's public ID
             attr_accessor id: String
 
+            # Project membership role
             attr_accessor role: OpenAI::Models::Admin::Organization::InviteCreateParams::Project::role
 
+            # @param id
+            #   Project's public ID
+            # @param role
+            #   Project membership role
             def initialize: (
               id: String,
               role: OpenAI::Models::Admin::Organization::InviteCreateParams::Project::role

data/sig/openai/models/admin/organization/invite_delete_response.rbs

@@ -10,8 +10,11 @@ module OpenAI
 
           attr_accessor deleted: bool
 
+          # The object type, which is always `organization.invite.deleted`
           attr_accessor object: :"organization.invite.deleted"
 
+          # @param object
+          #   The object type, which is always `organization.invite.deleted`
           def initialize: (
             id: String,
             deleted: bool,

data/sig/openai/models/admin/organization/invite_list_params.rbs

@@ -13,14 +13,34 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is an object ID that defines your place
+          # in the list. For instance, if you make a list request and receive 100 objects,
+          # ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          # fetch the next page of the list.
           def after=: (String) -> String
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           attr_reader limit: Integer?
 
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
           def limit=: (Integer) -> Integer
 
+          # @param after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          # @param limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
           def initialize: (
             ?after: String,
             ?limit: Integer,

data/sig/openai/models/admin/organization/organization_data_retention.rbs

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

data/sig/openai/models/admin/organization/organization_spend_alert.rbs

@@ -15,18 +15,36 @@ module OpenAI
           }
 
         class OrganizationSpendAlert < 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::OrganizationSpendAlert::currency
 
+          # The time interval for evaluating spend against the threshold.
           attr_accessor interval: OpenAI::Models::Admin::Organization::OrganizationSpendAlert::interval
 
+          # Email notification settings for a spend alert.
           attr_accessor notification_channel: OpenAI::Admin::Organization::OrganizationSpendAlert::NotificationChannel
 
+          # The object type, which is always `organization.spend_alert`.
           attr_accessor object: :"organization.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 `organization.spend_alert`.
           def initialize: (
             id: String,
             currency: OpenAI::Models::Admin::Organization::OrganizationSpendAlert::currency,
@@ -73,12 +91,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?,

data/sig/openai/models/admin/organization/organization_spend_alert_deleted.rbs

@@ -12,12 +12,21 @@ module OpenAI
           }
 
         class OrganizationSpendAlertDeleted < OpenAI::Internal::Type::BaseModel
+          # The deleted spend alert ID.
           attr_accessor id: String
 
+          # Whether the spend alert was deleted.
           attr_accessor deleted: bool
 
+          # Always `organization.spend_alert.deleted`.
           attr_accessor object: :"organization.spend_alert.deleted"
 
+          # @param id
+          #   The deleted spend alert ID.
+          # @param deleted
+          #   Whether the spend alert was deleted.
+          # @param object
+          #   Always `organization.spend_alert.deleted`.
           def initialize: (
             id: String,
             deleted: bool,

data/sig/openai/models/admin/organization/organization_spend_limit.rbs

@@ -14,16 +14,33 @@ module OpenAI
           }
 
         class OrganizationSpendLimit < OpenAI::Internal::Type::BaseModel
+          # The currency for the threshold amount. Currently, only `USD` is supported.
           attr_accessor currency: OpenAI::Models::Admin::Organization::OrganizationSpendLimit::currency
 
+          # The current enforcement state of the hard spend limit.
           attr_accessor enforcement: OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement
 
+          # The time interval for evaluating spend against the threshold. Currently, only
+          # `month` is supported.
           attr_accessor interval: OpenAI::Models::Admin::Organization::OrganizationSpendLimit::interval
 
+          # The object type, which is always `organization.spend_limit`.
           attr_accessor object: :"organization.spend_limit"
 
+          # The hard spend limit amount, in cents.
           attr_accessor threshold_amount: Integer
 
+          # @param currency
+          #   The currency for the threshold amount. Currently, only `USD` is supported.
+          # @param enforcement
+          #   The current enforcement state of the hard spend limit.
+          # @param interval
+          #   The time interval for evaluating spend against the threshold. Currently, only
+          #   `month` is supported.
+          # @param threshold_amount
+          #   The hard spend limit amount, in cents.
+          # @param object
+          #   The object type, which is always `organization.spend_limit`.
           def initialize: (
             currency: OpenAI::Models::Admin::Organization::OrganizationSpendLimit::currency,
             enforcement: OpenAI::Admin::Organization::OrganizationSpendLimit::Enforcement,
@@ -56,8 +73,11 @@ module OpenAI
             }
 
           class Enforcement < OpenAI::Internal::Type::BaseModel
+            # Whether the hard spend limit is currently enforcing.
             attr_accessor status: OpenAI::Models::Admin::Organization::OrganizationSpendLimit::Enforcement::status
 
+            # @param status
+            #   Whether the hard spend limit is currently enforcing.
             def initialize: (
               status: OpenAI::Models::Admin::Organization::OrganizationSpendLimit::Enforcement::status
             ) -> void

data/sig/openai/models/admin/organization/organization_spend_limit_deleted.rbs

@@ -8,10 +8,16 @@ module OpenAI
           { deleted: bool, ?object: :"organization.spend_limit.deleted" }
 
         class OrganizationSpendLimitDeleted < OpenAI::Internal::Type::BaseModel
+          # Whether the hard spend limit was deleted.
           attr_accessor deleted: bool
 
+          # The object type, which is always `organization.spend_limit.deleted`.
           attr_accessor object: :"organization.spend_limit.deleted"
 
+          # @param deleted
+          #   Whether the hard spend limit was deleted.
+          # @param object
+          #   The object type, which is always `organization.spend_limit.deleted`.
           def initialize: (
             deleted: bool,
             ?object: :"organization.spend_limit.deleted"

data/sig/openai/models/admin/organization/organization_user.rbs

@@ -25,50 +25,103 @@ module OpenAI
           }
 
         class OrganizationUser < 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 added.
           attr_accessor added_at: Integer
 
+          # The object type, which is always `organization.user`
           attr_accessor object: :"organization.user"
 
+          # The Unix timestamp (in seconds) of the user's last API key usage.
           attr_accessor api_key_last_used_at: Integer?
 
+          # The Unix timestamp (in seconds) of when the user was created.
           attr_reader created: Integer?
 
+          # The Unix timestamp (in seconds) of when the user was created.
           def created=: (Integer) -> Integer
 
+          # The developer persona metadata for the user.
           attr_accessor developer_persona: String?
 
+          # The email address of the user
           attr_accessor email: String?
 
+          # Whether this is the organization's default user.
           attr_reader is_default: bool?
 
+          # Whether this is the organization's default user.
           def is_default=: (bool) -> bool
 
+          # Whether the user is an authorized purchaser for Scale Tier.
           attr_accessor is_scale_tier_authorized_purchaser: bool?
 
+          # Whether the user is managed through SCIM.
           attr_reader is_scim_managed: bool?
 
+          # Whether the user is managed through SCIM.
           def is_scim_managed=: (bool) -> bool
 
+          # Whether the user is a service account.
           attr_reader is_service_account: bool?
 
+          # Whether the user is a service account.
           def is_service_account=: (bool) -> bool
 
+          # The name of the user
           attr_accessor name: String?
 
+          # Projects associated with the user, if included.
           attr_accessor projects: OpenAI::Admin::Organization::OrganizationUser::Projects?
 
+          # `owner` or `reader`
           attr_accessor role: String?
 
+          # The technical level metadata for the user.
           attr_accessor technical_level: String?
 
+          # Nested user details.
           attr_reader user: OpenAI::Admin::Organization::OrganizationUser::User?
 
+          # Nested user details.
           def user=: (
             OpenAI::Admin::Organization::OrganizationUser::User
           ) -> OpenAI::Admin::Organization::OrganizationUser::User
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param added_at
+          #   The Unix timestamp (in seconds) of when the user was added.
+          # @param api_key_last_used_at
+          #   The Unix timestamp (in seconds) of the user's last API key usage.
+          # @param created
+          #   The Unix timestamp (in seconds) of when the user was created.
+          # @param developer_persona
+          #   The developer persona metadata for the user.
+          # @param email
+          #   The email address of the user
+          # @param is_default
+          #   Whether this is the organization's default user.
+          # @param is_scale_tier_authorized_purchaser
+          #   Whether the user is an authorized purchaser for Scale Tier.
+          # @param is_scim_managed
+          #   Whether the user is managed through SCIM.
+          # @param is_service_account
+          #   Whether the user is a service account.
+          # @param name
+          #   The name of the user
+          # @param projects
+          #   Projects associated with the user, if included.
+          # @param role
+          #   `owner` or `reader`
+          # @param technical_level
+          #   The technical level metadata for the user.
+          # @param user
+          #   Nested user details.
+          # @param object
+          #   The object type, which is always `organization.user`
           def initialize: (
             id: String,
             added_at: Integer,

data/sig/openai/models/admin/organization/project.rbs

@@ -15,26 +15,51 @@ module OpenAI
           }
 
         class Project < 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 project was created.
           attr_accessor created_at: Integer
 
+          # The object type, which is always `organization.project`
           attr_accessor object: :"organization.project"
 
+          # The Unix timestamp (in seconds) of when the project was archived or `null`.
           attr_accessor archived_at: Integer?
 
+          # The external key associated with the project.
           attr_accessor external_key_id: String?
 
+          # The name of the project. This appears in reporting.
           attr_accessor name: String?
 
+          # The residency configuration for the project.
           attr_reader residency: OpenAI::Models::Admin::Organization::project_residency?
 
+          # The residency configuration for the project.
           def residency=: (
             OpenAI::Models::Admin::Organization::project_residency
           ) -> OpenAI::Models::Admin::Organization::project_residency
 
+          # `active` or `archived`
           attr_accessor status: String?
 
+          # @param id
+          #   The identifier, which can be referenced in API endpoints
+          # @param created_at
+          #   The Unix timestamp (in seconds) of when the project was created.
+          # @param archived_at
+          #   The Unix timestamp (in seconds) of when the project was archived or `null`.
+          # @param external_key_id
+          #   The external key associated with the project.
+          # @param name
+          #   The name of the project. This appears in reporting.
+          # @param residency
+          #   The residency configuration for the project.
+          # @param status
+          #   `active` or `archived`
+          # @param object
+          #   The object type, which is always `organization.project`
           def initialize: (
             id: String,
             created_at: Integer,

data/sig/openai/models/admin/organization/project_create_params.rbs

@@ -15,14 +15,42 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # The friendly name of the project, this name appears in reports.
           attr_accessor name: String
 
+          # External key ID to associate with the project.
           attr_accessor external_key_id: String?
 
+          # Create the project with the specified data residency region. Your organization
+          # must have access to Data residency functionality in order to use. See
+          # [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          # to review the functionality and limitations of setting this field. Deprecated:
+          # use `residency` instead. Do not provide both `geography` and `residency`.
           attr_accessor geography: String?
 
+          # Create the project with the specified residency configuration. Your organization
+          # must have access to the requested residency configuration in order to use it.
+          # See
+          # [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          # to review the functionality and limitations of setting this field.
           attr_accessor residency: OpenAI::Models::Admin::Organization::project_residency?
 
+          # @param name
+          #   The friendly name of the project, this name appears in reports.
+          # @param external_key_id
+          #   External key ID to associate with the project.
+          # @param geography
+          #   Create the project with the specified data residency region. Your organization
+          #   must have access to Data residency functionality in order to use. See
+          #   [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          #   to review the functionality and limitations of setting this field. Deprecated:
+          #   use `residency` instead. Do not provide both `geography` and `residency`.
+          # @param residency
+          #   Create the project with the specified residency configuration. Your organization
+          #   must have access to the requested residency configuration in order to use it.
+          #   See
+          #   [data residency controls](https://developers.openai.com/api/docs/guides/your-data#data-residency-controls)
+          #   to review the functionality and limitations of setting this field.
           def initialize: (
             name: String,
             ?external_key_id: String?,