GraphQL RepositoriesemailTemplateSharingClientRelation

`entities.emailTemplateSharingClientRelation`

Read email template sharing client relation records with the emailTemplateSharingClientRelation repository, and change them with the email template sharing client relation mutations. Same records as the REST EmailTemplateSharingClientRelations entity.

Example: first three email template sharing client relation recordsGraphQLcURL

query FirstEmailTemplateSharingClientRelations {
  entities {
    emailTemplateSharingClientRelation {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id 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 FirstEmailTemplateSharingClientRelations { entities { emailTemplateSharingClientRelation { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { emailTemplateSharingClientRelation { … } }.

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.	EmailTemplateSharingClientRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[EmailTemplateSharingClientRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: EmailTemplateSharingClientRelationFilterInput, orderBy: [EmailTemplateSharingClientRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[EmailTemplateSharingClientRelationEntity!]!
QUERY	`getByCriteria`(filter: EmailTemplateSharingClientRelationFilterInput, orderBy: [EmailTemplateSharingClientRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	EmailTemplateSharingClientRelationEntityConnection
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	`createEmailTemplateSharingClientRelation`(input: CreateEmailTemplateSharingClientRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateEmailTemplateSharingClientRelationPayload
MUTATION	`updateEmailTemplateSharingClientRelation`(input: UpdateEmailTemplateSharingClientRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateEmailTemplateSharingClientRelationPayload
MUTATION	`bulkUpdateEmailTemplateSharingClientRelation`(input: [CreateOrUpdateEmailTemplateSharingClientRelationInput!]!, deleteInput: [DeleteEmailTemplateSharingClientRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateEmailTemplateSharingClientRelationPayload
MUTATION	`deleteEmailTemplateSharingClientRelation`(input: DeleteEmailTemplateSharingClientRelationInput!)	Soft-delete	DeleteEmailTemplateSharingClientRelationPayload

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.

EmailTemplateSharingClientRelationEntity object 12 fields: isDeleteProtected, id, isDeleted, …

Sharing of an email template with a user, as a watcher or an editor.

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.
`client`	ClientEntity	User the template is shared with.
`emailTemplate`	EmailTemplateEntity	Email template being shared.
`clientId`	ID!	Id of the user.
`emailTemplateId`	ID!	Id of the email template shared with the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`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.

EmailTemplateSharingClientRelationEntityConnection object pageInfo: PageInfo!, edges: [EmailTemplateSharingClientRelationEntityEdge]!, totalCount: Int

Paginated list of EmailTemplateSharingClientRelation records.

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

EmailTemplateSharingClientRelationEntityEdge object node: EmailTemplateSharingClientRelationEntity, cursor: String!

A Relay edge containing a EmailTemplateSharingClientRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[EmailTemplateSharingClientRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[EmailTemplateSharingClientRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	EmailTemplateSharingClientRelationFilterInput	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.
`clientId`	EntityFilterStringField	Id of the user.
`emailTemplateId`	EntityFilterStringField	Id of the email template shared with the user.
`role`	SharingRoleEnumFilterInput	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`client`	ClientFilterInput	User the template is shared with. Matches records where a related record meets these conditions.
`emailTemplate`	EmailTemplateFilterInput	Email template being shared. Matches records where a related record meets these conditions.

EmailTemplateSharingClientRelationOrderByInput input Asc or Desc per field

Sorting of EmailTemplateSharingClientRelation 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.
`client`	[ClientOrderByNestedInput!]	User the template is shared with. Sorts by fields of the related record, listed in order of priority.
`emailTemplate`	[EmailTemplateOrderByNestedInput!]	Email template being shared. Sorts by fields of the related record, listed in order of priority.
`clientId`	OrderByEnum	Id of the user.
`emailTemplateId`	OrderByEnum	Id of the email template shared with the user.
`role`	OrderByEnum	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateEmailTemplateSharingClientRelationInput input 7 fields: clientMutationId, modified, created, …

Field values of a new EmailTemplateSharingClientRelation 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.
`clientId`	ID!	Id of the user.
`emailTemplateId`	ID!	Id of the email template shared with the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateEmailTemplateSharingClientRelationInput input 8 fields: clientMutationId, id, modified, …

Field values of an EmailTemplateSharingClientRelation 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.
`clientId`	ID	Id of the user.
`emailTemplateId`	ID	Id of the email template shared with the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

DeleteEmailTemplateSharingClientRelationInput input clientMutationId: String, id: ID!

Id of the EmailTemplateSharingClientRelation 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.

UpdateEmailTemplateSharingClientRelationInput input 8 fields: clientMutationId, id, modified, …

Id of an EmailTemplateSharingClientRelation 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.
`clientId`	ID	Id of the user.
`emailTemplateId`	ID	Id of the email template shared with the user.
`role`	SharingRoleEnum	Access the sharing gives the user on the template: Watcher can view it, Editor can view and edit it.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateEmailTemplateSharingClientRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateEmailTemplateSharingClientRelation mutation.

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

CreateEmailTemplateSharingClientRelationPayload object emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity, clientMutationId: String

Result of the createEmailTemplateSharingClientRelation mutation.

Field	Type	Description
`emailTemplateSharingClientRelation`	EmailTemplateSharingClientRelationEntity	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).

DeleteEmailTemplateSharingClientRelationPayload object emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity, clientMutationId: String

Result of the deleteEmailTemplateSharingClientRelation mutation.

Field	Type	Description
`emailTemplateSharingClientRelation`	EmailTemplateSharingClientRelationEntity	The deleted 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).

UpdateEmailTemplateSharingClientRelationPayload object emailTemplateSharingClientRelation: EmailTemplateSharingClientRelationEntity, clientMutationId: String

Result of the updateEmailTemplateSharingClientRelation mutation.

Field	Type	Description
`emailTemplateSharingClientRelation`	EmailTemplateSharingClientRelationEntity	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).