openai 0.60.0 → 0.62.0

data/rbi/openai/models/admin/organization/groups/role_list_params.rbi

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

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

@@ -0,0 +1,128 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          class RoleListResponse < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Models::Admin::Organization::Groups::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/admin/organization/groups/user_create_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          class UserCreateParams < 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::Groups::UserCreateParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :group_id
+
+            # Identifier of the user to add to the group.
+            sig { returns(String) }
+            attr_accessor :user_id
+
+            sig do
+              params(
+                group_id: String,
+                user_id: String,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              group_id:,
+              # Identifier of the user to add to the group.
+              user_id:,
+              request_options: {}
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  group_id: String,
+                  user_id: String,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/groups/user_create_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          class UserCreateResponse < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Models::Admin::Organization::Groups::UserCreateResponse,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Identifier of the group the user was added to.
+            sig { returns(String) }
+            attr_accessor :group_id
+
+            # Always `group.user`.
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # Identifier of the user that was added.
+            sig { returns(String) }
+            attr_accessor :user_id
+
+            # Confirmation payload returned after adding a user to a group.
+            sig do
+              params(group_id: String, user_id: String, object: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Identifier of the group the user was added to.
+              group_id:,
+              # Identifier of the user that was added.
+              user_id:,
+              # Always `group.user`.
+              object: :"group.user"
+            )
+            end
+
+            sig do
+              override.returns(
+                { group_id: String, object: Symbol, user_id: String }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/groups/user_delete_params.rbi

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

data/rbi/openai/models/admin/organization/groups/user_delete_response.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          class UserDeleteResponse < OpenAI::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  OpenAI::Models::Admin::Organization::Groups::UserDeleteResponse,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            # Whether the group membership was removed.
+            sig { returns(T::Boolean) }
+            attr_accessor :deleted
+
+            # Always `group.user.deleted`.
+            sig { returns(Symbol) }
+            attr_accessor :object
+
+            # Confirmation payload returned after removing a user from a group.
+            sig do
+              params(deleted: T::Boolean, object: Symbol).returns(
+                T.attached_class
+              )
+            end
+            def self.new(
+              # Whether the group membership was removed.
+              deleted:,
+              # Always `group.user.deleted`.
+              object: :"group.user.deleted"
+            )
+            end
+
+            sig { override.returns({ deleted: T::Boolean, object: Symbol }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/openai/models/admin/organization/groups/user_list_params.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          class UserListParams < 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::Groups::UserListParams,
+                  OpenAI::Internal::AnyHash
+                )
+              end
+
+            sig { returns(String) }
+            attr_accessor :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.
+            sig { returns(T.nilable(String)) }
+            attr_reader :after
+
+            sig { params(after: String).void }
+            attr_writer :after
+
+            # A limit on the number of users to be returned. Limit can range between 0 and
+            # 1000, and the default is 100.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # Specifies the sort order of users in the list.
+            sig do
+              returns(
+                T.nilable(
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::OrSymbol
+                )
+              )
+            end
+            attr_reader :order
+
+            sig do
+              params(
+                order:
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::OrSymbol
+              ).void
+            end
+            attr_writer :order
+
+            sig do
+              params(
+                group_id: String,
+                after: String,
+                limit: Integer,
+                order:
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::OrSymbol,
+                request_options: OpenAI::RequestOptions::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              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
+
+            sig do
+              override.returns(
+                {
+                  group_id: String,
+                  after: String,
+                  limit: Integer,
+                  order:
+                    OpenAI::Admin::Organization::Groups::UserListParams::Order::OrSymbol,
+                  request_options: OpenAI::RequestOptions
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Specifies the sort order of users in the list.
+            module Order
+              extend OpenAI::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    OpenAI::Admin::Organization::Groups::UserListParams::Order
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              ASC =
+                T.let(
+                  :asc,
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::TaggedSymbol
+                )
+              DESC =
+                T.let(
+                  :desc,
+                  OpenAI::Admin::Organization::Groups::UserListParams::Order::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    OpenAI::Admin::Organization::Groups::UserListParams::Order::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end