zapier-platform-schema 16.5.1 → 17.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/exported-schema.json +555 -276
- package/lib/constants.js +1 -1
- package/lib/functional-constraints/AuthFieldisSafe.js +85 -0
- package/lib/functional-constraints/bufferedCreateConstraints.js +4 -4
- package/lib/functional-constraints/deepNestedFields.js +2 -2
- package/lib/functional-constraints/index.js +1 -0
- package/lib/functional-constraints/mutuallyExclusiveFields.js +1 -1
- package/lib/functional-constraints/requirePerformConditionally.js +1 -1
- package/lib/schemas/AuthFieldSchema.js +122 -0
- package/lib/schemas/AuthFieldsSchema.js +67 -0
- package/lib/schemas/AuthenticationSchema.js +3 -3
- package/lib/schemas/{BasicCreateActionOperationSchema.js → BasicCreateOperationSchema.js} +8 -14
- package/lib/schemas/BasicOperationSchema.js +7 -5
- package/lib/schemas/BasicSearchOperationSchema.js +61 -0
- package/lib/schemas/CreateSchema.js +3 -28
- package/lib/schemas/InputFieldsSchema.js +20 -0
- package/lib/schemas/LockObjectSchema.js +1 -1
- package/lib/schemas/OutputFieldsSchema.js +20 -0
- package/lib/schemas/PlainFieldSchema.js +144 -0
- package/lib/schemas/{FieldSchema.js → PlainInputFieldSchema.js} +21 -95
- package/lib/schemas/PlainOutputFieldSchema.js +96 -0
- package/lib/schemas/RefResourceSchema.js +1 -1
- package/lib/schemas/ResourceSchema.js +3 -3
- package/lib/schemas/SearchSchema.js +3 -3
- package/package.json +2 -2
- package/lib/schemas/DynamicFieldsSchema.js +0 -36
- package/lib/schemas/FieldOrFunctionSchema.js +0 -40
- package/lib/schemas/FieldsSchema.js +0 -17
package/exported-schema.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"version": "
|
|
2
|
+
"version": "17.0.1",
|
|
3
3
|
"schemas": {
|
|
4
4
|
"AppSchema": {
|
|
5
5
|
"id": "/AppSchema",
|
|
@@ -96,6 +96,83 @@
|
|
|
96
96
|
},
|
|
97
97
|
"additionalProperties": false
|
|
98
98
|
},
|
|
99
|
+
"FunctionRequireSchema": {
|
|
100
|
+
"id": "/FunctionRequireSchema",
|
|
101
|
+
"description": "A path to a file that might have content like `module.exports = (z, bundle) => [{id: 123}];`.",
|
|
102
|
+
"type": "object",
|
|
103
|
+
"required": ["require"],
|
|
104
|
+
"properties": {
|
|
105
|
+
"require": {
|
|
106
|
+
"type": "string"
|
|
107
|
+
}
|
|
108
|
+
},
|
|
109
|
+
"additionalProperties": false
|
|
110
|
+
},
|
|
111
|
+
"FunctionSourceSchema": {
|
|
112
|
+
"id": "/FunctionSourceSchema",
|
|
113
|
+
"description": "Source code like `{source: \"return 1 + 2\"}` which the system will wrap in a function for you.",
|
|
114
|
+
"type": "object",
|
|
115
|
+
"required": ["source"],
|
|
116
|
+
"properties": {
|
|
117
|
+
"source": {
|
|
118
|
+
"type": "string",
|
|
119
|
+
"pattern": "return",
|
|
120
|
+
"description": "JavaScript code for the function body. This must end with a `return` statement."
|
|
121
|
+
},
|
|
122
|
+
"args": {
|
|
123
|
+
"type": "array",
|
|
124
|
+
"items": {
|
|
125
|
+
"type": "string"
|
|
126
|
+
},
|
|
127
|
+
"description": "Function signature. Defaults to `['z', 'bundle']` if not specified."
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
"additionalProperties": false
|
|
131
|
+
},
|
|
132
|
+
"FlatObjectSchema": {
|
|
133
|
+
"id": "/FlatObjectSchema",
|
|
134
|
+
"description": "An object whose values can only be primitives",
|
|
135
|
+
"type": "object",
|
|
136
|
+
"patternProperties": {
|
|
137
|
+
"[^\\s]+": {
|
|
138
|
+
"description": "Any key may exist in this flat object as long as its values are simple.",
|
|
139
|
+
"anyOf": [
|
|
140
|
+
{
|
|
141
|
+
"type": "null"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"type": "string"
|
|
145
|
+
},
|
|
146
|
+
{
|
|
147
|
+
"type": "integer"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"type": "number"
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
"type": "boolean"
|
|
154
|
+
}
|
|
155
|
+
]
|
|
156
|
+
}
|
|
157
|
+
},
|
|
158
|
+
"additionalProperties": false
|
|
159
|
+
},
|
|
160
|
+
"FunctionSchema": {
|
|
161
|
+
"id": "/FunctionSchema",
|
|
162
|
+
"description": "Internal pointer to a function from the original source or the source code itself. Encodes arity and if `arguments` is used in the body. Note - just write normal functions and the system will encode the pointers for you. Or, provide {source: \"return 1 + 2\"} and the system will wrap in a function for you.",
|
|
163
|
+
"oneOf": [
|
|
164
|
+
{
|
|
165
|
+
"type": "string",
|
|
166
|
+
"pattern": "^\\$func\\$\\d+\\$[tf]\\$$"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"$ref": "/FunctionRequireSchema"
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
"$ref": "/FunctionSourceSchema"
|
|
173
|
+
}
|
|
174
|
+
]
|
|
175
|
+
},
|
|
99
176
|
"FieldChoiceWithLabelSchema": {
|
|
100
177
|
"id": "/FieldChoiceWithLabelSchema",
|
|
101
178
|
"description": "An object describing a labeled choice in a static dropdown. Useful if the value a user picks isn't exactly what the zap uses. For instance, when they click on a nickname, but the zap uses the user's full name ([image](https://cdn.zapier.com/storage/photos/8ed01ac5df3a511ce93ed2dc43c7fbbc.png)).",
|
|
@@ -119,12 +196,6 @@
|
|
|
119
196
|
}
|
|
120
197
|
}
|
|
121
198
|
},
|
|
122
|
-
"RefResourceSchema": {
|
|
123
|
-
"id": "/RefResourceSchema",
|
|
124
|
-
"description": "Reference a resource by key and the data it returns. In the format of: `{resource_key}.{foreign_key}(.{human_label_key})`.",
|
|
125
|
-
"type": "string",
|
|
126
|
-
"pattern": "^[a-zA-Z0-9_]+\\.[a-zA-Z0-9_\\s\\[\\]]+(\\.[a-zA-Z0-9_\\s\\[\\]]+(,[a-zA-Z0-9_\\s\\[\\]]+)*)?$"
|
|
127
|
-
},
|
|
128
199
|
"FieldChoicesSchema": {
|
|
129
200
|
"id": "/FieldChoicesSchema",
|
|
130
201
|
"description": "A static dropdown of options. Which you use depends on your order and label requirements:\n\nNeed a Label? | Does Order Matter? | Type to Use\n---|---|---\nYes | No | Object of value -> label\nNo | Yes | Array of Strings\nYes | Yes | Array of [FieldChoiceWithLabel](#fieldchoicewithlabelschema)",
|
|
@@ -149,32 +220,14 @@
|
|
|
149
220
|
}
|
|
150
221
|
]
|
|
151
222
|
},
|
|
152
|
-
"
|
|
153
|
-
"id": "/
|
|
154
|
-
"
|
|
155
|
-
"description": "Allows for additional metadata to be stored on the field.",
|
|
156
|
-
"patternProperties": {
|
|
157
|
-
"[^\\s]+": {
|
|
158
|
-
"description": "Only string, integer or boolean values are allowed.",
|
|
159
|
-
"anyOf": [
|
|
160
|
-
{
|
|
161
|
-
"type": "string"
|
|
162
|
-
},
|
|
163
|
-
{
|
|
164
|
-
"type": "integer"
|
|
165
|
-
},
|
|
166
|
-
{
|
|
167
|
-
"type": "boolean"
|
|
168
|
-
}
|
|
169
|
-
]
|
|
170
|
-
}
|
|
171
|
-
}
|
|
172
|
-
},
|
|
173
|
-
"FieldSchema": {
|
|
174
|
-
"id": "/FieldSchema",
|
|
175
|
-
"description": "Defines a field an app either needs as input, or gives as output. In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
|
|
223
|
+
"PlainFieldSchema": {
|
|
224
|
+
"id": "/PlainFieldSchema",
|
|
225
|
+
"description": "In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
|
|
176
226
|
"type": "object",
|
|
177
227
|
"required": ["key"],
|
|
228
|
+
"docAnnotation": {
|
|
229
|
+
"hide": true
|
|
230
|
+
},
|
|
178
231
|
"properties": {
|
|
179
232
|
"key": {
|
|
180
233
|
"description": "A unique machine readable key for this value (IE: \"fname\").",
|
|
@@ -186,12 +239,6 @@
|
|
|
186
239
|
"type": "string",
|
|
187
240
|
"minLength": 1
|
|
188
241
|
},
|
|
189
|
-
"helpText": {
|
|
190
|
-
"description": "A human readable description of this value (IE: \"The first part of a full name.\"). You can use Markdown.",
|
|
191
|
-
"type": "string",
|
|
192
|
-
"minLength": 1,
|
|
193
|
-
"maxLength": 1000
|
|
194
|
-
},
|
|
195
242
|
"type": {
|
|
196
243
|
"description": "The type of this value. Use `string` for basic text input, `text` for a large, `<textarea>` style box, and `code` for a `<textarea>` with a fixed-width font. Field type of `file` will accept either a file object or a string. If a URL is provided in the string, Zapier will automatically make a GET for that file. Otherwise, a .txt file will be generated.",
|
|
197
244
|
"type": "string",
|
|
@@ -212,31 +259,66 @@
|
|
|
212
259
|
"description": "If this value is required or not.",
|
|
213
260
|
"type": "boolean"
|
|
214
261
|
},
|
|
215
|
-
"placeholder": {
|
|
216
|
-
"description": "An example value that is not saved.",
|
|
217
|
-
"type": "string",
|
|
218
|
-
"minLength": 1
|
|
219
|
-
},
|
|
220
262
|
"default": {
|
|
221
263
|
"description": "A default value that is saved the first time a Zap is created.",
|
|
222
264
|
"type": "string",
|
|
223
265
|
"minLength": 1
|
|
224
266
|
},
|
|
225
|
-
"
|
|
226
|
-
"description": "
|
|
267
|
+
"list": {
|
|
268
|
+
"description": "Acts differently when used in inputFields vs. when used in outputFields. In inputFields: Can a user provide multiples of this field? In outputFields: Does this field return an array of items of type `type`?",
|
|
227
269
|
"type": "boolean"
|
|
228
270
|
},
|
|
229
|
-
"
|
|
230
|
-
"
|
|
231
|
-
"
|
|
271
|
+
"children": {
|
|
272
|
+
"type": "array",
|
|
273
|
+
"items": {
|
|
274
|
+
"$ref": "/PlainFieldSchema"
|
|
275
|
+
},
|
|
276
|
+
"description": "An array of child fields that define the structure of a sub-object for this field. Usually used for line items.",
|
|
277
|
+
"minItems": 1
|
|
232
278
|
},
|
|
233
|
-
"
|
|
234
|
-
"description": "
|
|
235
|
-
"
|
|
279
|
+
"dict": {
|
|
280
|
+
"description": "Is this field a key/value input?",
|
|
281
|
+
"type": "boolean"
|
|
282
|
+
}
|
|
283
|
+
},
|
|
284
|
+
"additionalProperties": false
|
|
285
|
+
},
|
|
286
|
+
"AuthFieldSchema": {
|
|
287
|
+
"id": "/AuthFieldSchema",
|
|
288
|
+
"description": "Field schema specialized for authentication fields. In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
|
|
289
|
+
"required": ["key"],
|
|
290
|
+
"type": "object",
|
|
291
|
+
"properties": {
|
|
292
|
+
"key": {
|
|
293
|
+
"description": "A unique machine readable key for this value (IE: \"fname\").",
|
|
294
|
+
"type": "string",
|
|
295
|
+
"minLength": 1
|
|
236
296
|
},
|
|
237
|
-
"
|
|
238
|
-
"description": "
|
|
239
|
-
"
|
|
297
|
+
"label": {
|
|
298
|
+
"description": "A human readable label for this value (IE: \"First Name\").",
|
|
299
|
+
"type": "string",
|
|
300
|
+
"minLength": 1
|
|
301
|
+
},
|
|
302
|
+
"type": {
|
|
303
|
+
"description": "The type of this value used to be.",
|
|
304
|
+
"type": "string",
|
|
305
|
+
"enum": [
|
|
306
|
+
"string",
|
|
307
|
+
"number",
|
|
308
|
+
"boolean",
|
|
309
|
+
"datetime",
|
|
310
|
+
"copy",
|
|
311
|
+
"password"
|
|
312
|
+
]
|
|
313
|
+
},
|
|
314
|
+
"required": {
|
|
315
|
+
"description": "If this value is required or not. This defaults to `true`.",
|
|
316
|
+
"type": "boolean"
|
|
317
|
+
},
|
|
318
|
+
"default": {
|
|
319
|
+
"description": "A default value that is saved the first time a Zap is created.",
|
|
320
|
+
"type": "string",
|
|
321
|
+
"minLength": 1
|
|
240
322
|
},
|
|
241
323
|
"list": {
|
|
242
324
|
"description": "Acts differently when used in inputFields vs. when used in outputFields. In inputFields: Can a user provide multiples of this field? In outputFields: Does this field return an array of items of type `type`?",
|
|
@@ -245,7 +327,7 @@
|
|
|
245
327
|
"children": {
|
|
246
328
|
"type": "array",
|
|
247
329
|
"items": {
|
|
248
|
-
"$ref": "/
|
|
330
|
+
"$ref": "/AuthFieldSchema"
|
|
249
331
|
},
|
|
250
332
|
"description": "An array of child fields that define the structure of a sub-object for this field. Usually used for line items.",
|
|
251
333
|
"minItems": 1
|
|
@@ -254,16 +336,23 @@
|
|
|
254
336
|
"description": "Is this field a key/value input?",
|
|
255
337
|
"type": "boolean"
|
|
256
338
|
},
|
|
257
|
-
"
|
|
258
|
-
"description": "
|
|
259
|
-
"type": "
|
|
339
|
+
"helpText": {
|
|
340
|
+
"description": "A human readable description of this value (IE: \"The first part of a full name.\"). You can use Markdown.",
|
|
341
|
+
"type": "string",
|
|
342
|
+
"minLength": 1,
|
|
343
|
+
"maxLength": 1000
|
|
260
344
|
},
|
|
261
|
-
"
|
|
262
|
-
"description": "
|
|
263
|
-
"type": "
|
|
345
|
+
"placeholder": {
|
|
346
|
+
"description": "An example value that is not saved.",
|
|
347
|
+
"type": "string",
|
|
348
|
+
"minLength": 1
|
|
264
349
|
},
|
|
265
|
-
"
|
|
266
|
-
"description": "
|
|
350
|
+
"choices": {
|
|
351
|
+
"description": "An object of machine keys and human values to populate a static dropdown.",
|
|
352
|
+
"$ref": "/FieldChoicesSchema"
|
|
353
|
+
},
|
|
354
|
+
"computed": {
|
|
355
|
+
"description": "Is this field automatically populated (and hidden from the user)? Note: Only OAuth and Session Auth support fields with this key.",
|
|
267
356
|
"type": "boolean"
|
|
268
357
|
},
|
|
269
358
|
"inputFormat": {
|
|
@@ -271,89 +360,11 @@
|
|
|
271
360
|
"type": "string",
|
|
272
361
|
"pattern": "^.*{{input}}.*$"
|
|
273
362
|
},
|
|
274
|
-
"
|
|
275
|
-
"description": "
|
|
276
|
-
"
|
|
277
|
-
}
|
|
278
|
-
},
|
|
279
|
-
"additionalProperties": false
|
|
280
|
-
},
|
|
281
|
-
"FunctionRequireSchema": {
|
|
282
|
-
"id": "/FunctionRequireSchema",
|
|
283
|
-
"description": "A path to a file that might have content like `module.exports = (z, bundle) => [{id: 123}];`.",
|
|
284
|
-
"type": "object",
|
|
285
|
-
"required": ["require"],
|
|
286
|
-
"properties": {
|
|
287
|
-
"require": {
|
|
288
|
-
"type": "string"
|
|
289
|
-
}
|
|
290
|
-
},
|
|
291
|
-
"additionalProperties": false
|
|
292
|
-
},
|
|
293
|
-
"FunctionSourceSchema": {
|
|
294
|
-
"id": "/FunctionSourceSchema",
|
|
295
|
-
"description": "Source code like `{source: \"return 1 + 2\"}` which the system will wrap in a function for you.",
|
|
296
|
-
"type": "object",
|
|
297
|
-
"required": ["source"],
|
|
298
|
-
"properties": {
|
|
299
|
-
"source": {
|
|
300
|
-
"type": "string",
|
|
301
|
-
"pattern": "return",
|
|
302
|
-
"description": "JavaScript code for the function body. This must end with a `return` statement."
|
|
303
|
-
},
|
|
304
|
-
"args": {
|
|
305
|
-
"type": "array",
|
|
306
|
-
"items": {
|
|
307
|
-
"type": "string"
|
|
308
|
-
},
|
|
309
|
-
"description": "Function signature. Defaults to `['z', 'bundle']` if not specified."
|
|
310
|
-
}
|
|
311
|
-
},
|
|
312
|
-
"additionalProperties": false
|
|
313
|
-
},
|
|
314
|
-
"FlatObjectSchema": {
|
|
315
|
-
"id": "/FlatObjectSchema",
|
|
316
|
-
"description": "An object whose values can only be primitives",
|
|
317
|
-
"type": "object",
|
|
318
|
-
"patternProperties": {
|
|
319
|
-
"[^\\s]+": {
|
|
320
|
-
"description": "Any key may exist in this flat object as long as its values are simple.",
|
|
321
|
-
"anyOf": [
|
|
322
|
-
{
|
|
323
|
-
"type": "null"
|
|
324
|
-
},
|
|
325
|
-
{
|
|
326
|
-
"type": "string"
|
|
327
|
-
},
|
|
328
|
-
{
|
|
329
|
-
"type": "integer"
|
|
330
|
-
},
|
|
331
|
-
{
|
|
332
|
-
"type": "number"
|
|
333
|
-
},
|
|
334
|
-
{
|
|
335
|
-
"type": "boolean"
|
|
336
|
-
}
|
|
337
|
-
]
|
|
338
|
-
}
|
|
339
|
-
},
|
|
340
|
-
"additionalProperties": false
|
|
341
|
-
},
|
|
342
|
-
"FunctionSchema": {
|
|
343
|
-
"id": "/FunctionSchema",
|
|
344
|
-
"description": "Internal pointer to a function from the original source or the source code itself. Encodes arity and if `arguments` is used in the body. Note - just write normal functions and the system will encode the pointers for you. Or, provide {source: \"return 1 + 2\"} and the system will wrap in a function for you.",
|
|
345
|
-
"oneOf": [
|
|
346
|
-
{
|
|
347
|
-
"type": "string",
|
|
348
|
-
"pattern": "^\\$func\\$\\d+\\$[tf]\\$$"
|
|
349
|
-
},
|
|
350
|
-
{
|
|
351
|
-
"$ref": "/FunctionRequireSchema"
|
|
352
|
-
},
|
|
353
|
-
{
|
|
354
|
-
"$ref": "/FunctionSourceSchema"
|
|
363
|
+
"isNoSecret": {
|
|
364
|
+
"description": "Indicates if this authentication field is safe to e.g. be stored without encryption or displayed (not a secret).",
|
|
365
|
+
"type": "boolean"
|
|
355
366
|
}
|
|
356
|
-
|
|
367
|
+
}
|
|
357
368
|
},
|
|
358
369
|
"RequestSchema": {
|
|
359
370
|
"id": "/RequestSchema",
|
|
@@ -466,12 +477,16 @@
|
|
|
466
477
|
},
|
|
467
478
|
"additionalProperties": false
|
|
468
479
|
},
|
|
469
|
-
"
|
|
470
|
-
"id": "/
|
|
471
|
-
"description": "An array or collection of fields.",
|
|
480
|
+
"AuthFieldsSchema": {
|
|
481
|
+
"id": "/AuthFieldsSchema",
|
|
482
|
+
"description": "An array or collection of authentication fields.",
|
|
472
483
|
"type": "array",
|
|
473
484
|
"items": {
|
|
474
|
-
"
|
|
485
|
+
"oneOf": [
|
|
486
|
+
{
|
|
487
|
+
"$ref": "/AuthFieldSchema"
|
|
488
|
+
}
|
|
489
|
+
]
|
|
475
490
|
}
|
|
476
491
|
},
|
|
477
492
|
"AuthenticationBasicConfigSchema": {
|
|
@@ -524,124 +539,301 @@
|
|
|
524
539
|
}
|
|
525
540
|
]
|
|
526
541
|
},
|
|
527
|
-
"authorizeUrl": {
|
|
528
|
-
"description": "Define where Zapier will redirect the user to authorize our app. Typically, you should append an `oauth_token` querystring parameter to the request.",
|
|
529
|
-
"oneOf": [
|
|
530
|
-
{
|
|
531
|
-
"$ref": "/RedirectRequestSchema"
|
|
532
|
-
},
|
|
533
|
-
{
|
|
534
|
-
"$ref": "/FunctionSchema"
|
|
535
|
-
}
|
|
536
|
-
]
|
|
542
|
+
"authorizeUrl": {
|
|
543
|
+
"description": "Define where Zapier will redirect the user to authorize our app. Typically, you should append an `oauth_token` querystring parameter to the request.",
|
|
544
|
+
"oneOf": [
|
|
545
|
+
{
|
|
546
|
+
"$ref": "/RedirectRequestSchema"
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
"$ref": "/FunctionSchema"
|
|
550
|
+
}
|
|
551
|
+
]
|
|
552
|
+
},
|
|
553
|
+
"getAccessToken": {
|
|
554
|
+
"description": "Define how Zapier fetches an access token from the API",
|
|
555
|
+
"oneOf": [
|
|
556
|
+
{
|
|
557
|
+
"$ref": "/RequestSchema"
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
"$ref": "/FunctionSchema"
|
|
561
|
+
}
|
|
562
|
+
]
|
|
563
|
+
}
|
|
564
|
+
},
|
|
565
|
+
"additionalProperties": false
|
|
566
|
+
},
|
|
567
|
+
"AuthenticationOAuth2ConfigSchema": {
|
|
568
|
+
"id": "/AuthenticationOAuth2ConfigSchema",
|
|
569
|
+
"description": "Config for OAuth2 authentication.",
|
|
570
|
+
"type": "object",
|
|
571
|
+
"required": ["authorizeUrl", "getAccessToken"],
|
|
572
|
+
"properties": {
|
|
573
|
+
"authorizeUrl": {
|
|
574
|
+
"description": "Define where Zapier will redirect the user to authorize our app. Note: we append the redirect URL and state parameters to return value of this function.",
|
|
575
|
+
"oneOf": [
|
|
576
|
+
{
|
|
577
|
+
"$ref": "/RedirectRequestSchema"
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
"$ref": "/FunctionSchema"
|
|
581
|
+
}
|
|
582
|
+
]
|
|
583
|
+
},
|
|
584
|
+
"getAccessToken": {
|
|
585
|
+
"description": "Define how Zapier fetches an access token from the API",
|
|
586
|
+
"oneOf": [
|
|
587
|
+
{
|
|
588
|
+
"$ref": "/RequestSchema"
|
|
589
|
+
},
|
|
590
|
+
{
|
|
591
|
+
"$ref": "/FunctionSchema"
|
|
592
|
+
}
|
|
593
|
+
]
|
|
594
|
+
},
|
|
595
|
+
"refreshAccessToken": {
|
|
596
|
+
"description": "Define how Zapier will refresh the access token from the API",
|
|
597
|
+
"oneOf": [
|
|
598
|
+
{
|
|
599
|
+
"$ref": "/RequestSchema"
|
|
600
|
+
},
|
|
601
|
+
{
|
|
602
|
+
"$ref": "/FunctionSchema"
|
|
603
|
+
}
|
|
604
|
+
]
|
|
605
|
+
},
|
|
606
|
+
"codeParam": {
|
|
607
|
+
"description": "Define a non-standard code param Zapier should scrape instead.",
|
|
608
|
+
"type": "string"
|
|
609
|
+
},
|
|
610
|
+
"scope": {
|
|
611
|
+
"description": "What scope should Zapier request?",
|
|
612
|
+
"type": "string"
|
|
613
|
+
},
|
|
614
|
+
"autoRefresh": {
|
|
615
|
+
"description": "Should Zapier invoke `refreshAccessToken` when we receive an error for a 401 response?",
|
|
616
|
+
"type": "boolean"
|
|
617
|
+
},
|
|
618
|
+
"enablePkce": {
|
|
619
|
+
"description": "Should Zapier use PKCE for OAuth2?",
|
|
620
|
+
"type": "boolean"
|
|
621
|
+
}
|
|
622
|
+
},
|
|
623
|
+
"additionalProperties": false
|
|
624
|
+
},
|
|
625
|
+
"AuthenticationSessionConfigSchema": {
|
|
626
|
+
"id": "/AuthenticationSessionConfigSchema",
|
|
627
|
+
"description": "Config for session authentication.",
|
|
628
|
+
"type": "object",
|
|
629
|
+
"required": ["perform"],
|
|
630
|
+
"properties": {
|
|
631
|
+
"perform": {
|
|
632
|
+
"description": "Define how Zapier fetches the additional authData needed to make API calls.",
|
|
633
|
+
"oneOf": [
|
|
634
|
+
{
|
|
635
|
+
"$ref": "/RequestSchema"
|
|
636
|
+
},
|
|
637
|
+
{
|
|
638
|
+
"$ref": "/FunctionSchema"
|
|
639
|
+
}
|
|
640
|
+
]
|
|
641
|
+
}
|
|
642
|
+
},
|
|
643
|
+
"additionalProperties": false
|
|
644
|
+
},
|
|
645
|
+
"RefResourceSchema": {
|
|
646
|
+
"id": "/RefResourceSchema",
|
|
647
|
+
"description": "Reference a resource by key and the data it returns. In the format of: `{resource_key}.{foreign_key}(.{human_label_key})`.",
|
|
648
|
+
"type": "string",
|
|
649
|
+
"pattern": "^[a-zA-Z0-9_]+\\.[a-zA-Z0-9_\\s\\[\\]]+(\\.[a-zA-Z0-9_\\s\\[\\]]+(,[a-zA-Z0-9_\\s\\[\\]]+)*)?$"
|
|
650
|
+
},
|
|
651
|
+
"FieldMetaSchema": {
|
|
652
|
+
"id": "/FieldMetaSchema",
|
|
653
|
+
"type": "object",
|
|
654
|
+
"description": "Allows for additional metadata to be stored on the field.",
|
|
655
|
+
"patternProperties": {
|
|
656
|
+
"[^\\s]+": {
|
|
657
|
+
"description": "Only string, integer or boolean values are allowed.",
|
|
658
|
+
"anyOf": [
|
|
659
|
+
{
|
|
660
|
+
"type": "string"
|
|
661
|
+
},
|
|
662
|
+
{
|
|
663
|
+
"type": "integer"
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
"type": "boolean"
|
|
667
|
+
}
|
|
668
|
+
]
|
|
669
|
+
}
|
|
670
|
+
}
|
|
671
|
+
},
|
|
672
|
+
"PlainInputFieldSchema": {
|
|
673
|
+
"description": "Field schema specialized for input fields. In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
|
|
674
|
+
"id": "/PlainInputFieldSchema",
|
|
675
|
+
"type": "object",
|
|
676
|
+
"required": ["key"],
|
|
677
|
+
"properties": {
|
|
678
|
+
"key": {
|
|
679
|
+
"description": "A unique machine readable key for this value (IE: \"fname\").",
|
|
680
|
+
"type": "string",
|
|
681
|
+
"minLength": 1
|
|
682
|
+
},
|
|
683
|
+
"label": {
|
|
684
|
+
"description": "A human readable label for this value (IE: \"First Name\").",
|
|
685
|
+
"type": "string",
|
|
686
|
+
"minLength": 1
|
|
687
|
+
},
|
|
688
|
+
"type": {
|
|
689
|
+
"description": "The type of this value. Use `string` for basic text input, `text` for a large, `<textarea>` style box, and `code` for a `<textarea>` with a fixed-width font. Field type of `file` will accept either a file object or a string. If a URL is provided in the string, Zapier will automatically make a GET for that file. Otherwise, a .txt file will be generated.",
|
|
690
|
+
"type": "string",
|
|
691
|
+
"enum": [
|
|
692
|
+
"string",
|
|
693
|
+
"text",
|
|
694
|
+
"integer",
|
|
695
|
+
"number",
|
|
696
|
+
"boolean",
|
|
697
|
+
"datetime",
|
|
698
|
+
"file",
|
|
699
|
+
"password",
|
|
700
|
+
"copy",
|
|
701
|
+
"code"
|
|
702
|
+
]
|
|
703
|
+
},
|
|
704
|
+
"required": {
|
|
705
|
+
"description": "If this value is required or not.",
|
|
706
|
+
"type": "boolean"
|
|
707
|
+
},
|
|
708
|
+
"default": {
|
|
709
|
+
"description": "A default value that is saved the first time a Zap is created.",
|
|
710
|
+
"type": "string",
|
|
711
|
+
"minLength": 1
|
|
712
|
+
},
|
|
713
|
+
"list": {
|
|
714
|
+
"description": "Acts differently when used in inputFields vs. when used in outputFields. In inputFields: Can a user provide multiples of this field? In outputFields: Does this field return an array of items of type `type`?",
|
|
715
|
+
"type": "boolean"
|
|
716
|
+
},
|
|
717
|
+
"children": {
|
|
718
|
+
"type": "array",
|
|
719
|
+
"items": {
|
|
720
|
+
"$ref": "/PlainInputFieldSchema"
|
|
721
|
+
},
|
|
722
|
+
"description": "An array of child fields that define the structure of a sub-object for this field. Usually used for line items.",
|
|
723
|
+
"minItems": 1
|
|
724
|
+
},
|
|
725
|
+
"dict": {
|
|
726
|
+
"description": "Is this field a key/value input?",
|
|
727
|
+
"type": "boolean"
|
|
728
|
+
},
|
|
729
|
+
"helpText": {
|
|
730
|
+
"description": "A human readable description of this value (IE: \"The first part of a full name.\"). You can use Markdown.",
|
|
731
|
+
"type": "string",
|
|
732
|
+
"minLength": 1,
|
|
733
|
+
"maxLength": 1000
|
|
734
|
+
},
|
|
735
|
+
"search": {
|
|
736
|
+
"description": "A reference to a search that will guide the user to add a search step to populate this field when creating a Zap.",
|
|
737
|
+
"$ref": "/RefResourceSchema"
|
|
537
738
|
},
|
|
538
|
-
"
|
|
539
|
-
"description": "
|
|
540
|
-
"
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
739
|
+
"dynamic": {
|
|
740
|
+
"description": "A reference to a trigger that will power a dynamic dropdown.",
|
|
741
|
+
"$ref": "/RefResourceSchema"
|
|
742
|
+
},
|
|
743
|
+
"choices": {
|
|
744
|
+
"description": "An object of machine keys and human values to populate a static dropdown.",
|
|
745
|
+
"$ref": "/FieldChoicesSchema"
|
|
746
|
+
},
|
|
747
|
+
"placeholder": {
|
|
748
|
+
"description": "An example value that is not saved.",
|
|
749
|
+
"type": "string",
|
|
750
|
+
"minLength": 1
|
|
751
|
+
},
|
|
752
|
+
"altersDynamicFields": {
|
|
753
|
+
"description": "Does the value of this field affect the definitions of other fields in the set?",
|
|
754
|
+
"type": "boolean"
|
|
755
|
+
},
|
|
756
|
+
"computed": {
|
|
757
|
+
"description": "Is this field automatically populated (and hidden from the user)? Note: Only OAuth, Session Auth, and certain internal use cases support fields with this key.",
|
|
758
|
+
"type": "boolean"
|
|
759
|
+
},
|
|
760
|
+
"inputFormat": {
|
|
761
|
+
"description": "Useful when you expect the input to be part of a longer string. Put \"{{input}}\" in place of the user's input (IE: \"https://{{input}}.yourdomain.com\").",
|
|
762
|
+
"type": "string",
|
|
763
|
+
"pattern": "^.*{{input}}.*$"
|
|
764
|
+
},
|
|
765
|
+
"meta": {
|
|
766
|
+
"description": "Allows for additional metadata to be stored on the field. Supports simple key-values only (no sub-objects or arrays).",
|
|
767
|
+
"$ref": "/FieldMetaSchema"
|
|
548
768
|
}
|
|
549
769
|
},
|
|
550
770
|
"additionalProperties": false
|
|
551
771
|
},
|
|
552
|
-
"
|
|
553
|
-
"
|
|
554
|
-
"
|
|
772
|
+
"PlainOutputFieldSchema": {
|
|
773
|
+
"description": "Field schema specialized for output fields. In addition to the requirements below, the following keys are mutually exclusive:\n\n* `children` & `list`\n* `children` & `dict`\n* `children` & `type`\n* `children` & `placeholder`\n* `children` & `helpText`\n* `children` & `default`\n* `dict` & `list`\n* `dynamic` & `dict`\n* `dynamic` & `choices`",
|
|
774
|
+
"id": "/PlainOutputFieldSchema",
|
|
555
775
|
"type": "object",
|
|
556
|
-
"required": ["
|
|
776
|
+
"required": ["key"],
|
|
557
777
|
"properties": {
|
|
558
|
-
"
|
|
559
|
-
"description": "
|
|
560
|
-
"
|
|
561
|
-
|
|
562
|
-
"$ref": "/RedirectRequestSchema"
|
|
563
|
-
},
|
|
564
|
-
{
|
|
565
|
-
"$ref": "/FunctionSchema"
|
|
566
|
-
}
|
|
567
|
-
]
|
|
778
|
+
"key": {
|
|
779
|
+
"description": "A unique machine readable key for this value (IE: \"fname\").",
|
|
780
|
+
"type": "string",
|
|
781
|
+
"minLength": 1
|
|
568
782
|
},
|
|
569
|
-
"
|
|
570
|
-
"description": "
|
|
571
|
-
"
|
|
572
|
-
|
|
573
|
-
"$ref": "/RequestSchema"
|
|
574
|
-
},
|
|
575
|
-
{
|
|
576
|
-
"$ref": "/FunctionSchema"
|
|
577
|
-
}
|
|
578
|
-
]
|
|
783
|
+
"label": {
|
|
784
|
+
"description": "A human readable label for this value (IE: \"First Name\").",
|
|
785
|
+
"type": "string",
|
|
786
|
+
"minLength": 1
|
|
579
787
|
},
|
|
580
|
-
"
|
|
581
|
-
"description": "
|
|
582
|
-
"
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
788
|
+
"type": {
|
|
789
|
+
"description": "The type of this value. Field type of `file` will accept either a file object or a string. If a URL is provided in the string, Zapier will automatically make a GET for that file. Otherwise, a .txt file will be generated.",
|
|
790
|
+
"type": "string",
|
|
791
|
+
"enum": [
|
|
792
|
+
"string",
|
|
793
|
+
"number",
|
|
794
|
+
"boolean",
|
|
795
|
+
"datetime",
|
|
796
|
+
"file",
|
|
797
|
+
"password",
|
|
798
|
+
"integer"
|
|
589
799
|
]
|
|
590
800
|
},
|
|
591
|
-
"
|
|
592
|
-
"description": "
|
|
593
|
-
"type": "
|
|
801
|
+
"required": {
|
|
802
|
+
"description": "If this value is required or not.",
|
|
803
|
+
"type": "boolean"
|
|
594
804
|
},
|
|
595
|
-
"
|
|
596
|
-
"description": "
|
|
597
|
-
"type": "string"
|
|
805
|
+
"default": {
|
|
806
|
+
"description": "A default value that is saved the first time a Zap is created.",
|
|
807
|
+
"type": "string",
|
|
808
|
+
"minLength": 1
|
|
598
809
|
},
|
|
599
|
-
"
|
|
600
|
-
"description": "
|
|
810
|
+
"list": {
|
|
811
|
+
"description": "Acts differently when used in inputFields vs. when used in outputFields. In inputFields: Can a user provide multiples of this field? In outputFields: Does this field return an array of items of type `type`?",
|
|
601
812
|
"type": "boolean"
|
|
602
813
|
},
|
|
603
|
-
"
|
|
604
|
-
"
|
|
814
|
+
"children": {
|
|
815
|
+
"type": "array",
|
|
816
|
+
"items": {
|
|
817
|
+
"$ref": "/PlainOutputFieldSchema"
|
|
818
|
+
},
|
|
819
|
+
"description": "An array of child fields that define the structure of a sub-object for this field. Usually used for line items.",
|
|
820
|
+
"minItems": 1
|
|
821
|
+
},
|
|
822
|
+
"dict": {
|
|
823
|
+
"description": "Is this field a key/value input?",
|
|
824
|
+
"type": "boolean"
|
|
825
|
+
},
|
|
826
|
+
"primary": {
|
|
827
|
+
"description": "Use this field as part of the primary key for deduplication. You can set multiple fields as \"primary\", provided they are unique together. If no fields are set, Zapier will default to using the `id` field. `primary` only makes sense for `outputFields`. It only works in static `outputFields`; will not work in custom/dynamic `outputFields`. For more information, see [How deduplication works in Zapier](https://platform.zapier.com/build/deduplication).",
|
|
828
|
+
"type": "boolean"
|
|
829
|
+
},
|
|
830
|
+
"steadyState": {
|
|
831
|
+
"description": "Prevents triggering on new output until all values for fields with this property remain unchanged for 2 polls. It can be used to, e.g., not trigger on a new contact until the contact has completed typing their name. NOTE that this only applies to the `outputFields` of polling triggers.",
|
|
605
832
|
"type": "boolean"
|
|
606
833
|
}
|
|
607
834
|
},
|
|
608
835
|
"additionalProperties": false
|
|
609
836
|
},
|
|
610
|
-
"AuthenticationSessionConfigSchema": {
|
|
611
|
-
"id": "/AuthenticationSessionConfigSchema",
|
|
612
|
-
"description": "Config for session authentication.",
|
|
613
|
-
"type": "object",
|
|
614
|
-
"required": ["perform"],
|
|
615
|
-
"properties": {
|
|
616
|
-
"perform": {
|
|
617
|
-
"description": "Define how Zapier fetches the additional authData needed to make API calls.",
|
|
618
|
-
"oneOf": [
|
|
619
|
-
{
|
|
620
|
-
"$ref": "/RequestSchema"
|
|
621
|
-
},
|
|
622
|
-
{
|
|
623
|
-
"$ref": "/FunctionSchema"
|
|
624
|
-
}
|
|
625
|
-
]
|
|
626
|
-
}
|
|
627
|
-
},
|
|
628
|
-
"additionalProperties": false
|
|
629
|
-
},
|
|
630
|
-
"FieldOrFunctionSchema": {
|
|
631
|
-
"id": "/FieldOrFunctionSchema",
|
|
632
|
-
"description": "Represents an array of fields or functions.",
|
|
633
|
-
"type": "array",
|
|
634
|
-
"items": {
|
|
635
|
-
"oneOf": [
|
|
636
|
-
{
|
|
637
|
-
"$ref": "/FieldSchema"
|
|
638
|
-
},
|
|
639
|
-
{
|
|
640
|
-
"$ref": "/FunctionSchema"
|
|
641
|
-
}
|
|
642
|
-
]
|
|
643
|
-
}
|
|
644
|
-
},
|
|
645
837
|
"ThrottleOverrideObjectSchema": {
|
|
646
838
|
"id": "/ThrottleOverrideObjectSchema",
|
|
647
839
|
"description": "EXPERIMENTAL: Overrides the original throttle configuration based on a Zapier account attribute.",
|
|
@@ -668,10 +860,35 @@
|
|
|
668
860
|
},
|
|
669
861
|
"additionalProperties": false
|
|
670
862
|
},
|
|
671
|
-
"
|
|
672
|
-
"id": "/
|
|
673
|
-
"description": "
|
|
674
|
-
"
|
|
863
|
+
"InputFieldsSchema": {
|
|
864
|
+
"id": "/InputFieldsSchema",
|
|
865
|
+
"description": "An array or collection of input fields.",
|
|
866
|
+
"type": "array",
|
|
867
|
+
"items": {
|
|
868
|
+
"oneOf": [
|
|
869
|
+
{
|
|
870
|
+
"$ref": "/PlainInputFieldSchema"
|
|
871
|
+
},
|
|
872
|
+
{
|
|
873
|
+
"$ref": "/FunctionSchema"
|
|
874
|
+
}
|
|
875
|
+
]
|
|
876
|
+
}
|
|
877
|
+
},
|
|
878
|
+
"OutputFieldsSchema": {
|
|
879
|
+
"id": "/OutputFieldsSchema",
|
|
880
|
+
"description": "An array or collection of output fields.",
|
|
881
|
+
"type": "array",
|
|
882
|
+
"items": {
|
|
883
|
+
"oneOf": [
|
|
884
|
+
{
|
|
885
|
+
"$ref": "/PlainOutputFieldSchema"
|
|
886
|
+
},
|
|
887
|
+
{
|
|
888
|
+
"$ref": "/FunctionSchema"
|
|
889
|
+
}
|
|
890
|
+
]
|
|
891
|
+
}
|
|
675
892
|
},
|
|
676
893
|
"KeySchema": {
|
|
677
894
|
"id": "/KeySchema",
|
|
@@ -682,7 +899,7 @@
|
|
|
682
899
|
},
|
|
683
900
|
"LockObjectSchema": {
|
|
684
901
|
"id": "/LockObjectSchema",
|
|
685
|
-
"description": "
|
|
902
|
+
"description": "Zapier uses this configuration to ensure this action is performed one at a time per scope (avoid concurrency).",
|
|
686
903
|
"type": "object",
|
|
687
904
|
"required": ["key"],
|
|
688
905
|
"properties": {
|
|
@@ -827,11 +1044,11 @@
|
|
|
827
1044
|
},
|
|
828
1045
|
"inputFields": {
|
|
829
1046
|
"description": "What should the form a user sees and configures look like?",
|
|
830
|
-
"$ref": "/
|
|
1047
|
+
"$ref": "/InputFieldsSchema"
|
|
831
1048
|
},
|
|
832
1049
|
"outputFields": {
|
|
833
1050
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
834
|
-
"$ref": "/
|
|
1051
|
+
"$ref": "/OutputFieldsSchema"
|
|
835
1052
|
},
|
|
836
1053
|
"sample": {
|
|
837
1054
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -845,7 +1062,7 @@
|
|
|
845
1062
|
}
|
|
846
1063
|
},
|
|
847
1064
|
"lock": {
|
|
848
|
-
"description": "
|
|
1065
|
+
"description": "Zapier uses this configuration to ensure this action is performed one at a time per scope (avoid concurrency).",
|
|
849
1066
|
"$ref": "/LockObjectSchema"
|
|
850
1067
|
},
|
|
851
1068
|
"throttle": {
|
|
@@ -937,11 +1154,11 @@
|
|
|
937
1154
|
},
|
|
938
1155
|
"inputFields": {
|
|
939
1156
|
"description": "What should the form a user sees and configures look like?",
|
|
940
|
-
"$ref": "/
|
|
1157
|
+
"$ref": "/InputFieldsSchema"
|
|
941
1158
|
},
|
|
942
1159
|
"outputFields": {
|
|
943
1160
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
944
|
-
"$ref": "/
|
|
1161
|
+
"$ref": "/OutputFieldsSchema"
|
|
945
1162
|
},
|
|
946
1163
|
"sample": {
|
|
947
1164
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -990,11 +1207,11 @@
|
|
|
990
1207
|
},
|
|
991
1208
|
"inputFields": {
|
|
992
1209
|
"description": "What should the form a user sees and configures look like?",
|
|
993
|
-
"$ref": "/
|
|
1210
|
+
"$ref": "/InputFieldsSchema"
|
|
994
1211
|
},
|
|
995
1212
|
"outputFields": {
|
|
996
1213
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
997
|
-
"$ref": "/
|
|
1214
|
+
"$ref": "/OutputFieldsSchema"
|
|
998
1215
|
},
|
|
999
1216
|
"sample": {
|
|
1000
1217
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -1052,11 +1269,11 @@
|
|
|
1052
1269
|
},
|
|
1053
1270
|
"inputFields": {
|
|
1054
1271
|
"description": "What should the form a user sees and configures look like?",
|
|
1055
|
-
"$ref": "/
|
|
1272
|
+
"$ref": "/InputFieldsSchema"
|
|
1056
1273
|
},
|
|
1057
1274
|
"outputFields": {
|
|
1058
1275
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
1059
|
-
"$ref": "/
|
|
1276
|
+
"$ref": "/OutputFieldsSchema"
|
|
1060
1277
|
},
|
|
1061
1278
|
"sample": {
|
|
1062
1279
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -1070,7 +1287,7 @@
|
|
|
1070
1287
|
}
|
|
1071
1288
|
},
|
|
1072
1289
|
"lock": {
|
|
1073
|
-
"description": "
|
|
1290
|
+
"description": "Zapier uses this configuration to ensure this action is performed one at a time per scope (avoid concurrency).",
|
|
1074
1291
|
"$ref": "/LockObjectSchema"
|
|
1075
1292
|
},
|
|
1076
1293
|
"throttle": {
|
|
@@ -1203,7 +1420,7 @@
|
|
|
1203
1420
|
},
|
|
1204
1421
|
"outputFields": {
|
|
1205
1422
|
"description": "What fields of data will this return?",
|
|
1206
|
-
"$ref": "/
|
|
1423
|
+
"$ref": "/OutputFieldsSchema"
|
|
1207
1424
|
},
|
|
1208
1425
|
"sample": {
|
|
1209
1426
|
"description": "What does a sample of data look like?",
|
|
@@ -1294,11 +1511,11 @@
|
|
|
1294
1511
|
},
|
|
1295
1512
|
"inputFields": {
|
|
1296
1513
|
"description": "What should the form a user sees and configures look like?",
|
|
1297
|
-
"$ref": "/
|
|
1514
|
+
"$ref": "/InputFieldsSchema"
|
|
1298
1515
|
},
|
|
1299
1516
|
"outputFields": {
|
|
1300
1517
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
1301
|
-
"$ref": "/
|
|
1518
|
+
"$ref": "/OutputFieldsSchema"
|
|
1302
1519
|
},
|
|
1303
1520
|
"sample": {
|
|
1304
1521
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -1358,6 +1575,72 @@
|
|
|
1358
1575
|
},
|
|
1359
1576
|
"additionalProperties": false
|
|
1360
1577
|
},
|
|
1578
|
+
"BasicSearchOperationSchema": {
|
|
1579
|
+
"id": "/BasicSearchOperationSchema",
|
|
1580
|
+
"description": "Represents the fundamental mechanics of a search.",
|
|
1581
|
+
"type": "object",
|
|
1582
|
+
"required": ["perform"],
|
|
1583
|
+
"properties": {
|
|
1584
|
+
"resource": {
|
|
1585
|
+
"description": "Optionally reference and extends a resource. Allows Zapier to automatically tie together samples, lists and hooks, greatly improving the UX. EG: if you had another trigger reusing a resource but filtering the results.",
|
|
1586
|
+
"$ref": "/KeySchema"
|
|
1587
|
+
},
|
|
1588
|
+
"perform": {
|
|
1589
|
+
"description": "How will Zapier get the data? This can be a function like `(z) => [{id: 123}]` or a request like `{url: 'http...'}`.",
|
|
1590
|
+
"oneOf": [
|
|
1591
|
+
{
|
|
1592
|
+
"$ref": "/RequestSchema"
|
|
1593
|
+
},
|
|
1594
|
+
{
|
|
1595
|
+
"$ref": "/FunctionSchema"
|
|
1596
|
+
}
|
|
1597
|
+
]
|
|
1598
|
+
},
|
|
1599
|
+
"performResume": {
|
|
1600
|
+
"description": "A function that parses data from a perform (which uses z.generateCallbackUrl()) and callback request to resume this action.",
|
|
1601
|
+
"$ref": "/FunctionSchema"
|
|
1602
|
+
},
|
|
1603
|
+
"performGet": {
|
|
1604
|
+
"description": "How will Zapier get a single record? If you find yourself reaching for this - consider resources and their built-in get methods.",
|
|
1605
|
+
"oneOf": [
|
|
1606
|
+
{
|
|
1607
|
+
"$ref": "/RequestSchema"
|
|
1608
|
+
},
|
|
1609
|
+
{
|
|
1610
|
+
"$ref": "/FunctionSchema"
|
|
1611
|
+
}
|
|
1612
|
+
]
|
|
1613
|
+
},
|
|
1614
|
+
"inputFields": {
|
|
1615
|
+
"description": "What should the form a user sees and configures look like?",
|
|
1616
|
+
"$ref": "/InputFieldsSchema"
|
|
1617
|
+
},
|
|
1618
|
+
"outputFields": {
|
|
1619
|
+
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
1620
|
+
"$ref": "/OutputFieldsSchema"
|
|
1621
|
+
},
|
|
1622
|
+
"sample": {
|
|
1623
|
+
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
1624
|
+
"type": "object",
|
|
1625
|
+
"minProperties": 1,
|
|
1626
|
+
"docAnnotation": {
|
|
1627
|
+
"required": {
|
|
1628
|
+
"type": "replace",
|
|
1629
|
+
"value": "**yes** (with exceptions, see description)"
|
|
1630
|
+
}
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
"lock": {
|
|
1634
|
+
"description": "Zapier uses this configuration to ensure this action is performed one at a time per scope (avoid concurrency).",
|
|
1635
|
+
"$ref": "/LockObjectSchema"
|
|
1636
|
+
},
|
|
1637
|
+
"throttle": {
|
|
1638
|
+
"description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
|
|
1639
|
+
"$ref": "/ThrottleObjectSchema"
|
|
1640
|
+
}
|
|
1641
|
+
},
|
|
1642
|
+
"additionalProperties": false
|
|
1643
|
+
},
|
|
1361
1644
|
"SearchSchema": {
|
|
1362
1645
|
"id": "/SearchSchema",
|
|
1363
1646
|
"description": "How will Zapier search for existing objects?",
|
|
@@ -1380,7 +1663,7 @@
|
|
|
1380
1663
|
},
|
|
1381
1664
|
"operation": {
|
|
1382
1665
|
"description": "Powers the functionality for this search.",
|
|
1383
|
-
"$ref": "/
|
|
1666
|
+
"$ref": "/BasicSearchOperationSchema"
|
|
1384
1667
|
}
|
|
1385
1668
|
},
|
|
1386
1669
|
"additionalProperties": false
|
|
@@ -1403,8 +1686,8 @@
|
|
|
1403
1686
|
},
|
|
1404
1687
|
"additionalProperties": false
|
|
1405
1688
|
},
|
|
1406
|
-
"
|
|
1407
|
-
"id": "/
|
|
1689
|
+
"BasicCreateOperationSchema": {
|
|
1690
|
+
"id": "/BasicCreateOperationSchema",
|
|
1408
1691
|
"description": "Represents the fundamental mechanics of a create.",
|
|
1409
1692
|
"type": "object",
|
|
1410
1693
|
"properties": {
|
|
@@ -1446,11 +1729,11 @@
|
|
|
1446
1729
|
},
|
|
1447
1730
|
"inputFields": {
|
|
1448
1731
|
"description": "What should the form a user sees and configures look like?",
|
|
1449
|
-
"$ref": "/
|
|
1732
|
+
"$ref": "/InputFieldsSchema"
|
|
1450
1733
|
},
|
|
1451
1734
|
"outputFields": {
|
|
1452
1735
|
"description": "What fields of data will this return? Will use resource outputFields if missing, will also use sample if available.",
|
|
1453
|
-
"$ref": "/
|
|
1736
|
+
"$ref": "/OutputFieldsSchema"
|
|
1454
1737
|
},
|
|
1455
1738
|
"sample": {
|
|
1456
1739
|
"description": "What does a sample of data look like? Will use resource sample if missing. Requirement waived if `display.hidden` is true or if this belongs to a resource that has a top-level sample",
|
|
@@ -1464,17 +1747,13 @@
|
|
|
1464
1747
|
}
|
|
1465
1748
|
},
|
|
1466
1749
|
"lock": {
|
|
1467
|
-
"description": "
|
|
1750
|
+
"description": "Zapier uses this configuration to ensure this action is performed one at a time per scope (avoid concurrency).",
|
|
1468
1751
|
"$ref": "/LockObjectSchema"
|
|
1469
1752
|
},
|
|
1470
1753
|
"throttle": {
|
|
1471
1754
|
"description": "Zapier uses this configuration to apply throttling when the limit for the window is exceeded.",
|
|
1472
1755
|
"$ref": "/ThrottleObjectSchema"
|
|
1473
1756
|
},
|
|
1474
|
-
"shouldLock": {
|
|
1475
|
-
"description": "Should this action be performed one at a time (avoid concurrency)?",
|
|
1476
|
-
"type": "boolean"
|
|
1477
|
-
},
|
|
1478
1757
|
"buffer": {
|
|
1479
1758
|
"description": "Currently an **internal-only** feature. Zapier uses this configuration for creating objects in bulk with `performBuffer`.",
|
|
1480
1759
|
"$ref": "/BufferConfigSchema",
|
|
@@ -1520,7 +1799,7 @@
|
|
|
1520
1799
|
},
|
|
1521
1800
|
"operation": {
|
|
1522
1801
|
"description": "Powers the functionality for this create.",
|
|
1523
|
-
"$ref": "/
|
|
1802
|
+
"$ref": "/BasicCreateOperationSchema"
|
|
1524
1803
|
}
|
|
1525
1804
|
},
|
|
1526
1805
|
"additionalProperties": false
|
|
@@ -1598,7 +1877,7 @@
|
|
|
1598
1877
|
},
|
|
1599
1878
|
"fields": {
|
|
1600
1879
|
"description": "Fields you can request from the user before they connect your app to Zapier.",
|
|
1601
|
-
"$ref": "/
|
|
1880
|
+
"$ref": "/AuthFieldsSchema"
|
|
1602
1881
|
},
|
|
1603
1882
|
"connectionLabel": {
|
|
1604
1883
|
"description": "A string with variables, function, or request that returns the connection label for the authenticated user.",
|