OBJECT

ClientRepository

Read operations for Client records.

link GraphQL Schema definition

  • type ClientRepository {
  • # Returns the record with the given id, or null when there is none. Deleted
  • # records are returned as well.
  • #
  • # Arguments
  • # entityId: Id of the record to return.
  • getById(entityId: ID!): ClientEntity
  • # Returns the records with the given ids; ids without a record are left out.
  • # Deleted records are returned as well.
  • #
  • # Arguments
  • # entityIds: Ids of the records to return.
  • getByIds(entityIds: [ID!]!): [ClientEntity!]!
  • # Returns the records that match the filter, paged with limit and offset.
  • #
  • # Arguments
  • # limit: Maximum number of records to return.
  • # offset: Number of records to skip from the start of the result.
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • getAll(
  • limit: Int,
  • offset: Int,
  • filter: ClientFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean
  • ): [ClientEntity!]!
  • # Returns the records that match the filter as a cursor-paginated connection.
  • #
  • # Arguments
  • # filter: Conditions the returned records must meet.
  • # orderBy: Sorting of the returned records.
  • # includeDeleted: When true, deleted records are returned as
  • # well. Defaults to false.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • getByCriteria(
  • filter: ClientFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ClientEntityConnection
  • # Returns the ids of the fields of a record that changed after the given revision.
  • # Returns an empty list for entities without change tracking.
  • #
  • # Arguments
  • # id: Id of the record.
  • # revision: Revision to compare against; only later changes are
  • # returned.
  • getChangedFieldsSinceRevision(
  • id: UUID!,
  • revision: Int!
  • ): [UUID!]!
  • # Returns the email addresses of all users in every space of the subscription the
  • # current space belongs to, sorted alphabetically.
  • clientEmailsInSubscription: [String!]!
  • # Returns the current user's synchronization setting with the given name, or null
  • # when it does not exist.
  • #
  • # Arguments
  • # name: Name of the setting.
  • getEntitySyncSettings(name: String!): EntitySyncSettings
  • # Returns the space-wide synchronization status entry with the given name, or null
  • # when it does not exist. Only names ending with "_status" are resolved.
  • #
  • # Arguments
  • # name: Name of the status entry; must end with "_status".
  • getEntitySyncSettingStatus(name: String!): EntitySyncSettings
  • # Returns the current user's links between Coevera contacts and contacts in an
  • # external service (Exchange, Office 365 or Google) used by contact
  • # synchronization.
  • #
  • # Arguments
  • # serviceType: External service whose links are returned; only
  • # records linked in that service are included.
  • # flagToDelete: When true, returns only links flagged for
  • # deletion; when false, only links not flagged.
  • # flagOldFormat: When 1, returns only Google links that still use
  • # the legacy Google Contacts id format.
  • # foreignIds: Ids of records in the external service to limit the
  • # result to.
  • getContactMappings(
  • serviceType: ServiceMappingType!,
  • flagToDelete: Boolean!,
  • flagOldFormat: Int,
  • foreignIds: [String!]
  • ): [EntityMapping!]!
  • # Returns the current user's links between Coevera tasks and tasks in an external
  • # service (Exchange, Office 365 or Google) used by task synchronization.
  • #
  • # Arguments
  • # serviceType: External service whose links are returned; only
  • # records linked in that service are included.
  • # flagToDelete: When true, returns only links flagged for
  • # deletion; when false, only links not flagged.
  • # flagOldFormat: Currently not used.
  • # foreignIds: Ids of records in the external service to limit the
  • # result to.
  • getTaskMappings(
  • serviceType: ServiceMappingType!,
  • flagToDelete: Boolean!,
  • flagOldFormat: Int,
  • foreignIds: [String!]
  • ): [EntityMapping!]!
  • # Returns the current user's links between Coevera appointments and events in an
  • # external service (Exchange, Office 365 or Google) used by calendar
  • # synchronization.
  • #
  • # Arguments
  • # serviceType: External service whose links are returned; only
  • # records linked in that service are included.
  • # flagToDelete: When true, returns only links flagged for
  • # deletion; when false, only links not flagged.
  • # flagOldFormat: Currently not used.
  • # foreignIds: Ids of records in the external service to limit the
  • # result to.
  • getEventMappings(
  • serviceType: ServiceMappingType!,
  • flagToDelete: Boolean!,
  • flagOldFormat: Int,
  • foreignIds: [String!]
  • ): [EntityMapping!]!
  • # Returns the space user with the given email address, or null when there is none.
  • # The address is compared case-insensitively.
  • #
  • # Arguments
  • # email: Email address of the user.
  • getByEmail(email: String!): ClientEntity
  • # Returns the support staff who can be invited to the space: customer support
  • # users and users of the subscription's partner.
  • #
  • # Arguments
  • # invited: When true, support users already invited to the space
  • # are included. Defaults to false.
  • getSupportUsers(invited: Boolean): [SupportUser!]!
  • }