GraphQL RepositoriesallowedCompanyPhone

`entities.allowedCompanyPhone`

Read allowed company phone records with the allowedCompanyPhone repository, and change them with the allowed company phone mutations. Same records as the REST AllowedCompanyPhones entity.

Example: first three allowed company phone recordsGraphQLcURL

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

Queries

Fields of entities { allowedCompanyPhone { … } }.

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.	AllowedCompanyPhoneEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AllowedCompanyPhoneEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AllowedCompanyPhoneFilterInput, orderBy: [AllowedCompanyPhoneOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AllowedCompanyPhoneEntity!]!
QUERY	`getByCriteria`(filter: AllowedCompanyPhoneFilterInput, orderBy: [AllowedCompanyPhoneOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AllowedCompanyPhoneEntityConnection
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	`createAllowedCompanyPhone`(input: CreateAllowedCompanyPhoneInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAllowedCompanyPhonePayload
MUTATION	`updateAllowedCompanyPhone`(input: UpdateAllowedCompanyPhoneInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAllowedCompanyPhonePayload
MUTATION	`bulkUpdateAllowedCompanyPhone`(input: [CreateOrUpdateAllowedCompanyPhoneInput!]!, deleteInput: [DeleteAllowedCompanyPhoneInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAllowedCompanyPhonePayload
MUTATION	`deleteAllowedCompanyPhone`(input: DeleteAllowedCompanyPhoneInput!)	Soft-delete	DeleteAllowedCompanyPhonePayload

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.

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

Company phone number that a user role is allowed to use for calls and text messages.

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.
`masterRight`	MasterRightEntity	User role granted access to the company phone.
`phone`	PhoneEntity	Company phone the user role can use for calling/SMS.
`masterRightId`	ID!	Id of the user role.
`phoneId`	ID!	Id of the company phone.
`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.

AllowedCompanyPhoneEntityConnection object pageInfo: PageInfo!, edges: [AllowedCompanyPhoneEntityEdge]!, totalCount: Int

Paginated list of AllowedCompanyPhone records.

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

AllowedCompanyPhoneEntityEdge object node: AllowedCompanyPhoneEntity, cursor: String!

A Relay edge containing a AllowedCompanyPhoneEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AllowedCompanyPhoneFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AllowedCompanyPhoneFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AllowedCompanyPhoneFilterInput	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.
`masterRightId`	EntityFilterStringField	Id of the user role.
`phoneId`	EntityFilterStringField	Id of the company phone.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`masterRight`	MasterRightFilterInput	User role granted access to the company phone. Matches records where a related record meets these conditions.
`phone`	PhoneFilterInput	Company phone the user role can use for calling/SMS. Matches records where a related record meets these conditions.

AllowedCompanyPhoneOrderByInput input Asc or Desc per field

Sorting of AllowedCompanyPhone 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.
`masterRight`	[MasterRightOrderByNestedInput!]	User role granted access to the company phone. Sorts by fields of the related record, listed in order of priority.
`phone`	[PhoneOrderByNestedInput!]	Company phone the user role can use for calling/SMS. Sorts by fields of the related record, listed in order of priority.
`masterRightId`	OrderByEnum	Id of the user role.
`phoneId`	OrderByEnum	Id of the company phone.
`revision`	OrderByEnum	Revision when entity was lastly changed.

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

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

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

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

DeleteAllowedCompanyPhoneInput input clientMutationId: String, id: ID!

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

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

Id of an AllowedCompanyPhone 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.
`masterRightId`	ID	Id of the user role.
`phoneId`	ID	Id of the company phone.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAllowedCompanyPhonePayload object result: BulkUpdateResults!

Result of the bulkUpdateAllowedCompanyPhone mutation.

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

CreateAllowedCompanyPhonePayload object allowedCompanyPhone: AllowedCompanyPhoneEntity, clientMutationId: String

Result of the createAllowedCompanyPhone mutation.

Field	Type	Description
`allowedCompanyPhone`	AllowedCompanyPhoneEntity	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).

DeleteAllowedCompanyPhonePayload object allowedCompanyPhone: AllowedCompanyPhoneEntity, clientMutationId: String

Result of the deleteAllowedCompanyPhone mutation.

Field	Type	Description
`allowedCompanyPhone`	AllowedCompanyPhoneEntity	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).

UpdateAllowedCompanyPhonePayload object allowedCompanyPhone: AllowedCompanyPhoneEntity, clientMutationId: String

Result of the updateAllowedCompanyPhone mutation.

Field	Type	Description
`allowedCompanyPhone`	AllowedCompanyPhoneEntity	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).