Common GraphQL Enums

• Provide out-of-the-box validation on operations and data.
• Keep data values consistent by restricting a field to a smaller set of possible values.

Use this document to guide you in using various enums throughout Insites.

ACL

Code example:

enum ACL {
  private
  public
}

Values

Private.

Public (read-only).

AggregationSortFieldEnum

Code example:

enum AggregationSortFieldEnum {
  _count
  _term
}

Values

Document count sort.

Alpha sort.

AggregationSortOrderEnum

Code example:

enum AggregationSortOrderEnum {
  asc
  desc
}

Values

Ascending.

Descending.

AggregationTypeEnum

Code example:

enum AggregationTypeEnum {
  avg
  max
  min
  terms
}

Values

A single-value metrics aggregation that keeps track and returns the average value among the values extracted from the aggregated documents.

A single-value metrics aggregation that keeps track and returns the maximum value among the values extracted from the aggregated documents.

A single-value metrics aggregation that keeps track and returns the minimum value among the values extracted from the aggregated documents.

A multi-bucket value source-based aggregation where buckets are dynamically built - one per unique value.

AsyncCallbackPriority

Code example:

enum AsyncCallbackPriority {
  default
  high
  low
}

Values

Default - max timeout: 5 minutes.

High - max timeout: 1 minute.

Low - max timeout: 4 hours.

AttachmentContentDispositionEnum

Code example:

enum AttachmentContentDispositionEnum {
  download
  inline
}

Values

Download.

Inline.

AuthenticationProvider

List of authentication providers.

enum AuthenticationProvider {
  auth0
  facebook
  github
  google
  instagram
  linkedin
  openid_connect
  saml
  twitter
}

Values

auth0.

Facebook.

Github.

Google.

Instagram.

LinkedIn.

Openid_connect.

Saml.

Twitter.

BackgroundJobsTypeEnum

Background jobs type.

enum BackgroundJobsTypeEnum {
  DEAD
  RETRY
  RUNNING
  SCHEDULED
}

Values

Jobs that have failed max_attempts times and will not be retried.

Jobs that have failed and are scheduled for a retry.

Jobs that are being processed at this moment.

Jobs that have been scheduled to be performed in the future.

CustomizableTypeEnum

Code example:

enum CustomizableTypeEnum {
  Customization
  Transactable
  User
  UserProfile
}

Values

Customization.

Transactable.

User.

User Profile.

DistanceUnit

Code example:

enum DistanceUnit {
  cm
  km
  m
  mi
  nmi
  yd
}

Values

Centimetres.

Kilometres.

Meters.

Miles.

Nautical Miles.

Yards.

ImageFormat

Code example:

enum ImageFormat {
  avif
  jpeg
  png
  webp
}

Values

ImageResizeFit

Code example:

enum ImageResizeFit {
  contain
  cover
  fill
  inside
  outside
}

Values

Embed within both provided dimensions.

Crop to cover both provided dimensions.

Ignore the aspect ratio of the input and stretch to both provided dimensions.

Preserving the aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to those specified.

Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to those specified. Some of these values are based on the object-fit CSS property.

ImageResizePosition

Code example:

enum ImageResizePosition {
  bottom
  center
  left
  left_bottom
  left_top
  right
  right_bottom
  right_top
  top
}

Values

JwtAlgorithm

Code example:

enum JwtAlgorithm {
  ES256
  ES384
  ES512
  HS256
  HS384
  HS512
  PS256
  PS384
  PS512
  RS256
  RS384
  RS512
  none
}

Values

LogEntryType

List of available event types.

enum LogEntryType {
  debug
  error
  info
}

Values

NotificationTypeEnum

Code example:

enum NotificationTypeEnum {
  API_CALL
  EMAIL
  SMS
}

Values

ObjectsWithUploadsEnum

The kind of object that holds a property upload. Used by .

enum ObjectsWithUploadsEnum {
  Record
  User
  UserProfile
}

Values

For Record objects.

For User objects.

For UserProfile objects.

OperatorEnum

Code example:

enum OperatorEnum {
  AND
  OR
}

Values

All values should match.

Any value should match.

PageFormat

Code example:

enum PageFormat {
  css
  csv
  html
  ics
  js
  json
  pdf
  rss
  svg
  text
  txt
  xml
}

Values

PageHandler

Code example:

enum PageHandler {
  liquid
  markdown
}

Values

PageRedifectCode

Code example:

enum PageRedifectCode {
  MOVED_PERMANENTLY
  MOVED_TEMPORARILY
}

Values

301 Moved Permanently.

302 Moved Temporarily.

PageRequestMethod

Code example:

enum PageRequestMethod {
  delete
  get
  options
  patch
  post
  put
}

Values

ProcessStrategy

Code example:

enum ProcessStrategy {
  pdf
  text
}

Values

pdf - body should be HTML to be converted to pdf.

text - choose it for things like CSV, json, XML, plain text etc.

PropertyTargetType

Code example:

enum PropertyTargetType {
  ModelSchema
  User
  UserProfileSchema
}

Values

PropertyTypeEnum

Code example:

enum PropertyTypeEnum {
  address
  array
  binary
  boolean
  date
  datetime
  decimal
  file
  float
  geojson
  integer
  photo
  string
  text
  time
  upload
}

Values

An array of strings. Arrays of other types are not supported.

Deprecated; please use string.

PropertyUploadACL

Code example:

enum PropertyUploadACL {
  private
  public
}

Values

PropertyUploadContentDisposition

Code example:

enum PropertyUploadContentDisposition {
  attachment
  inline
}

Values

PropertyUploadFit

Code example:

enum PropertyUploadFit {
  contain
  cover
  fill
  inside
  outside
}

Values

Embed within both provided dimensions.

Crop to cover both provided dimensions.

Ignore the aspect ratio of the input and stretch to both provided dimensions.

Preserving the aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to those specified.

Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to those specified. Some of these values are based on the object-fit CSS property.

PropertyUploadFormat

Code example:

enum PropertyUploadFormat {
  avif
  jpeg
  png
  webp
}

Values

PropertyUploadPosition

Code example:

enum PropertyUploadPosition {
  bottom
  center
  left
  left_bottom
  left_top
  right
  right_bottom
  right_top
  top
}

Values

QueryMatchTypeEnum

Match types for keywords.

enum QueryMatchTypeEnum {
  CONTAINS
  ENDS_WITH
  EXACT
  FUZZY
  STARTS_WITH
}

Values

Match any characters on start and end foo.

Match any characters on start *foo.

Match whole words.

Match and allow typos. Keywodr -> Keyword.

Match any characters on end foo*.

SelectPropertyTypeEnum

The of a property in , used by .

enum SelectPropertyTypeEnum {
  array
  boolean
  float
  int
  json
  object
  string
}

Values

SortOrderEnum

Code example:

enum SortOrderEnum {
  ASC
  DESC
}

Values

For strings: , for numbers: .

For strings: , for numbers: .

TranslationJsonStrategy

Strategy how to set Translation JSON.

enum TranslationJsonStrategy {
  merge
  overwrite
}

Values

Will do the deep merge with existing translations; nothing will be deleted.

It will remove all existing translations for the given key prefix and replace them with provided values.

UploadType

Code example:

enum UploadType {
  attachment
  image
}

Values

ValueUploadInputTypeEnum

Type for upload data.

enum ValueUploadInputTypeEnum {
  image
  pdf
  plain
}

Values

Image upload, generate versions.

Data for a PDF upload.

Data for a plain upload without any processing.

VectorDistanceEnum

The distance used to sort embeddings. Used by .

enum VectorDistanceEnum {
  euclidean
}

Values

Euclidean distance between vectors.

VersionAction

Code example:

enum VersionAction {
  create
  destroy
  update
}

Values

VersionItemType

Code example:

enum VersionItemType {
  Customization
  User
  UserProfile
}

Values