GraphQL RepositoriesunsubscribedPhone

`entities.unsubscribedPhone`

Read unsubscribed phone records with the unsubscribedPhone repository, and change them with the unsubscribed phone mutations. Same records as the REST UnsubscribedPhones entity.

Example: first three unsubscribed phone recordsGraphQLcURL

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

Queries

Fields of entities { unsubscribedPhone { … } }.

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.	UnsubscribedPhoneEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[UnsubscribedPhoneEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: UnsubscribedPhoneFilterInput, orderBy: [UnsubscribedPhoneOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[UnsubscribedPhoneEntity!]!
QUERY	`getByCriteria`(filter: UnsubscribedPhoneFilterInput, orderBy: [UnsubscribedPhoneOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	UnsubscribedPhoneEntityConnection
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	`createUnsubscribedPhone`(input: CreateUnsubscribedPhoneInput!, validationLevel: [ValidationLevel!])	Create one record	CreateUnsubscribedPhonePayload
MUTATION	`updateUnsubscribedPhone`(input: UpdateUnsubscribedPhoneInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateUnsubscribedPhonePayload
MUTATION	`bulkUpdateUnsubscribedPhone`(input: [CreateOrUpdateUnsubscribedPhoneInput!]!, deleteInput: [DeleteUnsubscribedPhoneInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateUnsubscribedPhonePayload
MUTATION	`deleteUnsubscribedPhone`(input: DeleteUnsubscribedPhoneInput!)	Soft-delete	DeleteUnsubscribedPhonePayload

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.

UnsubscribedPhoneEntity object 8 fields: isDeleteProtected, id, isDeleted, …

Phone number that opted out of receiving 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.
`phone`	String	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`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.

UnsubscribedPhoneEntityConnection object pageInfo: PageInfo!, edges: [UnsubscribedPhoneEntityEdge]!, totalCount: Int

Paginated list of UnsubscribedPhone records.

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

UnsubscribedPhoneEntityEdge object node: UnsubscribedPhoneEntity, cursor: String!

A Relay edge containing a UnsubscribedPhoneEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[UnsubscribedPhoneFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[UnsubscribedPhoneFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	UnsubscribedPhoneFilterInput	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.
`phone`	EntityFilterStringField	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.

UnsubscribedPhoneOrderByInput input Asc or Desc per field

Sorting of UnsubscribedPhone 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.
`phone`	OrderByEnum	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`revision`	OrderByEnum	Revision when entity was lastly changed.

CreateOrUpdateUnsubscribedPhoneInput input 6 fields: clientMutationId, id, modified, …

Field values of an UnsubscribedPhone 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.
`phone`	String	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`revision`	Int	Revision when entity was lastly changed.

CreateUnsubscribedPhoneInput input 5 fields: clientMutationId, modified, created, …

Field values of a new UnsubscribedPhone 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.
`phone`	String	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`revision`	Int	Revision when entity was lastly changed.

DeleteUnsubscribedPhoneInput input clientMutationId: String, id: ID!

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

UpdateUnsubscribedPhoneInput input 6 fields: clientMutationId, id, modified, …

Id of an UnsubscribedPhone 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.
`phone`	String	Phone number that has unsubscribed from receiving SMS messages, in E.164 format.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateUnsubscribedPhonePayload object result: BulkUpdateResults!

Result of the bulkUpdateUnsubscribedPhone mutation.

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

CreateUnsubscribedPhonePayload object unsubscribedPhone: UnsubscribedPhoneEntity, clientMutationId: String

Result of the createUnsubscribedPhone mutation.

Field	Type	Description
`unsubscribedPhone`	UnsubscribedPhoneEntity	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).

DeleteUnsubscribedPhonePayload object unsubscribedPhone: UnsubscribedPhoneEntity, clientMutationId: String

Result of the deleteUnsubscribedPhone mutation.

Field	Type	Description
`unsubscribedPhone`	UnsubscribedPhoneEntity	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).

UpdateUnsubscribedPhonePayload object unsubscribedPhone: UnsubscribedPhoneEntity, clientMutationId: String

Result of the updateUnsubscribedPhone mutation.

Field	Type	Description
`unsubscribedPhone`	UnsubscribedPhoneEntity	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).