@zapier/zapier-sdk 0.39.0 → 0.40.0

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.
Files changed (192) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/CLAUDE.md +12 -14
  3. package/README.md +186 -192
  4. package/dist/api/schemas.d.ts +2 -2
  5. package/dist/api/schemas.js +3 -3
  6. package/dist/formatters/tableRecord.js +1 -1
  7. package/dist/index.cjs +652 -377
  8. package/dist/index.d.mts +468 -53
  9. package/dist/index.mjs +643 -378
  10. package/dist/plugins/apps/index.d.ts +1 -1
  11. package/dist/plugins/apps/index.d.ts.map +1 -1
  12. package/dist/plugins/apps/index.js +4 -8
  13. package/dist/plugins/apps/schemas.d.ts +2 -1
  14. package/dist/plugins/apps/schemas.d.ts.map +1 -1
  15. package/dist/plugins/apps/schemas.js +24 -8
  16. package/dist/plugins/fetch/index.d.ts +4 -2
  17. package/dist/plugins/fetch/index.d.ts.map +1 -1
  18. package/dist/plugins/fetch/index.js +1 -3
  19. package/dist/plugins/fetch/schemas.d.ts.map +1 -1
  20. package/dist/plugins/fetch/schemas.js +11 -4
  21. package/dist/plugins/findFirstConnection/index.d.ts.map +1 -1
  22. package/dist/plugins/findFirstConnection/index.js +0 -1
  23. package/dist/plugins/findFirstConnection/schemas.d.ts +4 -1
  24. package/dist/plugins/findFirstConnection/schemas.d.ts.map +1 -1
  25. package/dist/plugins/findFirstConnection/schemas.js +2 -0
  26. package/dist/plugins/findUniqueConnection/index.d.ts.map +1 -1
  27. package/dist/plugins/findUniqueConnection/index.js +0 -1
  28. package/dist/plugins/findUniqueConnection/schemas.d.ts +4 -1
  29. package/dist/plugins/findUniqueConnection/schemas.d.ts.map +1 -1
  30. package/dist/plugins/findUniqueConnection/schemas.js +2 -0
  31. package/dist/plugins/getAction/index.d.ts.map +1 -1
  32. package/dist/plugins/getAction/index.js +8 -6
  33. package/dist/plugins/getAction/schemas.d.ts +58 -1
  34. package/dist/plugins/getAction/schemas.d.ts.map +1 -1
  35. package/dist/plugins/getAction/schemas.js +16 -4
  36. package/dist/plugins/getApp/index.d.ts.map +1 -1
  37. package/dist/plugins/getApp/index.js +6 -5
  38. package/dist/plugins/getApp/schemas.d.ts +19 -1
  39. package/dist/plugins/getApp/schemas.d.ts.map +1 -1
  40. package/dist/plugins/getApp/schemas.js +14 -4
  41. package/dist/plugins/getConnection/index.d.ts.map +1 -1
  42. package/dist/plugins/getConnection/index.js +3 -5
  43. package/dist/plugins/getConnection/schemas.d.ts +1 -0
  44. package/dist/plugins/getConnection/schemas.d.ts.map +1 -1
  45. package/dist/plugins/getConnection/schemas.js +11 -5
  46. package/dist/plugins/getInputFieldsSchema/index.d.ts +2 -1
  47. package/dist/plugins/getInputFieldsSchema/index.d.ts.map +1 -1
  48. package/dist/plugins/getInputFieldsSchema/index.js +18 -12
  49. package/dist/plugins/getInputFieldsSchema/schemas.d.ts +71 -1
  50. package/dist/plugins/getInputFieldsSchema/schemas.d.ts.map +1 -1
  51. package/dist/plugins/getInputFieldsSchema/schemas.js +39 -10
  52. package/dist/plugins/listActions/index.d.ts.map +1 -1
  53. package/dist/plugins/listActions/index.js +5 -4
  54. package/dist/plugins/listActions/schemas.d.ts +58 -1
  55. package/dist/plugins/listActions/schemas.d.ts.map +1 -1
  56. package/dist/plugins/listActions/schemas.js +25 -12
  57. package/dist/plugins/listApps/index.js +1 -1
  58. package/dist/plugins/listApps/schemas.d.ts +1 -0
  59. package/dist/plugins/listApps/schemas.d.ts.map +1 -1
  60. package/dist/plugins/listApps/schemas.js +6 -1
  61. package/dist/plugins/listConnections/index.d.ts +2 -1
  62. package/dist/plugins/listConnections/index.d.ts.map +1 -1
  63. package/dist/plugins/listConnections/index.js +27 -14
  64. package/dist/plugins/listConnections/schemas.d.ts +5 -0
  65. package/dist/plugins/listConnections/schemas.d.ts.map +1 -1
  66. package/dist/plugins/listConnections/schemas.js +22 -9
  67. package/dist/plugins/listInputFieldChoices/index.d.ts +2 -2
  68. package/dist/plugins/listInputFieldChoices/index.d.ts.map +1 -1
  69. package/dist/plugins/listInputFieldChoices/index.js +21 -15
  70. package/dist/plugins/listInputFieldChoices/schemas.d.ts +92 -1
  71. package/dist/plugins/listInputFieldChoices/schemas.d.ts.map +1 -1
  72. package/dist/plugins/listInputFieldChoices/schemas.js +47 -23
  73. package/dist/plugins/listInputFields/index.d.ts +2 -1
  74. package/dist/plugins/listInputFields/index.d.ts.map +1 -1
  75. package/dist/plugins/listInputFields/index.js +18 -13
  76. package/dist/plugins/listInputFields/schemas.d.ts +80 -1
  77. package/dist/plugins/listInputFields/schemas.d.ts.map +1 -1
  78. package/dist/plugins/listInputFields/schemas.js +40 -11
  79. package/dist/plugins/manifest/schemas.d.ts.map +1 -1
  80. package/dist/plugins/manifest/schemas.js +4 -2
  81. package/dist/plugins/registry/index.d.ts.map +1 -1
  82. package/dist/plugins/registry/index.js +0 -1
  83. package/dist/plugins/request/index.d.ts.map +1 -1
  84. package/dist/plugins/request/index.js +2 -5
  85. package/dist/plugins/request/schemas.d.ts +2 -0
  86. package/dist/plugins/request/schemas.d.ts.map +1 -1
  87. package/dist/plugins/request/schemas.js +13 -5
  88. package/dist/plugins/runAction/index.d.ts.map +1 -1
  89. package/dist/plugins/runAction/index.js +17 -15
  90. package/dist/plugins/runAction/schemas.d.ts +83 -2
  91. package/dist/plugins/runAction/schemas.d.ts.map +1 -1
  92. package/dist/plugins/runAction/schemas.js +41 -17
  93. package/dist/plugins/tables/createTableFields/index.d.ts.map +1 -1
  94. package/dist/plugins/tables/createTableFields/index.js +5 -4
  95. package/dist/plugins/tables/createTableFields/schemas.d.ts +128 -2
  96. package/dist/plugins/tables/createTableFields/schemas.d.ts.map +1 -1
  97. package/dist/plugins/tables/createTableFields/schemas.js +23 -7
  98. package/dist/plugins/tables/createTableRecords/index.d.ts.map +1 -1
  99. package/dist/plugins/tables/createTableRecords/index.js +7 -6
  100. package/dist/plugins/tables/createTableRecords/schemas.d.ts +38 -2
  101. package/dist/plugins/tables/createTableRecords/schemas.d.ts.map +1 -1
  102. package/dist/plugins/tables/createTableRecords/schemas.js +23 -7
  103. package/dist/plugins/tables/deleteTable/index.d.ts.map +1 -1
  104. package/dist/plugins/tables/deleteTable/index.js +5 -4
  105. package/dist/plugins/tables/deleteTable/schemas.d.ts +17 -1
  106. package/dist/plugins/tables/deleteTable/schemas.d.ts.map +1 -1
  107. package/dist/plugins/tables/deleteTable/schemas.js +14 -2
  108. package/dist/plugins/tables/deleteTableFields/index.d.ts.map +1 -1
  109. package/dist/plugins/tables/deleteTableFields/index.js +9 -7
  110. package/dist/plugins/tables/deleteTableFields/schemas.d.ts +22 -1
  111. package/dist/plugins/tables/deleteTableFields/schemas.d.ts.map +1 -1
  112. package/dist/plugins/tables/deleteTableFields/schemas.js +18 -2
  113. package/dist/plugins/tables/deleteTableRecords/index.d.ts.map +1 -1
  114. package/dist/plugins/tables/deleteTableRecords/index.js +7 -5
  115. package/dist/plugins/tables/deleteTableRecords/schemas.d.ts +22 -1
  116. package/dist/plugins/tables/deleteTableRecords/schemas.d.ts.map +1 -1
  117. package/dist/plugins/tables/deleteTableRecords/schemas.js +18 -2
  118. package/dist/plugins/tables/getTable/index.d.ts.map +1 -1
  119. package/dist/plugins/tables/getTable/index.js +6 -5
  120. package/dist/plugins/tables/getTable/schemas.d.ts +16 -1
  121. package/dist/plugins/tables/getTable/schemas.d.ts.map +1 -1
  122. package/dist/plugins/tables/getTable/schemas.js +14 -2
  123. package/dist/plugins/tables/getTableRecord/index.d.ts.map +1 -1
  124. package/dist/plugins/tables/getTableRecord/index.js +9 -7
  125. package/dist/plugins/tables/getTableRecord/schemas.d.ts +39 -2
  126. package/dist/plugins/tables/getTableRecord/schemas.d.ts.map +1 -1
  127. package/dist/plugins/tables/getTableRecord/schemas.js +20 -5
  128. package/dist/plugins/tables/listTableFields/index.d.ts.map +1 -1
  129. package/dist/plugins/tables/listTableFields/index.js +10 -8
  130. package/dist/plugins/tables/listTableFields/schemas.d.ts +27 -2
  131. package/dist/plugins/tables/listTableFields/schemas.d.ts.map +1 -1
  132. package/dist/plugins/tables/listTableFields/schemas.js +24 -8
  133. package/dist/plugins/tables/listTableRecords/index.d.ts.map +1 -1
  134. package/dist/plugins/tables/listTableRecords/index.js +7 -6
  135. package/dist/plugins/tables/listTableRecords/schemas.d.ts +119 -2
  136. package/dist/plugins/tables/listTableRecords/schemas.d.ts.map +1 -1
  137. package/dist/plugins/tables/listTableRecords/schemas.js +23 -7
  138. package/dist/plugins/tables/listTables/index.d.ts.map +1 -1
  139. package/dist/plugins/tables/listTables/index.js +3 -2
  140. package/dist/plugins/tables/listTables/schemas.d.ts +5 -1
  141. package/dist/plugins/tables/listTables/schemas.d.ts.map +1 -1
  142. package/dist/plugins/tables/listTables/schemas.js +4 -1
  143. package/dist/plugins/tables/updateTableRecords/index.d.ts.map +1 -1
  144. package/dist/plugins/tables/updateTableRecords/index.js +7 -6
  145. package/dist/plugins/tables/updateTableRecords/schemas.d.ts +41 -2
  146. package/dist/plugins/tables/updateTableRecords/schemas.d.ts.map +1 -1
  147. package/dist/plugins/tables/updateTableRecords/schemas.js +23 -7
  148. package/dist/resolvers/actionKey.d.ts +1 -1
  149. package/dist/resolvers/actionKey.d.ts.map +1 -1
  150. package/dist/resolvers/actionKey.js +3 -3
  151. package/dist/resolvers/actionType.d.ts +1 -1
  152. package/dist/resolvers/actionType.d.ts.map +1 -1
  153. package/dist/resolvers/actionType.js +2 -2
  154. package/dist/resolvers/connectionId.d.ts +1 -1
  155. package/dist/resolvers/connectionId.d.ts.map +1 -1
  156. package/dist/resolvers/connectionId.js +9 -9
  157. package/dist/resolvers/inputFieldKey.d.ts +3 -3
  158. package/dist/resolvers/inputFieldKey.d.ts.map +1 -1
  159. package/dist/resolvers/inputFieldKey.js +6 -6
  160. package/dist/resolvers/inputs.d.ts +3 -3
  161. package/dist/resolvers/inputs.d.ts.map +1 -1
  162. package/dist/resolvers/inputs.js +8 -8
  163. package/dist/resolvers/tableFieldIds.d.ts +1 -1
  164. package/dist/resolvers/tableFieldIds.d.ts.map +1 -1
  165. package/dist/resolvers/tableFieldIds.js +3 -3
  166. package/dist/resolvers/tableFilters.d.ts +1 -1
  167. package/dist/resolvers/tableFilters.d.ts.map +1 -1
  168. package/dist/resolvers/tableFilters.js +4 -4
  169. package/dist/resolvers/tableId.js +1 -1
  170. package/dist/resolvers/tableRecordId.d.ts +2 -2
  171. package/dist/resolvers/tableRecordId.d.ts.map +1 -1
  172. package/dist/resolvers/tableRecordId.js +5 -5
  173. package/dist/resolvers/tableRecords.d.ts +2 -2
  174. package/dist/resolvers/tableRecords.d.ts.map +1 -1
  175. package/dist/resolvers/tableRecords.js +6 -6
  176. package/dist/resolvers/tableSort.d.ts +1 -1
  177. package/dist/resolvers/tableSort.d.ts.map +1 -1
  178. package/dist/resolvers/tableSort.js +2 -2
  179. package/dist/services/implementations.d.ts.map +1 -1
  180. package/dist/services/implementations.js +2 -3
  181. package/dist/types/properties.d.ts +30 -0
  182. package/dist/types/properties.d.ts.map +1 -1
  183. package/dist/types/properties.js +34 -1
  184. package/dist/types/sdk.d.ts +0 -2
  185. package/dist/types/sdk.d.ts.map +1 -1
  186. package/dist/utils/domain-utils.d.ts +5 -0
  187. package/dist/utils/domain-utils.d.ts.map +1 -1
  188. package/dist/utils/domain-utils.js +17 -3
  189. package/dist/utils/id-utils.d.ts +2 -0
  190. package/dist/utils/id-utils.d.ts.map +1 -1
  191. package/dist/utils/id-utils.js +2 -0
  192. package/package.json +1 -1
package/README.md CHANGED
@@ -211,7 +211,7 @@ console.log({
211
211
 
212
212
  // The item methods return a promise for a single item, wrapped with {data}.
213
213
  // This is just to give us room to add metadata in the future.
214
- const { data: app } = await zapier.getApp({ appKey: "slack" });
214
+ const { data: app } = await zapier.getApp({ app: "slack" });
215
215
 
216
216
  console.log({
217
217
  app,
@@ -219,7 +219,7 @@ console.log({
219
219
 
220
220
  // ######## Connection Usage ########
221
221
  const { data: myConnections } = await zapier.listConnections({
222
- appKey: "slack",
222
+ app: "slack",
223
223
  owner: "me",
224
224
  });
225
225
 
@@ -231,16 +231,16 @@ console.log({
231
231
  // Option 1: List actions
232
232
  // Remember, this is just the first page which may not include them all!
233
233
  // See `.items()` usage above, which can be used to make sure you get all actions.
234
- const { data: actions } = await zapier.listActions({ appKey: "slack" });
234
+ const { data: actions } = await zapier.listActions({ app: "slack" });
235
235
 
236
236
  console.log({
237
237
  actions,
238
238
  });
239
239
 
240
240
  const singleAction = await zapier.getAction({
241
- appKey: "slack",
241
+ app: "slack",
242
242
  actionType: actions[0].action_type,
243
- actionKey: actions[0].key,
243
+ action: actions[0].key,
244
244
  });
245
245
 
246
246
  console.log({
@@ -257,10 +257,10 @@ console.log({
257
257
  // ######## Run Actions ########
258
258
  // Option 1:
259
259
  const { data: channels } = await zapier.runAction({
260
- appKey: "slack",
260
+ app: "slack",
261
261
  actionType: "read",
262
- actionKey: "channels",
263
- connectionId: myConnections[0].id,
262
+ action: "channels",
263
+ connection: myConnections[0].id,
264
264
  });
265
265
 
266
266
  console.log({
@@ -272,7 +272,7 @@ const { data: profile } = await zapier.getProfile();
272
272
  // Option 2:
273
273
  // Create an app binding to your connection.
274
274
  const mySlack = zapier.apps.slack({
275
- connectionId: myConnections[0].id,
275
+ connection: myConnections[0].id,
276
276
  });
277
277
 
278
278
  // Use your app binding to run the action.
@@ -291,7 +291,7 @@ const { data: sameUsers } = await zapier.apps.slack.search.user_by_email({
291
291
  inputs: {
292
292
  email: profile.email,
293
293
  },
294
- connectionId: myConnections[0].id,
294
+ connection: myConnections[0].id,
295
295
  });
296
296
 
297
297
  console.log({
@@ -308,7 +308,7 @@ console.log({
308
308
  // using the same connections with `.fetch`! This returns a response just
309
309
  // like a normal `fetch` call in JavaScript.
310
310
  const emojiResponse = await zapier.fetch("https://slack.com/api/emoji.list", {
311
- connectionId: myConnections[0].id,
311
+ connection: myConnections[0].id,
312
312
  });
313
313
 
314
314
  const emojiData = await emojiResponse.json();
@@ -334,7 +334,7 @@ The `createZapierSdk(...)` factory function is the main entry point for the SDK.
334
334
 
335
335
  ## Named Connections
336
336
 
337
- Named connections let you decouple workflow code from specific connection IDs. Instead of hardcoding a `connectionId`, you reference a connection by name and the SDK resolves it from a mapping.
337
+ Named connections let you decouple workflow code from specific connection IDs. Instead of hardcoding an ID, you reference a connection by name and the SDK resolves it from a mapping.
338
338
 
339
339
  This is useful when an execution engine or deployment system manages which connections a workflow should use.
340
340
 
@@ -358,7 +358,7 @@ Each connection entry maps a name to a `connectionId`. App version resolution is
358
358
 
359
359
  ### Using named connections
360
360
 
361
- Reference connections by alias using the `connection` parameter. String values are resolved from the connections map; numeric values are used directly as a `connectionId`.
361
+ Reference connections using the `connection` parameter. Pass a connection name to be resolved from the connections map or a connection ID to be used directly.
362
362
 
363
363
  ```typescript
364
364
  // Per-call with alias
@@ -370,9 +370,9 @@ await slack.read.channels({});
370
370
 
371
371
  // Lower-level runAction
372
372
  await zapier.runAction({
373
- appKey: "slack",
373
+ app: "slack",
374
374
  actionType: "read",
375
- actionKey: "channels",
375
+ action: "channels",
376
376
  connection: "slack_work",
377
377
  });
378
378
 
@@ -381,12 +381,10 @@ await zapier.fetch("https://slack.com/api/auth.test", {
381
381
  connection: "slack_work",
382
382
  });
383
383
 
384
- // Direct connectionId also works
384
+ // Direct connection ID also works
385
385
  await zapier.apps.slack.read.channels({ connection: 12345 });
386
386
  ```
387
387
 
388
- `connection` and `connectionId` are mutually exclusive in the same call. You can still use `connectionId` directly if you prefer.
389
-
390
388
  ## Available Functions
391
389
 
392
390
  ### Accounts
@@ -417,12 +415,12 @@ Get detailed information about a specific action
417
415
 
418
416
  **Parameters:**
419
417
 
420
- | Name | Type | Required | Default | Possible Values | Description |
421
- | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | --------------------------------------------------- |
422
- | `options` | `object` | ✅ | — | — | |
423
- | ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
424
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
425
- | ↳ `actionKey` | `string` | ✅ | — | — | Action key to execute |
418
+ | Name | Type | Required | Default | Possible Values | Description |
419
+ | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
420
+ | `options` | `object` | ✅ | — | — | |
421
+ | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
422
+ | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
423
+ | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
426
424
 
427
425
  **Returns:** `Promise<ActionItem>`
428
426
 
@@ -430,9 +428,9 @@ Get detailed information about a specific action
430
428
 
431
429
  ```typescript
432
430
  const { data: action } = await zapier.getAction({
433
- appKey: "example-key",
431
+ app: "example-value",
434
432
  actionType: "read",
435
- actionKey: "example-key",
433
+ action: "example-value",
436
434
  });
437
435
  ```
438
436
 
@@ -442,14 +440,14 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
442
440
 
443
441
  **Parameters:**
444
442
 
445
- | Name | Type | Required | Default | Possible Values | Description |
446
- | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
447
- | `options` | `object` | ✅ | — | — | |
448
- | ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
449
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
450
- | ↳ `actionKey` | `string` | ✅ | — | — | Action key to get the input schema for |
451
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use when fetching the schema. Required if the action needs a connection to determine available fields. |
452
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
443
+ | Name | Type | Required | Default | Possible Values | Description |
444
+ | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
445
+ | `options` | `object` | ✅ | — | — | |
446
+ | ↳ `app` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') to get the input schema for |
447
+ | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
448
+ | ↳ `action` | `string` | ✅ | — | — | Action key to get the input schema for |
449
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
450
+ | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect the schema (e.g., when fields depend on other field values) |
453
451
 
454
452
  **Returns:** `Promise<InputSchemaItem>`
455
453
 
@@ -457,9 +455,9 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
457
455
 
458
456
  ```typescript
459
457
  const { data: inputSchema } = await zapier.getInputFieldsSchema({
460
- appKey: "example-key",
458
+ app: "example-value",
461
459
  actionType: "read",
462
- actionKey: "example-key",
460
+ action: "example-value",
463
461
  });
464
462
  ```
465
463
 
@@ -472,7 +470,7 @@ List all actions for a specific app
472
470
  | Name | Type | Required | Default | Possible Values | Description |
473
471
  | -------------- | -------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
474
472
  | `options` | `object` | ✅ | — | — | |
475
- | ↳ `appKey` | `string` | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
473
+ | ↳ `app` | `string` | ✅ | — | — | App key of actions to list (e.g., 'SlackCLIAPI' or slug like 'github') |
476
474
  | ↳ `actionType` | `string` | ❌ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Filter actions by type |
477
475
  | ↳ `pageSize` | `number` | ❌ | — | — | Number of actions per page |
478
476
  | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
@@ -485,12 +483,12 @@ List all actions for a specific app
485
483
  ```typescript
486
484
  // Get first page and a cursor for the second page
487
485
  const { data: actions, nextCursor } = await zapier.listActions({
488
- appKey: "example-key",
486
+ app: "example-value",
489
487
  });
490
488
 
491
489
  // Or iterate over all pages
492
490
  for await (const page of zapier.listActions({
493
- appKey: "example-key",
491
+ app: "example-value",
494
492
  })) {
495
493
  // Do something with each page
496
494
  }
@@ -498,7 +496,7 @@ for await (const page of zapier.listActions({
498
496
  // Or iterate over individual items across all pages
499
497
  for await (const action of zapier
500
498
  .listActions({
501
- appKey: "example-key",
499
+ app: "example-value",
502
500
  })
503
501
  .items()) {
504
502
  // Do something with each action
@@ -511,19 +509,19 @@ Get the available choices for a dynamic dropdown input field
511
509
 
512
510
  **Parameters:**
513
511
 
514
- | Name | Type | Required | Default | Possible Values | Description |
515
- | ----------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
516
- | `options` | `object` | ✅ | — | — | |
517
- | ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
518
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
519
- | ↳ `actionKey` | `string` | ✅ | — | — | Action key to execute |
520
- | ↳ `inputFieldKey` | `string` | ✅ | — | — | Input field key to get choices for. |
521
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use when listing available field choices. Required if the action needs a connection to populate dynamic dropdown options. |
522
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
523
- | ↳ `page` | `number` | ❌ | — | — | Page number for paginated results |
524
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of choices per page |
525
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
526
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
512
+ | Name | Type | Required | Default | Possible Values | Description |
513
+ | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
514
+ | `options` | `object` | ✅ | — | — | |
515
+ | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
516
+ | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
517
+ | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
518
+ | ↳ `inputField` | `string` | ✅ | — | — | Input field key to get choices for |
519
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
520
+ | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available choices |
521
+ | ↳ `page` | `number` | ❌ | — | — | Page number for paginated results |
522
+ | ↳ `pageSize` | `number` | ❌ | — | — | Number of choices per page |
523
+ | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
524
+ | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
527
525
 
528
526
  **Returns:** `Promise<PaginatedResult<InputFieldChoiceItem>>`
529
527
 
@@ -533,18 +531,18 @@ Get the available choices for a dynamic dropdown input field
533
531
  // Get first page and a cursor for the second page
534
532
  const { data: inputFieldChoices, nextCursor } =
535
533
  await zapier.listInputFieldChoices({
536
- appKey: "example-key",
534
+ app: "example-value",
537
535
  actionType: "read",
538
- actionKey: "example-key",
539
- inputFieldKey: "example-key",
536
+ action: "example-value",
537
+ inputField: "example-value",
540
538
  });
541
539
 
542
540
  // Or iterate over all pages
543
541
  for await (const page of zapier.listInputFieldChoices({
544
- appKey: "example-key",
542
+ app: "example-value",
545
543
  actionType: "read",
546
- actionKey: "example-key",
547
- inputFieldKey: "example-key",
544
+ action: "example-value",
545
+ inputField: "example-value",
548
546
  })) {
549
547
  // Do something with each page
550
548
  }
@@ -552,10 +550,10 @@ for await (const page of zapier.listInputFieldChoices({
552
550
  // Or iterate over individual items across all pages
553
551
  for await (const inputFieldChoice of zapier
554
552
  .listInputFieldChoices({
555
- appKey: "example-key",
553
+ app: "example-value",
556
554
  actionType: "read",
557
- actionKey: "example-key",
558
- inputFieldKey: "example-key",
555
+ action: "example-value",
556
+ inputField: "example-value",
559
557
  })
560
558
  .items()) {
561
559
  // Do something with each inputFieldChoice
@@ -568,17 +566,17 @@ Get the input fields required for a specific action
568
566
 
569
567
  **Parameters:**
570
568
 
571
- | Name | Type | Required | Default | Possible Values | Description |
572
- | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
573
- | `options` | `object` | ✅ | — | — | |
574
- | ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
575
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
576
- | ↳ `actionKey` | `string` | ✅ | — | — | Action key to execute |
577
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use when listing input fields. Required if the action needs a connection to determine available fields. |
578
- | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
579
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of input fields per page |
580
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
581
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
569
+ | Name | Type | Required | Default | Possible Values | Description |
570
+ | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
571
+ | `options` | `object` | ✅ | — | — | |
572
+ | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
573
+ | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
574
+ | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
575
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
576
+ | ↳ `inputs` | `object` | ❌ | — | — | Current input values that may affect available fields |
577
+ | ↳ `pageSize` | `number` | ❌ | — | — | Number of input fields per page |
578
+ | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
579
+ | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
582
580
 
583
581
  **Returns:** `Promise<PaginatedResult<RootFieldItemItem>>`
584
582
 
@@ -587,16 +585,16 @@ Get the input fields required for a specific action
587
585
  ```typescript
588
586
  // Get first page and a cursor for the second page
589
587
  const { data: rootFieldItems, nextCursor } = await zapier.listInputFields({
590
- appKey: "example-key",
588
+ app: "example-value",
591
589
  actionType: "read",
592
- actionKey: "example-key",
590
+ action: "example-value",
593
591
  });
594
592
 
595
593
  // Or iterate over all pages
596
594
  for await (const page of zapier.listInputFields({
597
- appKey: "example-key",
595
+ app: "example-value",
598
596
  actionType: "read",
599
- actionKey: "example-key",
597
+ action: "example-value",
600
598
  })) {
601
599
  // Do something with each page
602
600
  }
@@ -604,9 +602,9 @@ for await (const page of zapier.listInputFields({
604
602
  // Or iterate over individual items across all pages
605
603
  for await (const rootFieldItem of zapier
606
604
  .listInputFields({
607
- appKey: "example-key",
605
+ app: "example-value",
608
606
  actionType: "read",
609
- actionKey: "example-key",
607
+ action: "example-value",
610
608
  })
611
609
  .items()) {
612
610
  // Do something with each rootFieldItem
@@ -619,19 +617,18 @@ Execute an action with the given inputs
619
617
 
620
618
  **Parameters:**
621
619
 
622
- | Name | Type | Required | Default | Possible Values | Description |
623
- | ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
624
- | `options` | `object` | ✅ | — | — | |
625
- | ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github') |
626
- | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
627
- | ↳ `actionKey` | `string` | ✅ | — | — | Action key to execute |
628
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use when running the action. Required if the action needs a connection to authenticate and interact with the service. |
629
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
630
- | ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the action |
631
- | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
632
- | ↳ `pageSize` | `number` | ❌ | — | — | Number of results per page |
633
- | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
634
- | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
620
+ | Name | Type | Required | Default | Possible Values | Description |
621
+ | -------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
622
+ | `options` | `object` | ✅ | — | — | |
623
+ | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
624
+ | ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
625
+ | ↳ `action` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
626
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. Mutually exclusive with connectionId. |
627
+ | ↳ `inputs` | `object` | ❌ | — | — | Input parameters for the action |
628
+ | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
629
+ | ↳ `pageSize` | `number` | ❌ | — | — | Number of results per page |
630
+ | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
631
+ | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
635
632
 
636
633
  **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
637
634
 
@@ -640,16 +637,16 @@ Execute an action with the given inputs
640
637
  ```typescript
641
638
  // Get first page and a cursor for the second page
642
639
  const { data: actionResults, nextCursor } = await zapier.runAction({
643
- appKey: "example-key",
640
+ app: "example-value",
644
641
  actionType: "read",
645
- actionKey: "example-key",
642
+ action: "example-value",
646
643
  });
647
644
 
648
645
  // Or iterate over all pages
649
646
  for await (const page of zapier.runAction({
650
- appKey: "example-key",
647
+ app: "example-value",
651
648
  actionType: "read",
652
- actionKey: "example-key",
649
+ action: "example-value",
653
650
  })) {
654
651
  // Do something with each page
655
652
  }
@@ -657,9 +654,9 @@ for await (const page of zapier.runAction({
657
654
  // Or iterate over individual items across all pages
658
655
  for await (const actionResult of zapier
659
656
  .runAction({
660
- appKey: "example-key",
657
+ app: "example-value",
661
658
  actionType: "read",
662
- actionKey: "example-key",
659
+ action: "example-value",
663
660
  })
664
661
  .items()) {
665
662
  // Do something with each actionResult
@@ -674,11 +671,10 @@ Bind a connection alias or numeric connectionId to an app
674
671
 
675
672
  **Parameters:**
676
673
 
677
- | Name | Type | Required | Default | Possible Values | Description |
678
- | ---------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
679
- | `options` | `object` | ✅ | — | — | |
680
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action |
681
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
674
+ | Name | Type | Required | Default | Possible Values | Description |
675
+ | -------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
676
+ | `options` | `object` | ✅ | — | — | |
677
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
682
678
 
683
679
  **Returns:** `Promise<AppProxy>`
684
680
 
@@ -694,13 +690,12 @@ Execute an action with the given inputs for the bound app, as an alternative to
694
690
 
695
691
  **Parameters:**
696
692
 
697
- | Name | Type | Required | Default | Possible Values | Description |
698
- | ---------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
699
- | `options` | `object` | ✅ | — | — | |
700
- | ↳ `inputs` | `object` | ❌ | — | — | |
701
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action |
702
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
703
- | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
693
+ | Name | Type | Required | Default | Possible Values | Description |
694
+ | -------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
695
+ | `options` | `object` | ✅ | — | — | |
696
+ | ↳ `inputs` | `object` | ❌ | — | — | |
697
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
698
+ | ↳ `timeoutMs` | `number` | ❌ | — | — | Maximum time to wait for action completion in milliseconds (default: 180000) |
704
699
 
705
700
  **Returns:** `Promise<PaginatedResult<ActionResultItem>>`
706
701
 
@@ -730,10 +725,10 @@ Get detailed information about a specific app
730
725
 
731
726
  **Parameters:**
732
727
 
733
- | Name | Type | Required | Default | Possible Values | Description |
734
- | ---------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
735
- | `options` | `object` | ✅ | — | — | |
736
- | ↳ `appKey` | `string` | ✅ | — | — | App key of app to fetch (e.g., 'SlackCLIAPI' or slug like 'github') |
728
+ | Name | Type | Required | Default | Possible Values | Description |
729
+ | --------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------------------------------ |
730
+ | `options` | `object` | ✅ | — | — | |
731
+ | ↳ `app` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
737
732
 
738
733
  **Returns:** `Promise<AppItem>`
739
734
 
@@ -741,7 +736,7 @@ Get detailed information about a specific app
741
736
 
742
737
  ```typescript
743
738
  const { data: app } = await zapier.getApp({
744
- appKey: "example-key",
739
+ app: "example-value",
745
740
  });
746
741
  ```
747
742
 
@@ -754,9 +749,9 @@ List all available apps with optional filtering
754
749
  | Name | Type | Required | Default | Possible Values | Description |
755
750
  | ------------ | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------- |
756
751
  | `options` | `object` | ✅ | — | — | |
757
- | ↳ `appKeys` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
758
752
  | ↳ `search` | `string` | ❌ | — | — | Search term to filter apps by name |
759
753
  | ↳ `pageSize` | `number` | ❌ | — | — | Number of apps per page |
754
+ | ↳ `apps` | `array` | ❌ | — | — | Filter apps by app keys (e.g., 'SlackCLIAPI' or slug like 'github') |
760
755
  | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
761
756
  | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
762
757
 
@@ -871,8 +866,8 @@ Find the first connection matching the criteria
871
866
  | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
872
867
  | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
873
868
  | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
874
- | ↳ `appKey` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
875
- | ↳ `accountId` | `string` | ❌ | — | — | Account ID to filter by |
869
+ | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
870
+ | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
876
871
  | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
877
872
  | ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
878
873
 
@@ -896,8 +891,8 @@ Find a unique connection matching the criteria
896
891
  | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
897
892
  | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
898
893
  | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
899
- | ↳ `appKey` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
900
- | ↳ `accountId` | `string` | ❌ | — | — | Account ID to filter by |
894
+ | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
895
+ | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
901
896
  | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
902
897
  | ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
903
898
 
@@ -915,10 +910,10 @@ Execute getConnection
915
910
 
916
911
  **Parameters:**
917
912
 
918
- | Name | Type | Required | Default | Possible Values | Description |
919
- | ---------------- | ---------------- | -------- | ------- | --------------- | ------------------------------------ |
920
- | `options` | `object` | ✅ | — | — | |
921
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action |
913
+ | Name | Type | Required | Default | Possible Values | Description |
914
+ | -------------- | ---------------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------------------------------------- |
915
+ | `options` | `object` | ✅ | — | — | |
916
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
922
917
 
923
918
  **Returns:** `Promise<ConnectionItem>`
924
919
 
@@ -940,9 +935,9 @@ List available connections with optional filtering
940
935
  | ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
941
936
  | ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
942
937
  | ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID |
943
- | ↳ `appKey` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
944
- | ↳ `connectionIds` | `array` | ❌ | — | — | List of connection IDs to filter by |
945
- | ↳ `accountId` | `string` | ❌ | — | — | Account ID to filter by |
938
+ | ↳ `app` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github') |
939
+ | ↳ `connections` | `array` | ❌ | — | — | List of connection IDs to filter by |
940
+ | ↳ `account` | `string` | ❌ | — | — | Account to filter by |
946
941
  | ↳ `includeShared` | `boolean` | ❌ | — | — | Include connections shared with you. By default, only your own connections are returned (owner=me). Set to true to also include shared connections. |
947
942
  | ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
948
943
  | ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
@@ -976,16 +971,15 @@ Make authenticated HTTP requests to any API through Zapier. Pass a connectionId
976
971
 
977
972
  **Parameters:**
978
973
 
979
- | Name | Type | Required | Default | Possible Values | Description |
980
- | ---------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
981
- | `url` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
982
- | `init` | `object` | ❌ | — | — | Request options including method, headers, body, and authentication |
983
- | ↳ `method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
984
- | ↳ `headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
985
- | ↳ `body` | `string, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
986
- | ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action |
987
- | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
988
- | ↳ `callbackUrl` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
974
+ | Name | Type | Required | Default | Possible Values | Description |
975
+ | --------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
976
+ | `url` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service) |
977
+ | `init` | `object` | ❌ | — | — | Request options including method, headers, body, and authentication |
978
+ | ↳ `method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET) |
979
+ | ↳ `headers` | `object` | ❌ | — | — | HTTP headers to include in the request |
980
+ | ↳ `body` | `string, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly |
981
+ | ↳ `connection` | `string, number` | ❌ | — | — | Connection alias (string) or numeric connectionId. Strings are resolved from the connections map; numbers are used directly. |
982
+ | ↳ `callbackUrl` | `string` | ❌ | — | — | URL to send async response to (makes request async) |
989
983
 
990
984
  **Returns:** `Promise<Response>`
991
985
 
@@ -1025,11 +1019,11 @@ Create one or more fields in a table
1025
1019
 
1026
1020
  **Parameters:**
1027
1021
 
1028
- | Name | Type | Required | Default | Possible Values | Description |
1029
- | ----------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
1030
- | `options` | `object` | ✅ | — | — | |
1031
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1032
- | ↳ `fields` | `array` | ✅ | — | — | Array of field definitions to create |
1022
+ | Name | Type | Required | Default | Possible Values | Description |
1023
+ | ---------- | -------- | -------- | ------- | --------------- | ------------------------------------ |
1024
+ | `options` | `object` | ✅ | — | — | |
1025
+ | ↳ `fields` | `array` | ✅ | — | — | Array of field definitions to create |
1026
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1033
1027
 
1034
1028
  **Returns:** `Promise<any>`
1035
1029
 
@@ -1037,8 +1031,8 @@ Create one or more fields in a table
1037
1031
 
1038
1032
  ```typescript
1039
1033
  const result = await zapier.createTableFields({
1040
- tableId: "example-id",
1041
1034
  fields: ["example-item"],
1035
+ table: "example-value",
1042
1036
  });
1043
1037
  ```
1044
1038
 
@@ -1051,9 +1045,9 @@ Create one or more records in a table
1051
1045
  | Name | Type | Required | Default | Possible Values | Description |
1052
1046
  | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1053
1047
  | `options` | `object` | ✅ | — | — | |
1054
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1055
1048
  | ↳ `records` | `array` | ✅ | — | — | Array of records to create (max 100) |
1056
1049
  | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1050
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1057
1051
 
1058
1052
  **Returns:** `Promise<any>`
1059
1053
 
@@ -1061,8 +1055,8 @@ Create one or more records in a table
1061
1055
 
1062
1056
  ```typescript
1063
1057
  const result = await zapier.createTableRecords({
1064
- tableId: "example-id",
1065
1058
  records: ["example-item"],
1059
+ table: "example-value",
1066
1060
  });
1067
1061
  ```
1068
1062
 
@@ -1072,10 +1066,10 @@ Delete a table by its ID
1072
1066
 
1073
1067
  **Parameters:**
1074
1068
 
1075
- | Name | Type | Required | Default | Possible Values | Description |
1076
- | ----------- | -------- | -------- | ------- | --------------- | -------------------------------------------- |
1077
- | `options` | `object` | ✅ | — | — | |
1078
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table to delete |
1069
+ | Name | Type | Required | Default | Possible Values | Description |
1070
+ | --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1071
+ | `options` | `object` | ✅ | — | — | |
1072
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1079
1073
 
1080
1074
  **Returns:** `Promise<any>`
1081
1075
 
@@ -1083,7 +1077,7 @@ Delete a table by its ID
1083
1077
 
1084
1078
  ```typescript
1085
1079
  const result = await zapier.deleteTable({
1086
- tableId: "example-id",
1080
+ table: "example-value",
1087
1081
  });
1088
1082
  ```
1089
1083
 
@@ -1093,11 +1087,11 @@ Delete one or more fields from a table
1093
1087
 
1094
1088
  **Parameters:**
1095
1089
 
1096
- | Name | Type | Required | Default | Possible Values | Description |
1097
- | ------------- | -------- | -------- | ------- | --------------- | ------------------------------------------------------------------------------------- |
1098
- | `options` | `object` | ✅ | — | — | |
1099
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1100
- | ↳ `fieldKeys` | `array` | ✅ | — | — | Fields to delete. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1090
+ | Name | Type | Required | Default | Possible Values | Description |
1091
+ | ---------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1092
+ | `options` | `object` | ✅ | — | — | |
1093
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1094
+ | ↳ `fields` | `array` | ✅ | — | — | |
1101
1095
 
1102
1096
  **Returns:** `Promise<any>`
1103
1097
 
@@ -1105,8 +1099,8 @@ Delete one or more fields from a table
1105
1099
 
1106
1100
  ```typescript
1107
1101
  const result = await zapier.deleteTableFields({
1108
- tableId: "example-id",
1109
- fieldKeys: ["example-item"],
1102
+ table: "example-value",
1103
+ fields: ["example-item"],
1110
1104
  });
1111
1105
  ```
1112
1106
 
@@ -1116,11 +1110,11 @@ Delete one or more records from a table
1116
1110
 
1117
1111
  **Parameters:**
1118
1112
 
1119
- | Name | Type | Required | Default | Possible Values | Description |
1120
- | ------------- | -------- | -------- | ------- | --------------- | --------------------------------------- |
1121
- | `options` | `object` | ✅ | — | — | |
1122
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1123
- | ↳ `recordIds` | `array` | ✅ | — | — | Array of record IDs to delete (max 100) |
1113
+ | Name | Type | Required | Default | Possible Values | Description |
1114
+ | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1115
+ | `options` | `object` | ✅ | — | — | |
1116
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1117
+ | ↳ `records` | `array` | ✅ | — | — | Record IDs to operate on |
1124
1118
 
1125
1119
  **Returns:** `Promise<any>`
1126
1120
 
@@ -1128,8 +1122,8 @@ Delete one or more records from a table
1128
1122
 
1129
1123
  ```typescript
1130
1124
  const result = await zapier.deleteTableRecords({
1131
- tableId: "example-id",
1132
- recordIds: ["example-item"],
1125
+ table: "example-value",
1126
+ records: ["example-item"],
1133
1127
  });
1134
1128
  ```
1135
1129
 
@@ -1139,10 +1133,10 @@ Get detailed information about a specific table
1139
1133
 
1140
1134
  **Parameters:**
1141
1135
 
1142
- | Name | Type | Required | Default | Possible Values | Description |
1143
- | ----------- | -------- | -------- | ------- | --------------- | ---------------------------------------------- |
1144
- | `options` | `object` | ✅ | — | — | |
1145
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table to retrieve |
1136
+ | Name | Type | Required | Default | Possible Values | Description |
1137
+ | --------- | -------- | -------- | ------- | --------------- | ---------------------------------- |
1138
+ | `options` | `object` | ✅ | — | — | |
1139
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1146
1140
 
1147
1141
  **Returns:** `Promise<TableItem>`
1148
1142
 
@@ -1150,7 +1144,7 @@ Get detailed information about a specific table
1150
1144
 
1151
1145
  ```typescript
1152
1146
  const { data: table } = await zapier.getTable({
1153
- tableId: "example-id",
1147
+ table: "example-value",
1154
1148
  });
1155
1149
  ```
1156
1150
 
@@ -1160,12 +1154,12 @@ Get a single record from a table by ID
1160
1154
 
1161
1155
  **Parameters:**
1162
1156
 
1163
- | Name | Type | Required | Default | Possible Values | Description |
1164
- | ------------ | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1165
- | `options` | `object` | ✅ | — | — | |
1166
- | ↳ `tableId` | `string` | | | — | The unique identifier of the table |
1167
- | ↳ `recordId` | `string` | ✅ | — | — | The unique identifier of the record |
1168
- | ↳ `keyMode` | `string` | | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1157
+ | Name | Type | Required | Default | Possible Values | Description |
1158
+ | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1159
+ | `options` | `object` | ✅ | — | — | |
1160
+ | ↳ `keyMode` | `string` | | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1161
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1162
+ | ↳ `record` | `string` | | | — | The unique identifier of the record |
1169
1163
 
1170
1164
  **Returns:** `Promise<RecordItem>`
1171
1165
 
@@ -1173,8 +1167,8 @@ Get a single record from a table by ID
1173
1167
 
1174
1168
  ```typescript
1175
1169
  const { data: record } = await zapier.getTableRecord({
1176
- tableId: "example-id",
1177
- recordId: "example-id",
1170
+ table: "example-value",
1171
+ record: "example-value",
1178
1172
  });
1179
1173
  ```
1180
1174
 
@@ -1184,11 +1178,11 @@ List fields for a table
1184
1178
 
1185
1179
  **Parameters:**
1186
1180
 
1187
- | Name | Type | Required | Default | Possible Values | Description |
1188
- | ------------- | -------- | -------- | ------- | --------------- | ---------------------------------------------------------------------------------------------- |
1189
- | `options` | `object` | ✅ | — | — | |
1190
- | ↳ `tableId` | `string` | | — | — | The unique identifier of the table |
1191
- | ↳ `fieldKeys` | `array` | | — | — | Filter by specific fields. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1181
+ | Name | Type | Required | Default | Possible Values | Description |
1182
+ | ---------- | -------- | -------- | ------- | --------------- | ----------------------------------------------------------------------------------------- |
1183
+ | `options` | `object` | ✅ | — | — | |
1184
+ | ↳ `fields` | `array` | | — | — | Fields to operate on. Accepts field names (e.g., "Email") or IDs (e.g., "f6", "6", or 6). |
1185
+ | ↳ `table` | `string` | | — | — | The unique identifier of the table |
1192
1186
 
1193
1187
  **Returns:** `Promise<PaginatedResult<FieldItem>>`
1194
1188
 
@@ -1197,12 +1191,12 @@ List fields for a table
1197
1191
  ```typescript
1198
1192
  // Get first page and a cursor for the second page
1199
1193
  const { data: fields, nextCursor } = await zapier.listTableFields({
1200
- tableId: "example-id",
1194
+ table: "example-value",
1201
1195
  });
1202
1196
 
1203
1197
  // Or iterate over all pages
1204
1198
  for await (const page of zapier.listTableFields({
1205
- tableId: "example-id",
1199
+ table: "example-value",
1206
1200
  })) {
1207
1201
  // Do something with each page
1208
1202
  }
@@ -1210,7 +1204,7 @@ for await (const page of zapier.listTableFields({
1210
1204
  // Or iterate over individual items across all pages
1211
1205
  for await (const field of zapier
1212
1206
  .listTableFields({
1213
- tableId: "example-id",
1207
+ table: "example-value",
1214
1208
  })
1215
1209
  .items()) {
1216
1210
  // Do something with each field
@@ -1226,7 +1220,6 @@ List records in a table with optional filtering and sorting
1226
1220
  | Name | Type | Required | Default | Possible Values | Description |
1227
1221
  | ------------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1228
1222
  | `options` | `object` | ✅ | — | — | |
1229
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1230
1223
  | ↳ `filters` | `array` | ❌ | — | — | Filter conditions for the query |
1231
1224
  | ↳ `sort` | `object` | ❌ | — | — | Sort records by a field |
1232
1225
  | ↳ `fieldKey` | `string` | ✅ | — | — | The field key to sort by |
@@ -1235,6 +1228,7 @@ List records in a table with optional filtering and sorting
1235
1228
  | ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
1236
1229
  | ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
1237
1230
  | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1231
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1238
1232
 
1239
1233
  **Returns:** `Promise<PaginatedResult<RecordItem>>`
1240
1234
 
@@ -1243,12 +1237,12 @@ List records in a table with optional filtering and sorting
1243
1237
  ```typescript
1244
1238
  // Get first page and a cursor for the second page
1245
1239
  const { data: records, nextCursor } = await zapier.listTableRecords({
1246
- tableId: "example-id",
1240
+ table: "example-value",
1247
1241
  });
1248
1242
 
1249
1243
  // Or iterate over all pages
1250
1244
  for await (const page of zapier.listTableRecords({
1251
- tableId: "example-id",
1245
+ table: "example-value",
1252
1246
  })) {
1253
1247
  // Do something with each page
1254
1248
  }
@@ -1256,7 +1250,7 @@ for await (const page of zapier.listTableRecords({
1256
1250
  // Or iterate over individual items across all pages
1257
1251
  for await (const record of zapier
1258
1252
  .listTableRecords({
1259
- tableId: "example-id",
1253
+ table: "example-value",
1260
1254
  })
1261
1255
  .items()) {
1262
1256
  // Do something with each record
@@ -1272,7 +1266,7 @@ List tables available to the authenticated user
1272
1266
  | Name | Type | Required | Default | Possible Values | Description |
1273
1267
  | ----------------- | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
1274
1268
  | `options` | `object` | ✅ | — | — | |
1275
- | ↳ `tableIds` | `array` | ❌ | — | — | Filter by specific table IDs |
1269
+ | ↳ `tables` | `array` | ❌ | — | — | Filter by specific table IDs |
1276
1270
  | ↳ `kind` | `string` | ❌ | — | `table`, `virtual_table`, `both` | Filter by table type |
1277
1271
  | ↳ `search` | `string` | ❌ | — | — | Search term to filter tables by name |
1278
1272
  | ↳ `owner` | `string` | ❌ | — | — | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
@@ -1309,9 +1303,9 @@ Update one or more records in a table
1309
1303
  | Name | Type | Required | Default | Possible Values | Description |
1310
1304
  | ----------- | -------- | -------- | --------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------- |
1311
1305
  | `options` | `object` | ✅ | — | — | |
1312
- | ↳ `tableId` | `string` | ✅ | — | — | The unique identifier of the table |
1313
1306
  | ↳ `records` | `array` | ✅ | — | — | Array of records to update (max 100) |
1314
1307
  | ↳ `keyMode` | `string` | ❌ | `"names"` | — | How to interpret field keys in record data. "names" (default) uses human-readable field names, "ids" uses raw field IDs (f1, f2). |
1308
+ | ↳ `table` | `string` | ✅ | — | — | The unique identifier of the table |
1315
1309
 
1316
1310
  **Returns:** `Promise<any>`
1317
1311
 
@@ -1319,7 +1313,7 @@ Update one or more records in a table
1319
1313
 
1320
1314
  ```typescript
1321
1315
  const result = await zapier.updateTableRecords({
1322
- tableId: "example-id",
1323
1316
  records: ["example-item"],
1317
+ table: "example-value",
1324
1318
  });
1325
1319
  ```