openai 0.60.0 → 0.61.0

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

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

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

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

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Users#list
+        class UserListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute after
+          #   A cursor for use in pagination. `after` is an object ID that defines your place
+          #   in the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with obj_foo, your subsequent call can include after=obj_foo in order to
+          #   fetch the next page of the list.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute emails
+          #   Filter by the email address of users.
+          #
+          #   @return [Array<String>, nil]
+          optional :emails, OpenAI::Internal::Type::ArrayOf[String]
+
+          # @!attribute limit
+          #   A limit on the number of objects to be returned. Limit can range between 1 and
+          #   100, and the default is 20.
+          #
+          #   @return [Integer, nil]
+          optional :limit, Integer
+
+          # @!method initialize(after: nil, emails: nil, limit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::UserListParams} for more details.
+          #
+          #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          #
+          #   @param emails [Array<String>] Filter by the email address of users.
+          #
+          #   @param limit [Integer] A limit on the number of objects to be returned. Limit can range between 1 and 1
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Users#update
+        class UserUpdateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute user_id
+          #
+          #   @return [String]
+          required :user_id, String
+
+          # @!attribute developer_persona
+          #   Developer persona metadata.
+          #
+          #   @return [String, nil]
+          optional :developer_persona, String, nil?: true
+
+          # @!attribute role
+          #   `owner` or `reader`
+          #
+          #   @return [String, nil]
+          optional :role, String, nil?: true
+
+          # @!attribute role_id
+          #   Role ID to assign to the user.
+          #
+          #   @return [String, nil]
+          optional :role_id, String, nil?: true
+
+          # @!attribute technical_level
+          #   Technical level metadata.
+          #
+          #   @return [String, nil]
+          optional :technical_level, String, nil?: true
+
+          # @!method initialize(user_id:, developer_persona: nil, role: nil, role_id: nil, technical_level: nil, request_options: {})
+          #   @param user_id [String]
+          #
+          #   @param developer_persona [String, nil] Developer persona metadata.
+          #
+          #   @param role [String, nil] `owner` or `reader`
+          #
+          #   @param role_id [String, nil] Role ID to assign to the user.
+          #
+          #   @param technical_level [String, nil] Technical level metadata.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/users/role_create_params.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          # @see OpenAI::Resources::Admin::Organization::Users::Roles#create
+          class RoleCreateParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute user_id
+            #
+            #   @return [String]
+            required :user_id, String
+
+            # @!attribute role_id
+            #   Identifier of the role to assign.
+            #
+            #   @return [String]
+            required :role_id, String
+
+            # @!method initialize(user_id:, role_id:, request_options: {})
+            #   @param user_id [String]
+            #
+            #   @param role_id [String] Identifier of the role to assign.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/users/role_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          # @see OpenAI::Resources::Admin::Organization::Users::Roles#create
+          class RoleCreateResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute object
+            #   Always `user.role`.
+            #
+            #   @return [Symbol, :"user.role"]
+            required :object, const: :"user.role"
+
+            # @!attribute role
+            #   Details about a role that can be assigned through the public Roles API.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Role]
+            required :role, -> { OpenAI::Admin::Organization::Role }
+
+            # @!attribute user
+            #   Represents an individual `user` within an organization.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::OrganizationUser]
+            required :user, -> { OpenAI::Admin::Organization::OrganizationUser }
+
+            # @!method initialize(role:, user:, object: :"user.role")
+            #   Role assignment linking a user to a role.
+            #
+            #   @param role [OpenAI::Models::Admin::Organization::Role] Details about a role that can be assigned through the public Roles API.
+            #
+            #   @param user [OpenAI::Models::Admin::Organization::OrganizationUser] Represents an individual `user` within an organization.
+            #
+            #   @param object [Symbol, :"user.role"] Always `user.role`.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/users/role_delete_params.rb

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

data/lib/openai/models/admin/organization/users/role_delete_response.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          # @see OpenAI::Resources::Admin::Organization::Users::Roles#delete
+          class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute deleted
+            #   Whether the assignment was removed.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   Identifier for the deleted assignment, such as `group.role.deleted` or
+            #   `user.role.deleted`.
+            #
+            #   @return [String]
+            required :object, String
+
+            # @!method initialize(deleted:, object:)
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Admin::Organization::Users::RoleDeleteResponse} for more
+            #   details.
+            #
+            #   Confirmation payload returned after unassigning a role.
+            #
+            #   @param deleted [Boolean] Whether the assignment was removed.
+            #
+            #   @param object [String] Identifier for the deleted assignment, such as `group.role.deleted` or `user.rol
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/users/role_list_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          # @see OpenAI::Resources::Admin::Organization::Users::Roles#list
+          class RoleListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute user_id
+            #
+            #   @return [String]
+            required :user_id, String
+
+            # @!attribute after
+            #   Cursor for pagination. Provide the value from the previous response's `next`
+            #   field to continue listing organization roles.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   A limit on the number of organization role assignments to return.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   Sort order for the returned organization roles.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Users::RoleListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Admin::Organization::Users::RoleListParams::Order }
+
+            # @!method initialize(user_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Admin::Organization::Users::RoleListParams} for more details.
+            #
+            #   @param user_id [String]
+            #
+            #   @param after [String] Cursor for pagination. Provide the value from the previous response's `next` fie
+            #
+            #   @param limit [Integer] A limit on the number of organization role assignments to return.
+            #
+            #   @param order [Symbol, OpenAI::Models::Admin::Organization::Users::RoleListParams::Order] Sort order for the returned organization roles.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # Sort order for the returned organization roles.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              ASC = :asc
+              DESC = :desc
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/users/role_list_response.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Users
+          # @see OpenAI::Resources::Admin::Organization::Users::Roles#list
+          class RoleListResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Identifier for the role.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   When the role was created.
+            #
+            #   @return [Integer, nil]
+            required :created_at, Integer, nil?: true
+
+            # @!attribute created_by
+            #   Identifier of the actor who created the role.
+            #
+            #   @return [String, nil]
+            required :created_by, String, nil?: true
+
+            # @!attribute created_by_user_obj
+            #   User details for the actor that created the role, when available.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            required :created_by_user_obj,
+                     OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown],
+                     nil?: true
+
+            # @!attribute description
+            #   Description of the role.
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute metadata
+            #   Arbitrary metadata stored on the role.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            required :metadata, OpenAI::Internal::Type::HashOf[OpenAI::Internal::Type::Unknown], nil?: true
+
+            # @!attribute name
+            #   Name of the role.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!attribute permissions
+            #   Permissions associated with the role.
+            #
+            #   @return [Array<String>]
+            required :permissions, OpenAI::Internal::Type::ArrayOf[String]
+
+            # @!attribute predefined_role
+            #   Whether the role is predefined by OpenAI.
+            #
+            #   @return [Boolean]
+            required :predefined_role, OpenAI::Internal::Type::Boolean
+
+            # @!attribute resource_type
+            #   Resource type the role applies to.
+            #
+            #   @return [String]
+            required :resource_type, String
+
+            # @!attribute updated_at
+            #   When the role was last updated.
+            #
+            #   @return [Integer, nil]
+            required :updated_at, Integer, nil?: true
+
+            # @!method initialize(id:, created_at:, created_by:, created_by_user_obj:, description:, metadata:, name:, permissions:, predefined_role:, resource_type:, updated_at:)
+            #   Detailed information about a role assignment entry returned when listing
+            #   assignments.
+            #
+            #   @param id [String] Identifier for the role.
+            #
+            #   @param created_at [Integer, nil] When the role was created.
+            #
+            #   @param created_by [String, nil] Identifier of the actor who created the role.
+            #
+            #   @param created_by_user_obj [Hash{Symbol=>Object}, nil] User details for the actor that created the role, when available.
+            #
+            #   @param description [String, nil] Description of the role.
+            #
+            #   @param metadata [Hash{Symbol=>Object}, nil] Arbitrary metadata stored on the role.
+            #
+            #   @param name [String] Name of the role.
+            #
+            #   @param permissions [Array<String>] Permissions associated with the role.
+            #
+            #   @param predefined_role [Boolean] Whether the role is predefined by OpenAI.
+            #
+            #   @param resource_type [String] Resource type the role applies to.
+            #
+            #   @param updated_at [Integer, nil] When the role was last updated.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models.rb

@@ -39,6 +39,8 @@ module OpenAI
     mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
   end
 
+  Admin = OpenAI::Models::Admin
+
   AllModels = OpenAI::Models::AllModels
 
   Audio = OpenAI::Models::Audio

data/lib/openai/resources/admin/organization/admin_api_keys.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Resources
+    class Admin
+      class Organization
+        class AdminAPIKeys
+          # Create an organization admin API key
+          #
+          # @overload create(name:, request_options: {})
+          #
+          # @param name [String]
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyCreateParams
+          def create(params)
+            parsed, options = OpenAI::Admin::Organization::AdminAPIKeyCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "organization/admin_api_keys",
+              body: parsed,
+              model: OpenAI::Models::Admin::Organization::AdminAPIKeyCreateResponse,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Retrieve a single organization API key
+          #
+          # @overload retrieve(key_id, request_options: {})
+          #
+          # @param key_id [String] The ID of the API key.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKey]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyRetrieveParams
+          def retrieve(key_id, params = {})
+            @client.request(
+              method: :get,
+              path: ["organization/admin_api_keys/%1$s", key_id],
+              model: OpenAI::Admin::Organization::AdminAPIKey,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # List organization API keys
+          #
+          # @overload list(after: nil, limit: nil, order: nil, request_options: {})
+          #
+          # @param after [String, nil] Return keys with IDs that come after this ID in the pagination order.
+          #
+          # @param limit [Integer] Maximum number of keys to return.
+          #
+          # @param order [Symbol, OpenAI::Models::Admin::Organization::AdminAPIKeyListParams::Order] Order results by creation time, ascending or descending.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Internal::CursorPage<OpenAI::Models::Admin::Organization::AdminAPIKey>]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyListParams
+          def list(params = {})
+            parsed, options = OpenAI::Admin::Organization::AdminAPIKeyListParams.dump_request(params)
+            query = OpenAI::Internal::Util.encode_query_params(parsed)
+            @client.request(
+              method: :get,
+              path: "organization/admin_api_keys",
+              query: query,
+              page: OpenAI::Internal::CursorPage,
+              model: OpenAI::Admin::Organization::AdminAPIKey,
+              security: {admin_api_key_auth: true},
+              options: options
+            )
+          end
+
+          # Delete an organization admin API key
+          #
+          # @overload delete(key_id, request_options: {})
+          #
+          # @param key_id [String] The ID of the API key to be deleted.
+          #
+          # @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse]
+          #
+          # @see OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteParams
+          def delete(key_id, params = {})
+            @client.request(
+              method: :delete,
+              path: ["organization/admin_api_keys/%1$s", key_id],
+              model: OpenAI::Models::Admin::Organization::AdminAPIKeyDeleteResponse,
+              security: {admin_api_key_auth: true},
+              options: params[:request_options]
+            )
+          end
+
+          # @api private
+          #
+          # @param client [OpenAI::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end