GraphQL - Enums

ACL

Values

  • private - private
  • public - public (read only)

AggregationSortFieldEnum

Values

  • _count - document count sort
  • _term - alpha sort

AggregationSortOrderEnum

Values

  • asc - ascending
  • desc - descending

AggregationTypeEnum

Values

  • avg - A single-value metrics aggregation that keeps track and returns the average value among the values extracted from the aggregated documents.
  • max - A single-value metrics aggregation that keeps track and returns the maximum value among the values extracted from the aggregated documents.
  • min - A single-value metrics aggregation that keeps track and returns the minimum value among the values extracted from the aggregated documents.
  • terms - A multi-bucket value source based aggregation where buckets are dynamically built - one per unique value.

AsyncCallbackPriority

Values

  • default - default - max timeout: 5 minutes
  • high - high - max timeout: 1 minute
  • low - low - max timeout: 4 hours

AuthenticationProvider

List of authentication providers

Values

  • auth0 - auth0
  • facebook - facebook
  • github - github
  • google - google
  • instagram - instagram
  • linkedin - linkedin
  • openid_connect - openid_connect
  • saml - saml
  • twitter - twitter

CMSItemType

Values

  • ActivityStreamsGroupingHandler -
  • ActivityStreamsHandler -
  • ApiCallNotification -
  • Asset -
  • AuthorizationPolicy -
  • CustomModelType -
  • EmailNotification -
  • FormConfiguration -
  • GraphQuery -
  • InstanceProfileType -
  • LiquidView -
  • Migration -
  • Page -
  • RelationshipTransactableType -
  • RelationshipType -
  • RelationshipUserType -
  • SmsNotification -
  • TransactableType -
  • Translation -
  • UserType -

CustomizableTypeEnum

Values

  • Customization - Customization
  • Payment - Payment
  • Relationship - Relationship
  • Transactable - Transactable
  • User - User
  • UserProfile - UserProfile

DistanceUnit

Values

  • cm - Centimeters
  • km - Kilometers
  • m - Meters
  • mi - Miles
  • nmi - Nautical Miles
  • yd - Yards

ImageFormat

Values

  • jpeg -
  • png -
  • webp -

ImageResizeFit

Values

  • contain - Embed within both provided dimensions.
  • cover - Crop to cover both provided dimensions
  • fill - Ignore the aspect ratio of the input and stretch to both provided dimensions.
  • inside - Preserving aspect ratio, resize the image to be as large as possible while ensuring its dimensions are less than or equal to both those specified.
  • outside - Preserving aspect ratio, resize the image to be as small as possible while ensuring its dimensions are greater than or equal to both those specified. Some of these values are based on the object-fit CSS property.

ImageResizePosition

Values

  • bottom -
  • left -
  • left_bottom -
  • left_top -
  • right -
  • right_bottom -
  • right_top -
  • top -

LogEntryType

List of available event types

Values

  • debug -
  • error -
  • info -

MerchantAccountState

List of states for merchant account

Values

  • failed - Failed merchant account
  • pending - Pending merchant account
  • verified - Verified merchant account
  • voided - Voided merchant account

OperatorEnum

Values

  • AND - all values should match
  • OR - any value should match

OrderDirection

Order direction

Values

  • ASC - Asc
  • DESC - Desc

PageFormat

Values

  • css - css
  • csv - csv
  • html - html
  • js - js
  • json - json
  • pdf - pdf
  • rss - rss
  • svg - svg
  • text - text
  • txt - txt
  • xml - xml

PageHandler

Values

  • liquid - liquid
  • markdown - markdown

PageRedifectCode

Values

  • MOVED_PERMANENTLY - 301 Moved Permanently
  • MOVED_TEMPORARILY - 302 Moved Temporarily

PageRequestMethod

Values

  • delete - delete
  • get - get
  • patch - patch
  • post - post
  • put - put

PaymentGatewayMode

List modes of Payment Gateway

Values

  • live - Uses live account, all transactions are charged
  • test - Uses test account, no transactons are actually charged

PaymentGatewayType

List of available types of Payment Gatweways

Values

  • BraintreeMarketplacePaymentGateway -
  • BraintreePaymentGateway -
  • ManualPaymentGateway -
  • PaypalExpressChainPaymentGateway -
  • PaypalExpressPaymentGateway -
  • PaypalPaymentGateway -
  • StripeConnectPaymentGateway -
  • StripePaymentGateway -

PaymentMethodType

List of available types of Payment Methods

Values

  • ach -
  • credit_card -
  • express_checkout -
  • free -
  • manual -
  • nonce -
  • remote -

PaymentMode

List of available modes for Payment

Values

  • live - Live mode
  • test - Test mode

PaymentState

List of available states for Payment

Values

  • authorized - Authorized payment
  • failed - Failed payment
  • paid - Payment has been made
  • pending - Pending payment
  • refunded - Payment has been refunded
  • voided - Voided payment

ProcessStrategy

Values

  • pdf - pdf - body should be html to be converted to pdf
  • text - text - choose it for things like csv, json, xml, plain text etc.

PropertyTypeEnum

Values

  • address - address
  • array - array of strings, will be deprecated in the future as current implementation prevents arrays of other types
  • binary - binary
  • boolean - boolean
  • date - date
  • datetime - datetime
  • decimal - decimal
  • file - file
  • float - float
  • geojson - geojson
  • integer - integer
  • photo - photo
  • string - string
  • text - deprecated, please use string
  • time - time

QueryMatchTypeEnum

Match types for keyword

Values

  • CONTAINS - Match any characters on start and end *foo*
  • ENDS_WITH - Match any characters on start *foo
  • EXACT - Match whole words
  • STARTS_WITH - Match any characters on end foo*

SortOrderEnum

Values

  • ASC - for strings: `a,b,c`, for numbers: `1,2,3`
  • DESC - for strings: `z,x,y`, for numbers: `99,98,97`

UploadType

Values

  • attachment - Attachment
  • image - Image

__DirectiveLocation

A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.

Values

  • QUERY - Location adjacent to a query operation.
  • MUTATION - Location adjacent to a mutation operation.
  • SUBSCRIPTION - Location adjacent to a subscription operation.
  • FIELD - Location adjacent to a field.
  • FRAGMENT_DEFINITION - Location adjacent to a fragment definition.
  • FRAGMENT_SPREAD - Location adjacent to a fragment spread.
  • INLINE_FRAGMENT - Location adjacent to an inline fragment.
  • SCHEMA - Location adjacent to a schema definition.
  • SCALAR - Location adjacent to a scalar definition.
  • OBJECT - Location adjacent to an object type definition.
  • FIELD_DEFINITION - Location adjacent to a field definition.
  • ARGUMENT_DEFINITION - Location adjacent to an argument definition.
  • INTERFACE - Location adjacent to an interface definition.
  • UNION - Location adjacent to a union definition.
  • ENUM - Location adjacent to an enum definition.
  • ENUM_VALUE - Location adjacent to an enum value definition.
  • INPUT_OBJECT - Location adjacent to an input object type definition.
  • INPUT_FIELD_DEFINITION - Location adjacent to an input object field definition.

__TypeKind

An enum describing what kind of type a given `__Type` is.

Values

  • SCALAR - Indicates this type is a scalar.
  • OBJECT - Indicates this type is an object. `fields` and `interfaces` are valid fields.
  • INTERFACE - Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.
  • UNION - Indicates this type is a union. `possibleTypes` is a valid field.
  • ENUM - Indicates this type is an enum. `enumValues` is a valid field.
  • INPUT_OBJECT - Indicates this type is an input object. `inputFields` is a valid field.
  • LIST - Indicates this type is a list. `ofType` is a valid field.
  • NON_NULL - Indicates this type is a non-null. `ofType` is a valid field.

Questions?

We are always happy to help with any questions you may have.