openai 0.60.0 → 0.61.0

data/rbi/openai/models/admin/organization/users/role_list_response.rbi

@@ -0,0 +1,128 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          class RoleListResponse < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Models::Admin::Organization::Users::RoleListResponse,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Identifier for the role.
+            sig { returns(String) }
+            attr_accessor :id
+
+            # When the role was created.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :created_at
+
+            # Identifier of the actor who created the role.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :created_by
+
+            # User details for the actor that created the role, when available.
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+            attr_accessor :created_by_user_obj
+
+            # Description of the role.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :description
+
+            # Arbitrary metadata stored on the role.
+            sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+            attr_accessor :metadata
+
+            # Name of the role.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # Permissions associated with the role.
+            sig { returns(T::Array[String]) }
+            attr_accessor :permissions
+
+            # Whether the role is predefined by OpenAI.
+            sig { returns(T::Boolean) }
+            attr_accessor :predefined_role
+
+            # Resource type the role applies to.
+            sig { returns(String) }
+            attr_accessor :resource_type
+
+            # When the role was last updated.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :updated_at
+
+            # Detailed information about a role assignment entry returned when listing
+            # assignments.
+            sig do
+              params(
+                id: String,
+                created_at: T.nilable(Integer),
+                created_by: T.nilable(String),
+                created_by_user_obj: T.nilable(T::Hash[Symbol, T.anything]),
+                description: T.nilable(String),
+                metadata: T.nilable(T::Hash[Symbol, T.anything]),
+                name: String,
+                permissions: T::Array[String],
+                predefined_role: T::Boolean,
+                resource_type: String,
+                updated_at: T.nilable(Integer)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Identifier for the role.
+              id:,
+              # When the role was created.
+              created_at:,
+              # Identifier of the actor who created the role.
+              created_by:,
+              # User details for the actor that created the role, when available.
+              created_by_user_obj:,
+              # Description of the role.
+              description:,
+              # Arbitrary metadata stored on the role.
+              metadata:,
+              # Name of the role.
+              name:,
+              # Permissions associated with the role.
+              permissions:,
+              # Whether the role is predefined by OpenAI.
+              predefined_role:,
+              # Resource type the role applies to.
+              resource_type:,
+              # When the role was last updated.
+              updated_at:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  created_at: T.nilable(Integer),
+                  created_by: T.nilable(String),
+                  created_by_user_obj: T.nilable(T::Hash[Symbol, T.anything]),
+                  description: T.nilable(String),
+                  metadata: T.nilable(T::Hash[Symbol, T.anything]),
+                  name: String,
+                  permissions: T::Array[String],
+                  predefined_role: T::Boolean,
+                  resource_type: String,
+                  updated_at: T.nilable(Integer)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models.rbi

@@ -1,6 +1,8 @@
 # typed: strong
 
 module OpenAI
+  Admin = OpenAI::Models::Admin
+
   AllModels = OpenAI::Models::AllModels
 
   Audio = OpenAI::Models::Audio

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

@@ -0,0 +1,83 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class AdminAPIKeys
+          # Create an organization admin API key
+          sig do
+            params(
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse
+            )
+          end
+          def create(name:, request_options: {})
+          end
+
+          # Retrieve a single organization API key
+          sig do
+            params(
+              key_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::AdminAPIKey)
+          end
+          def retrieve(
+            # The ID of the API key.
+            key_id,
+            request_options: {}
+          )
+          end
+
+          # List organization API keys
+          sig do
+            params(
+              after: T.nilable(String),
+              limit: Integer,
+              order:
+                OpenAI::Admin::Organization::AdminAPIKeyListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::CursorPage[
+                OpenAI::Admin::Organization::AdminAPIKey
+              ]
+            )
+          end
+          def list(
+            # Return keys with IDs that come after this ID in the pagination order.
+            after: nil,
+            # Maximum number of keys to return.
+            limit: nil,
+            # Order results by creation time, ascending or descending.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # Delete an organization admin API key
+          sig do
+            params(
+              key_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse
+            )
+          end
+          def delete(
+            # The ID of the API key to be deleted.
+            key_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/audit_logs.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        # List user actions and configuration changes within this organization.
+        class AuditLogs
+          # List user actions and configuration changes within this organization.
+          sig do
+            params(
+              actor_emails: T::Array[String],
+              actor_ids: T::Array[String],
+              after: String,
+              before: String,
+              effective_at:
+                OpenAI::Admin::Organization::AuditLogListParams::EffectiveAt::OrHash,
+              event_types:
+                T::Array[
+                  OpenAI::Admin::Organization::AuditLogListParams::EventType::OrSymbol
+                ],
+              limit: Integer,
+              project_ids: T::Array[String],
+              resource_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Models::Admin::Organization::AuditLogListResponse
+              ]
+            )
+          end
+          def list(
+            # Return only events performed by users with these emails.
+            actor_emails: nil,
+            # Return only events performed by these actors. Can be a user ID, a service
+            # account ID, or an api key tracking ID.
+            actor_ids: nil,
+            # 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,
+            # starting with obj_foo, your subsequent call can include before=obj_foo in order
+            # to fetch the previous page of the list.
+            before: nil,
+            # Return only events whose `effective_at` (Unix seconds) is in this range.
+            effective_at: nil,
+            # Return only events with a `type` in one of these values. For example,
+            # `project.created`. For all options, see the documentation for the
+            # [audit log object](https://platform.openai.com/docs/api-reference/audit-logs/object).
+            event_types: 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,
+            # Return only events for these projects.
+            project_ids: nil,
+            # Return only events performed on these targets. For example, a project ID
+            # updated.
+            resource_ids: 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

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

@@ -0,0 +1,156 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Certificates
+          # Upload a certificate to the organization. This does **not** automatically
+          # activate the certificate.
+          #
+          # Organizations can upload up to 50 certificates.
+          sig do
+            params(
+              certificate: String,
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Certificate)
+          end
+          def create(
+            # The certificate content in PEM format
+            certificate:,
+            # An optional name for the certificate
+            name: nil,
+            request_options: {}
+          )
+          end
+
+          # Get a certificate that has been uploaded to the organization.
+          #
+          # You can get a certificate regardless of whether it is active or not.
+          sig do
+            params(
+              certificate_id: String,
+              include:
+                T::Array[
+                  OpenAI::Admin::Organization::CertificateRetrieveParams::Include::OrSymbol
+                ],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Certificate)
+          end
+          def retrieve(
+            # Unique ID of the certificate to retrieve.
+            certificate_id,
+            # A list of additional fields to include in the response. Currently the only
+            # supported value is `content` to fetch the PEM content of the certificate.
+            include: nil,
+            request_options: {}
+          )
+          end
+
+          # Modify a certificate. Note that only the name can be modified.
+          sig do
+            params(
+              certificate_id: String,
+              name: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(OpenAI::Admin::Organization::Certificate)
+          end
+          def update(
+            # Unique ID of the certificate to modify.
+            certificate_id,
+            # The updated name for the certificate
+            name: nil,
+            request_options: {}
+          )
+          end
+
+          # List uploaded certificates for this organization.
+          sig do
+            params(
+              after: String,
+              limit: Integer,
+              order:
+                OpenAI::Admin::Organization::CertificateListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::ConversationCursorPage[
+                OpenAI::Models::Admin::Organization::CertificateListResponse
+              ]
+            )
+          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,
+            # Sort order by the `created_at` timestamp of the objects. `asc` for ascending
+            # order and `desc` for descending order.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          # Delete a certificate from the organization.
+          #
+          # The certificate must be inactive for the organization and all projects.
+          sig do
+            params(
+              certificate_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Models::Admin::Organization::CertificateDeleteResponse
+            )
+          end
+          def delete(
+            # Unique ID of the certificate to delete.
+            certificate_id,
+            request_options: {}
+          )
+          end
+
+          # Activate certificates at the organization level.
+          #
+          # You can atomically and idempotently activate up to 10 certificates at a time.
+          sig do
+            params(
+              certificate_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::Page[
+                OpenAI::Models::Admin::Organization::CertificateActivateResponse
+              ]
+            )
+          end
+          def activate(certificate_ids:, request_options: {})
+          end
+
+          # Deactivate certificates at the organization level.
+          #
+          # You can atomically and idempotently deactivate up to 10 certificates at a time.
+          sig do
+            params(
+              certificate_ids: T::Array[String],
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(
+              OpenAI::Internal::Page[
+                OpenAI::Models::Admin::Organization::CertificateDeactivateResponse
+              ]
+            )
+          end
+          def deactivate(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

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

@@ -0,0 +1,85 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Groups
+          class Roles
+            # Assigns an organization role to a group within the organization.
+            sig do
+              params(
+                group_id: String,
+                role_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Groups::RoleCreateResponse
+              )
+            end
+            def create(
+              # The ID of the group that should receive the organization role.
+              group_id,
+              # Identifier of the role to assign.
+              role_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists the organization roles assigned to a group within the organization.
+            sig do
+              params(
+                group_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Groups::RoleListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::NextCursorPage[
+                  OpenAI::Models::Admin::Organization::Groups::RoleListResponse
+                ]
+              )
+            end
+            def list(
+              # The ID of the group whose organization role assignments you want to list.
+              group_id,
+              # Cursor for pagination. Provide the value from the previous response's `next`
+              # field to continue listing organization roles.
+              after: nil,
+              # A limit on the number of organization role assignments to return.
+              limit: nil,
+              # Sort order for the returned organization roles.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Unassigns an organization role from a group within the organization.
+            sig do
+              params(
+                role_id: String,
+                group_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Groups::RoleDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the organization role to remove from the group.
+              role_id,
+              # The ID of the group to modify.
+              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

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

@@ -0,0 +1,86 @@
+# typed: strong
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class Groups
+          class Users
+            # Adds a user to a group.
+            sig do
+              params(
+                group_id: String,
+                user_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Groups::UserCreateResponse
+              )
+            end
+            def create(
+              # The ID of the group to update.
+              group_id,
+              # Identifier of the user to add to the group.
+              user_id:,
+              request_options: {}
+            )
+            end
+
+            # Lists the users assigned to a group.
+            sig do
+              params(
+                group_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Internal::NextCursorPage[
+                  OpenAI::Admin::Organization::Groups::OrganizationGroupUser
+                ]
+              )
+            end
+            def list(
+              # The ID of the group to inspect.
+              group_id,
+              # A cursor for use in pagination. Provide the ID of the last user from the
+              # previous list response to retrieve the next page.
+              after: nil,
+              # A limit on the number of users to be returned. Limit can range between 0 and
+              # 1000, and the default is 100.
+              limit: nil,
+              # Specifies the sort order of users in the list.
+              order: nil,
+              request_options: {}
+            )
+            end
+
+            # Removes a user from a group.
+            sig do
+              params(
+                user_id: String,
+                group_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(
+                OpenAI::Models::Admin::Organization::Groups::UserDeleteResponse
+              )
+            end
+            def delete(
+              # The ID of the user to remove from the group.
+              user_id,
+              # The ID of the group to update.
+              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