openai 0.60.0 → 0.61.0

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

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#create
+        class Group < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier for the group.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   Unix timestamp (in seconds) when the group was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute group_type
+          #   The type of the group.
+          #
+          #   @return [String]
+          required :group_type, String
+
+          # @!attribute is_scim_managed
+          #   Whether the group is managed through SCIM and controlled by your identity
+          #   provider.
+          #
+          #   @return [Boolean]
+          required :is_scim_managed, OpenAI::Internal::Type::Boolean
+
+          # @!attribute name
+          #   Display name of the group.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(id:, created_at:, group_type:, is_scim_managed:, name:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::Group} for more details.
+          #
+          #   Details about an organization group.
+          #
+          #   @param id [String] Identifier for the group.
+          #
+          #   @param created_at [Integer] Unix timestamp (in seconds) when the group was created.
+          #
+          #   @param group_type [String] The type of the group.
+          #
+          #   @param is_scim_managed [Boolean] Whether the group is managed through SCIM and controlled by your identity provid
+          #
+          #   @param name [String] Display name of the group.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#create
+        class GroupCreateParams < OpenAI::Internal::Type::BaseModel
+          extend OpenAI::Internal::Type::RequestParameters::Converter
+          include OpenAI::Internal::Type::RequestParameters
+
+          # @!attribute name
+          #   Human readable name for the group.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(name:, request_options: {})
+          #   @param name [String] Human readable name for the group.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#delete
+        class GroupDeleteResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier of the deleted group.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute deleted
+          #   Whether the group was deleted.
+          #
+          #   @return [Boolean]
+          required :deleted, OpenAI::Internal::Type::Boolean
+
+          # @!attribute object
+          #   Always `group.deleted`.
+          #
+          #   @return [Symbol, :"group.deleted"]
+          required :object, const: :"group.deleted"
+
+          # @!method initialize(id:, deleted:, object: :"group.deleted")
+          #   Confirmation payload returned after deleting a group.
+          #
+          #   @param id [String] Identifier of the deleted group.
+          #
+          #   @param deleted [Boolean] Whether the group was deleted.
+          #
+          #   @param object [Symbol, :"group.deleted"] Always `group.deleted`.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#list
+        class GroupListParams < 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 a group ID that defines your place in
+          #   the list. For instance, if you make a list request and receive 100 objects,
+          #   ending with group_abc, your subsequent call can include `after=group_abc` in
+          #   order to fetch the next page of the list.
+          #
+          #   @return [String, nil]
+          optional :after, String
+
+          # @!attribute limit
+          #   A limit on the number of groups 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 the returned groups.
+          #
+          #   @return [Symbol, OpenAI::Models::Admin::Organization::GroupListParams::Order, nil]
+          optional :order, enum: -> { OpenAI::Admin::Organization::GroupListParams::Order }
+
+          # @!method initialize(after: nil, limit: nil, order: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::GroupListParams} for more details.
+          #
+          #   @param after [String] A cursor for use in pagination. `after` is a group ID that defines your place in
+          #
+          #   @param limit [Integer] A limit on the number of groups to be returned. Limit can range between 0 and 10
+          #
+          #   @param order [Symbol, OpenAI::Models::Admin::Organization::GroupListParams::Order] Specifies the sort order of the returned groups.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+
+          # Specifies the sort order of the returned groups.
+          module Order
+            extend OpenAI::Internal::Type::Enum
+
+            ASC = :asc
+            DESC = :desc
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#update
+        class GroupUpdateParams < 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 name
+          #   New display name for the group.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(group_id:, name:, request_options: {})
+          #   @param group_id [String]
+          #
+          #   @param name [String] New display name for the group.
+          #
+          #   @param request_options [OpenAI::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        # @see OpenAI::Resources::Admin::Organization::Groups#update
+        class GroupUpdateResponse < OpenAI::Internal::Type::BaseModel
+          # @!attribute id
+          #   Identifier for the group.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   Unix timestamp (in seconds) when the group was created.
+          #
+          #   @return [Integer]
+          required :created_at, Integer
+
+          # @!attribute is_scim_managed
+          #   Whether the group is managed through SCIM and controlled by your identity
+          #   provider.
+          #
+          #   @return [Boolean]
+          required :is_scim_managed, OpenAI::Internal::Type::Boolean
+
+          # @!attribute name
+          #   Updated display name for the group.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(id:, created_at:, is_scim_managed:, name:)
+          #   Some parameter documentations has been truncated, see
+          #   {OpenAI::Models::Admin::Organization::GroupUpdateResponse} for more details.
+          #
+          #   Response returned after updating a group.
+          #
+          #   @param id [String] Identifier for the group.
+          #
+          #   @param created_at [Integer] Unix timestamp (in seconds) when the group was created.
+          #
+          #   @param is_scim_managed [Boolean] Whether the group is managed through SCIM and controlled by your identity provid
+          #
+          #   @param name [String] Updated display name for the group.
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/groups/organization_group_user.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#list
+          class OrganizationGroupUser < OpenAI::Internal::Type::BaseModel
+            # @!attribute id
+            #   The identifier, which can be referenced in API endpoints
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute email
+            #   The email address of the user.
+            #
+            #   @return [String, nil]
+            required :email, String, nil?: true
+
+            # @!attribute name
+            #   The name of the user.
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, email:, name:)
+            #   Represents an individual user returned when inspecting group membership.
+            #
+            #   @param id [String] The identifier, which can be referenced in API endpoints
+            #
+            #   @param email [String, nil] The email address of the user.
+            #
+            #   @param name [String] The name of the user.
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/groups/role_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::Roles#create
+          class RoleCreateParams < 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 role_id
+            #   Identifier of the role to assign.
+            #
+            #   @return [String]
+            required :role_id, String
+
+            # @!method initialize(group_id:, role_id:, request_options: {})
+            #   @param group_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/groups/role_create_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Roles#create
+          class RoleCreateResponse < OpenAI::Internal::Type::BaseModel
+            # @!attribute group
+            #   Summary information about a group returned in role assignment responses.
+            #
+            #   @return [OpenAI::Models::Admin::Organization::Groups::RoleCreateResponse::Group]
+            required :group, -> { OpenAI::Models::Admin::Organization::Groups::RoleCreateResponse::Group }
+
+            # @!attribute object
+            #   Always `group.role`.
+            #
+            #   @return [Symbol, :"group.role"]
+            required :object, const: :"group.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 }
+
+            # @!method initialize(group:, role:, object: :"group.role")
+            #   Role assignment linking a group to a role.
+            #
+            #   @param group [OpenAI::Models::Admin::Organization::Groups::RoleCreateResponse::Group] Summary information about a group returned in role assignment responses.
+            #
+            #   @param role [OpenAI::Models::Admin::Organization::Role] Details about a role that can be assigned through the public Roles API.
+            #
+            #   @param object [Symbol, :"group.role"] Always `group.role`.
+
+            # @see OpenAI::Models::Admin::Organization::Groups::RoleCreateResponse#group
+            class Group < OpenAI::Internal::Type::BaseModel
+              # @!attribute id
+              #   Identifier for the group.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute created_at
+              #   Unix timestamp (in seconds) when the group was created.
+              #
+              #   @return [Integer]
+              required :created_at, Integer
+
+              # @!attribute name
+              #   Display name of the group.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute object
+              #   Always `group`.
+              #
+              #   @return [Symbol, :group]
+              required :object, const: :group
+
+              # @!attribute scim_managed
+              #   Whether the group is managed through SCIM.
+              #
+              #   @return [Boolean]
+              required :scim_managed, OpenAI::Internal::Type::Boolean
+
+              # @!method initialize(id:, created_at:, name:, scim_managed:, object: :group)
+              #   Summary information about a group returned in role assignment responses.
+              #
+              #   @param id [String] Identifier for the group.
+              #
+              #   @param created_at [Integer] Unix timestamp (in seconds) when the group was created.
+              #
+              #   @param name [String] Display name of the group.
+              #
+              #   @param scim_managed [Boolean] Whether the group is managed through SCIM.
+              #
+              #   @param object [Symbol, :group] Always `group`.
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openai/models/admin/organization/groups/role_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::Roles#delete
+          class RoleDeleteParams < 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 role_id
+            #
+            #   @return [String]
+            required :role_id, String
+
+            # @!method initialize(group_id:, role_id:, request_options: {})
+            #   @param group_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/groups/role_delete_response.rb

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module OpenAI
+  module Models
+    module Admin
+      module Organization
+        module Groups
+          # @see OpenAI::Resources::Admin::Organization::Groups::Roles#list
+          class RoleListParams < 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
+            #   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::Groups::RoleListParams::Order, nil]
+            optional :order, enum: -> { OpenAI::Admin::Organization::Groups::RoleListParams::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::RoleListParams} for more details.
+            #
+            #   @param group_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::Groups::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