Package ch.brix.gql.client.frontify.builders

Class On_RootMutation

  • public class On_RootMutation
extends ch.brix.gql.client.TypeBuilder

    • Constructor Detail

      • On_RootMutation

        public On_RootMutation()

    • Method Detail

      • addAssetLicense

        public On_RootMutation addAssetLicense​(RootMutation_addAssetLicense callBuilder)
        Add a relation between an existing `Asset` and `License`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • addAssetMetadataFieldValue

        @Deprecated
public On_RootMutation addAssetMetadataFieldValue​(RootMutation_addAssetMetadataFieldValue callBuilder)
        Deprecated.
        **DEPRECATED** Add a new relation between an existing `Asset` and an existing `MetadataField` with its value. The value will be automatically created and linked to its `MetadataField`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`. This field will be removed. Use `addCustomMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `addCustomMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00

      • addAssetRelations

        public On_RootMutation addAssetRelations​(RootMutation_addAssetRelations callBuilder)
        Relate existing `Asset`s. The `relatedAssetIds` input field list is limited to 100 ids per request and cannot contain the same `assetId` input field value. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • addAssetTags

        public On_RootMutation addAssetTags​(RootMutation_addAssetTags callBuilder)
        Add new `Asset` tags. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • addCollectionAssets

        public On_RootMutation addCollectionAssets​(RootMutation_addCollectionAssets callBuilder)
        Add `Assets` to the existing `Collection`. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • addCustomMetadata

        public On_RootMutation addCustomMetadata​(RootMutation_addCustomMetadata callBuilder)
        Add `CustomMetadata` values to a supported parent (`Asset` | `WorkspaceProject`). Requires `basic:write` scope to be accessible and permission level `EDIT` for the respective parent.

      • addCustomMetadataPropertyOptions

        public On_RootMutation addCustomMetadataPropertyOptions​(RootMutation_addCustomMetadataPropertyOptions callBuilder)
        Add options to an existing `SELECT` or `MULTISELECT` type `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `CustomMetadataProperty` permission level `EDIT`.

      • addWorkflowChecklistItem

        public On_RootMutation addWorkflowChecklistItem​(RootMutation_addWorkflowChecklistItem callBuilder)
        **BETA** Add a new `WorkflowChecklistItem` for a given `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • addWorkflowChecklistPreset

        public On_RootMutation addWorkflowChecklistPreset​(RootMutation_addWorkflowChecklistPreset callBuilder)
        **BETA** Add a new `WorkflowChecklistPreset` for a given `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • addWorkflowStatusAssignees

        public On_RootMutation addWorkflowStatusAssignees​(RootMutation_addWorkflowStatusAssignees callBuilder)
        **BETA** Add assignees to an existing `WorkflowStatus`. Currently, only one assignee is supported. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • addWorkflowTaskAssignees

        public On_RootMutation addWorkflowTaskAssignees​(RootMutation_addWorkflowTaskAssignees callBuilder)
        **BETA** Add assignees to an existing `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createAsset

        public On_RootMutation createAsset​(RootMutation_createAsset callBuilder)
        Create a new `Asset`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createAssetComment

        public On_RootMutation createAssetComment​(RootMutation_createAssetComment callBuilder)
        Create a new `Asset` `Comment`. Requires `basic:write` scope to be accessible and `Asset` permission level `COMMENT`.

      • createAttachment

        public On_RootMutation createAttachment​(RootMutation_createAttachment callBuilder)
        Create a new `Attachment`. Attachments require a valid parent ID string. This mutation currently only supports attachments for parents of `Asset` type. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • createCollection

        public On_RootMutation createCollection​(RootMutation_createCollection callBuilder)
        Create a new `Collection`. Currently supported for `Library` type parent entities only. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • createCustomMetadataProperty

        public On_RootMutation createCustomMetadataProperty​(RootMutation_createCustomMetadataProperty callBuilder)
        Create a new `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `Brand` or `Project` permission level `EDIT`.

      • createExternalAsset

        public On_RootMutation createExternalAsset​(RootMutation_createExternalAsset callBuilder)
        Create a new External `Asset` from a url. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createFolder

        public On_RootMutation createFolder​(RootMutation_createFolder callBuilder)
        Create a new `Folder`. Requires `basic:write` scope to be accessible and `Project` or `Folder` permission level `EDIT`.

      • createLicense

        public On_RootMutation createLicense​(RootMutation_createLicense callBuilder)
        Create a new `Project` `License`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createMetadataField

        @Deprecated
public On_RootMutation createMetadataField​(RootMutation_createMetadataField callBuilder)
        Deprecated.
        **DEPRECATED** Create a new `Project` `MetadataField` with your desired configuration. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`. This field will be removed. Use `createCustomMetadataProperty` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `createCustomMetadataProperty` instead. | Date: 2025-01-01T00:00:00.000+00:00

      • createWorkflowStatus

        public On_RootMutation createWorkflowStatus​(RootMutation_createWorkflowStatus callBuilder)
        **BETA** Create new `WorkflowStatus` in a given `Workflow`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createAssetWorkflowTask

        public On_RootMutation createAssetWorkflowTask​(RootMutation_createAssetWorkflowTask callBuilder)
        **BETA** Create a new `WorkflowTask` for an `Asset` in a given `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • deleteAsset

        public On_RootMutation deleteAsset​(RootMutation_deleteAsset callBuilder)
        Delete an existing `Asset`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • deleteAttachment

        public On_RootMutation deleteAttachment​(RootMutation_deleteAttachment callBuilder)
        Delete an existing `Attachment`. Requires `basic:write` scope to be accessible and depending on the `Attachment` type, either `Portal` or `Asset` permission level `EDIT`.

      • deleteCollection

        public On_RootMutation deleteCollection​(RootMutation_deleteCollection callBuilder)
        Delete an existing `Collection`. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • deleteComment

        public On_RootMutation deleteComment​(RootMutation_deleteComment callBuilder)
        Delete an existing `Comment`. This will update and/or remove all relations to that `Comment`. Requires `basic:write` scope to be accessible and `Asset` permission level `COMMENT`.

      • deleteFolders

        public On_RootMutation deleteFolders​(RootMutation_deleteFolders callBuilder)
        Delete the existing `Folders`. This will delete all of the `Assets` and `SubFolders` within the `Folders`. Requires `basic:write` scope to be accessible and `Folder` permission level `EDIT`.

      • deleteLicense

        public On_RootMutation deleteLicense​(RootMutation_deleteLicense callBuilder)
        Delete an existing `Project` `License`. This will remove all relations to that `License`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • deleteMetadataField

        @Deprecated
public On_RootMutation deleteMetadataField​(RootMutation_deleteMetadataField callBuilder)
        Deprecated.
        **DEPRECATED** Delete an existing `Project` `MetadataField`. Existing `MetadataField`'s with the same value with be automatically removed. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`. This field will be removed. Use `deleteCustomMetadataProperty` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `deleteCustomMetadataProperty` instead. | Date: 2025-01-01T00:00:00.000+00:00

      • deleteWorkflowStatus

        public On_RootMutation deleteWorkflowStatus​(RootMutation_deleteWorkflowStatus callBuilder)
        **BETA** Delete an existing `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • deleteWorkflowTask

        public On_RootMutation deleteWorkflowTask​(RootMutation_deleteWorkflowTask callBuilder)
        **BETA** Delete an existing `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • editComment

        public On_RootMutation editComment​(RootMutation_editComment callBuilder)
        Edit an existing `AssetComment`. Requires `basic:write` scope to be accessible and `Asset` permission level `COMMENT`.

      • installProjectWebhook

        public On_RootMutation installProjectWebhook​(RootMutation_installProjectWebhook callBuilder)
        Install `Webhook`. Requires `basic:write` and `webhook:write` scopes to be accessible and `Project` permission level `EDIT`.

      • inviteProjectUser

        public On_RootMutation inviteProjectUser​(RootMutation_inviteProjectUser callBuilder)
        Invite `Project` user. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`. Limitations: Does not work if User Provisioning feature is enabled.

      • moveAssets

        public On_RootMutation moveAssets​(RootMutation_moveAssets callBuilder)
        Move existing `Asset` item(s) to the given `Library`, `Workspace` or `Folder` destination. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • moveFolders

        public On_RootMutation moveFolders​(RootMutation_moveFolders callBuilder)
        Move existing `Folder` item(s) to the given `Library`, `Workspace` or `Folder` destination. This operation will move all of the `Asset` item(s) and `SubFolder` item(s) within the provided `Folder` item(s). Requires `basic:write` scope to be accessible and `Folder` permission level `EDIT`.

      • moveWorkflowTask

        public On_RootMutation moveWorkflowTask​(RootMutation_moveWorkflowTask callBuilder)
        **BETA** Move one or more `WorkflowTask` to a new `WorkflowStatus`. All `EnterRule` of the destination `WorkflowStatus` have to be satisfied to be able to move. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • removeAssetLicense

        public On_RootMutation removeAssetLicense​(RootMutation_removeAssetLicense callBuilder)
        Remove an existing relation between an `Asset` and a `License`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeAssetRelations

        public On_RootMutation removeAssetRelations​(RootMutation_removeAssetRelations callBuilder)
        **BETA** Remove existing relations between `Asset` items. The `relatedAssetIds` input field list is limited to 100 ids per request and cannot contain the same `assetId` input field value. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeAssetTags

        public On_RootMutation removeAssetTags​(RootMutation_removeAssetTags callBuilder)
        Remove existing `Asset` tags. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeCollectionAssets

        public On_RootMutation removeCollectionAssets​(RootMutation_removeCollectionAssets callBuilder)
        Remove `Assets` from the existing `Collection`. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • removeCustomMetadata

        public On_RootMutation removeCustomMetadata​(RootMutation_removeCustomMetadata callBuilder)
        Remove `CustomMetadata` values from a supported parent (`Asset` | `WorkspaceProject`). Requires `basic:write` scope to be accessible and permission level `EDIT` for the respective parent.

      • removeCustomMetadataPropertyOptions

        public On_RootMutation removeCustomMetadataPropertyOptions​(RootMutation_removeCustomMetadataPropertyOptions callBuilder)
        Remove options from an existing `SELECT` or `MULTISELECT` type `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `CustomMetadataProperty` permission level `EDIT`.

      • removeMetadataValue

        @Deprecated
public On_RootMutation removeMetadataValue​(RootMutation_removeMetadataValue callBuilder)
        Deprecated.
        **DEPRECATED** Remove existing `MetadataField` value.Existing relations to that `MetadataField` with the same value will be automatically removed.Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`. This field will be removed. Use `removeCustomMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00 This field will be removed. Use `removeCustomMetadata` instead. | Date: 2025-01-01T00:00:00.000+00:00

      • removeWorkflowStatusAssignees

        public On_RootMutation removeWorkflowStatusAssignees​(RootMutation_removeWorkflowStatusAssignees callBuilder)
        **BETA** Remove assignees from an existing `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • removeWorkflowTaskAssignees

        public On_RootMutation removeWorkflowTaskAssignees​(RootMutation_removeWorkflowTaskAssignees callBuilder)
        **BETA** Remove assignees from an existing `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • reopenAssetComment

        public On_RootMutation reopenAssetComment​(RootMutation_reopenAssetComment callBuilder)
        Reopens a resolved `AssetComment`. Requires `basic:write` scope to be accessible and `Comment` permission level `EDIT`.

      • replaceAsset

        public On_RootMutation replaceAsset​(RootMutation_replaceAsset callBuilder)
        Replace an existing `Asset`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • replyToComment

        public On_RootMutation replyToComment​(RootMutation_replyToComment callBuilder)
        Add a new reply to an existing `Asset` `Comment`. Requires `basic:write` scope to be accessible and `Asset` permission level `COMMENT`.

      • setCustomMetadata

        public On_RootMutation setCustomMetadata​(RootMutation_setCustomMetadata callBuilder)
        **BETA** Set `CustomMetadataProperty` values to any supported parent (`WorkspaceProject` | `Asset`). Attention: Existing `CustomMetadataProperty` values for the selected parents will be overwritten and/or removed. Requires `basic:write` scope to be accessible and permission level `EDIT` for the respective parent.

      • setCollectionAssets

        public On_RootMutation setCollectionAssets​(RootMutation_setCollectionAssets callBuilder)
        Replace the existing set of the `Assets` in the `Collection` with the new set of the `Assets`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • uninstallWebhook

        public On_RootMutation uninstallWebhook​(RootMutation_uninstallWebhook callBuilder)
        Uninstall `Webhook`. Requires `basic:write` and `webhook:write` scopes to be accessible and `Project` permission level `EDIT`.

      • updateAsset

        public On_RootMutation updateAsset​(RootMutation_updateAsset callBuilder)
        Update an existing `Asset`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • updateCollection

        public On_RootMutation updateCollection​(RootMutation_updateCollection callBuilder)
        Update an existing `Collection`. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • updateCustomMetadataProperty

        public On_RootMutation updateCustomMetadataProperty​(RootMutation_updateCustomMetadataProperty callBuilder)
        Update an existing `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `CustomMetadataProperty` permission level `EDIT`.

      • updateFolder

        public On_RootMutation updateFolder​(RootMutation_updateFolder callBuilder)
        Update an existing `Folder`. Requires `basic:write` scope to be accessible and `Folder` permission level `EDIT`.

      • updateWorkflowChecklistItem

        public On_RootMutation updateWorkflowChecklistItem​(RootMutation_updateWorkflowChecklistItem callBuilder)
        **BETA** Update an existing `WorkflowChecklistItem`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • updateWorkflowChecklistPreset

        public On_RootMutation updateWorkflowChecklistPreset​(RootMutation_updateWorkflowChecklistPreset callBuilder)
        **BETA** Update an existing `WorkflowChecklistPreset`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • updateWorkflowStatus

        public On_RootMutation updateWorkflowStatus​(RootMutation_updateWorkflowStatus callBuilder)
        **BETA** Update an existing `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • updateWorkflowTask

        public On_RootMutation updateWorkflowTask​(RootMutation_updateWorkflowTask callBuilder)
        **BETA** Update an existing `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • uploadFile

        public On_RootMutation uploadFile​(RootMutation_uploadFile callBuilder)
        Upload a new file. This stores the binary file temporarily so it can be then permanently linked to a specific type (ie. `Asset`, `Attachment`, `Revision`) after the upload is complete by using a different mutation. Requires `basic:write` scope to be accessible.