openai 0.59.0 → 0.61.0

data/rbi/openai/resources/admin/organization/projects/rate_limits.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class RateLimits
+            # Returns the rate limits per model for a project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                before: String,
+                limit: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::ConversationCursorPage[
+                  OpenAI::Admin::Organization::Projects::ProjectRateLimit
+                ]
+              )
+            end
+            def list_rate_limits(
+              # The ID of the project.
+              project_id,
+              # 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,
+              # A cursor for use in pagination. `before` is an object ID that defines your place
+              # in the list. For instance, if you make a list request and receive 100 objects,
+              # beginning with obj_foo, your subsequent call can include before=obj_foo in order
+              # to fetch the previous page of the list.
+              before: nil,
+              # A limit on the number of objects to be returned. The default is 100.
+              limit: nil,
+              request_options: {}
+            )
+            end
+
+            # Updates a project rate limit.
+            sig do
+              params(
+                rate_limit_id: String,
+                project_id: String,
+                batch_1_day_max_input_tokens: Integer,
+                max_audio_megabytes_per_1_minute: Integer,
+                max_images_per_1_minute: Integer,
+                max_requests_per_1_day: Integer,
+                max_requests_per_1_minute: Integer,
+                max_tokens_per_1_minute: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectRateLimit)
+            end
+            def update_rate_limit(
+              # Path param: The ID of the rate limit.
+              rate_limit_id,
+              # Path param: The ID of the project.
+              project_id:,
+              # Body param: The maximum batch input tokens per day. Only relevant for certain
+              # models.
+              batch_1_day_max_input_tokens: nil,
+              # Body param: The maximum audio megabytes per minute. Only relevant for certain
+              # models.
+              max_audio_megabytes_per_1_minute: nil,
+              # Body param: The maximum images per minute. Only relevant for certain models.
+              max_images_per_1_minute: nil,
+              # Body param: The maximum requests per day. Only relevant for certain models.
+              max_requests_per_1_day: nil,
+              # Body param: The maximum requests per minute.
+              max_requests_per_1_minute: nil,
+              # Body param: The maximum tokens per minute.
+              max_tokens_per_1_minute: nil,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization/projects/roles.rbi

@@ -0,0 +1,115 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Roles
+            # Creates a custom role for a project.
+            sig do
+              params(
+                project_id: String,
+                permissions: T::Array[String],
+                role_name: String,
+                description: T.nilable(String),
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Role)
+            end
+            def create(
+              # The ID of the project to update.
+              project_id,
+              # Permissions to grant to the role.
+              permissions:,
+              # Unique name for the role.
+              role_name:,
+              # Optional description of the role.
+              description: nil,
+              request_options: {}
+            )
+            end
+
+            # Updates an existing project role.
+            sig do
+              params(
+                role_id: String,
+                project_id: String,
+                description: T.nilable(String),
+                permissions: T.nilable(T::Array[String]),
+                role_name: T.nilable(String),
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Role)
+            end
+            def update(
+              # Path param: The ID of the role to update.
+              role_id,
+              # Path param: The ID of the project to update.
+              project_id:,
+              # Body param: New description for the role.
+              description: nil,
+              # Body param: Updated set of permissions for the role.
+              permissions: nil,
+              # Body param: New name for the role.
+              role_name: nil,
+              request_options: {}
+            )
+            end
+
+            # Lists the roles configured for a project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Projects::RoleListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::NextCursorPage[
+                  OpenAI::Admin::Organization::Role
+                ]
+              )
+            end
+            def list(
+              # The ID of the project to inspect.
+              project_id,
+              # Cursor for pagination. Provide the value from the previous response's `next`
+              # field to continue listing roles.
+              after: nil,
+              # A limit on the number of roles to return. Defaults to 1000.
+              limit: nil,
+              # Sort order for the returned roles.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Deletes a custom role from a project.
+            sig do
+              params(
+                role_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::RoleDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the role to delete.
+              role_id,
+              # The ID of the project to update.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization/projects/service_accounts.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class ServiceAccounts
+            # Creates a new service account in the project. This also returns an unredacted
+            # API key for the service account.
+            sig do
+              params(
+                project_id: String,
+                name: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::ServiceAccountCreateResponse
+              )
+            end
+            def create(
+              # The ID of the project.
+              project_id,
+              # The name of the service account being created.
+              name:,
+              request_options: {}
+            )
+            end
+
+            # Retrieves a service account in the project.
+            sig do
+              params(
+                service_account_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Admin::Organization::Projects::ProjectServiceAccount
+              )
+            end
+            def retrieve(
+              # The ID of the service account.
+              service_account_id,
+              # The ID of the project.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # Returns a list of service accounts in the project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                limit: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::ConversationCursorPage[
+                  OpenAI::Admin::Organization::Projects::ProjectServiceAccount
+                ]
+              )
+            end
+            def list(
+              # The ID of the project.
+              project_id,
+              # 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,
+              # 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
+
+            # Deletes a service account from the project.
+            #
+            # Returns confirmation of service account deletion, or an error if the project is
+            # archived (archived projects have no service accounts).
+            sig do
+              params(
+                service_account_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::ServiceAccountDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the service account.
+              service_account_id,
+              # The ID of the project.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization/projects/users/roles.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Users
+            class Roles
+              # Assigns a project role to a user within a project.
+              sig do
+                params(
+                  user_id: String,
+                  project_id: String,
+                  role_id: String,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Models::Admin::Organization::Projects::Users::RoleCreateResponse
+                )
+              end
+              def create(
+                # Path param: The ID of the user that should receive the project role.
+                user_id,
+                # Path param: The ID of the project to update.
+                project_id:,
+                # Body param: Identifier of the role to assign.
+                role_id:,
+                request_options: {}
+              )
+              end
+
+              # Lists the project roles assigned to a user within a project.
+              sig do
+                params(
+                  user_id: String,
+                  project_id: String,
+                  after: String,
+                  limit: Integer,
+                  order:
+                    OpenAI::Admin::Organization::Projects::Users::RoleListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Internal::NextCursorPage[
+                    OpenAI::Models::Admin::Organization::Projects::Users::RoleListResponse
+                  ]
+                )
+              end
+              def list(
+                # Path param: The ID of the user to inspect.
+                user_id,
+                # Path param: The ID of the project to inspect.
+                project_id:,
+                # Query param: Cursor for pagination. Provide the value from the previous
+                # response's `next` field to continue listing project roles.
+                after: nil,
+                # Query param: A limit on the number of project role assignments to return.
+                limit: nil,
+                # Query param: Sort order for the returned project roles.
+                order: nil,
+                request_options: {}
+              )
+              end
+
+              # Unassigns a project role from a user within a project.
+              sig do
+                params(
+                  role_id: String,
+                  project_id: String,
+                  user_id: String,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Models::Admin::Organization::Projects::Users::RoleDeleteResponse
+                )
+              end
+              def delete(
+                # The ID of the project role to remove from the user.
+                role_id,
+                # The ID of the project to modify.
+                project_id:,
+                # The ID of the user whose project role assignment should be removed.
+                user_id:,
+                request_options: {}
+              )
+              end
+
+              # @api private
+              sig { params(client: OpenAI::Client).returns(T.attached_class) }
+              def self.new(client:)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization/projects/users.rbi

@@ -0,0 +1,136 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Users
+            sig do
+              returns(
+                OpenAI::Resources::Admin::Organization::Projects::Users::Roles
+              )
+            end
+            attr_reader :roles
+
+            # Adds a user to the project. Users must already be members of the organization to
+            # be added to a project.
+            sig do
+              params(
+                project_id: String,
+                role: String,
+                email: T.nilable(String),
+                user_id: T.nilable(String),
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectUser)
+            end
+            def create(
+              # The ID of the project.
+              project_id,
+              # `owner` or `member`
+              role:,
+              # Email of the user to add.
+              email: nil,
+              # The ID of the user.
+              user_id: nil,
+              request_options: {}
+            )
+            end
+
+            # Retrieves a user in the project.
+            sig do
+              params(
+                user_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectUser)
+            end
+            def retrieve(
+              # The ID of the user.
+              user_id,
+              # The ID of the project.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # Modifies a user's role in the project.
+            sig do
+              params(
+                user_id: String,
+                project_id: String,
+                role: T.nilable(String),
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectUser)
+            end
+            def update(
+              # Path param: The ID of the user.
+              user_id,
+              # Path param: The ID of the project.
+              project_id:,
+              # Body param: `owner` or `member`
+              role: nil,
+              request_options: {}
+            )
+            end
+
+            # Returns a list of users in the project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                limit: Integer,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::ConversationCursorPage[
+                  OpenAI::Admin::Organization::Projects::ProjectUser
+                ]
+              )
+            end
+            def list(
+              # The ID of the project.
+              project_id,
+              # 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,
+              # 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
+
+            # Deletes a user from the project.
+            #
+            # Returns confirmation of project user deletion, or an error if the project is
+            # archived (archived projects have no users).
+            sig do
+              params(
+                user_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::UserDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the user.
+              user_id,
+              # The ID of the project.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # @api private
+            sig { params(client: OpenAI::Client).returns(T.attached_class) }
+            def self.new(client:)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/resources/admin/organization/projects.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          sig do
+            returns(OpenAI::Resources::Admin::Organization::Projects::Users)
+          end
+          attr_reader :users
+
+          sig do
+            returns(
+              OpenAI::Resources::Admin::Organization::Projects::ServiceAccounts
+            )
+          end
+          attr_reader :service_accounts
+
+          sig do
+            returns(OpenAI::Resources::Admin::Organization::Projects::APIKeys)
+          end
+          attr_reader :api_keys
+
+          sig do
+            returns(
+              OpenAI::Resources::Admin::Organization::Projects::RateLimits
+            )
+          end
+          attr_reader :rate_limits
+
+          sig do
+            returns(OpenAI::Resources::Admin::Organization::Projects::Groups)
+          end
+          attr_reader :groups
+
+          sig do
+            returns(OpenAI::Resources::Admin::Organization::Projects::Roles)
+          end
+          attr_reader :roles
+
+          sig do
+            returns(
+              OpenAI::Resources::Admin::Organization::Projects::Certificates
+            )
+          end
+          attr_reader :certificates
+
+          # Create a new project in the organization. Projects can be created and archived,
+          # but cannot be deleted.
+          sig do
+            params(
+              name: String,
+              external_key_id: T.nilable(String),
+              geography: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Project)
+          end
+          def create(
+            # 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
+
+          # Retrieves a project.
+          sig do
+            params(
+              project_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Project)
+          end
+          def retrieve(
+            # The ID of the project.
+            project_id,
+            request_options: {}
+          )
+          end
+
+          # Modifies a project in the organization.
+          sig do
+            params(
+              project_id: String,
+              external_key_id: T.nilable(String),
+              geography: T.nilable(String),
+              name: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Project)
+          end
+          def update(
+            # The ID of the project.
+            project_id,
+            # External key ID to associate with the project.
+            external_key_id: nil,
+            # Geography for the project.
+            geography: nil,
+            # The updated name of the project, this name appears in reports.
+            name: nil,
+            request_options: {}
+          )
+          end
+
+          # Returns a list of projects.
+          sig do
+            params(
+              after: String,
+              include_archived: T::Boolean,
+              limit: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Admin::Organization::Project
+              ]
+            )
+          end
+          def list(
+            # 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
+
+          # Archives a project in the organization. Archived projects cannot be used or
+          # updated.
+          sig do
+            params(
+              project_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Project)
+          end
+          def archive(
+            # The ID of the project.
+            project_id,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: OpenAI::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end