| | extend type Query { |
| | """ |
| | destinationTypes returns a list of destination types that can be used for |
| | notifications. |
| | """ |
| | destinationTypes(isDynamicAction: Boolean): [DestinationTypeInfo!]! |
| |
|
| | """ |
| | destinationFieldValidate validates a destination field value as valid or invalid. |
| | |
| | It does not guarantee that the value is valid for the destination type, only |
| | that it is valid for the field (i.e., syntax/formatting). |
| | """ |
| | destinationFieldValidate(input: DestinationFieldValidateInput!): Boolean! |
| | destinationFieldSearch( |
| | input: DestinationFieldSearchInput! |
| | ): FieldSearchConnection! |
| | destinationFieldValueName(input: DestinationFieldValidateInput!): String! |
| |
|
| | """ |
| | destinationDisplayInfo returns the display information for a destination. |
| | """ |
| | destinationDisplayInfo(input: DestinationInput!): DestinationDisplayInfo! |
| | } |
| |
|
| | """ |
| | FieldSearchConnection is a connection to a list of FieldSearchResult. |
| | """ |
| | type FieldSearchConnection { |
| | nodes: [FieldSearchResult!]! |
| | pageInfo: PageInfo! |
| | } |
| |
|
| | type FieldSearchResult { |
| | """ |
| | The ID of the input field that this value is for. |
| | """ |
| | fieldID: ID! |
| |
|
| | """ |
| | The value of the input field. |
| | """ |
| | value: String! |
| |
|
| | """ |
| | The user-friendly text for this value of the input field (e.g., if the value is a user ID, label would be the user's name). |
| | """ |
| | label: String! |
| |
|
| | """ |
| | if true, this value is a favorite for the user, only set for search results |
| | """ |
| | isFavorite: Boolean! |
| | } |
| |
|
| | input DestinationFieldValidateInput { |
| | """ |
| | the type of destination to validate |
| | """ |
| | destType: DestinationType! |
| |
|
| | """ |
| | the ID of the input field to validate |
| | """ |
| | fieldID: ID! |
| |
|
| | """ |
| | the value to validate |
| | """ |
| | value: String! |
| | } |
| |
|
| | """ |
| | DestinationType represents a type of destination that can be used for |
| | notifications. |
| | """ |
| | scalar DestinationType |
| |
|
| | input DestinationFieldSearchInput { |
| | """ |
| | the type of destination to search for |
| | """ |
| | destType: DestinationType! |
| |
|
| | """ |
| | the ID of the input field to search for |
| | """ |
| | fieldID: ID! |
| |
|
| | """ |
| | search string to match against |
| | """ |
| | search: String |
| |
|
| | """ |
| | values/ids to omit from results |
| | """ |
| | omit: [String!] |
| |
|
| | """ |
| | cursor to start search from |
| | """ |
| | after: String |
| |
|
| | """ |
| | number of results to return |
| | """ |
| | first: Int = 15 |
| | } |
| |
|
| | union InlineDisplayInfo = DestinationDisplayInfo | DestinationDisplayInfoError |
| |
|
| | """ |
| | A map of string keys to string values |
| | """ |
| | scalar StringMap |
| |
|
| | """ |
| | Destination represents a destination that can be used for notifications. |
| | """ |
| | type Destination { |
| | type: DestinationType! |
| | values: [FieldValuePair!]! |
| | @goField(forceResolver: true) |
| | @deprecated(reason: "Use the args field instead") |
| | args: StringMap! |
| | displayInfo: InlineDisplayInfo! @goField(forceResolver: true) |
| | } |
| |
|
| | type DestinationDisplayInfoError { |
| | """ |
| | error message to display when the display info cannot be retrieved |
| | """ |
| | error: String! |
| | } |
| |
|
| | """ |
| | DestinationDisplayInfo provides information for displaying a destination. |
| | """ |
| | type DestinationDisplayInfo { |
| | """ |
| | user-friendly text to display for this destination |
| | """ |
| | text: String! |
| |
|
| | """ |
| | URL to an icon to display for this destination |
| | """ |
| | iconURL: String! |
| |
|
| | """ |
| | alt text for the icon, should be human-readable and usable in place of the icon |
| | """ |
| | iconAltText: String! |
| |
|
| | """ |
| | URL to link to for more information about this destination |
| | """ |
| | linkURL: String! |
| | } |
| |
|
| | type FieldValuePair { |
| | """ |
| | The ID of the input field that this value is for. |
| | """ |
| | fieldID: ID! |
| |
|
| | """ |
| | The value of the input field. |
| | """ |
| | value: String! |
| | } |
| |
|
| | input DestinationInput { |
| | type: DestinationType! |
| | values: [FieldValueInput!] |
| | @goField(forceResolver: true) |
| | @deprecated(reason: "Use the args field instead") |
| | args: StringMap |
| | } |
| |
|
| | input FieldValueInput { |
| | """ |
| | The ID of the input field that this value is for. |
| | """ |
| | fieldID: ID! |
| | value: String! |
| | } |
| |
|
| | type DestinationTypeInfo { |
| | type: DestinationType! |
| |
|
| | name: String! |
| |
|
| | """ |
| | URL to an icon to display for the destination type |
| | """ |
| | iconURL: String! |
| |
|
| | """ |
| | alt text for the icon, should be usable in place of the icon |
| | """ |
| | iconAltText: String! |
| |
|
| | """ |
| | if false, the destination type is disabled and cannot be used |
| | """ |
| | enabled: Boolean! |
| | requiredFields: [DestinationFieldConfig!]! |
| |
|
| | """ |
| | expr parameters that can be used for this destination type |
| | """ |
| | dynamicParams: [DynamicParamConfig!]! |
| |
|
| | """ |
| | disclaimer text to display when a user is selecting this destination type for a contact method |
| | """ |
| | userDisclaimer: String! |
| |
|
| | """ |
| | this destination type can be used as a user contact method |
| | """ |
| | isContactMethod: Boolean! |
| |
|
| | """ |
| | this destination type can be used as an escalation policy step action |
| | """ |
| | isEPTarget: Boolean! |
| |
|
| | """ |
| | this destination type can be used for schedule on-call notifications |
| | """ |
| | isSchedOnCallNotify: Boolean! |
| |
|
| | """ |
| | this destination type can be used for dynamic actions |
| | """ |
| | isDynamicAction: Boolean! |
| |
|
| | """ |
| | if true, the destination type supports status updates |
| | """ |
| | supportsStatusUpdates: Boolean! |
| |
|
| | """ |
| | if true, the destination type requires status updates to be enabled |
| | """ |
| | statusUpdatesRequired: Boolean! |
| | } |
| |
|
| | type DestinationFieldConfig { |
| | """ |
| | unique ID for the input field |
| | """ |
| | fieldID: ID! |
| |
|
| | """ |
| | user-friendly label (should be singular) |
| | """ |
| | label: String! |
| |
|
| | """ |
| | user-friendly helper text for input fields (i.e., "Enter a phone number") |
| | """ |
| | hint: String! |
| |
|
| | """ |
| | URL to link to for more information about the destination type |
| | """ |
| | hintURL: String! |
| |
|
| | """ |
| | placeholder text to display in input fields (e.g., "Phone Number") |
| | """ |
| | placeholderText: String! |
| |
|
| | """ |
| | the prefix to use when displaying the destination (e.g., "+" for phone numbers) |
| | """ |
| | prefix: String! |
| |
|
| | """ |
| | the type of input field (type attribute) to use (e.g., "text" or "tel") |
| | """ |
| | inputType: String! |
| |
|
| | """ |
| | if true, the destination can be selected via search |
| | """ |
| | supportsSearch: Boolean! |
| |
|
| | """ |
| | if true, the destination type supports real-time validation |
| | """ |
| | supportsValidation: Boolean! |
| | } |
| |
|
| | type DynamicParamConfig { |
| | """ |
| | unique ID for the input field |
| | """ |
| | paramID: ID! |
| |
|
| | """ |
| | user-friendly label (should be singular) |
| | """ |
| | label: String! |
| |
|
| | """ |
| | user-friendly helper text for input fields (i.e., "Enter a phone number") |
| | """ |
| | hint: String! |
| |
|
| | """ |
| | URL to link to for more information about the destination type |
| | """ |
| | hintURL: String! |
| |
|
| | """ |
| | default value for the input field |
| | """ |
| | defaultValue: ExprStringExpression! |
| | } |
| |
|
