Package ch.brix.gql.client.frontify

Class Mutation

  • public class Mutation
extends Object

    • Constructor Detail

      • Mutation

        public Mutation()

    • Method Detail

      • addAssetLicense

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

      • addAssetMetadataFieldValue

        @Deprecated
public static RootMutation_addAssetMetadataFieldValue addAssetMetadataFieldValue()
        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

      • addAssetPreviewImage

        public static RootMutation_addAssetPreviewImage addAssetPreviewImage()
        Add new `Asset` preview image. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • addAssetRelations

        public static RootMutation_addAssetRelations addAssetRelations()
        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 static RootMutation_addAssetTags addAssetTags()
        Add new `Asset` tags. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • addCollectionAssets

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

      • addCustomMetadata

        public static RootMutation_addCustomMetadata addCustomMetadata()
        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 static RootMutation_addCustomMetadataPropertyOptions addCustomMetadataPropertyOptions()
        Add options to an existing `SELECT` or `MULTISELECT` type `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `CustomMetadataProperty` permission level `EDIT`.

      • addWorkflowChecklistItem

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

      • addWorkflowChecklistPreset

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

      • addWorkflowStatusAssignees

        public static RootMutation_addWorkflowStatusAssignees addWorkflowStatusAssignees()
        **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 static RootMutation_addWorkflowTaskAssignees addWorkflowTaskAssignees()
        **BETA** Add assignees to an existing `WorkflowTask`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createAsset

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

      • createAssetComment

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

      • createAttachment

        public static RootMutation_createAttachment createAttachment()
        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 static RootMutation_createCollection createCollection()
        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 static RootMutation_createCustomMetadataProperty createCustomMetadataProperty()
        Create a new `CustomMetadataProperty`. RequiresRequires `basic:write` scope to be accessible and `Brand` or `Project` permission level `EDIT`.

      • createExternalAsset

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

      • createFolder

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

      • createLicense

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

      • createMetadataField

        @Deprecated
public static RootMutation_createMetadataField createMetadataField()
        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 static RootMutation_createWorkflowStatus createWorkflowStatus()
        **BETA** Create new `WorkflowStatus` in a given `Workflow`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • createAssetWorkflowTask

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

      • createWorkspaceProject

        public static RootMutation_createWorkspaceProject createWorkspaceProject()
        Create a new `Workspace` type `Project`. Requires `basic:write` scope to be accessible.

      • deleteAsset

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

      • deleteAttachment

        public static RootMutation_deleteAttachment deleteAttachment()
        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 static RootMutation_deleteCollection deleteCollection()
        Delete an existing `Collection`. Requires `basic:write` scope to be accessible and `Collection` permission level `EDIT`.

      • deleteComment

        public static RootMutation_deleteComment deleteComment()
        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 static RootMutation_deleteFolders deleteFolders()
        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 static RootMutation_deleteLicense deleteLicense()
        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 static RootMutation_deleteMetadataField deleteMetadataField()
        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 static RootMutation_deleteWorkflowStatus deleteWorkflowStatus()
        **BETA** Delete an existing `WorkflowStatus`. Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • deleteWorkflowTask

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

      • editComment

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

      • installProjectWebhook

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

      • inviteProjectUser

        public static RootMutation_inviteProjectUser inviteProjectUser()
        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 static RootMutation_moveAssets moveAssets()
        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 static RootMutation_moveFolders moveFolders()
        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 static RootMutation_moveWorkflowTask moveWorkflowTask()
        **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 static RootMutation_removeAssetLicense removeAssetLicense()
        Remove an existing relation between an `Asset` and a `License`. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeAssetPreviewImage

        public static RootMutation_removeAssetPreviewImage removeAssetPreviewImage()
        Remove existing `Asset` preview image. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeAssetRelations

        public static RootMutation_removeAssetRelations removeAssetRelations()
        **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 static RootMutation_removeAssetTags removeAssetTags()
        Remove existing `Asset` tags. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • removeCollectionAssets

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

      • removeCustomMetadata

        public static RootMutation_removeCustomMetadata removeCustomMetadata()
        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 static RootMutation_removeCustomMetadataPropertyOptions removeCustomMetadataPropertyOptions()
        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 static RootMutation_removeMetadataValue removeMetadataValue()
        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

      • removeWorkflowChecklistItem

        public static RootMutation_removeWorkflowChecklistItem removeWorkflowChecklistItem()
        **BETA** Remove a `WorkflowChecklistItem`.Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • removeWorkflowChecklistPreset

        public static RootMutation_removeWorkflowChecklistPreset removeWorkflowChecklistPreset()
        **BETA** Remove a `WorkflowChecklistPreset`.Requires `basic:write` scope to be accessible and `Project` permission level `EDIT`.

      • removeWorkflowStatusAssignees

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

      • removeWorkflowTaskAssignees

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

      • reopenAssetComment

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

      • replaceAsset

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

      • replyToComment

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

      • resolveAssetComment

        public static RootMutation_resolveAssetComment resolveAssetComment()
        Resolve an open `AssetComment`. Requires `basic:write` scope to be accessible and `Comment` permission level `EDIT`.

      • setCustomMetadata

        public static RootMutation_setCustomMetadata setCustomMetadata()
        **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 static RootMutation_setCollectionAssets setCollectionAssets()
        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`.

      • syncAssetTags

        public static RootMutation_syncAssetTags syncAssetTags()
        Sync `Asset` tags. Requires `basic:write` scope to be accessible and `Asset` permission level `EDIT`.

      • uninstallWebhook

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

      • updateAsset

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

      • updateCollection

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

      • updateCustomMetadataProperty

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

      • updateFolder

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

      • updateWorkflowChecklistItem

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

      • updateWorkflowChecklistPreset

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

      • updateWorkflowStatus

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

      • updateWorkflowTask

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

      • uploadFile

        public static RootMutation_uploadFile uploadFile()
        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.