File size: 6,455 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 |
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!
}
|