openai 0.59.0 → 0.61.0

data/lib/openai/models/admin/organization/organization_user.rb

@@ -0,0 +1,242 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Users#retrieve
+        class OrganizationUser < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute added_at
+          #   The Unix timestamp (in seconds) of when the user was added.
+          #
+          #   @return [Integer]
+          required :added_at, Integer
+
+          # @!attribute object
+          #   The object type, which is always `organization.user`
+          #
+          #   @return [Symbol, :"organization.user"]
+          required :object, const: :"organization.user"
+
+          # @!attribute api_key_last_used_at
+          #   The Unix timestamp (in seconds) of the user's last API key usage.
+          #
+          #   @return [Integer, nil]
+          optional :api_key_last_used_at, Integer, nil?: true
+
+          # @!attribute created
+          #   The Unix timestamp (in seconds) of when the user was created.
+          #
+          #   @return [Integer, nil]
+          optional :created, Integer
+
+          # @!attribute developer_persona
+          #   The developer persona metadata for the user.
+          #
+          #   @return [String, nil]
+          optional :developer_persona, String, nil?: true
+
+          # @!attribute email
+          #   The email address of the user
+          #
+          #   @return [String, nil]
+          optional :email, String, nil?: true
+
+          # @!attribute is_default
+          #   Whether this is the organization's default user.
+          #
+          #   @return [Boolean, nil]
+          optional :is_default, OpenAI::Internal::Type::Boolean
+
+          # @!attribute is_scale_tier_authorized_purchaser
+          #   Whether the user is an authorized purchaser for Scale Tier.
+          #
+          #   @return [Boolean, nil]
+          optional :is_scale_tier_authorized_purchaser, OpenAI::Internal::Type::Boolean, nil?: true
+
+          # @!attribute is_scim_managed
+          #   Whether the user is managed through SCIM.
+          #
+          #   @return [Boolean, nil]
+          optional :is_scim_managed, OpenAI::Internal::Type::Boolean
+
+          # @!attribute is_service_account
+          #   Whether the user is a service account.
+          #
+          #   @return [Boolean, nil]
+          optional :is_service_account, OpenAI::Internal::Type::Boolean
+
+          # @!attribute name
+          #   The name of the user
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute projects
+          #   Projects associated with the user, if included.
+          #
+          #   @return [OpenAI::Models::Admin::Organization::OrganizationUser::Projects, nil]
+          optional :projects, -> { OpenAI::Admin::Organization::OrganizationUser::Projects }, nil?: true
+
+          # @!attribute role
+          #   `owner` or `reader`
+          #
+          #   @return [String, nil]
+          optional :role, String, nil?: true
+
+          # @!attribute technical_level
+          #   The technical level metadata for the user.
+          #
+          #   @return [String, nil]
+          optional :technical_level, String, nil?: true
+
+          # @!attribute user
+          #   Nested user details.
+          #
+          #   @return [OpenAI::Models::Admin::Organization::OrganizationUser::User, nil]
+          optional :user, -> { OpenAI::Admin::Organization::OrganizationUser::User }
+
+          # @!method initialize(id:, added_at:, api_key_last_used_at: nil, created: nil, developer_persona: nil, email: nil, is_default: nil, is_scale_tier_authorized_purchaser: nil, is_scim_managed: nil, is_service_account: nil, name: nil, projects: nil, role: nil, technical_level: nil, user: nil, object: :"organization.user")
+          #   Represents an individual `user` within an organization.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param added_at [Integer] The Unix timestamp (in seconds) of when the user was added.
+          #
+          #   @param api_key_last_used_at [Integer, nil] The Unix timestamp (in seconds) of the user's last API key usage.
+          #
+          #   @param created [Integer] The Unix timestamp (in seconds) of when the user was created.
+          #
+          #   @param developer_persona [String, nil] The developer persona metadata for the user.
+          #
+          #   @param email [String, nil] The email address of the user
+          #
+          #   @param is_default [Boolean] Whether this is the organization's default user.
+          #
+          #   @param is_scale_tier_authorized_purchaser [Boolean, nil] Whether the user is an authorized purchaser for Scale Tier.
+          #
+          #   @param is_scim_managed [Boolean] Whether the user is managed through SCIM.
+          #
+          #   @param is_service_account [Boolean] Whether the user is a service account.
+          #
+          #   @param name [String, nil] The name of the user
+          #
+          #   @param projects [OpenAI::Models::Admin::Organization::OrganizationUser::Projects, nil] Projects associated with the user, if included.
+          #
+          #   @param role [String, nil] `owner` or `reader`
+          #
+          #   @param technical_level [String, nil] The technical level metadata for the user.
+          #
+          #   @param user [OpenAI::Models::Admin::Organization::OrganizationUser::User] Nested user details.
+          #
+          #   @param object [Symbol, :"organization.user"] The object type, which is always `organization.user`
+
+          # @see OpenAI::Models::Admin::Organization::OrganizationUser#projects
+          class Projects < OpenAI::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Array<OpenAI::Models::Admin::Organization::OrganizationUser::Projects::Data>]
+            required :data,
+                     -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Admin::Organization::OrganizationUser::Projects::Data] }
+
+            # @!attribute object
+            #
+            #   @return [Symbol, :list]
+            required :object, const: :list
+
+            # @!method initialize(data:, object: :list)
+            #   Projects associated with the user, if included.
+            #
+            #   @param data [Array<OpenAI::Models::Admin::Organization::OrganizationUser::Projects::Data>]
+            #   @param object [Symbol, :list]
+
+            class Data < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String, nil]
+              optional :id, String, nil?: true
+
+              # @!attribute name
+              #
+              #   @return [String, nil]
+              optional :name, String, nil?: true
+
+              # @!attribute role
+              #
+              #   @return [String, nil]
+              optional :role, String, nil?: true
+
+              # @!method initialize(id: nil, name: nil, role: nil)
+              #   @param id [String, nil]
+              #   @param name [String, nil]
+              #   @param role [String, nil]
+            end
+          end
+
+          # @see OpenAI::Models::Admin::Organization::OrganizationUser#user
+          class User < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute object
+            #
+            #   @return [Symbol, :user]
+            required :object, const: :user
+
+            # @!attribute banned
+            #
+            #   @return [Boolean, nil]
+            optional :banned, OpenAI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute banned_at
+            #
+            #   @return [Integer, nil]
+            optional :banned_at, Integer, nil?: true
+
+            # @!attribute email
+            #
+            #   @return [String, nil]
+            optional :email, String, nil?: true
+
+            # @!attribute enabled
+            #
+            #   @return [Boolean, nil]
+            optional :enabled, OpenAI::Internal::Type::Boolean, nil?: true
+
+            # @!attribute name
+            #
+            #   @return [String, nil]
+            optional :name, String, nil?: true
+
+            # @!attribute picture
+            #
+            #   @return [String, nil]
+            optional :picture, String, nil?: true
+
+            # @!method initialize(id:, banned: nil, banned_at: nil, email: nil, enabled: nil, name: nil, picture: nil, object: :user)
+            #   Nested user details.
+            #
+            #   @param id [String]
+            #   @param banned [Boolean, nil]
+            #   @param banned_at [Integer, nil]
+            #   @param email [String, nil]
+            #   @param enabled [Boolean, nil]
+            #   @param name [String, nil]
+            #   @param picture [String, nil]
+            #   @param object [Symbol, :user]
+          end
+        end
+      end
+
+      OrganizationUser = Organization::OrganizationUser
+    end
+  end
+end

data/lib/openai/models/admin/organization/project.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Projects#create
+        class Project < 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 project was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute object
+          #   The object type, which is always `organization.project`
+          #
+          #   @return [Symbol, :"organization.project"]
+          required :object, const: :"organization.project"
+
+          # @!attribute archived_at
+          #   The Unix timestamp (in seconds) of when the project was archived or `null`.
+          #
+          #   @return [Integer, nil]
+          optional :archived_at, Integer, nil?: true
+
+          # @!attribute external_key_id
+          #   The external key associated with the project.
+          #
+          #   @return [String, nil]
+          optional :external_key_id, String, nil?: true
+
+          # @!attribute name
+          #   The name of the project. This appears in reporting.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute status
+          #   `active` or `archived`
+          #
+          #   @return [String, nil]
+          optional :status, String, nil?: true
+
+          # @!method initialize(id:, created_at:, archived_at: nil, external_key_id: nil, name: nil, status: nil, object: :"organization.project")
+          #   Represents an individual 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 project was created.
+          #
+          #   @param archived_at [Integer, nil] The Unix timestamp (in seconds) of when the project was archived or `null`.
+          #
+          #   @param external_key_id [String, nil] The external key associated with the project.
+          #
+          #   @param name [String, nil] The name of the project. This appears in reporting.
+          #
+          #   @param status [String, nil] `active` or `archived`
+          #
+          #   @param object [Symbol, :"organization.project"] The object type, which is always `organization.project`
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/project_archive_params.rb

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

data/lib/openai/models/admin/organization/project_create_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Projects#create
+        class ProjectCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute name
+          #   The friendly name of the project, this name appears in reports.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute external_key_id
+          #   External key ID to associate with the project.
+          #
+          #   @return [String, nil]
+          optional :external_key_id, String, nil?: true
+
+          # @!attribute 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://platform.openai.com/docs/guides/your-data#data-residency-controls)
+          #   to review the functionality and limitations of setting this field.
+          #
+          #   @return [String, nil]
+          optional :geography, String, nil?: true
+
+          # @!method initialize(name:, external_key_id: nil, geography: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::ProjectCreateParams} for more details.
+          #
+          #   @param name [String] The friendly name of the project, this name appears in reports.
+          #
+          #   @param external_key_id [String, nil] External key ID to associate with the project.
+          #
+          #   @param geography [String, nil] Create the project with the specified data residency region. Your organization m
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/project_list_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Projects#list
+        class ProjectListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute 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.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute include_archived
+          #   If `true` returns all projects including those that have been `archived`.
+          #   Archived projects are not included by default.
+          #
+          #   @return [Boolean, nil]
+          optional :include_archived, OpenAI::Internal::Type::Boolean
+
+          # @!attribute limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!method initialize(after: nil, include_archived: nil, limit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::ProjectListParams} for more details.
+          #
+          #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          #
+          #   @param include_archived [Boolean] If `true` returns all projects including those that have been `archived`. Archiv
+          #
+          #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/project_retrieve_params.rb

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

data/lib/openai/models/admin/organization/project_update_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Projects#update
+        class ProjectUpdateParams < 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 external_key_id
+          #   External key ID to associate with the project.
+          #
+          #   @return [String, nil]
+          optional :external_key_id, String, nil?: true
+
+          # @!attribute geography
+          #   Geography for the project.
+          #
+          #   @return [String, nil]
+          optional :geography, String, nil?: true
+
+          # @!attribute name
+          #   The updated name of the project, this name appears in reports.
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!method initialize(project_id:, external_key_id: nil, geography: nil, name: nil, request_options: {})
+          #   @param project_id [String]
+          #
+          #   @param external_key_id [String, nil] External key ID to associate with the project.
+          #
+          #   @param geography [String, nil] Geography for the project.
+          #
+          #   @param name [String, nil] The updated name of the project, this name appears in reports.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::APIKeys#delete
+          class APIKeyDeleteParams < 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 api_key_id
+            #
+            #   @return [String]
+            required :api_key_id, String
+
+            # @!method initialize(project_id:, api_key_id:, request_options: {})
+            #   @param project_id [String]
+            #   @param api_key_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::APIKeys#delete
+          class APIKeyDeleteResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute deleted
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #
+            #   @return [Symbol, :"organization.project.api_key.deleted"]
+            required :object, const: :"organization.project.api_key.deleted"
+
+            # @!method initialize(id:, deleted:, object: :"organization.project.api_key.deleted")
+            #   @param id [String]
+            #   @param deleted [Boolean]
+            #   @param object [Symbol, :"organization.project.api_key.deleted"]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::APIKeys#list
+          class APIKeyListParams < 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 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.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   A limit on the number of objects to be returned. Limit can range between 1 and
+            #   100, and the default is 20.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!method initialize(project_id:, after: nil, limit: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Admin::Organization::Projects::APIKeyListParams} for more
+            #   details.
+            #
+            #   @param project_id [String]
+            #
+            #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+            #
+            #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          # @see OpenAI::Resources::Admin::Organization::Projects::APIKeys#retrieve
+          class APIKeyRetrieveParams < 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 api_key_id
+            #
+            #   @return [String]
+            required :api_key_id, String
+
+            # @!method initialize(project_id:, api_key_id:, request_options: {})
+            #   @param project_id [String]
+            #   @param api_key_id [String]
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end