openai 0.60.0 → 0.62.0

data/lib/openai/models/admin/organization/projects/groups/role_create_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Groups
+            # @see OpenAI::Resources::Admin::Organization::Projects::Groups::Roles#create
+            class RoleCreateResponse < OpenAI::Internal::Type::BaseModel
+              # @!attribute group
+              #   Summary information about a group returned in role assignment responses.
+              #
+              #   @return [OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse::Group]
+              required :group, -> { OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse::Group }
+
+              # @!attribute object
+              #   Always `group.role`.
+              #
+              #   @return [Symbol, :"group.role"]
+              required :object, const: :"group.role"
+
+              # @!attribute role
+              #   Details about a role that can be assigned through the public Roles API.
+              #
+              #   @return [OpenAI::Models::Admin::Organization::Role]
+              required :role, -> { OpenAI::Admin::Organization::Role }
+
+              # @!method initialize(group:, role:, object: :"group.role")
+              #   Role assignment linking a group to a role.
+              #
+              #   @param group [OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse::Group] Summary information about a group returned in role assignment responses.
+              #
+              #   @param role [OpenAI::Models::Admin::Organization::Role] Details about a role that can be assigned through the public Roles API.
+              #
+              #   @param object [Symbol, :"group.role"] Always `group.role`.
+
+              # @see OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse#group
+              class Group < OpenAI::Internal::Type::BaseModel
+                # @!attribute id
+                #   Identifier for the group.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute created_at
+                #   Unix timestamp (in seconds) when the group was created.
+                #
+                #   @return [Integer]
+                required :created_at, Integer
+
+                # @!attribute name
+                #   Display name of the group.
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!attribute object
+                #   Always `group`.
+                #
+                #   @return [Symbol, :group]
+                required :object, const: :group
+
+                # @!attribute scim_managed
+                #   Whether the group is managed through SCIM.
+                #
+                #   @return [Boolean]
+                required :scim_managed, OpenAI::Internal::Type::Boolean
+
+                # @!method initialize(id:, created_at:, name:, scim_managed:, object: :group)
+                #   Summary information about a group returned in role assignment responses.
+                #
+                #   @param id [String] Identifier for the group.
+                #
+                #   @param created_at [Integer] Unix timestamp (in seconds) when the group was created.
+                #
+                #   @param name [String] Display name of the group.
+                #
+                #   @param scim_managed [Boolean] Whether the group is managed through SCIM.
+                #
+                #   @param object [Symbol, :group] Always `group`.
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/groups/role_delete_params.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Groups
+            # @see OpenAI::Resources::Admin::Organization::Projects::Groups::Roles#delete
+            class RoleDeleteParams < OpenAI::Internal::Type::BaseModel
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              # @!attribute project_id
+              #
+              #   @return [String]
+              required :project_id, String
+
+              # @!attribute group_id
+              #
+              #   @return [String]
+              required :group_id, String
+
+              # @!attribute role_id
+              #
+              #   @return [String]
+              required :role_id, String
+
+              # @!method initialize(project_id:, group_id:, role_id:, request_options: {})
+              #   @param project_id [String]
+              #   @param group_id [String]
+              #   @param role_id [String]
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/groups/role_delete_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Groups
+            # @see OpenAI::Resources::Admin::Organization::Projects::Groups::Roles#delete
+            class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+              # @!attribute deleted
+              #   Whether the assignment was removed.
+              #
+              #   @return [Boolean]
+              required :deleted, OpenAI::Internal::Type::Boolean
+
+              # @!attribute object
+              #   Identifier for the deleted assignment, such as `group.role.deleted` or
+              #   `user.role.deleted`.
+              #
+              #   @return [String]
+              required :object, String
+
+              # @!method initialize(deleted:, object:)
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteResponse} for
+              #   more details.
+              #
+              #   Confirmation payload returned after unassigning a role.
+              #
+              #   @param deleted [Boolean] Whether the assignment was removed.
+              #
+              #   @param object [String] Identifier for the deleted assignment, such as `group.role.deleted` or `user.rol
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/groups/role_list_params.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Groups
+            # @see OpenAI::Resources::Admin::Organization::Projects::Groups::Roles#list
+            class RoleListParams < OpenAI::Internal::Type::BaseModel
+              extend OpenAI::Internal::Type::RequestParameters::Converter
+              include OpenAI::Internal::Type::RequestParameters
+
+              # @!attribute project_id
+              #
+              #   @return [String]
+              required :project_id, String
+
+              # @!attribute group_id
+              #
+              #   @return [String]
+              required :group_id, String
+
+              # @!attribute after
+              #   Cursor for pagination. Provide the value from the previous response's `next`
+              #   field to continue listing project roles.
+              #
+              #   @return [String, nil]
+              optional :after, String
+
+              # @!attribute limit
+              #   A limit on the number of project role assignments to return.
+              #
+              #   @return [Integer, nil]
+              optional :limit, Integer
+
+              # @!attribute order
+              #   Sort order for the returned project roles.
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams::Order, nil]
+              optional :order, enum: -> { OpenAI::Admin::Organization::Projects::Groups::RoleListParams::Order }
+
+              # @!method initialize(project_id:, group_id:, after: nil, limit: nil, order: nil, request_options: {})
+              #   Some parameter documentations has been truncated, see
+              #   {OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams} for more
+              #   details.
+              #
+              #   @param project_id [String]
+              #
+              #   @param group_id [String]
+              #
+              #   @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+              #
+              #   @param limit [Integer] A limit on the number of project role assignments to return.
+              #
+              #   @param order [Symbol, OpenAI::Models::Admin::Organization::Projects::Groups::RoleListParams::Order] Sort order for the returned project roles.
+              #
+              #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+              # Sort order for the returned project roles.
+              module Order
+                extend OpenAI::Internal::Type::Enum
+
+                ASC = :asc
+                DESC = :desc
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/groups/role_list_response.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Groups
+            # @see OpenAI::Resources::Admin::Organization::Projects::Groups::Roles#list
+            class RoleListResponse < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Identifier for the role.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute created_at
+              #   When the role was created.
+              #
+              #   @return [Integer, nil]
+              required :created_at, Integer, nil?: true
+
+              # @!attribute created_by
+              #   Identifier of the actor who created the role.
+              #
+              #   @return [String, nil]
+              required :created_by, String, nil?: true
+
+              # @!attribute created_by_user_obj
+              #   User details for the actor that created the role, when available.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              required :created_by_user_obj,
+                       OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+                       nil?: true
+
+              # @!attribute description
+              #   Description of the role.
+              #
+              #   @return [String, nil]
+              required :description, String, nil?: true
+
+              # @!attribute metadata
+              #   Arbitrary metadata stored on the role.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              required :metadata, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown], nil?: true
+
+              # @!attribute name
+              #   Name of the role.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute permissions
+              #   Permissions associated with the role.
+              #
+              #   @return [Array<String>]
+              required :permissions, OpenAI::Internal::Type::ArrayOf[String]
+
+              # @!attribute predefined_role
+              #   Whether the role is predefined by OpenAI.
+              #
+              #   @return [Boolean]
+              required :predefined_role, OpenAI::Internal::Type::Boolean
+
+              # @!attribute resource_type
+              #   Resource type the role applies to.
+              #
+              #   @return [String]
+              required :resource_type, String
+
+              # @!attribute updated_at
+              #   When the role was last updated.
+              #
+              #   @return [Integer, nil]
+              required :updated_at, Integer, nil?: true
+
+              # @!method initialize(id:, created_at:, created_by:, created_by_user_obj:, description:, metadata:, name:, permissions:, predefined_role:, resource_type:, updated_at:)
+              #   Detailed information about a role assignment entry returned when listing
+              #   assignments.
+              #
+              #   @param id [String] Identifier for the role.
+              #
+              #   @param created_at [Integer, nil] When the role was created.
+              #
+              #   @param created_by [String, nil] Identifier of the actor who created the role.
+              #
+              #   @param created_by_user_obj [Hash{Symbol=>Object}, nil] User details for the actor that created the role, when available.
+              #
+              #   @param description [String, nil] Description of the role.
+              #
+              #   @param metadata [Hash{Symbol=>Object}, nil] Arbitrary metadata stored on the role.
+              #
+              #   @param name [String] Name of the role.
+              #
+              #   @param permissions [Array<String>] Permissions associated with the role.
+              #
+              #   @param predefined_role [Boolean] Whether the role is predefined by OpenAI.
+              #
+              #   @param resource_type [String] Resource type the role applies to.
+              #
+              #   @param updated_at [Integer, nil] When the role was last updated.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_api_key.rb

@@ -0,0 +1,200 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::APIKeys#retrieve
+          class ProjectAPIKey < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The identifier, which can be referenced in API endpoints
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   The Unix timestamp (in seconds) of when the API key was created
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute last_used_at
+            #   The Unix timestamp (in seconds) of when the API key was last used.
+            #
+            #   @return [Integer, nil]
+            required :last_used_at, Integer, nil?: true
+
+            # @!attribute name
+            #   The name of the API key
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute object
+            #   The object type, which is always `organization.project.api_key`
+            #
+            #   @return [Symbol, :"organization.project.api_key"]
+            required :object, const: :"organization.project.api_key"
+
+            # @!attribute owner
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner]
+            required :owner, -> { OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner }
+
+            # @!attribute redacted_value
+            #   The redacted value of the API key
+            #
+            #   @return [String]
+            required :redacted_value, String
+
+            # @!method initialize(id:, created_at:, last_used_at:, name:, owner:, redacted_value:, object: :"organization.project.api_key")
+            #   Represents an individual API key in a project.
+            #
+            #   @param id [String] The identifier, which can be referenced in API endpoints
+            #
+            #   @param created_at [Integer] The Unix timestamp (in seconds) of when the API key was created
+            #
+            #   @param last_used_at [Integer, nil] The Unix timestamp (in seconds) of when the API key was last used.
+            #
+            #   @param name [String] The name of the API key
+            #
+            #   @param owner [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner]
+            #
+            #   @param redacted_value [String] The redacted value of the API key
+            #
+            #   @param object [Symbol, :"organization.project.api_key"] The object type, which is always `organization.project.api_key`
+
+            # @see OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey#owner
+            class Owner < OpenAI::Internal::Type::BaseModel
+              # @!attribute service_account
+              #   The service account that owns a project API key.
+              #
+              #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount, nil]
+              optional :service_account,
+                       -> { OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount }
+
+              # @!attribute type
+              #   `user` or `service_account`
+              #
+              #   @return [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::Type, nil]
+              optional :type, enum: -> { OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::Type }
+
+              # @!attribute user
+              #   The user that owns a project API key.
+              #
+              #   @return [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::User, nil]
+              optional :user, -> { OpenAI::Admin::Organization::Projects::ProjectAPIKey::Owner::User }
+
+              # @!method initialize(service_account: nil, type: nil, user: nil)
+              #   @param service_account [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::ServiceAccount] The service account that owns a project API key.
+              #
+              #   @param type [Symbol, OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::Type] `user` or `service_account`
+              #
+              #   @param user [OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner::User] The user that owns a project API key.
+
+              # @see OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner#service_account
+              class ServiceAccount < OpenAI::Internal::Type::BaseModel
+                # @!attribute id
+                #   The identifier, which can be referenced in API endpoints
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute created_at
+                #   The Unix timestamp (in seconds) of when the service account was created.
+                #
+                #   @return [Integer]
+                required :created_at, Integer
+
+                # @!attribute name
+                #   The name of the service account.
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!attribute role
+                #   The service account's project role.
+                #
+                #   @return [String]
+                required :role, String
+
+                # @!method initialize(id:, created_at:, name:, role:)
+                #   The service account that owns a project API key.
+                #
+                #   @param id [String] The identifier, which can be referenced in API endpoints
+                #
+                #   @param created_at [Integer] The Unix timestamp (in seconds) of when the service account was created.
+                #
+                #   @param name [String] The name of the service account.
+                #
+                #   @param role [String] The service account's project role.
+              end
+
+              # `user` or `service_account`
+              #
+              # @see OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner#type
+              module Type
+                extend OpenAI::Internal::Type::Enum
+
+                USER = :user
+                SERVICE_ACCOUNT = :service_account
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # @see OpenAI::Models::Admin::Organization::Projects::ProjectAPIKey::Owner#user
+              class User < OpenAI::Internal::Type::BaseModel
+                # @!attribute id
+                #   The identifier, which can be referenced in API endpoints
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute created_at
+                #   The Unix timestamp (in seconds) of when the user was created.
+                #
+                #   @return [Integer]
+                required :created_at, Integer
+
+                # @!attribute email
+                #   The email address of the user.
+                #
+                #   @return [String]
+                required :email, String
+
+                # @!attribute name
+                #   The name of the user.
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!attribute role
+                #   The user's project role.
+                #
+                #   @return [String]
+                required :role, String
+
+                # @!method initialize(id:, created_at:, email:, name:, role:)
+                #   The user that owns a project API key.
+                #
+                #   @param id [String] The identifier, which can be referenced in API endpoints
+                #
+                #   @param created_at [Integer] The Unix timestamp (in seconds) of when the user was created.
+                #
+                #   @param email [String] The email address of the user.
+                #
+                #   @param name [String] The name of the user.
+                #
+                #   @param role [String] The user's project role.
+              end
+            end
+          end
+        end
+
+        ProjectAPIKey = Projects::ProjectAPIKey
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/projects/project_group.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::Groups#create
+          class ProjectGroup < OpenAI::Internal::Type::BaseModel
+            # @!attribute created_at
+            #   Unix timestamp (in seconds) when the group was granted project access.
+            #
+            #   @return [Integer]
+            required :created_at, Integer
+
+            # @!attribute group_id
+            #   Identifier of the group that has access to the project.
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute group_name
+            #   Display name of the group.
+            #
+            #   @return [String]
+            required :group_name, String
+
+            # @!attribute group_type
+            #   The type of the group.
+            #
+            #   @return [String]
+            required :group_type, String
+
+            # @!attribute object
+            #   Always `project.group`.
+            #
+            #   @return [Symbol, :"project.group"]
+            required :object, const: :"project.group"
+
+            # @!attribute project_id
+            #   Identifier of the project.
+            #
+            #   @return [String]
+            required :project_id, String
+
+            # @!method initialize(created_at:, group_id:, group_name:, group_type:, project_id:, object: :"project.group")
+            #   Details about a group's membership in a project.
+            #
+            #   @param created_at [Integer] Unix timestamp (in seconds) when the group was granted project access.
+            #
+            #   @param group_id [String] Identifier of the group that has access to the project.
+            #
+            #   @param group_name [String] Display name of the group.
+            #
+            #   @param group_type [String] The type of the group.
+            #
+            #   @param project_id [String] Identifier of the project.
+            #
+            #   @param object [Symbol, :"project.group"] Always `project.group`.
+          end
+        end
+
+        ProjectGroup = Projects::ProjectGroup
+      end
+    end
+  end
+end