openai 0.60.0 → 0.62.0

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

@@ -0,0 +1,130 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Projects
+          module Users
+            class RoleListResponse < OpenAI::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    OpenAI::Models::Admin::Organization::Projects::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
+end

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

@@ -0,0 +1,95 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class Role < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Admin::Organization::Role,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier for the role.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Optional description of the role.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # Unique name for the role.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # Always `role`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Permissions granted by the role.
+          sig { returns(T::Array[String]) }
+          attr_accessor :permissions
+
+          # Whether the role is predefined and managed by OpenAI.
+          sig { returns(T::Boolean) }
+          attr_accessor :predefined_role
+
+          # Resource type the role is bound to (for example `api.organization` or
+          # `api.project`).
+          sig { returns(String) }
+          attr_accessor :resource_type
+
+          # Details about a role that can be assigned through the public Roles API.
+          sig do
+            params(
+              id: String,
+              description: T.nilable(String),
+              name: String,
+              permissions: T::Array[String],
+              predefined_role: T::Boolean,
+              resource_type: String,
+              object: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Identifier for the role.
+            id:,
+            # Optional description of the role.
+            description:,
+            # Unique name for the role.
+            name:,
+            # Permissions granted by the role.
+            permissions:,
+            # Whether the role is predefined and managed by OpenAI.
+            predefined_role:,
+            # Resource type the role is bound to (for example `api.organization` or
+            # `api.project`).
+            resource_type:,
+            # Always `role`.
+            object: :role
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                description: T.nilable(String),
+                name: String,
+                object: Symbol,
+                permissions: T::Array[String],
+                predefined_role: T::Boolean,
+                resource_type: String
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleCreateParams < 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::RoleCreateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Permissions to grant to the role.
+          sig { returns(T::Array[String]) }
+          attr_accessor :permissions
+
+          # Unique name for the role.
+          sig { returns(String) }
+          attr_accessor :role_name
+
+          # Optional description of the role.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          sig do
+            params(
+              permissions: T::Array[String],
+              role_name: String,
+              description: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Permissions to grant to the role.
+            permissions:,
+            # Unique name for the role.
+            role_name:,
+            # Optional description of the role.
+            description: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                permissions: T::Array[String],
+                role_name: String,
+                description: T.nilable(String),
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleDeleteParams < 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::RoleDeleteParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :role_id
+
+          sig do
+            params(
+              role_id: String,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(role_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              { role_id: String, request_options: OpenAI::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,55 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleDeleteResponse < OpenAI::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                OpenAI::Models::Admin::Organization::RoleDeleteResponse,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Identifier of the deleted role.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Whether the role was deleted.
+          sig { returns(T::Boolean) }
+          attr_accessor :deleted
+
+          # Always `role.deleted`.
+          sig { returns(Symbol) }
+          attr_accessor :object
+
+          # Confirmation payload returned after deleting a role.
+          sig do
+            params(id: String, deleted: T::Boolean, object: Symbol).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Identifier of the deleted role.
+            id:,
+            # Whether the role was deleted.
+            deleted:,
+            # Always `role.deleted`.
+            object: :"role.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/role_list_params.rbi

@@ -0,0 +1,125 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleListParams < 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::RoleListParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          # Cursor for pagination. Provide the value from the previous response's `next`
+          # field to continue listing roles.
+          sig { returns(T.nilable(String)) }
+          attr_reader :after
+
+          sig { params(after: String).void }
+          attr_writer :after
+
+          # A limit on the number of roles to return. Defaults to 1000.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :limit
+
+          sig { params(limit: Integer).void }
+          attr_writer :limit
+
+          # Sort order for the returned roles.
+          sig do
+            returns(
+              T.nilable(
+                OpenAI::Admin::Organization::RoleListParams::Order::OrSymbol
+              )
+            )
+          end
+          attr_reader :order
+
+          sig do
+            params(
+              order:
+                OpenAI::Admin::Organization::RoleListParams::Order::OrSymbol
+            ).void
+          end
+          attr_writer :order
+
+          sig do
+            params(
+              after: String,
+              limit: Integer,
+              order:
+                OpenAI::Admin::Organization::RoleListParams::Order::OrSymbol,
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Cursor for pagination. Provide the value from the previous response's `next`
+            # field to continue listing roles.
+            after: nil,
+            # A limit on the number of roles to return. Defaults to 1000.
+            limit: nil,
+            # Sort order for the returned roles.
+            order: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::RoleListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # Sort order for the returned roles.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  OpenAI::Admin::Organization::RoleListParams::Order
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ASC =
+              T.let(
+                :asc,
+                OpenAI::Admin::Organization::RoleListParams::Order::TaggedSymbol
+              )
+            DESC =
+              T.let(
+                :desc,
+                OpenAI::Admin::Organization::RoleListParams::Order::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  OpenAI::Admin::Organization::RoleListParams::Order::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        class RoleUpdateParams < 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::RoleUpdateParams,
+                OpenAI::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :role_id
+
+          # New description for the role.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # Updated set of permissions for the role.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_accessor :permissions
+
+          # New name for the role.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :role_name
+
+          sig do
+            params(
+              role_id: String,
+              description: T.nilable(String),
+              permissions: T.nilable(T::Array[String]),
+              role_name: T.nilable(String),
+              request_options: OpenAI::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            role_id:,
+            # New description for the role.
+            description: nil,
+            # Updated set of permissions for the role.
+            permissions: nil,
+            # New name for the role.
+            role_name: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                role_id: String,
+                description: T.nilable(String),
+                permissions: T.nilable(T::Array[String]),
+                role_name: T.nilable(String),
+                request_options: OpenAI::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end