openai 0.60.0 → 0.61.0

data/rbi/openai/models/admin/organization/organization_user.rbi

@@ -0,0 +1,376 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      OrganizationUser = Organization::OrganizationUser
+
+      module Organization
+        class OrganizationUser < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::OrganizationUser,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier, which can be referenced in API endpoints
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The Unix timestamp (in seconds) of when the user was added.
+          sig { returns(Integer) }
+          attr_accessor :added_at
+
+          # The object type, which is always `organization.user`
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # The Unix timestamp (in seconds) of the user's last API key usage.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :api_key_last_used_at
+
+          # The Unix timestamp (in seconds) of when the user was created.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :created
+
+          sig { params(created: Integer).void }
+          attr_writer :created
+
+          # The developer persona metadata for the user.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :developer_persona
+
+          # The email address of the user
+          sig { returns(T.nilable(String)) }
+          attr_accessor :email
+
+          # Whether this is the organization's default user.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_default
+
+          sig { params(is_default: T::Boolean).void }
+          attr_writer :is_default
+
+          # Whether the user is an authorized purchaser for Scale Tier.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :is_scale_tier_authorized_purchaser
+
+          # Whether the user is managed through SCIM.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_scim_managed
+
+          sig { params(is_scim_managed: T::Boolean).void }
+          attr_writer :is_scim_managed
+
+          # Whether the user is a service account.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_service_account
+
+          sig { params(is_service_account: T::Boolean).void }
+          attr_writer :is_service_account
+
+          # The name of the user
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # Projects associated with the user, if included.
+          sig do
+            returns(
+              T.nilable(OpenAI::Admin::Organization::OrganizationUser::Projects)
+            )
+          end
+          attr_reader :projects
+
+          sig do
+            params(
+              projects:
+                T.nilable(
+                  OpenAI::Admin::Organization::OrganizationUser::Projects::OrHash
+                )
+            ).void
+          end
+          attr_writer :projects
+
+          # `owner` or `reader`
+          sig { returns(T.nilable(String)) }
+          attr_accessor :role
+
+          # The technical level metadata for the user.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :technical_level
+
+          # Nested user details.
+          sig do
+            returns(
+              T.nilable(OpenAI::Admin::Organization::OrganizationUser::User)
+            )
+          end
+          attr_reader :user
+
+          sig do
+            params(
+              user: OpenAI::Admin::Organization::OrganizationUser::User::OrHash
+            ).void
+          end
+          attr_writer :user
+
+          # Represents an individual `user` within an organization.
+          sig do
+            params(
+              id: String,
+              added_at: Integer,
+              api_key_last_used_at: T.nilable(Integer),
+              created: Integer,
+              developer_persona: T.nilable(String),
+              email: T.nilable(String),
+              is_default: T::Boolean,
+              is_scale_tier_authorized_purchaser: T.nilable(T::Boolean),
+              is_scim_managed: T::Boolean,
+              is_service_account: T::Boolean,
+              name: T.nilable(String),
+              projects:
+                T.nilable(
+                  OpenAI::Admin::Organization::OrganizationUser::Projects::OrHash
+                ),
+              role: T.nilable(String),
+              technical_level: T.nilable(String),
+              user: OpenAI::Admin::Organization::OrganizationUser::User::OrHash,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The identifier, which can be referenced in API endpoints
+            id:,
+            # The Unix timestamp (in seconds) of when the user was added.
+            added_at:,
+            # The Unix timestamp (in seconds) of the user's last API key usage.
+            api_key_last_used_at: nil,
+            # The Unix timestamp (in seconds) of when the user was created.
+            created: nil,
+            # The developer persona metadata for the user.
+            developer_persona: nil,
+            # The email address of the user
+            email: nil,
+            # Whether this is the organization's default user.
+            is_default: nil,
+            # Whether the user is an authorized purchaser for Scale Tier.
+            is_scale_tier_authorized_purchaser: nil,
+            # Whether the user is managed through SCIM.
+            is_scim_managed: nil,
+            # Whether the user is a service account.
+            is_service_account: nil,
+            # The name of the user
+            name: nil,
+            # Projects associated with the user, if included.
+            projects: nil,
+            # `owner` or `reader`
+            role: nil,
+            # The technical level metadata for the user.
+            technical_level: nil,
+            # Nested user details.
+            user: nil,
+            # The object type, which is always `organization.user`
+            object: :"organization.user"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                added_at: Integer,
+                object: Symbol,
+                api_key_last_used_at: T.nilable(Integer),
+                created: Integer,
+                developer_persona: T.nilable(String),
+                email: T.nilable(String),
+                is_default: T::Boolean,
+                is_scale_tier_authorized_purchaser: T.nilable(T::Boolean),
+                is_scim_managed: T::Boolean,
+                is_service_account: T::Boolean,
+                name: T.nilable(String),
+                projects:
+                  T.nilable(
+                    OpenAI::Admin::Organization::OrganizationUser::Projects
+                  ),
+                role: T.nilable(String),
+                technical_level: T.nilable(String),
+                user: OpenAI::Admin::Organization::OrganizationUser::User
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Projects < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::OrganizationUser::Projects,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                T::Array[
+                  OpenAI::Admin::Organization::OrganizationUser::Projects::Data
+                ]
+              )
+            end
+            attr_accessor :data
+
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # Projects associated with the user, if included.
+            sig do
+              params(
+                data:
+                  T::Array[
+                    OpenAI::Admin::Organization::OrganizationUser::Projects::Data::OrHash
+                  ],
+                object: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(data:, object: :list)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    T::Array[
+                      OpenAI::Admin::Organization::OrganizationUser::Projects::Data
+                    ],
+                  object: Symbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Admin::Organization::OrganizationUser::Projects::Data,
+                    OpenAI::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :id
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :name
+
+              sig { returns(T.nilable(String)) }
+              attr_accessor :role
+
+              sig do
+                params(
+                  id: T.nilable(String),
+                  name: T.nilable(String),
+                  role: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(id: nil, name: nil, role: nil)
+              end
+
+              sig do
+                override.returns(
+                  {
+                    id: T.nilable(String),
+                    name: T.nilable(String),
+                    role: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+
+          class User < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::OrganizationUser::User,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :id
+
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :banned
+
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :banned_at
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :email
+
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :enabled
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :name
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :picture
+
+            # Nested user details.
+            sig do
+              params(
+                id: String,
+                banned: T.nilable(T::Boolean),
+                banned_at: T.nilable(Integer),
+                email: T.nilable(String),
+                enabled: T.nilable(T::Boolean),
+                name: T.nilable(String),
+                picture: T.nilable(String),
+                object: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              id:,
+              banned: nil,
+              banned_at: nil,
+              email: nil,
+              enabled: nil,
+              name: nil,
+              picture: nil,
+              object: :user
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  object: Symbol,
+                  banned: T.nilable(T::Boolean),
+                  banned_at: T.nilable(Integer),
+                  email: T.nilable(String),
+                  enabled: T.nilable(T::Boolean),
+                  name: T.nilable(String),
+                  picture: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/project.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class Project < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::Project,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier, which can be referenced in API endpoints
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The Unix timestamp (in seconds) of when the project was created.
+          sig { returns(Integer) }
+          attr_accessor :created_at
+
+          # The object type, which is always `organization.project`
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # The Unix timestamp (in seconds) of when the project was archived or `null`.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :archived_at
+
+          # The external key associated with the project.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_key_id
+
+          # The name of the project. This appears in reporting.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # `active` or `archived`
+          sig { returns(T.nilable(String)) }
+          attr_accessor :status
+
+          # Represents an individual project.
+          sig do
+            params(
+              id: String,
+              created_at: Integer,
+              archived_at: T.nilable(Integer),
+              external_key_id: T.nilable(String),
+              name: T.nilable(String),
+              status: T.nilable(String),
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The identifier, which can be referenced in API endpoints
+            id:,
+            # The Unix timestamp (in seconds) of when the project was created.
+            created_at:,
+            # The Unix timestamp (in seconds) of when the project was archived or `null`.
+            archived_at: nil,
+            # The external key associated with the project.
+            external_key_id: nil,
+            # The name of the project. This appears in reporting.
+            name: nil,
+            # `active` or `archived`
+            status: nil,
+            # The object type, which is always `organization.project`
+            object: :"organization.project"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Integer,
+                object: Symbol,
+                archived_at: T.nilable(Integer),
+                external_key_id: T.nilable(String),
+                name: T.nilable(String),
+                status: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/project_archive_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class ProjectArchiveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::ProjectArchiveParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :project_id
+
+          sig do
+            params(
+              project_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(project_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { project_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/project_create_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class ProjectCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::ProjectCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The friendly name of the project, this name appears in reports.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # External key ID to associate with the project.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :external_key_id
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :geography
+
+          sig do
+            params(
+              name: String,
+              external_key_id: T.nilable(String),
+              geography: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The friendly name of the project, this name appears in reports.
+            name:,
+            # External key ID to associate with the project.
+            external_key_id: nil,
+            # 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.
+            geography: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name: String,
+                external_key_id: T.nilable(String),
+                geography: T.nilable(String),
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/project_list_params.rbi

@@ -0,0 +1,85 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class ProjectListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::ProjectListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :after
+
+          sig { params(after: String).void }
+          attr_writer :after
+
+          # If `true` returns all projects including those that have been `archived`.
+          # Archived projects are not included by default.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_archived
+
+          sig { params(include_archived: T::Boolean).void }
+          attr_writer :include_archived
+
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          sig do
+            params(
+              after: String,
+              include_archived: T::Boolean,
+              limit: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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.
+            after: nil,
+            # If `true` returns all projects including those that have been `archived`.
+            # Archived projects are not included by default.
+            include_archived: nil,
+            # A limit on the number of objects to be returned. Limit can range between 1 and
+            # 100, and the default is 20.
+            limit: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                include_archived: T::Boolean,
+                limit: Integer,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/project_retrieve_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class ProjectRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::ProjectRetrieveParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :project_id
+
+          sig do
+            params(
+              project_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(project_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { project_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end