openai 0.92.0 → 0.93.0

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

@@ -14,18 +14,45 @@ 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
 
+          # If `true` returns all projects including those that have been `archived`.
+          # Archived projects are not included by default.
           attr_reader include_archived: bool?
 
+          # If `true` returns all projects including those that have been `archived`.
+          # Archived projects are not included by default.
           def include_archived=: (bool) -> bool
 
+          # 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 include_archived
+          #   If `true` returns all projects including those that have been `archived`.
+          #   Archived projects are not included by default.
+          # @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,
             ?include_archived: bool,

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

@@ -17,12 +17,23 @@ module OpenAI
 
           attr_accessor project_id: String
 
+          # External key ID to associate with the project.
           attr_accessor external_key_id: String?
 
+          # Geography for the project. Deprecated: use `residency` when creating a project
+          # to configure data residency. This field is retained for backward compatibility.
           attr_accessor geography: String?
 
+          # The updated name of the project, this name appears in reports.
           attr_accessor name: String?
 
+          # @param external_key_id
+          #   External key ID to associate with the project.
+          # @param geography
+          #   Geography for the project. Deprecated: use `residency` when creating a project
+          #   to configure data residency. This field is retained for backward compatibility.
+          # @param name
+          #   The updated name of the project, this name appears in reports.
           def initialize: (
             project_id: String,
             ?external_key_id: String?,

data/sig/openai/models/admin/organization/projects/api_key_list_params.rbs

@@ -18,20 +18,56 @@ module OpenAI
 
             attr_accessor project_id: 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.
             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
 
+            # Filter API keys by whether the owner currently has effective access to the
+            # project. Use `active` for owners with access, `inactive` for owners without
+            # access, or `any` for all enabled project API keys. If omitted, the endpoint
+            # applies its existing membership-based visibility rules, which may exclude some
+            # enabled keys.
             attr_reader owner_project_access: OpenAI::Models::Admin::Organization::Projects::APIKeyListParams::owner_project_access?
 
+            # Filter API keys by whether the owner currently has effective access to the
+            # project. Use `active` for owners with access, `inactive` for owners without
+            # access, or `any` for all enabled project API keys. If omitted, the endpoint
+            # applies its existing membership-based visibility rules, which may exclude some
+            # enabled keys.
             def owner_project_access=: (
               OpenAI::Models::Admin::Organization::Projects::APIKeyListParams::owner_project_access
             ) -> OpenAI::Models::Admin::Organization::Projects::APIKeyListParams::owner_project_access
 
+            # @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.
+            # @param owner_project_access
+            #   Filter API keys by whether the owner currently has effective access to the
+            #   project. Use `active` for owners with access, `inactive` for owners without
+            #   access, or `any` for all enabled project API keys. If omitted, the endpoint
+            #   applies its existing membership-based visibility rules, which may exclude some
+            #   enabled keys.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/certificate_activate_response.rbs

@@ -14,18 +14,33 @@ module OpenAI
             }
 
           class CertificateActivateResponse < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
 
+            # Whether the certificate is currently active at the project level.
             attr_accessor active: bool
 
             attr_accessor certificate_details: OpenAI::Models::Admin::Organization::Projects::CertificateActivateResponse::CertificateDetails
 
+            # The Unix timestamp (in seconds) of when the certificate was uploaded.
             attr_accessor created_at: Integer
 
+            # The name of the certificate.
             attr_accessor name: String?
 
+            # The object type, which is always `organization.project.certificate`.
             attr_accessor object: :"organization.project.certificate"
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param active
+            #   Whether the certificate is currently active at the project level.
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+            # @param name
+            #   The name of the certificate.
+            # @param object
+            #   The object type, which is always `organization.project.certificate`.
             def initialize: (
               id: String,
               active: bool,
@@ -48,14 +63,22 @@ module OpenAI
               { ?expires_at: Integer, ?valid_at: Integer }
 
             class CertificateDetails < OpenAI::Internal::Type::BaseModel
+              # The Unix timestamp (in seconds) of when the certificate expires.
               attr_reader expires_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate expires.
               def expires_at=: (Integer) -> Integer
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               attr_reader valid_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               def valid_at=: (Integer) -> Integer
 
+              # @param expires_at
+              #   The Unix timestamp (in seconds) of when the certificate expires.
+              # @param valid_at
+              #   The Unix timestamp (in seconds) of when the certificate becomes valid.
               def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
               def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/projects/certificate_deactivate_response.rbs

@@ -14,18 +14,33 @@ module OpenAI
             }
 
           class CertificateDeactivateResponse < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
 
+            # Whether the certificate is currently active at the project level.
             attr_accessor active: bool
 
             attr_accessor certificate_details: OpenAI::Models::Admin::Organization::Projects::CertificateDeactivateResponse::CertificateDetails
 
+            # The Unix timestamp (in seconds) of when the certificate was uploaded.
             attr_accessor created_at: Integer
 
+            # The name of the certificate.
             attr_accessor name: String?
 
+            # The object type, which is always `organization.project.certificate`.
             attr_accessor object: :"organization.project.certificate"
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param active
+            #   Whether the certificate is currently active at the project level.
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+            # @param name
+            #   The name of the certificate.
+            # @param object
+            #   The object type, which is always `organization.project.certificate`.
             def initialize: (
               id: String,
               active: bool,
@@ -48,14 +63,22 @@ module OpenAI
               { ?expires_at: Integer, ?valid_at: Integer }
 
             class CertificateDetails < OpenAI::Internal::Type::BaseModel
+              # The Unix timestamp (in seconds) of when the certificate expires.
               attr_reader expires_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate expires.
               def expires_at=: (Integer) -> Integer
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               attr_reader valid_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               def valid_at=: (Integer) -> Integer
 
+              # @param expires_at
+              #   The Unix timestamp (in seconds) of when the certificate expires.
+              # @param valid_at
+              #   The Unix timestamp (in seconds) of when the certificate becomes valid.
               def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
               def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/projects/certificate_list_params.rbs

@@ -18,20 +18,47 @@ module OpenAI
 
             attr_accessor project_id: 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.
             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
 
+            # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+            # order and `desc` for descending order.
             attr_reader order: OpenAI::Models::Admin::Organization::Projects::CertificateListParams::order?
 
+            # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+            # order and `desc` for descending order.
             def order=: (
               OpenAI::Models::Admin::Organization::Projects::CertificateListParams::order
             ) -> OpenAI::Models::Admin::Organization::Projects::CertificateListParams::order
 
+            # @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.
+            # @param order
+            #   Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+            #   order and `desc` for descending order.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/certificate_list_response.rbs

@@ -14,18 +14,33 @@ module OpenAI
             }
 
           class CertificateListResponse < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
 
+            # Whether the certificate is currently active at the project level.
             attr_accessor active: bool
 
             attr_accessor certificate_details: OpenAI::Models::Admin::Organization::Projects::CertificateListResponse::CertificateDetails
 
+            # The Unix timestamp (in seconds) of when the certificate was uploaded.
             attr_accessor created_at: Integer
 
+            # The name of the certificate.
             attr_accessor name: String?
 
+            # The object type, which is always `organization.project.certificate`.
             attr_accessor object: :"organization.project.certificate"
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param active
+            #   Whether the certificate is currently active at the project level.
+            # @param created_at
+            #   The Unix timestamp (in seconds) of when the certificate was uploaded.
+            # @param name
+            #   The name of the certificate.
+            # @param object
+            #   The object type, which is always `organization.project.certificate`.
             def initialize: (
               id: String,
               active: bool,
@@ -48,14 +63,22 @@ module OpenAI
               { ?expires_at: Integer, ?valid_at: Integer }
 
             class CertificateDetails < OpenAI::Internal::Type::BaseModel
+              # The Unix timestamp (in seconds) of when the certificate expires.
               attr_reader expires_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate expires.
               def expires_at=: (Integer) -> Integer
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               attr_reader valid_at: Integer?
 
+              # The Unix timestamp (in seconds) of when the certificate becomes valid.
               def valid_at=: (Integer) -> Integer
 
+              # @param expires_at
+              #   The Unix timestamp (in seconds) of when the certificate expires.
+              # @param valid_at
+              #   The Unix timestamp (in seconds) of when the certificate becomes valid.
               def initialize: (?expires_at: Integer, ?valid_at: Integer) -> void
 
               def to_hash: -> { ?expires_at: Integer, ?valid_at: Integer }

data/sig/openai/models/admin/organization/projects/data_retention_update_params.rbs

@@ -16,8 +16,11 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # The desired project data retention type.
             attr_accessor retention_type: OpenAI::Models::Admin::Organization::Projects::DataRetentionUpdateParams::retention_type
 
+            # @param retention_type
+            #   The desired project data retention type.
             def initialize: (
               project_id: String,
               retention_type: OpenAI::Models::Admin::Organization::Projects::DataRetentionUpdateParams::retention_type,

data/sig/openai/models/admin/organization/projects/group_create_params.rbs

@@ -17,10 +17,16 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # Identifier of the group to add to the project.
             attr_accessor group_id: String
 
+            # Identifier of the project role to grant to the group.
             attr_accessor role: String
 
+            # @param group_id
+            #   Identifier of the group to add to the project.
+            # @param role
+            #   Identifier of the project role to grant to the group.
             def initialize: (
               project_id: String,
               group_id: String,

data/sig/openai/models/admin/organization/projects/group_delete_response.rbs

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

data/sig/openai/models/admin/organization/projects/group_list_params.rbs

@@ -18,20 +18,35 @@ module OpenAI
 
             attr_accessor project_id: String
 
+            # Cursor for pagination. Provide the ID of the last group from the previous
+            # response to fetch the next page.
             attr_reader after: String?
 
+            # Cursor for pagination. Provide the ID of the last group from the previous
+            # response to fetch the next page.
             def after=: (String) -> String
 
+            # A limit on the number of project groups to return. Defaults to 20.
             attr_reader limit: Integer?
 
+            # A limit on the number of project groups to return. Defaults to 20.
             def limit=: (Integer) -> Integer
 
+            # Sort order for the returned groups.
             attr_reader order: OpenAI::Models::Admin::Organization::Projects::GroupListParams::order?
 
+            # Sort order for the returned groups.
             def order=: (
               OpenAI::Models::Admin::Organization::Projects::GroupListParams::order
             ) -> OpenAI::Models::Admin::Organization::Projects::GroupListParams::order
 
+            # @param after
+            #   Cursor for pagination. Provide the ID of the last group from the previous
+            #   response to fetch the next page.
+            # @param limit
+            #   A limit on the number of project groups to return. Defaults to 20.
+            # @param order
+            #   Sort order for the returned groups.
             def initialize: (
               project_id: String,
               ?after: String,

data/sig/openai/models/admin/organization/projects/group_retrieve_params.rbs

@@ -19,12 +19,16 @@ module OpenAI
 
             attr_accessor group_id: String
 
+            # The type of group to retrieve.
             attr_reader group_type: OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams::group_type?
 
+            # The type of group to retrieve.
             def group_type=: (
               OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams::group_type
             ) -> OpenAI::Models::Admin::Organization::Projects::GroupRetrieveParams::group_type
 
+            # @param group_type
+            #   The type of group to retrieve.
             def initialize: (
               project_id: String,
               group_id: String,

data/sig/openai/models/admin/organization/projects/groups/role_create_params.rbs

@@ -20,8 +20,11 @@ module OpenAI
 
               attr_accessor group_id: String
 
+              # Identifier of the role to assign.
               attr_accessor role_id: String
 
+              # @param role_id
+              #   Identifier of the role to assign.
               def initialize: (
                 project_id: String,
                 group_id: String,

data/sig/openai/models/admin/organization/projects/groups/role_create_response.rbs

@@ -12,12 +12,21 @@ module OpenAI
               }
 
             class RoleCreateResponse < OpenAI::Internal::Type::BaseModel
+              # Summary information about a group returned in role assignment responses.
               attr_accessor group: OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse::Group
 
+              # Always `group.role`.
               attr_accessor object: :"group.role"
 
+              # Details about a role that can be assigned through the public Roles API.
               attr_accessor role: OpenAI::Admin::Organization::Role
 
+              # @param group
+              #   Summary information about a group returned in role assignment responses.
+              # @param role
+              #   Details about a role that can be assigned through the public Roles API.
+              # @param object
+              #   Always `group.role`.
               def initialize: (
                 group: OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse::Group,
                 role: OpenAI::Admin::Organization::Role,
@@ -40,16 +49,31 @@ module OpenAI
                 }
 
               class Group < OpenAI::Internal::Type::BaseModel
+                # Identifier for the group.
                 attr_accessor id: String
 
+                # Unix timestamp (in seconds) when the group was created.
                 attr_accessor created_at: Integer
 
+                # Display name of the group.
                 attr_accessor name: String
 
+                # Always `group`.
                 attr_accessor object: :group
 
+                # Whether the group is managed through SCIM.
                 attr_accessor scim_managed: bool
 
+                # @param id
+                #   Identifier for the group.
+                # @param created_at
+                #   Unix timestamp (in seconds) when the group was created.
+                # @param name
+                #   Display name of the group.
+                # @param scim_managed
+                #   Whether the group is managed through SCIM.
+                # @param object
+                #   Always `group`.
                 def initialize: (
                   id: String,
                   created_at: Integer,

data/sig/openai/models/admin/organization/projects/groups/role_delete_response.rbs

@@ -7,10 +7,18 @@ module OpenAI
             type role_delete_response = { deleted: bool, object: String }
 
             class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+              # Whether the assignment was removed.
               attr_accessor deleted: bool
 
+              # Identifier for the deleted assignment, such as `group.role.deleted` or
+              # `user.role.deleted`.
               attr_accessor object: String
 
+              # @param deleted
+              #   Whether the assignment was removed.
+              # @param object
+              #   Identifier for the deleted assignment, such as `group.role.deleted` or
+              #   `user.role.deleted`.
               def initialize: (deleted: bool, object: String) -> void
 
               def to_hash: -> { deleted: bool, object: String }

data/sig/openai/models/admin/organization/projects/groups/role_list_params.rbs

@@ -22,20 +22,35 @@ module OpenAI
 
               attr_accessor group_id: String
 
+              # Cursor for pagination. Provide the value from the previous response's `next`
+              # field to continue listing project roles.
               attr_reader after: String?
 
+              # Cursor for pagination. Provide the value from the previous response's `next`
+              # field to continue listing project roles.
               def after=: (String) -> String
 
+              # A limit on the number of project role assignments to return.
               attr_reader limit: Integer?
 
+              # A limit on the number of project role assignments to return.
               def limit=: (Integer) -> Integer
 
+              # Sort order for the returned project roles.
               attr_reader order: OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams::order?
 
+              # Sort order for the returned project roles.
               def order=: (
                 OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams::order
               ) -> OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams::order
 
+              # @param after
+              #   Cursor for pagination. Provide the value from the previous response's `next`
+              #   field to continue listing project roles.
+              # @param limit
+              #   A limit on the number of project role assignments to return.
+              # @param order
+              #   Sort order for the returned project roles.
               def initialize: (
                 project_id: String,
                 group_id: String,

data/sig/openai/models/admin/organization/projects/groups/role_list_response.rbs

@@ -21,30 +21,66 @@ module OpenAI
               }
 
             class RoleListResponse < 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::RoleListResponse::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::RoleListResponse::AssignmentSource]?,