@zapier/zapier-sdk-cli 0.38.2 → 0.39.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/CHANGELOG.md +21 -0
- package/README.md +128 -129
- package/dist/cli.cjs +88 -70
- package/dist/cli.mjs +89 -71
- package/dist/index.cjs +50 -50
- package/dist/index.d.mts +13 -13
- package/dist/index.d.ts +13 -13
- package/dist/index.mjs +50 -50
- package/dist/package.json +1 -1
- package/dist/src/generators/ast-generator.js +4 -8
- package/dist/src/plugins/add/index.js +12 -12
- package/dist/src/plugins/add/schemas.d.ts +2 -2
- package/dist/src/plugins/add/schemas.js +2 -2
- package/dist/src/plugins/buildManifest/index.js +7 -8
- package/dist/src/plugins/buildManifest/schemas.d.ts +6 -6
- package/dist/src/plugins/buildManifest/schemas.js +1 -1
- package/dist/src/plugins/curl/index.js +3 -2
- package/dist/src/plugins/curl/schemas.d.ts +1 -0
- package/dist/src/plugins/curl/schemas.js +6 -1
- package/dist/src/plugins/generateAppTypes/index.js +9 -9
- package/dist/src/plugins/generateAppTypes/schemas.d.ts +7 -7
- package/dist/src/plugins/generateAppTypes/schemas.js +2 -2
- package/dist/src/utils/cli-generator.d.ts +1 -1
- package/dist/src/utils/cli-generator.js +37 -13
- package/dist/src/utils/parameter-resolver.js +4 -4
- package/dist/tsconfig.tsbuildinfo +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -184,16 +184,16 @@ Get detailed information about a specific action
|
|
|
184
184
|
|
|
185
185
|
**Options:**
|
|
186
186
|
|
|
187
|
-
| Option | Type | Required | Default | Possible Values | Description
|
|
188
|
-
| --------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
|
|
189
|
-
| `<app
|
|
190
|
-
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type
|
|
191
|
-
| `<action
|
|
187
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
188
|
+
| --------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
189
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
190
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
191
|
+
| `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
|
|
192
192
|
|
|
193
193
|
**Usage:**
|
|
194
194
|
|
|
195
195
|
```bash
|
|
196
|
-
npx zapier-sdk get-action <app
|
|
196
|
+
npx zapier-sdk get-action <app> <action-type> <action>
|
|
197
197
|
```
|
|
198
198
|
|
|
199
199
|
#### `get-input-fields-schema`
|
|
@@ -202,18 +202,18 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
|
|
|
202
202
|
|
|
203
203
|
**Options:**
|
|
204
204
|
|
|
205
|
-
| Option
|
|
206
|
-
|
|
|
207
|
-
| `<app
|
|
208
|
-
| `<action-type>`
|
|
209
|
-
| `<action
|
|
210
|
-
| `--connection
|
|
211
|
-
| `--inputs`
|
|
205
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
206
|
+
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
207
|
+
| `<app>` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
|
|
208
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
209
|
+
| `<action>` | `string` | ✅ | — | — | Action key to get the input schema for |
|
|
210
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
|
|
211
|
+
| `--inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
|
|
212
212
|
|
|
213
213
|
**Usage:**
|
|
214
214
|
|
|
215
215
|
```bash
|
|
216
|
-
npx zapier-sdk get-input-fields-schema <app
|
|
216
|
+
npx zapier-sdk get-input-fields-schema <app> <action-type> <action> [--connection] [--inputs]
|
|
217
217
|
```
|
|
218
218
|
|
|
219
219
|
#### `list-actions`
|
|
@@ -224,7 +224,7 @@ List all actions for a specific app
|
|
|
224
224
|
|
|
225
225
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
226
226
|
| --------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
|
227
|
-
| `<app
|
|
227
|
+
| `<app>` | `string` | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
228
228
|
| `--action-type` | `string` | ❌ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type |
|
|
229
229
|
| `--page-size` | `number` | ❌ | — | — | Number of actions per page |
|
|
230
230
|
| `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
@@ -233,7 +233,7 @@ List all actions for a specific app
|
|
|
233
233
|
**Usage:**
|
|
234
234
|
|
|
235
235
|
```bash
|
|
236
|
-
npx zapier-sdk list-actions <app
|
|
236
|
+
npx zapier-sdk list-actions <app> [--action-type] [--page-size] [--max-items] [--cursor]
|
|
237
237
|
```
|
|
238
238
|
|
|
239
239
|
#### `list-input-field-choices`
|
|
@@ -242,23 +242,23 @@ Get the available choices for a dynamic dropdown input field
|
|
|
242
242
|
|
|
243
243
|
**Options:**
|
|
244
244
|
|
|
245
|
-
| Option
|
|
246
|
-
|
|
|
247
|
-
| `<app
|
|
248
|
-
| `<action-type>`
|
|
249
|
-
| `<action
|
|
250
|
-
| `<input-field
|
|
251
|
-
| `--connection
|
|
252
|
-
| `--inputs`
|
|
253
|
-
| `--page`
|
|
254
|
-
| `--page-size`
|
|
255
|
-
| `--max-items`
|
|
256
|
-
| `--cursor`
|
|
245
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
246
|
+
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
247
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
248
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
249
|
+
| `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
|
|
250
|
+
| `<input-field>` | `string` | ✅ | — | — | Input field key to get choices for |
|
|
251
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
|
|
252
|
+
| `--inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
|
|
253
|
+
| `--page` | `number` | ❌ | — | — | Page number for paginated results |
|
|
254
|
+
| `--page-size` | `number` | ❌ | — | — | Number of choices per page |
|
|
255
|
+
| `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
256
|
+
| `--cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
257
257
|
|
|
258
258
|
**Usage:**
|
|
259
259
|
|
|
260
260
|
```bash
|
|
261
|
-
npx zapier-sdk list-input-field-choices <app
|
|
261
|
+
npx zapier-sdk list-input-field-choices <app> <action-type> <action> <input-field> [--connection] [--inputs] [--page] [--page-size] [--max-items] [--cursor]
|
|
262
262
|
```
|
|
263
263
|
|
|
264
264
|
#### `list-input-fields`
|
|
@@ -267,21 +267,21 @@ Get the input fields required for a specific action
|
|
|
267
267
|
|
|
268
268
|
**Options:**
|
|
269
269
|
|
|
270
|
-
| Option
|
|
271
|
-
|
|
|
272
|
-
| `<app
|
|
273
|
-
| `<action-type>`
|
|
274
|
-
| `<action
|
|
275
|
-
| `--connection
|
|
276
|
-
| `--inputs`
|
|
277
|
-
| `--page-size`
|
|
278
|
-
| `--max-items`
|
|
279
|
-
| `--cursor`
|
|
270
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
271
|
+
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
272
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
273
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
274
|
+
| `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
|
|
275
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
|
|
276
|
+
| `--inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
|
|
277
|
+
| `--page-size` | `number` | ❌ | — | — | Number of input fields per page |
|
|
278
|
+
| `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
279
|
+
| `--cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
280
280
|
|
|
281
281
|
**Usage:**
|
|
282
282
|
|
|
283
283
|
```bash
|
|
284
|
-
npx zapier-sdk list-input-fields <app
|
|
284
|
+
npx zapier-sdk list-input-fields <app> <action-type> <action> [--connection] [--inputs] [--page-size] [--max-items] [--cursor]
|
|
285
285
|
```
|
|
286
286
|
|
|
287
287
|
#### `run-action`
|
|
@@ -290,23 +290,22 @@ Execute an action with the given inputs
|
|
|
290
290
|
|
|
291
291
|
**Options:**
|
|
292
292
|
|
|
293
|
-
| Option
|
|
294
|
-
|
|
|
295
|
-
| `<app
|
|
296
|
-
| `<action-type>`
|
|
297
|
-
| `<action
|
|
298
|
-
| `--connection
|
|
299
|
-
| `--
|
|
300
|
-
| `--
|
|
301
|
-
| `--
|
|
302
|
-
| `--
|
|
303
|
-
| `--
|
|
304
|
-
| `--cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
293
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
294
|
+
| --------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
295
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
296
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
297
|
+
| `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
|
|
298
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
|
|
299
|
+
| `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
|
|
300
|
+
| `--timeout-ms` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
|
|
301
|
+
| `--page-size` | `number` | ❌ | — | — | Number of results per page |
|
|
302
|
+
| `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
303
|
+
| `--cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
305
304
|
|
|
306
305
|
**Usage:**
|
|
307
306
|
|
|
308
307
|
```bash
|
|
309
|
-
npx zapier-sdk run-action <app
|
|
308
|
+
npx zapier-sdk run-action <app> <action-type> <action> [--connection] [--inputs] [--timeout-ms] [--page-size] [--max-items] [--cursor]
|
|
310
309
|
```
|
|
311
310
|
|
|
312
311
|
### Apps
|
|
@@ -317,14 +316,14 @@ Get detailed information about a specific app
|
|
|
317
316
|
|
|
318
317
|
**Options:**
|
|
319
318
|
|
|
320
|
-
| Option
|
|
321
|
-
|
|
|
322
|
-
| `<app
|
|
319
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
320
|
+
| ------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
321
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
323
322
|
|
|
324
323
|
**Usage:**
|
|
325
324
|
|
|
326
325
|
```bash
|
|
327
|
-
npx zapier-sdk get-app <app
|
|
326
|
+
npx zapier-sdk get-app <app>
|
|
328
327
|
```
|
|
329
328
|
|
|
330
329
|
#### `list-apps`
|
|
@@ -335,16 +334,16 @@ List all available apps with optional filtering
|
|
|
335
334
|
|
|
336
335
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
337
336
|
| ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
|
|
338
|
-
| `--app-keys` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
339
337
|
| `--search` | `string` | ❌ | — | — | Search term to filter apps by name |
|
|
340
338
|
| `--page-size` | `number` | ❌ | — | — | Number of apps per page |
|
|
339
|
+
| `--apps` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
341
340
|
| `--max-items` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
342
341
|
| `--cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
343
342
|
|
|
344
343
|
**Usage:**
|
|
345
344
|
|
|
346
345
|
```bash
|
|
347
|
-
npx zapier-sdk list-apps [--
|
|
346
|
+
npx zapier-sdk list-apps [--search] [--page-size] [--apps] [--max-items] [--cursor]
|
|
348
347
|
```
|
|
349
348
|
|
|
350
349
|
### Client Credentials
|
|
@@ -413,15 +412,15 @@ Find the first connection matching the criteria
|
|
|
413
412
|
| `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
414
413
|
| `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
415
414
|
| `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
|
|
416
|
-
| `--app
|
|
417
|
-
| `--account
|
|
415
|
+
| `--app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
416
|
+
| `--account` | `string` | ❌ | — | — | Account to filter by |
|
|
418
417
|
| `--include-shared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
|
|
419
418
|
| `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
420
419
|
|
|
421
420
|
**Usage:**
|
|
422
421
|
|
|
423
422
|
```bash
|
|
424
|
-
npx zapier-sdk find-first-connection [--search] [--title] [--owner] [--app
|
|
423
|
+
npx zapier-sdk find-first-connection [--search] [--title] [--owner] [--app] [--account] [--include-shared] [--is-expired]
|
|
425
424
|
```
|
|
426
425
|
|
|
427
426
|
#### `find-unique-connection`
|
|
@@ -435,15 +434,15 @@ Find a unique connection matching the criteria
|
|
|
435
434
|
| `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
436
435
|
| `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
437
436
|
| `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
|
|
438
|
-
| `--app
|
|
439
|
-
| `--account
|
|
437
|
+
| `--app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
438
|
+
| `--account` | `string` | ❌ | — | — | Account to filter by |
|
|
440
439
|
| `--include-shared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
|
|
441
440
|
| `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
442
441
|
|
|
443
442
|
**Usage:**
|
|
444
443
|
|
|
445
444
|
```bash
|
|
446
|
-
npx zapier-sdk find-unique-connection [--search] [--title] [--owner] [--app
|
|
445
|
+
npx zapier-sdk find-unique-connection [--search] [--title] [--owner] [--app] [--account] [--include-shared] [--is-expired]
|
|
447
446
|
```
|
|
448
447
|
|
|
449
448
|
#### `get-connection`
|
|
@@ -452,14 +451,14 @@ Execute getConnection
|
|
|
452
451
|
|
|
453
452
|
**Options:**
|
|
454
453
|
|
|
455
|
-
| Option
|
|
456
|
-
|
|
|
457
|
-
| `--connection
|
|
454
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
455
|
+
| -------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
|
456
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
|
|
458
457
|
|
|
459
458
|
**Usage:**
|
|
460
459
|
|
|
461
460
|
```bash
|
|
462
|
-
npx zapier-sdk get-connection [--connection
|
|
461
|
+
npx zapier-sdk get-connection [--connection]
|
|
463
462
|
```
|
|
464
463
|
|
|
465
464
|
#### `list-connections`
|
|
@@ -473,9 +472,9 @@ List available connections with optional filtering
|
|
|
473
472
|
| `--search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
474
473
|
| `--title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
475
474
|
| `--owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
|
|
476
|
-
| `--app
|
|
477
|
-
| `--
|
|
478
|
-
| `--account
|
|
475
|
+
| `--app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
|
|
476
|
+
| `--connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
|
|
477
|
+
| `--account` | `string` | ❌ | — | — | Account to filter by |
|
|
479
478
|
| `--include-shared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
|
|
480
479
|
| `--is-expired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
481
480
|
| `--page-size` | `number` | ❌ | — | — | Number of connections per page |
|
|
@@ -485,7 +484,7 @@ List available connections with optional filtering
|
|
|
485
484
|
**Usage:**
|
|
486
485
|
|
|
487
486
|
```bash
|
|
488
|
-
npx zapier-sdk list-connections [--search] [--title] [--owner] [--app
|
|
487
|
+
npx zapier-sdk list-connections [--search] [--title] [--owner] [--app] [--connections] [--account] [--include-shared] [--is-expired] [--page-size] [--max-items] [--cursor]
|
|
489
488
|
```
|
|
490
489
|
|
|
491
490
|
### HTTP Requests
|
|
@@ -524,12 +523,12 @@ Make authenticated HTTP requests to any API through Zapier. Pass a connection ID
|
|
|
524
523
|
| `--max-time` | `number` | ❌ | — | — | Maximum time in seconds for the request |
|
|
525
524
|
| `--user` | `string` | ❌ | — | — | Basic auth credentials as 'user:password' |
|
|
526
525
|
| `--compressed` | `boolean` | ❌ | — | — | Request compressed response (sends Accept-Encoding header) |
|
|
527
|
-
| `--connection
|
|
526
|
+
| `--connection` | `string, number` | ❌ | — | — | Zapier connection ID or alias for authentication |
|
|
528
527
|
|
|
529
528
|
**Usage:**
|
|
530
529
|
|
|
531
530
|
```bash
|
|
532
|
-
npx zapier-sdk curl <url> [--request] [--header] [--data] [--data-raw] [--data-ascii] [--data-binary] [--data-urlencode] [--json] [--form] [--form-string] [--get] [--head] [--location] [--include] [--output] [--remote-name] [--verbose] [--silent] [--show-error] [--fail] [--fail-with-body] [--write-out] [--max-time] [--user] [--compressed] [--connection
|
|
531
|
+
npx zapier-sdk curl <url> [--request] [--header] [--data] [--data-raw] [--data-ascii] [--data-binary] [--data-urlencode] [--json] [--form] [--form-string] [--get] [--head] [--location] [--include] [--output] [--remote-name] [--verbose] [--silent] [--show-error] [--fail] [--fail-with-body] [--write-out] [--max-time] [--user] [--compressed] [--connection]
|
|
533
532
|
```
|
|
534
533
|
|
|
535
534
|
### Tables
|
|
@@ -557,15 +556,15 @@ Create one or more fields in a table
|
|
|
557
556
|
|
|
558
557
|
**Options:**
|
|
559
558
|
|
|
560
|
-
| Option
|
|
561
|
-
|
|
|
562
|
-
| `<table
|
|
563
|
-
| `<fields>`
|
|
559
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
560
|
+
| ---------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
|
|
561
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
562
|
+
| `<fields>` | `array` | ✅ | — | — | Array of field definitions to create |
|
|
564
563
|
|
|
565
564
|
**Usage:**
|
|
566
565
|
|
|
567
566
|
```bash
|
|
568
|
-
npx zapier-sdk create-table-fields <table
|
|
567
|
+
npx zapier-sdk create-table-fields <table> <fields>
|
|
569
568
|
```
|
|
570
569
|
|
|
571
570
|
#### `create-table-records`
|
|
@@ -576,14 +575,14 @@ Create one or more records in a table
|
|
|
576
575
|
|
|
577
576
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
578
577
|
| ------------ | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
579
|
-
| `<table
|
|
578
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
580
579
|
| `<records>` | `array` | ✅ | — | — | Array of records to create (max 100) |
|
|
581
580
|
| `--key-mode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
|
|
582
581
|
|
|
583
582
|
**Usage:**
|
|
584
583
|
|
|
585
584
|
```bash
|
|
586
|
-
npx zapier-sdk create-table-records <table
|
|
585
|
+
npx zapier-sdk create-table-records <table> <records> [--key-mode]
|
|
587
586
|
```
|
|
588
587
|
|
|
589
588
|
#### `delete-table`
|
|
@@ -592,14 +591,14 @@ Delete a table by its ID
|
|
|
592
591
|
|
|
593
592
|
**Options:**
|
|
594
593
|
|
|
595
|
-
| Option
|
|
596
|
-
|
|
|
597
|
-
| `<table
|
|
594
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
595
|
+
| --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
|
|
596
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
598
597
|
|
|
599
598
|
**Usage:**
|
|
600
599
|
|
|
601
600
|
```bash
|
|
602
|
-
npx zapier-sdk delete-table <table
|
|
601
|
+
npx zapier-sdk delete-table <table>
|
|
603
602
|
```
|
|
604
603
|
|
|
605
604
|
#### `delete-table-fields`
|
|
@@ -608,15 +607,15 @@ Delete one or more fields from a table
|
|
|
608
607
|
|
|
609
608
|
**Options:**
|
|
610
609
|
|
|
611
|
-
| Option
|
|
612
|
-
|
|
|
613
|
-
| `<table
|
|
614
|
-
| `<
|
|
610
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
611
|
+
| ---------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
|
|
612
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
613
|
+
| `<fields>` | `array` | ✅ | — | — | |
|
|
615
614
|
|
|
616
615
|
**Usage:**
|
|
617
616
|
|
|
618
617
|
```bash
|
|
619
|
-
npx zapier-sdk delete-table-fields <table
|
|
618
|
+
npx zapier-sdk delete-table-fields <table> <fields>
|
|
620
619
|
```
|
|
621
620
|
|
|
622
621
|
#### `delete-table-records`
|
|
@@ -625,15 +624,15 @@ Delete one or more records from a table
|
|
|
625
624
|
|
|
626
625
|
**Options:**
|
|
627
626
|
|
|
628
|
-
| Option
|
|
629
|
-
|
|
|
630
|
-
| `<table
|
|
631
|
-
| `<
|
|
627
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
628
|
+
| ----------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
|
|
629
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
630
|
+
| `<records>` | `array` | ✅ | — | — | Record IDs to operate on |
|
|
632
631
|
|
|
633
632
|
**Usage:**
|
|
634
633
|
|
|
635
634
|
```bash
|
|
636
|
-
npx zapier-sdk delete-table-records <table
|
|
635
|
+
npx zapier-sdk delete-table-records <table> <records>
|
|
637
636
|
```
|
|
638
637
|
|
|
639
638
|
#### `get-table`
|
|
@@ -642,14 +641,14 @@ Get detailed information about a specific table
|
|
|
642
641
|
|
|
643
642
|
**Options:**
|
|
644
643
|
|
|
645
|
-
| Option
|
|
646
|
-
|
|
|
647
|
-
| `<table
|
|
644
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
645
|
+
| --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
|
|
646
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
648
647
|
|
|
649
648
|
**Usage:**
|
|
650
649
|
|
|
651
650
|
```bash
|
|
652
|
-
npx zapier-sdk get-table <table
|
|
651
|
+
npx zapier-sdk get-table <table>
|
|
653
652
|
```
|
|
654
653
|
|
|
655
654
|
#### `get-table-record`
|
|
@@ -658,16 +657,16 @@ Get a single record from a table by ID
|
|
|
658
657
|
|
|
659
658
|
**Options:**
|
|
660
659
|
|
|
661
|
-
| Option
|
|
662
|
-
|
|
|
663
|
-
| `<table
|
|
664
|
-
| `<record
|
|
665
|
-
| `--key-mode`
|
|
660
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
661
|
+
| ------------ | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
662
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
663
|
+
| `<record>` | `string` | ✅ | — | — | The unique identifier of the record |
|
|
664
|
+
| `--key-mode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
|
|
666
665
|
|
|
667
666
|
**Usage:**
|
|
668
667
|
|
|
669
668
|
```bash
|
|
670
|
-
npx zapier-sdk get-table-record <table
|
|
669
|
+
npx zapier-sdk get-table-record <table> <record> [--key-mode]
|
|
671
670
|
```
|
|
672
671
|
|
|
673
672
|
#### `list-table-fields`
|
|
@@ -676,15 +675,15 @@ List fields for a table
|
|
|
676
675
|
|
|
677
676
|
**Options:**
|
|
678
677
|
|
|
679
|
-
| Option
|
|
680
|
-
|
|
|
681
|
-
| `<table
|
|
682
|
-
| `--
|
|
678
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
679
|
+
| ---------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
|
|
680
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
681
|
+
| `--fields` | `array` | ❌ | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
|
|
683
682
|
|
|
684
683
|
**Usage:**
|
|
685
684
|
|
|
686
685
|
```bash
|
|
687
|
-
npx zapier-sdk list-table-fields <table
|
|
686
|
+
npx zapier-sdk list-table-fields <table> [--fields]
|
|
688
687
|
```
|
|
689
688
|
|
|
690
689
|
#### `list-table-records`
|
|
@@ -695,7 +694,7 @@ List records in a table with optional filtering and sorting
|
|
|
695
694
|
|
|
696
695
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
697
696
|
| --------------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
698
|
-
| `<table
|
|
697
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
699
698
|
| `--filters` | `array` | ❌ | — | — | Filter conditions for the query |
|
|
700
699
|
| `--sort` | `object` | ❌ | — | — | Sort records by a field |
|
|
701
700
|
| ↳ `<field-key>` | `string` | ✅ | — | — | The field key to sort by |
|
|
@@ -708,7 +707,7 @@ List records in a table with optional filtering and sorting
|
|
|
708
707
|
**Usage:**
|
|
709
708
|
|
|
710
709
|
```bash
|
|
711
|
-
npx zapier-sdk list-table-records <table
|
|
710
|
+
npx zapier-sdk list-table-records <table> <field-key> [--filters] [--sort] [--direction] [--page-size] [--max-items] [--cursor] [--key-mode]
|
|
712
711
|
```
|
|
713
712
|
|
|
714
713
|
#### `list-tables`
|
|
@@ -719,7 +718,7 @@ List tables available to the authenticated user
|
|
|
719
718
|
|
|
720
719
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
721
720
|
| ------------------ | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
722
|
-
| `--
|
|
721
|
+
| `--tables` | `array` | ❌ | — | — | Filter by specific table IDs |
|
|
723
722
|
| `--kind` | `string` | ❌ | — | `table`, `virtual_table`, `both` | Filter by table type |
|
|
724
723
|
| `--search` | `string` | ❌ | — | — | Search term to filter tables by name |
|
|
725
724
|
| `--owner` | `string` | ❌ | — | — | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
|
|
@@ -731,7 +730,7 @@ List tables available to the authenticated user
|
|
|
731
730
|
**Usage:**
|
|
732
731
|
|
|
733
732
|
```bash
|
|
734
|
-
npx zapier-sdk list-tables [--
|
|
733
|
+
npx zapier-sdk list-tables [--tables] [--kind] [--search] [--owner] [--include-shared] [--page-size] [--max-items] [--cursor]
|
|
735
734
|
```
|
|
736
735
|
|
|
737
736
|
#### `update-table-records`
|
|
@@ -742,14 +741,14 @@ Update one or more records in a table
|
|
|
742
741
|
|
|
743
742
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
744
743
|
| ------------ | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
|
|
745
|
-
| `<table
|
|
744
|
+
| `<table>` | `string` | ✅ | — | — | The unique identifier of the table |
|
|
746
745
|
| `<records>` | `array` | ✅ | — | — | Array of records to update (max 100) |
|
|
747
746
|
| `--key-mode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
|
|
748
747
|
|
|
749
748
|
**Usage:**
|
|
750
749
|
|
|
751
750
|
```bash
|
|
752
|
-
npx zapier-sdk update-table-records <table
|
|
751
|
+
npx zapier-sdk update-table-records <table> <records> [--key-mode]
|
|
753
752
|
```
|
|
754
753
|
|
|
755
754
|
### Utilities
|
|
@@ -760,17 +759,17 @@ Add apps with manifest locking and TypeScript type generation - updates .zapierr
|
|
|
760
759
|
|
|
761
760
|
**Options:**
|
|
762
761
|
|
|
763
|
-
| Option
|
|
764
|
-
|
|
|
765
|
-
| `<
|
|
766
|
-
| `--
|
|
767
|
-
| `--config-path`
|
|
768
|
-
| `--types-output`
|
|
762
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
763
|
+
| ---------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------- |
|
|
764
|
+
| `<apps>` | `array` | ✅ | — | — | One or more app keys to add (e.g., 'slack', 'github', 'trello') |
|
|
765
|
+
| `--connections` | `array` | ❌ | — | — | Connection IDs to use for type generation (e.g., ['123', '456']) |
|
|
766
|
+
| `--config-path` | `string` | ❌ | — | — | Path to Zapier config file (defaults to '.zapierrc', e.g., './custom/.zapierrc') |
|
|
767
|
+
| `--types-output` | `string` | ❌ | — | — | Directory for TypeScript type files (defaults to (src/lib/.)/zapier/apps/, e.g., './src/types/zapier/') |
|
|
769
768
|
|
|
770
769
|
**Usage:**
|
|
771
770
|
|
|
772
771
|
```bash
|
|
773
|
-
npx zapier-sdk add <
|
|
772
|
+
npx zapier-sdk add <apps> [--connections] [--config-path] [--types-output]
|
|
774
773
|
```
|
|
775
774
|
|
|
776
775
|
#### `build-manifest`
|
|
@@ -781,14 +780,14 @@ Build manifest entries for apps - can optionally write to disk or just return JS
|
|
|
781
780
|
|
|
782
781
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
783
782
|
| --------------- | --------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
|
|
784
|
-
| `<
|
|
783
|
+
| `<apps>` | `array` | ✅ | — | — | One or more app keys to build manifest entries for (e.g., 'slack', 'github', 'trello') |
|
|
785
784
|
| `--skip-write` | `boolean` | ❌ | — | — | If true, returns manifest entries without writing to disk. If false or omitted, writes to the manifest file. |
|
|
786
785
|
| `--config-path` | `string` | ❌ | — | — | Path to the manifest file. Only used when skipWrite is false or omitted. |
|
|
787
786
|
|
|
788
787
|
**Usage:**
|
|
789
788
|
|
|
790
789
|
```bash
|
|
791
|
-
npx zapier-sdk build-manifest <
|
|
790
|
+
npx zapier-sdk build-manifest <apps> [--skip-write] [--config-path]
|
|
792
791
|
```
|
|
793
792
|
|
|
794
793
|
#### `bundle-code`
|
|
@@ -836,15 +835,15 @@ Generate TypeScript type definitions for apps - can optionally write to disk or
|
|
|
836
835
|
|
|
837
836
|
| Option | Type | Required | Default | Possible Values | Description |
|
|
838
837
|
| -------------------------- | --------- | -------- | ------- | --------------- | -------------------------------------------------------------------------------------------------- |
|
|
839
|
-
| `<
|
|
840
|
-
| `--
|
|
838
|
+
| `<apps>` | `array` | ✅ | — | — | One or more app keys to generate types for (e.g., 'slack', 'github', 'trello') |
|
|
839
|
+
| `--connections` | `array` | ❌ | — | — | Connection IDs to use for type generation (e.g., ['123', '456']) |
|
|
841
840
|
| `--skip-write` | `boolean` | ❌ | — | — | If true, returns type definitions without writing to disk. If false or omitted, writes type files. |
|
|
842
841
|
| `--types-output-directory` | `string` | ❌ | — | — | Directory for TypeScript type files. Required when skipWrite is false or omitted. |
|
|
843
842
|
|
|
844
843
|
**Usage:**
|
|
845
844
|
|
|
846
845
|
```bash
|
|
847
|
-
npx zapier-sdk generate-app-types <
|
|
846
|
+
npx zapier-sdk generate-app-types <apps> [--connections] [--skip-write] [--types-output-directory]
|
|
848
847
|
```
|
|
849
848
|
|
|
850
849
|
#### `get-login-config-path`
|