GraphQL RepositoriesallowedCompanyEmail

`entities.allowedCompanyEmail`

Read allowed company email records with the allowedCompanyEmail repository, and change them with the allowed company email mutations. Same records as the REST AllowedCompanyEmails entity.

Example: first three allowed company email recordsGraphQLcURL

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

Queries

Fields of entities { allowedCompanyEmail { … } }.

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.	AllowedCompanyEmailEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AllowedCompanyEmailEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AllowedCompanyEmailFilterInput, orderBy: [AllowedCompanyEmailOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AllowedCompanyEmailEntity!]!
QUERY	`getByCriteria`(filter: AllowedCompanyEmailFilterInput, orderBy: [AllowedCompanyEmailOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AllowedCompanyEmailEntityConnection
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	`createAllowedCompanyEmail`(input: CreateAllowedCompanyEmailInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAllowedCompanyEmailPayload
MUTATION	`updateAllowedCompanyEmail`(input: UpdateAllowedCompanyEmailInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAllowedCompanyEmailPayload
MUTATION	`bulkUpdateAllowedCompanyEmail`(input: [CreateOrUpdateAllowedCompanyEmailInput!]!, deleteInput: [DeleteAllowedCompanyEmailInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAllowedCompanyEmailPayload
MUTATION	`deleteAllowedCompanyEmail`(input: DeleteAllowedCompanyEmailInput!)	Soft-delete	DeleteAllowedCompanyEmailPayload

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.

AllowedCompanyEmailEntity object 11 fields: isDeleteProtected, id, isDeleted, …

Company email address that a user role is allowed to send emails from.

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.
`companyEmail`	CompanyEmailEntity	Company email address the user role can send from.
`masterRight`	MasterRightEntity	User role granted access to the company email address.
`companyEmailId`	ID!	Id of the company email address.
`masterRightId`	ID!	Id of the user role.
`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.

AllowedCompanyEmailEntityConnection object pageInfo: PageInfo!, edges: [AllowedCompanyEmailEntityEdge]!, totalCount: Int

Paginated list of AllowedCompanyEmail records.

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

AllowedCompanyEmailEntityEdge object node: AllowedCompanyEmailEntity, cursor: String!

A Relay edge containing a AllowedCompanyEmailEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AllowedCompanyEmailFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AllowedCompanyEmailFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AllowedCompanyEmailFilterInput	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.
`companyEmailId`	EntityFilterStringField	Id of the company email address.
`masterRightId`	EntityFilterStringField	Id of the user role.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`companyEmail`	CompanyEmailFilterInput	Company email address the user role can send from. Matches records where a related record meets these conditions.
`masterRight`	MasterRightFilterInput	User role granted access to the company email address. Matches records where a related record meets these conditions.

AllowedCompanyEmailOrderByInput input Asc or Desc per field

Sorting of AllowedCompanyEmail 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.
`companyEmail`	[CompanyEmailOrderByNestedInput!]	Company email address the user role can send from. Sorts by fields of the related record, listed in order of priority.
`masterRight`	[MasterRightOrderByNestedInput!]	User role granted access to the company email address. Sorts by fields of the related record, listed in order of priority.
`companyEmailId`	OrderByEnum	Id of the company email address.
`masterRightId`	OrderByEnum	Id of the user role.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

Field values of a new AllowedCompanyEmail 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.
`companyEmailId`	ID!	Id of the company email address.
`masterRightId`	ID!	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

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

Field values of an AllowedCompanyEmail 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.
`companyEmailId`	ID	Id of the company email address.
`masterRightId`	ID	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

DeleteAllowedCompanyEmailInput input clientMutationId: String, id: ID!

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

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

Id of an AllowedCompanyEmail 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.
`companyEmailId`	ID	Id of the company email address.
`masterRightId`	ID	Id of the user role.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAllowedCompanyEmailPayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedCompanyEmail mutation.

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

CreateAllowedCompanyEmailPayload object allowedCompanyEmail: AllowedCompanyEmailEntity, clientMutationId: String

Result of the createAllowedCompanyEmail mutation.

Field	Type	Description
`allowedCompanyEmail`	AllowedCompanyEmailEntity	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).

DeleteAllowedCompanyEmailPayload object allowedCompanyEmail: AllowedCompanyEmailEntity, clientMutationId: String

Result of the deleteAllowedCompanyEmail mutation.

Field	Type	Description
`allowedCompanyEmail`	AllowedCompanyEmailEntity	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).

UpdateAllowedCompanyEmailPayload object allowedCompanyEmail: AllowedCompanyEmailEntity, clientMutationId: String

Result of the updateAllowedCompanyEmail mutation.

Field	Type	Description
`allowedCompanyEmail`	AllowedCompanyEmailEntity	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).