openai 0.60.0 → 0.61.0

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

@@ -0,0 +1,96 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Groups
+          sig { returns(OpenAI::Resources::Admin::Organization::Groups::Users) }
+          attr_reader :users
+
+          sig { returns(OpenAI::Resources::Admin::Organization::Groups::Roles) }
+          attr_reader :roles
+
+          # Creates a new group in the organization.
+          sig do
+            params(
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Group)
+          end
+          def create(
+            # Human readable name for the group.
+            name:,
+            request_options: {}
+          )
+          end
+
+          # Updates a group's information.
+          sig do
+            params(
+              group_id: String,
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Models::Admin::Organization::GroupUpdateResponse)
+          end
+          def update(
+            # The ID of the group to update.
+            group_id,
+            # New display name for the group.
+            name:,
+            request_options: {}
+          )
+          end
+
+          # Lists all groups in the organization.
+          sig do
+            params(
+              after: String,
+              limit: Integer,
+              order:
+                OpenAI::Admin::Organization::GroupListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::NextCursorPage[
+                OpenAI::Admin::Organization::Group
+              ]
+            )
+          end
+          def list(
+            # A cursor for use in pagination. `after` is a group ID that defines your place in
+            # the list. For instance, if you make a list request and receive 100 objects,
+            # ending with group_abc, your subsequent call can include `after=group_abc` in
+            # order to fetch the next page of the list.
+            after: nil,
+            # A limit on the number of groups to be returned. Limit can range between 0 and
+            # 1000, and the default is 100.
+            limit: nil,
+            # Specifies the sort order of the returned groups.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # Deletes a group from the organization.
+          sig do
+            params(
+              group_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Models::Admin::Organization::GroupDeleteResponse)
+          end
+          def delete(
+            # The ID of the group to delete.
+            group_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

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

@@ -0,0 +1,96 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Invites
+          # Create an invite for a user to the organization. The invite must be accepted by
+          # the user before they have access to the organization.
+          sig do
+            params(
+              email: String,
+              role:
+                OpenAI::Admin::Organization::InviteCreateParams::Role::OrSymbol,
+              projects:
+                T::Array[
+                  OpenAI::Admin::Organization::InviteCreateParams::Project::OrHash
+                ],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Invite)
+          end
+          def create(
+            # Send an email to this address
+            email:,
+            # `owner` or `reader`
+            role:,
+            # An array of projects to which membership is granted at the same time the org
+            # invite is accepted. If omitted, the user will be invited to the default project
+            # for compatibility with legacy behavior.
+            projects: nil,
+            request_options: {}
+          )
+          end
+
+          # Retrieves an invite.
+          sig do
+            params(
+              invite_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Invite)
+          end
+          def retrieve(
+            # The ID of the invite to retrieve.
+            invite_id,
+            request_options: {}
+          )
+          end
+
+          # Returns a list of invites in the organization.
+          sig do
+            params(
+              after: String,
+              limit: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Admin::Organization::Invite
+              ]
+            )
+          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,
+            # 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
+
+          # Delete an invite. If the invite has already been accepted, it cannot be deleted.
+          sig do
+            params(
+              invite_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Models::Admin::Organization::InviteDeleteResponse)
+          end
+          def delete(
+            # The ID of the invite to delete.
+            invite_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

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

@@ -0,0 +1,85 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class APIKeys
+            # Retrieves an API key in the project.
+            sig do
+              params(
+                api_key_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectAPIKey)
+            end
+            def retrieve(
+              # The ID of the API key.
+              api_key_id,
+              # The ID of the project.
+              project_id:,
+              request_options: {}
+            )
+            end
+
+            # Returns a list of API keys 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::ProjectAPIKey
+                ]
+              )
+            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 an API key from the project.
+            #
+            # Returns confirmation of the key deletion, or an error if the key belonged to a
+            # service account.
+            sig do
+              params(
+                api_key_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::APIKeyDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the API key.
+              api_key_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/certificates.rbi

@@ -0,0 +1,94 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Certificates
+            # List certificates for this project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Projects::CertificateListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::ConversationCursorPage[
+                  OpenAI::Models::Admin::Organization::Projects::CertificateListResponse
+                ]
+              )
+            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,
+              # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+              # order and `desc` for descending order.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Activate certificates at the project level.
+            #
+            # You can atomically and idempotently activate up to 10 certificates at a time.
+            sig do
+              params(
+                project_id: String,
+                certificate_ids: T::Array[String],
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::Page[
+                  OpenAI::Models::Admin::Organization::Projects::CertificateActivateResponse
+                ]
+              )
+            end
+            def activate(
+              # The ID of the project.
+              project_id,
+              certificate_ids:,
+              request_options: {}
+            )
+            end
+
+            # Deactivate certificates at the project level. You can atomically and
+            # idempotently deactivate up to 10 certificates at a time.
+            sig do
+              params(
+                project_id: String,
+                certificate_ids: T::Array[String],
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::Page[
+                  OpenAI::Models::Admin::Organization::Projects::CertificateDeactivateResponse
+                ]
+              )
+            end
+            def deactivate(
+              # The ID of the project.
+              project_id,
+              certificate_ids:,
+              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/groups/roles.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Groups
+            class Roles
+              # Assigns a project role to a group within a project.
+              sig do
+                params(
+                  group_id: String,
+                  project_id: String,
+                  role_id: String,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Models::Admin::Organization::Projects::Groups::RoleCreateResponse
+                )
+              end
+              def create(
+                # Path param: The ID of the group that should receive the project role.
+                group_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 group within a project.
+              sig do
+                params(
+                  group_id: String,
+                  project_id: String,
+                  after: String,
+                  limit: Integer,
+                  order:
+                    OpenAI::Admin::Organization::Projects::Groups::RoleListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Internal::NextCursorPage[
+                    OpenAI::Models::Admin::Organization::Projects::Groups::RoleListResponse
+                  ]
+                )
+              end
+              def list(
+                # Path param: The ID of the group to inspect.
+                group_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 group within a project.
+              sig do
+                params(
+                  role_id: String,
+                  project_id: String,
+                  group_id: String,
+                  request_options: OpenAI::RequestOptions::OrHash
+                ).returns(
+                  OpenAI::Models::Admin::Organization::Projects::Groups::RoleDeleteResponse
+                )
+              end
+              def delete(
+                # The ID of the project role to remove from the group.
+                role_id,
+                # The ID of the project to modify.
+                project_id:,
+                # The ID of the group whose project role assignment should be removed.
+                group_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/groups.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Projects
+          class Groups
+            sig do
+              returns(
+                OpenAI::Resources::Admin::Organization::Projects::Groups::Roles
+              )
+            end
+            attr_reader :roles
+
+            # Grants a group access to a project.
+            sig do
+              params(
+                project_id: String,
+                group_id: String,
+                role: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(OpenAI::Admin::Organization::Projects::ProjectGroup)
+            end
+            def create(
+              # The ID of the project to update.
+              project_id,
+              # Identifier of the group to add to the project.
+              group_id:,
+              # Identifier of the project role to grant to the group.
+              role:,
+              request_options: {}
+            )
+            end
+
+            # Lists the groups that have access to a project.
+            sig do
+              params(
+                project_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Projects::GroupListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::NextCursorPage[
+                  OpenAI::Admin::Organization::Projects::ProjectGroup
+                ]
+              )
+            end
+            def list(
+              # The ID of the project to inspect.
+              project_id,
+              # Cursor for pagination. Provide the ID of the last group from the previous
+              # response to fetch the next page.
+              after: nil,
+              # A limit on the number of project groups to return. Defaults to 20.
+              limit: nil,
+              # Sort order for the returned groups.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Revokes a group's access to a project.
+            sig do
+              params(
+                group_id: String,
+                project_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Projects::GroupDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the group to remove from the project.
+              group_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/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