GraphQL RepositoriesappointmentContactInviteesRelation

`entities.appointmentContactInviteesRelation`

Read appointment contact invitees relation records with the appointmentContactInviteesRelation repository, and change them with the appointment contact invitees relation mutations. Same records as the REST AppointmentContactInviteesRelations entity.

Example: first three appointment contact invitees relation recordsGraphQLcURL

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

Queries

Fields of entities { appointmentContactInviteesRelation { … } }.

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.	AppointmentContactInviteesRelationEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[AppointmentContactInviteesRelationEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: AppointmentContactInviteesRelationFilterInput, orderBy: [AppointmentContactInviteesRelationOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[AppointmentContactInviteesRelationEntity!]!
QUERY	`getByCriteria`(filter: AppointmentContactInviteesRelationFilterInput, orderBy: [AppointmentContactInviteesRelationOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	AppointmentContactInviteesRelationEntityConnection
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	`createAppointmentContactInviteesRelation`(input: CreateAppointmentContactInviteesRelationInput!, validationLevel: [ValidationLevel!])	Create one record	CreateAppointmentContactInviteesRelationPayload
MUTATION	`updateAppointmentContactInviteesRelation`(input: UpdateAppointmentContactInviteesRelationInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateAppointmentContactInviteesRelationPayload
MUTATION	`bulkUpdateAppointmentContactInviteesRelation`(input: [CreateOrUpdateAppointmentContactInviteesRelationInput!]!, deleteInput: [DeleteAppointmentContactInviteesRelationInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateAppointmentContactInviteesRelationPayload
MUTATION	`deleteAppointmentContactInviteesRelation`(input: DeleteAppointmentContactInviteesRelationInput!)	Soft-delete	DeleteAppointmentContactInviteesRelationPayload

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.

AppointmentContactInviteesRelationEntity object 16 fields: isDeleteProtected, id, isDeleted, …

Invitation of an external person to an appointment, identified by email and matched to a contact when one exists, with their response.

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.
`appointment`	AppointmentEntity	Appointment the contact has been invited to.
`contact`	ContactEntity	Coevera Contact record matching the invitee email, when one exists.
`appointmentId`	ID!	Id of the appointment the contact has been invited to.
`contactId`	ID	Id of the matched contact.
`email`	String!	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	String	Given name of the invitee, when supplied.
`inviteeType`	AppointmentInviteeTypeEnum	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	String	Family name of the invitee, when supplied.
`response`	InviteeResponseEnum	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`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.

AppointmentContactInviteesRelationEntityConnection object pageInfo: PageInfo!, edges: [AppointmentContactInviteesRelationEntityEdge]!, totalCount: Int

Paginated list of AppointmentContactInviteesRelation records.

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

AppointmentContactInviteesRelationEntityEdge object node: AppointmentContactInviteesRelationEntity, cursor: String!

A Relay edge containing a AppointmentContactInviteesRelationEntity and its cursor.

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

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

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

Input field	Type	Description
`OR`	[AppointmentContactInviteesRelationFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[AppointmentContactInviteesRelationFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	AppointmentContactInviteesRelationFilterInput	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.
`appointmentId`	EntityFilterStringField	Id of the appointment the contact has been invited to.
`contactId`	EntityFilterStringField	Id of the matched contact.
`email`	EntityFilterStringField	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	EntityFilterStringField	Given name of the invitee, when supplied.
`inviteeType`	AppointmentInviteeTypeEnumFilterInput	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	EntityFilterStringField	Family name of the invitee, when supplied.
`response`	InviteeResponseEnumFilterInput	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`revision`	EntityFilterNumberField	Revision when entity was lastly changed.
`appointment`	AppointmentFilterInput	Appointment the contact has been invited to. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Coevera Contact record matching the invitee email, when one exists. Matches records where a related record meets these conditions.

AppointmentContactInviteesRelationOrderByInput input Asc or Desc per field

Sorting of AppointmentContactInviteesRelation 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.
`appointment`	[AppointmentOrderByNestedInput!]	Appointment the contact has been invited to. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Coevera Contact record matching the invitee email, when one exists. Sorts by fields of the related record, listed in order of priority.
`appointmentId`	OrderByEnum	Id of the appointment the contact has been invited to.
`contactId`	OrderByEnum	Id of the matched contact.
`email`	OrderByEnum	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	OrderByEnum	Given name of the invitee, when supplied.
`inviteeType`	OrderByEnum	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	OrderByEnum	Family name of the invitee, when supplied.
`response`	OrderByEnum	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`revision`	OrderByEnum	Revision when entity was lastly changed.

AppointmentInviteeTypeEnumFilterInput input eq: [AppointmentInviteeTypeEnum!], NOT: AppointmentInviteeTypeEnumFilterInput

Conditions on an enumeration field. Several conditions given together must all match.

Input field	Type	Description
`eq`	[AppointmentInviteeTypeEnum!]	Matches any of the listed values.
`NOT`	AppointmentInviteeTypeEnumFilterInput	Matches values that do not meet this condition.

CreateAppointmentContactInviteesRelationInput input 11 fields: clientMutationId, modified, created, …

Field values of a new AppointmentContactInviteesRelation 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.
`appointmentId`	ID!	Id of the appointment the contact has been invited to.
`contactId`	ID	Id of the matched contact.
`email`	String!	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	String	Given name of the invitee, when supplied.
`inviteeType`	AppointmentInviteeTypeEnum	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	String	Family name of the invitee, when supplied.
`response`	InviteeResponseEnum	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`revision`	Int	Revision when entity was lastly changed.

CreateOrUpdateAppointmentContactInviteesRelationInput input 12 fields: clientMutationId, id, modified, …

Field values of an AppointmentContactInviteesRelation 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.
`appointmentId`	ID	Id of the appointment the contact has been invited to.
`contactId`	ID	Id of the matched contact.
`email`	String	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	String	Given name of the invitee, when supplied.
`inviteeType`	AppointmentInviteeTypeEnum	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	String	Family name of the invitee, when supplied.
`response`	InviteeResponseEnum	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`revision`	Int	Revision when entity was lastly changed.

DeleteAppointmentContactInviteesRelationInput input clientMutationId: String, id: ID!

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

UpdateAppointmentContactInviteesRelationInput input 12 fields: clientMutationId, id, modified, …

Id of an AppointmentContactInviteesRelation 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.
`appointmentId`	ID	Id of the appointment the contact has been invited to.
`contactId`	ID	Id of the matched contact.
`email`	String	Email address of the invitee. Required and used as the natural key for the link.
`firstName`	String	Given name of the invitee, when supplied.
`inviteeType`	AppointmentInviteeTypeEnum	How the invitee was added: invited directly on the appointment (Standard), or the person who booked it through an appointment schedule (Scheduled).
`lastName`	String	Family name of the invitee, when supplied.
`response`	InviteeResponseEnum	Response of the invitee to the appointment invitation: NoResponse, Accepted or Rejected.
`revision`	Int	Revision when entity was lastly changed.

BulkUpdateAppointmentContactInviteesRelationPayload object result: BulkUpdateResults!

Result of the bulkUpdateAppointmentContactInviteesRelation mutation.

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

CreateAppointmentContactInviteesRelationPayload object appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity, clientMutationId: String

Result of the createAppointmentContactInviteesRelation mutation.

Field	Type	Description
`appointmentContactInviteesRelation`	AppointmentContactInviteesRelationEntity	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).

DeleteAppointmentContactInviteesRelationPayload object appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity, clientMutationId: String

Result of the deleteAppointmentContactInviteesRelation mutation.

Field	Type	Description
`appointmentContactInviteesRelation`	AppointmentContactInviteesRelationEntity	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).

UpdateAppointmentContactInviteesRelationPayload object appointmentContactInviteesRelation: AppointmentContactInviteesRelationEntity, clientMutationId: String

Result of the updateAppointmentContactInviteesRelation mutation.

Field	Type	Description
`appointmentContactInviteesRelation`	AppointmentContactInviteesRelationEntity	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).

AppointmentInviteeTypeEnum enum Standard, Scheduled

How a contact invitee was added to an appointment.

Value	Description
`Standard`	Invited directly on the appointment.
`Scheduled`	The person who booked the appointment through an appointment schedule.