openai 0.59.0 → 0.61.0

data/rbi/openai/models/admin/organization/invite.rbi

@@ -0,0 +1,271 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class Invite < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::Invite,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # The identifier, which can be referenced in API endpoints
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The Unix timestamp (in seconds) of when the invite was sent.
+          sig { returns(Integer) }
+          attr_accessor :created_at
+
+          # The email address of the individual to whom the invite was sent
+          sig { returns(String) }
+          attr_accessor :email
+
+          # The object type, which is always `organization.invite`
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # The projects that were granted membership upon acceptance of the invite.
+          sig do
+            returns(T::Array[OpenAI::Admin::Organization::Invite::Project])
+          end
+          attr_accessor :projects
+
+          # `owner` or `reader`
+          sig do
+            returns(OpenAI::Admin::Organization::Invite::Role::TaggedSymbol)
+          end
+          attr_accessor :role
+
+          # `accepted`,`expired`, or `pending`
+          sig do
+            returns(OpenAI::Admin::Organization::Invite::Status::TaggedSymbol)
+          end
+          attr_accessor :status
+
+          # The Unix timestamp (in seconds) of when the invite was accepted.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :accepted_at
+
+          # The Unix timestamp (in seconds) of when the invite expires.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :expires_at
+
+          # Represents an individual `invite` to the organization.
+          sig do
+            params(
+              id: String,
+              created_at: Integer,
+              email: String,
+              projects:
+                T::Array[OpenAI::Admin::Organization::Invite::Project::OrHash],
+              role: OpenAI::Admin::Organization::Invite::Role::OrSymbol,
+              status: OpenAI::Admin::Organization::Invite::Status::OrSymbol,
+              accepted_at: T.nilable(Integer),
+              expires_at: T.nilable(Integer),
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The identifier, which can be referenced in API endpoints
+            id:,
+            # The Unix timestamp (in seconds) of when the invite was sent.
+            created_at:,
+            # The email address of the individual to whom the invite was sent
+            email:,
+            # The projects that were granted membership upon acceptance of the invite.
+            projects:,
+            # `owner` or `reader`
+            role:,
+            # `accepted`,`expired`, or `pending`
+            status:,
+            # The Unix timestamp (in seconds) of when the invite was accepted.
+            accepted_at: nil,
+            # The Unix timestamp (in seconds) of when the invite expires.
+            expires_at: nil,
+            # The object type, which is always `organization.invite`
+            object: :"organization.invite"
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Integer,
+                email: String,
+                object: Symbol,
+                projects:
+                  T::Array[OpenAI::Admin::Organization::Invite::Project],
+                role: OpenAI::Admin::Organization::Invite::Role::TaggedSymbol,
+                status:
+                  OpenAI::Admin::Organization::Invite::Status::TaggedSymbol,
+                accepted_at: T.nilable(Integer),
+                expires_at: T.nilable(Integer)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Project < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::Invite::Project,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Project's public ID
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Project membership role
+            sig do
+              returns(
+                OpenAI::Admin::Organization::Invite::Project::Role::TaggedSymbol
+              )
+            end
+            attr_accessor :role
+
+            sig do
+              params(
+                id: String,
+                role:
+                  OpenAI::Admin::Organization::Invite::Project::Role::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Project's public ID
+              id:,
+              # Project membership role
+              role:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  role:
+                    OpenAI::Admin::Organization::Invite::Project::Role::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Project membership role
+            module Role
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Invite::Project::Role
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MEMBER =
+                T.let(
+                  :member,
+                  OpenAI::Admin::Organization::Invite::Project::Role::TaggedSymbol
+                )
+              OWNER =
+                T.let(
+                  :owner,
+                  OpenAI::Admin::Organization::Invite::Project::Role::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Invite::Project::Role::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          # `owner` or `reader`
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Admin::Organization::Invite::Role)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            OWNER =
+              T.let(
+                :owner,
+                OpenAI::Admin::Organization::Invite::Role::TaggedSymbol
+              )
+            READER =
+              T.let(
+                :reader,
+                OpenAI::Admin::Organization::Invite::Role::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::Invite::Role::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          # `accepted`,`expired`, or `pending`
+          module Status
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, OpenAI::Admin::Organization::Invite::Status)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ACCEPTED =
+              T.let(
+                :accepted,
+                OpenAI::Admin::Organization::Invite::Status::TaggedSymbol
+              )
+            EXPIRED =
+              T.let(
+                :expired,
+                OpenAI::Admin::Organization::Invite::Status::TaggedSymbol
+              )
+            PENDING =
+              T.let(
+                :pending,
+                OpenAI::Admin::Organization::Invite::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::Invite::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/invite_create_params.rbi

@@ -0,0 +1,219 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class InviteCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::InviteCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Send an email to this address
+          sig { returns(String) }
+          attr_accessor :email
+
+          # `owner` or `reader`
+          sig do
+            returns(
+              OpenAI::Admin::Organization::InviteCreateParams::Role::OrSymbol
+            )
+          end
+          attr_accessor :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.
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  OpenAI::Admin::Organization::InviteCreateParams::Project
+                ]
+              )
+            )
+          end
+          attr_reader :projects
+
+          sig do
+            params(
+              projects:
+                T::Array[
+                  OpenAI::Admin::Organization::InviteCreateParams::Project::OrHash
+                ]
+            ).void
+          end
+          attr_writer :projects
+
+          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(T.attached_class)
+          end
+          def self.new(
+            # 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
+
+          sig do
+            override.returns(
+              {
+                email: String,
+                role:
+                  OpenAI::Admin::Organization::InviteCreateParams::Role::OrSymbol,
+                projects:
+                  T::Array[
+                    OpenAI::Admin::Organization::InviteCreateParams::Project
+                  ],
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # `owner` or `reader`
+          module Role
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::InviteCreateParams::Role
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            READER =
+              T.let(
+                :reader,
+                OpenAI::Admin::Organization::InviteCreateParams::Role::TaggedSymbol
+              )
+            OWNER =
+              T.let(
+                :owner,
+                OpenAI::Admin::Organization::InviteCreateParams::Role::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::InviteCreateParams::Role::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          class Project < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Admin::Organization::InviteCreateParams::Project,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Project's public ID
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Project membership role
+            sig do
+              returns(
+                OpenAI::Admin::Organization::InviteCreateParams::Project::Role::OrSymbol
+              )
+            end
+            attr_accessor :role
+
+            sig do
+              params(
+                id: String,
+                role:
+                  OpenAI::Admin::Organization::InviteCreateParams::Project::Role::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Project's public ID
+              id:,
+              # Project membership role
+              role:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  role:
+                    OpenAI::Admin::Organization::InviteCreateParams::Project::Role::OrSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Project membership role
+            module Role
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::InviteCreateParams::Project::Role
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MEMBER =
+                T.let(
+                  :member,
+                  OpenAI::Admin::Organization::InviteCreateParams::Project::Role::TaggedSymbol
+                )
+              OWNER =
+                T.let(
+                  :owner,
+                  OpenAI::Admin::Organization::InviteCreateParams::Project::Role::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::InviteCreateParams::Project::Role::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/invite_delete_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class InviteDeleteParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::InviteDeleteParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :invite_id
+
+          sig do
+            params(
+              invite_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(invite_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { invite_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/invite_delete_response.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class InviteDeleteResponse < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Models::Admin::Organization::InviteDeleteResponse,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(T::Boolean) }
+          attr_accessor :deleted
+
+          # The object type, which is always `organization.invite.deleted`
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          sig do
+            params(id: String, deleted: T::Boolean, object: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            id:,
+            deleted:,
+            # The object type, which is always `organization.invite.deleted`
+            object: :"organization.invite.deleted"
+          )
+          end
+
+          sig do
+            override.returns(
+              { id: String, deleted: T::Boolean, object: Symbol }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/invite_list_params.rbi

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class InviteListParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::InviteListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :after
+
+          sig { params(after: String).void }
+          attr_writer :after
+
+          # A limit on the number of objects to be returned. Limit can range between 1 and
+          # 100, and the default is 20.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          sig do
+            params(
+              after: String,
+              limit: Integer,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # 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
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                limit: Integer,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/invite_retrieve_params.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class InviteRetrieveParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::InviteRetrieveParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :invite_id
+
+          sig do
+            params(
+              invite_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(invite_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { invite_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end