GraphQL RepositoriesemailTemplateFolder

`entities.emailTemplateFolder`

Read email template folder records with the emailTemplateFolder repository, and change them with the email template folder mutations. Same records as the REST EmailTemplateFolders entity.

Example: first three email template folder recordsGraphQLcURL

query FirstEmailTemplateFolders {
  entities {
    emailTemplateFolder {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id name modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstEmailTemplateFolders { entities { emailTemplateFolder { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id name modified } } } } } }"}'

Queries

Fields of entities { emailTemplateFolder { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	EmailTemplateFolderEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailTemplateFolderEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailTemplateFolderFilterInput, orderBy: [EmailTemplateFolderOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailTemplateFolderEntity!]!
QUERY	`getByCriteria`(filter: EmailTemplateFolderFilterInput, orderBy: [EmailTemplateFolderOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	EmailTemplateFolderEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createEmailTemplateFolder`(input: CreateEmailTemplateFolderInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailTemplateFolderPayload
MUTATION	`updateEmailTemplateFolder`(input: UpdateEmailTemplateFolderInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailTemplateFolderPayload
MUTATION	`bulkUpdateEmailTemplateFolder`(input: [CreateOrUpdateEmailTemplateFolderInput!]!, deleteInput: [DeleteEmailTemplateFolderInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailTemplateFolderPayload
MUTATION	`deleteEmailTemplateFolder`(input: DeleteEmailTemplateFolderInput!, deleteContents: Boolean)	Soft-delete	DeleteEmailTemplateFolderPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

EmailTemplateFolderEntity object 10 fields: isDeleteProtected, id, isDeleted, …

Folder that organizes email templates; folders can be nested.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`parentEmailTemplateFolder`	EmailTemplateFolderEntity	Parent folder in the template hierarchy. Empty for top-level folders.
`name`	String!	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	ID	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.

EmailTemplateFolderEntityConnection object pageInfo: PageInfo!, edges: [EmailTemplateFolderEntityEdge]!, totalCount: Int

Paginated list of EmailTemplateFolder records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[EmailTemplateFolderEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

EmailTemplateFolderEntityEdge object node: EmailTemplateFolderEntity, cursor: String!

A Relay edge containing a EmailTemplateFolderEntity and its cursor.

Field	Type	Description
`node`	EmailTemplateFolderEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

EmailTemplateFolderFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for EmailTemplateFolder records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[EmailTemplateFolderFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailTemplateFolderFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailTemplateFolderFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`name`	EntityFilterStringField	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	EntityFilterStringField	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`parentEmailTemplateFolder`	EmailTemplateFolderFilterInput	Parent folder in the template hierarchy. Empty for top-level folders. Matches records where a related record meets these conditions.

EmailTemplateFolderOrderByInput input Asc or Desc per field

Sorting of EmailTemplateFolder records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`parentEmailTemplateFolder`	[EmailTemplateFolderOrderByNestedInput!]	Parent folder in the template hierarchy. Empty for top-level folders. Sorts by fields of the related record, listed in order of priority.
`name`	OrderByEnum	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	OrderByEnum	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateEmailTemplateFolderInput input 6 fields: clientMutationId, modified, created, …

Field values of a new EmailTemplateFolder record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String!	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	ID	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateEmailTemplateFolderInput input 7 fields: clientMutationId, id, modified, …

Field values of an EmailTemplateFolder record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	ID	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

DeleteEmailTemplateFolderInput input clientMutationId: String, id: ID!

Id of the EmailTemplateFolder record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.

UpdateEmailTemplateFolderInput input 7 fields: clientMutationId, id, modified, …

Id of an EmailTemplateFolder record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`name`	String	Name of the entity and its default text representation.
`parentEmailTemplateFolderId`	ID	Id of the parent folder in the template hierarchy. Empty for top-level folders.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateEmailTemplateFolderPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailTemplateFolder mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateEmailTemplateFolderPayload object emailTemplateFolder: EmailTemplateFolderEntity, clientMutationId: String

Result of the createEmailTemplateFolder mutation.

Field	Type	Description
`emailTemplateFolder`	EmailTemplateFolderEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteEmailTemplateFolderPayload object errors: Boolean!, emailTemplateFolder: EmailTemplateFolderEntity!, clientMutationId: String

Result of the deleteEmailTemplateFolder mutation.

Field	Type	Description
`errors`	Boolean!	The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
`emailTemplateFolder`	EmailTemplateFolderEntity!	The folder, and errors set to true when some of its contents could not be deleted; the folder is then kept.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateEmailTemplateFolderPayload object emailTemplateFolder: EmailTemplateFolderEntity, clientMutationId: String

Result of the updateEmailTemplateFolder mutation.

Field	Type	Description
`emailTemplateFolder`	EmailTemplateFolderEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).