openai 0.92.0 → 0.94.0

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

@@ -0,0 +1,30 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_delete_params =
+          {
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ExternalStorageDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor external_storage_id: String
+
+          def initialize: (
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            external_storage_id: String,
+            ?request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_deleted =
+          {
+            id: String,
+            deleted: bool,
+            ?object: :"organization.external_storage.deleted"
+          }
+
+        class ExternalStorageDeleted < OpenAI::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor deleted: bool
+
+          attr_accessor object: :"organization.external_storage.deleted"
+
+          def initialize: (
+            id: String,
+            deleted: bool,
+            ?object: :"organization.external_storage.deleted"
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            deleted: bool,
+            ?object: :"organization.external_storage.deleted"
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_list_params =
+          {
+            ?after: String?,
+            ?limit: Integer,
+            ?order: OpenAI::Models::Admin::Organization::ExternalStorageListParams::order,
+            ?project_id: String?,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ExternalStorageListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # Return external storage configurations after this ID.
+          attr_accessor after: String?
+
+          attr_reader limit: Integer?
+
+          def limit=: (Integer) -> Integer
+
+          attr_reader order: OpenAI::Models::Admin::Organization::ExternalStorageListParams::order?
+
+          def order=: (
+            OpenAI::Models::Admin::Organization::ExternalStorageListParams::order
+          ) -> OpenAI::Models::Admin::Organization::ExternalStorageListParams::order
+
+          attr_accessor project_id: String?
+
+          # @param after
+          #   Return external storage configurations after this ID.
+          def initialize: (
+            ?after: String?,
+            ?limit: Integer,
+            ?order: OpenAI::Models::Admin::Organization::ExternalStorageListParams::order,
+            ?project_id: String?,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            ?after: String?,
+            ?limit: Integer,
+            ?order: OpenAI::Models::Admin::Organization::ExternalStorageListParams::order,
+            ?project_id: String?,
+            ?request_options: OpenAI::RequestOptions
+          }
+
+          type order = :asc | :desc
+
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            ASC: :asc
+            DESC: :desc
+
+            def self?.values: -> ::Array[OpenAI::Models::Admin::Organization::ExternalStorageListParams::order]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_retrieve_params =
+          {
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ExternalStorageRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor external_storage_id: String
+
+          def initialize: (
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            external_storage_id: String,
+            ?request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        type external_storage_validate_params =
+          {
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          }
+
+        class ExternalStorageValidateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          attr_accessor external_storage_id: String
+
+          def initialize: (
+            external_storage_id: String,
+            ?request_options: OpenAI::request_opts
+          ) -> void
+
+          def to_hash: -> {
+            external_storage_id: String,
+            ?request_options: OpenAI::RequestOptions
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -12,16 +12,33 @@ 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
 
+          # The type of the group.
           attr_accessor group_type: OpenAI::Models::Admin::Organization::Group::group_type
 
+          # Whether the group is managed through SCIM and controlled by your identity
+          # provider.
           attr_accessor is_scim_managed: bool
 
+          # Display name of the group.
           attr_accessor name: String
 
+          # @param id
+          #   Identifier for the group.
+          # @param created_at
+          #   Unix timestamp (in seconds) when the group was created.
+          # @param group_type
+          #   The type of the group.
+          # @param is_scim_managed
+          #   Whether the group is managed through SCIM and controlled by your identity
+          #   provider.
+          # @param name
+          #   Display name of the group.
           def initialize: (
             id: String,
             created_at: Integer,

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

@@ -9,8 +9,11 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # Human readable name for the group.
           attr_accessor name: String
 
+          # @param name
+          #   Human readable name for the group.
           def initialize: (
             name: String,
             ?request_options: OpenAI::request_opts

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

@@ -6,12 +6,21 @@ module OpenAI
           { id: String, deleted: bool, ?object: :"group.deleted" }
 
         class GroupDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # Identifier of the deleted group.
           attr_accessor id: String
 
+          # Whether the group was deleted.
           attr_accessor deleted: bool
 
+          # Always `group.deleted`.
           attr_accessor object: :"group.deleted"
 
+          # @param id
+          #   Identifier of the deleted group.
+          # @param deleted
+          #   Whether the group was deleted.
+          # @param object
+          #   Always `group.deleted`.
           def initialize: (
             id: String,
             deleted: bool,

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

@@ -14,20 +14,44 @@ module OpenAI
           extend OpenAI::Internal::Type::RequestParameters::Converter
           include OpenAI::Internal::Type::RequestParameters
 
+          # A cursor for use in pagination. `after` is a group ID that defines your place in
+          # the list. For instance, if you make a list request and receive 100 objects,
+          # ending with group_abc, your subsequent call can include `after=group_abc` in
+          # order to fetch the next page of the list.
           attr_reader after: String?
 
+          # A cursor for use in pagination. `after` is a group ID that defines your place in
+          # the list. For instance, if you make a list request and receive 100 objects,
+          # ending with group_abc, your subsequent call can include `after=group_abc` in
+          # order to fetch the next page of the list.
           def after=: (String) -> String
 
+          # A limit on the number of groups 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 groups to be returned. Limit can range between 0 and
+          # 1000, and the default is 100.
           def limit=: (Integer) -> Integer
 
+          # Specifies the sort order of the returned groups.
           attr_reader order: OpenAI::Models::Admin::Organization::GroupListParams::order?
 
+          # Specifies the sort order of the returned groups.
           def order=: (
             OpenAI::Models::Admin::Organization::GroupListParams::order
           ) -> OpenAI::Models::Admin::Organization::GroupListParams::order
 
+          # @param after
+          #   A cursor for use in pagination. `after` is a group ID that defines your place in
+          #   the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with group_abc, your subsequent call can include `after=group_abc` in
+          #   order to fetch the next page of the list.
+          # @param limit
+          #   A limit on the number of groups to be returned. Limit can range between 0 and
+          #   1000, and the default is 100.
+          # @param order
+          #   Specifies the sort order of the returned groups.
           def initialize: (
             ?after: String,
             ?limit: Integer,

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

@@ -15,8 +15,11 @@ module OpenAI
 
           attr_accessor group_id: String
 
+          # New display name for the group.
           attr_accessor name: String
 
+          # @param name
+          #   New display name for the group.
           def initialize: (
             group_id: String,
             name: String,

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

@@ -11,14 +11,28 @@ module OpenAI
           }
 
         class GroupUpdateResponse < 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
 
+          # Whether the group is managed through SCIM and controlled by your identity
+          # provider.
           attr_accessor is_scim_managed: bool
 
+          # Updated display name for the group.
           attr_accessor name: String
 
+          # @param id
+          #   Identifier for the group.
+          # @param created_at
+          #   Unix timestamp (in seconds) when the group was created.
+          # @param is_scim_managed
+          #   Whether the group is managed through SCIM and controlled by your identity
+          #   provider.
+          # @param name
+          #   Updated display name for the group.
           def initialize: (
             id: String,
             created_at: Integer,

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

@@ -7,12 +7,21 @@ module OpenAI
             { id: String, email: String?, name: String }
 
           class OrganizationGroupUser < OpenAI::Internal::Type::BaseModel
+            # The identifier, which can be referenced in API endpoints
             attr_accessor id: String
 
+            # The email address of the user.
             attr_accessor email: String?
 
+            # The name of the user.
             attr_accessor name: String
 
+            # @param id
+            #   The identifier, which can be referenced in API endpoints
+            # @param email
+            #   The email address of the user.
+            # @param name
+            #   The name of the user.
             def initialize: (id: String, email: String?, name: String) -> void
 
             def to_hash: -> { id: String, email: String?, name: String }

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

@@ -16,8 +16,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: (
               group_id: String,
               role_id: String,

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

@@ -11,12 +11,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::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::Groups::RoleCreateResponse::Group,
               role: OpenAI::Admin::Organization::Role,
@@ -39,16 +48,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/groups/role_delete_response.rbs

@@ -6,10 +6,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/groups/role_list_params.rbs

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

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

@@ -20,30 +20,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::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::Groups::RoleListResponse::AssignmentSource]?,

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

@@ -20,30 +20,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::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::Groups::RoleRetrieveResponse::AssignmentSource]?,

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

@@ -16,8 +16,11 @@ module OpenAI
 
             attr_accessor group_id: String
 
+            # Identifier of the user to add to the group.
             attr_accessor user_id: String
 
+            # @param user_id
+            #   Identifier of the user to add to the group.
             def initialize: (
               group_id: String,
               user_id: String,

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

@@ -7,12 +7,21 @@ module OpenAI
             { group_id: String, ?object: :"group.user", user_id: String }
 
           class UserCreateResponse < OpenAI::Internal::Type::BaseModel
+            # Identifier of the group the user was added to.
             attr_accessor group_id: String
 
+            # Always `group.user`.
             attr_accessor object: :"group.user"
 
+            # Identifier of the user that was added.
             attr_accessor user_id: String
 
+            # @param group_id
+            #   Identifier of the group the user was added to.
+            # @param user_id
+            #   Identifier of the user that was added.
+            # @param object
+            #   Always `group.user`.
             def initialize: (
               group_id: String,
               user_id: String,