openai 0.59.0 → 0.61.0

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

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::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/admin/organization/groups/user_create_params.rb

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

data/lib/openai/models/admin/organization/groups/user_create_response.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Users#create
+          class UserCreateResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute group_id
+            #   Identifier of the group the user was added to.
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute object
+            #   Always `group.user`.
+            #
+            #   @return [Symbol, :"group.user"]
+            required :object, const: :"group.user"
+
+            # @!attribute user_id
+            #   Identifier of the user that was added.
+            #
+            #   @return [String]
+            required :user_id, String
+
+            # @!method initialize(group_id:, user_id:, object: :"group.user")
+            #   Confirmation payload returned after adding a user to a group.
+            #
+            #   @param group_id [String] Identifier of the group the user was added to.
+            #
+            #   @param user_id [String] Identifier of the user that was added.
+            #
+            #   @param object [Symbol, :"group.user"] Always `group.user`.
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Users#delete
+          class UserDeleteResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute deleted
+            #   Whether the group membership was removed.
+            #
+            #   @return [Boolean]
+            required :deleted, OpenAI::Internal::Type::Boolean
+
+            # @!attribute object
+            #   Always `group.user.deleted`.
+            #
+            #   @return [Symbol, :"group.user.deleted"]
+            required :object, const: :"group.user.deleted"
+
+            # @!method initialize(deleted:, object: :"group.user.deleted")
+            #   Confirmation payload returned after removing a user from a group.
+            #
+            #   @param deleted [Boolean] Whether the group membership was removed.
+            #
+            #   @param object [Symbol, :"group.user.deleted"] Always `group.user.deleted`.
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Users#list
+          class UserListParams < OpenAI::Internal::Type::BaseModel
+            extend OpenAI::Internal::Type::RequestParameters::Converter
+            include OpenAI::Internal::Type::RequestParameters
+
+            # @!attribute group_id
+            #
+            #   @return [String]
+            required :group_id, String
+
+            # @!attribute after
+            #   A cursor for use in pagination. Provide the ID of the last user from the
+            #   previous list response to retrieve the next page.
+            #
+            #   @return [String, nil]
+            optional :after, String
+
+            # @!attribute limit
+            #   A limit on the number of users to be returned. Limit can range between 0 and
+            #   1000, and the default is 100.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute order
+            #   Specifies the sort order of users in the list.
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Groups::UserListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Admin::Organization::Groups::UserListParams::Order }
+
+            # @!method initialize(group_id:, after: nil, limit: nil, order: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {OpenAI::Models::Admin::Organization::Groups::UserListParams} for more details.
+            #
+            #   @param group_id [String]
+            #
+            #   @param after [String] A cursor for use in pagination. Provide the ID of the last user from the previou
+            #
+            #   @param limit [Integer] A limit on the number of users to be returned. Limit can range between 0 and 100
+            #
+            #   @param order [Symbol, OpenAI::Models::Admin::Organization::Groups::UserListParams::Order] Specifies the sort order of users in the list.
+            #
+            #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+            # Specifies the sort order of users in the list.
+            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/invite.rb

@@ -0,0 +1,146 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Invites#create
+        class Invite < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   The identifier, which can be referenced in API endpoints
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   The Unix timestamp (in seconds) of when the invite was sent.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute email
+          #   The email address of the individual to whom the invite was sent
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute object
+          #   The object type, which is always `organization.invite`
+          #
+          #   @return [Symbol, :"organization.invite"]
+          required :object, const: :"organization.invite"
+
+          # @!attribute projects
+          #   The projects that were granted membership upon acceptance of the invite.
+          #
+          #   @return [Array<OpenAI::Models::Admin::Organization::Invite::Project>]
+          required :projects, -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Admin::Organization::Invite::Project] }
+
+          # @!attribute role
+          #   `owner` or `reader`
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::Invite::Role]
+          required :role, enum: -> { OpenAI::Admin::Organization::Invite::Role }
+
+          # @!attribute status
+          #   `accepted`,`expired`, or `pending`
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::Invite::Status]
+          required :status, enum: -> { OpenAI::Admin::Organization::Invite::Status }
+
+          # @!attribute accepted_at
+          #   The Unix timestamp (in seconds) of when the invite was accepted.
+          #
+          #   @return [Integer, nil]
+          optional :accepted_at, Integer, nil?: true
+
+          # @!attribute expires_at
+          #   The Unix timestamp (in seconds) of when the invite expires.
+          #
+          #   @return [Integer, nil]
+          optional :expires_at, Integer, nil?: true
+
+          # @!method initialize(id:, created_at:, email:, projects:, role:, status:, accepted_at: nil, expires_at: nil, object: :"organization.invite")
+          #   Represents an individual `invite` to the organization.
+          #
+          #   @param id [String] The identifier, which can be referenced in API endpoints
+          #
+          #   @param created_at [Integer] The Unix timestamp (in seconds) of when the invite was sent.
+          #
+          #   @param email [String] The email address of the individual to whom the invite was sent
+          #
+          #   @param projects [Array<OpenAI::Models::Admin::Organization::Invite::Project>] The projects that were granted membership upon acceptance of the invite.
+          #
+          #   @param role [Symbol, OpenAI::Models::Admin::Organization::Invite::Role] `owner` or `reader`
+          #
+          #   @param status [Symbol, OpenAI::Models::Admin::Organization::Invite::Status] `accepted`,`expired`, or `pending`
+          #
+          #   @param accepted_at [Integer, nil] The Unix timestamp (in seconds) of when the invite was accepted.
+          #
+          #   @param expires_at [Integer, nil] The Unix timestamp (in seconds) of when the invite expires.
+          #
+          #   @param object [Symbol, :"organization.invite"] The object type, which is always `organization.invite`
+
+          class Project < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Project's public ID
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute role
+            #   Project membership role
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::Invite::Project::Role]
+            required :role, enum: -> { OpenAI::Admin::Organization::Invite::Project::Role }
+
+            # @!method initialize(id:, role:)
+            #   @param id [String] Project's public ID
+            #
+            #   @param role [Symbol, OpenAI::Models::Admin::Organization::Invite::Project::Role] Project membership role
+
+            # Project membership role
+            #
+            # @see OpenAI::Models::Admin::Organization::Invite::Project#role
+            module Role
+              extend OpenAI::Internal::Type::Enum
+
+              MEMBER = :member
+              OWNER = :owner
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # `owner` or `reader`
+          #
+          # @see OpenAI::Models::Admin::Organization::Invite#role
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            OWNER = :owner
+            READER = :reader
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # `accepted`,`expired`, or `pending`
+          #
+          # @see OpenAI::Models::Admin::Organization::Invite#status
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            ACCEPTED = :accepted
+            EXPIRED = :expired
+            PENDING = :pending
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Invites#create
+        class InviteCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute email
+          #   Send an email to this address
+          #
+          #   @return [String]
+          required :email, String
+
+          # @!attribute role
+          #   `owner` or `reader`
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::InviteCreateParams::Role]
+          required :role, enum: -> { OpenAI::Admin::Organization::InviteCreateParams::Role }
+
+          # @!attribute projects
+          #   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.
+          #
+          #   @return [Array<OpenAI::Models::Admin::Organization::InviteCreateParams::Project>, nil]
+          optional :projects,
+                   -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Admin::Organization::InviteCreateParams::Project] }
+
+          # @!method initialize(email:, role:, projects: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::InviteCreateParams} for more details.
+          #
+          #   @param email [String] Send an email to this address
+          #
+          #   @param role [Symbol, OpenAI::Models::Admin::Organization::InviteCreateParams::Role] `owner` or `reader`
+          #
+          #   @param projects [Array<OpenAI::Models::Admin::Organization::InviteCreateParams::Project>] An array of projects to which membership is granted at the same time the org inv
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # `owner` or `reader`
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            READER = :reader
+            OWNER = :owner
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          class Project < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   Project's public ID
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute role
+            #   Project membership role
+            #
+            #   @return [Symbol, OpenAI::Models::Admin::Organization::InviteCreateParams::Project::Role]
+            required :role, enum: -> { OpenAI::Admin::Organization::InviteCreateParams::Project::Role }
+
+            # @!method initialize(id:, role:)
+            #   @param id [String] Project's public ID
+            #
+            #   @param role [Symbol, OpenAI::Models::Admin::Organization::InviteCreateParams::Project::Role] Project membership role
+
+            # Project membership role
+            #
+            # @see OpenAI::Models::Admin::Organization::InviteCreateParams::Project#role
+            module Role
+              extend OpenAI::Internal::Type::Enum
+
+              MEMBER = :member
+              OWNER = :owner
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Invites#delete
+        class InviteDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute deleted
+          #
+          #   @return [Boolean]
+          required :deleted, OpenAI::Internal::Type::Boolean
+
+          # @!attribute object
+          #   The object type, which is always `organization.invite.deleted`
+          #
+          #   @return [Symbol, :"organization.invite.deleted"]
+          required :object, const: :"organization.invite.deleted"
+
+          # @!method initialize(id:, deleted:, object: :"organization.invite.deleted")
+          #   @param id [String]
+          #
+          #   @param deleted [Boolean]
+          #
+          #   @param object [Symbol, :"organization.invite.deleted"] The object type, which is always `organization.invite.deleted`
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Invites#list
+        class InviteListParams < 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 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, limit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::InviteListParams} for more details.
+          #
+          #   @param after [String] A cursor for use in pagination. `after` is an object ID that defines your place
+          #
+          #   @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/invite_retrieve_params.rb

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