@zapier/zapier-sdk 0.36.0 → 0.38.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.
- package/CHANGELOG.md +12 -0
- package/CLAUDE.md +50 -0
- package/README.md +147 -81
- package/dist/index.cjs +417 -166
- package/dist/index.d.mts +99 -13
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +5 -0
- package/dist/index.mjs +413 -167
- package/dist/plugins/apps/index.d.ts.map +1 -1
- package/dist/plugins/apps/index.js +61 -24
- package/dist/plugins/apps/schemas.d.ts +4 -1
- package/dist/plugins/apps/schemas.d.ts.map +1 -1
- package/dist/plugins/apps/schemas.js +4 -2
- package/dist/plugins/capabilities/index.d.ts +22 -0
- package/dist/plugins/capabilities/index.d.ts.map +1 -0
- package/dist/plugins/capabilities/index.js +76 -0
- package/dist/plugins/connections/index.d.ts +11 -0
- package/dist/plugins/connections/index.d.ts.map +1 -0
- package/dist/plugins/connections/index.js +21 -0
- package/dist/plugins/fetch/index.d.ts +4 -1
- package/dist/plugins/fetch/index.d.ts.map +1 -1
- package/dist/plugins/fetch/index.js +9 -3
- package/dist/plugins/fetch/schemas.d.ts +1 -0
- package/dist/plugins/fetch/schemas.d.ts.map +1 -1
- package/dist/plugins/fetch/schemas.js +2 -1
- package/dist/plugins/findFirstConnection/schemas.d.ts +1 -0
- package/dist/plugins/findFirstConnection/schemas.d.ts.map +1 -1
- package/dist/plugins/findUniqueConnection/schemas.d.ts +1 -0
- package/dist/plugins/findUniqueConnection/schemas.d.ts.map +1 -1
- package/dist/plugins/listConnections/index.d.ts +2 -1
- package/dist/plugins/listConnections/index.d.ts.map +1 -1
- package/dist/plugins/listConnections/index.js +10 -3
- package/dist/plugins/listConnections/schemas.d.ts +1 -0
- package/dist/plugins/listConnections/schemas.d.ts.map +1 -1
- package/dist/plugins/listConnections/schemas.js +5 -0
- package/dist/plugins/manifest/index.d.ts +3 -0
- package/dist/plugins/manifest/index.d.ts.map +1 -1
- package/dist/plugins/manifest/index.js +15 -6
- package/dist/plugins/manifest/schemas.d.ts +36 -7
- package/dist/plugins/manifest/schemas.d.ts.map +1 -1
- package/dist/plugins/manifest/schemas.js +17 -10
- package/dist/plugins/runAction/index.d.ts +2 -1
- package/dist/plugins/runAction/index.d.ts.map +1 -1
- package/dist/plugins/runAction/index.js +8 -3
- package/dist/plugins/runAction/schemas.d.ts +1 -0
- package/dist/plugins/runAction/schemas.d.ts.map +1 -1
- package/dist/plugins/runAction/schemas.js +2 -1
- package/dist/plugins/tables/deleteTable/index.d.ts +2 -1
- package/dist/plugins/tables/deleteTable/index.d.ts.map +1 -1
- package/dist/plugins/tables/deleteTable/index.js +1 -0
- package/dist/plugins/tables/listTables/index.d.ts +2 -1
- package/dist/plugins/tables/listTables/index.d.ts.map +1 -1
- package/dist/plugins/tables/listTables/index.js +14 -6
- package/dist/plugins/tables/listTables/schemas.d.ts +1 -0
- package/dist/plugins/tables/listTables/schemas.d.ts.map +1 -1
- package/dist/plugins/tables/listTables/schemas.js +5 -1
- package/dist/resolvers/connectionId.d.ts.map +1 -1
- package/dist/resolvers/connectionId.js +13 -23
- package/dist/resolvers/tableId.d.ts.map +1 -1
- package/dist/resolvers/tableId.js +17 -6
- package/dist/sdk.d.ts +6 -1
- package/dist/sdk.d.ts.map +1 -1
- package/dist/sdk.js +6 -0
- package/dist/types/connections.d.ts +19 -0
- package/dist/types/connections.d.ts.map +1 -0
- package/dist/types/connections.js +18 -0
- package/dist/types/properties.d.ts +2 -0
- package/dist/types/properties.d.ts.map +1 -1
- package/dist/types/properties.js +3 -0
- package/dist/types/sdk.d.ts +3 -0
- package/dist/types/sdk.d.ts.map +1 -1
- package/dist/types/sdk.js +9 -0
- package/dist/utils/domain-utils.d.ts +15 -0
- package/dist/utils/domain-utils.d.ts.map +1 -1
- package/dist/utils/domain-utils.js +30 -0
- package/dist/utils/pagination-utils.d.ts +6 -0
- package/dist/utils/pagination-utils.d.ts.map +1 -1
- package/dist/utils/pagination-utils.js +8 -0
- package/dist/utils/schema-utils.d.ts +6 -1
- package/dist/utils/schema-utils.d.ts.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,17 @@
|
|
|
1
1
|
# @zapier/zapier-sdk
|
|
2
2
|
|
|
3
|
+
## 0.38.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 2906101: Default `listConnections` and `listTables` to only return your own items. Gate shared access and table deletion behind boolean flags: `canIncludeSharedConnections`, `canIncludeSharedTables`, `canDeleteTables`. Set via SDK options, `.zapierrc`, CLI flags (`--can-delete-tables`), or env vars (`ZAPIER_CAN_DELETE_TABLES=true`).
|
|
8
|
+
|
|
9
|
+
## 0.37.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- 307aa98: Add named connections support. A new `connection` parameter on `runAction`, the apps proxy, and `fetch` resolves a connection alias (string) from a connections map, or accepts a numeric `connectionId` directly. The map is provided via the `connections` field in `.zapierrc` (or the inline `manifest` option on `createZapierSdk()`).
|
|
14
|
+
|
|
3
15
|
## 0.36.0
|
|
4
16
|
|
|
5
17
|
### Minor Changes
|
package/CLAUDE.md
CHANGED
|
@@ -237,6 +237,56 @@ Run `add` again when:
|
|
|
237
237
|
- An app has been updated and you want the latest fields
|
|
238
238
|
- You've deleted your generated types
|
|
239
239
|
|
|
240
|
+
## Named Connections
|
|
241
|
+
|
|
242
|
+
Named connections let you decouple workflow code from specific connection IDs. An external system (like an execution engine) provides the mapping via `.zapierrc`, and the workflow code references connections by name.
|
|
243
|
+
|
|
244
|
+
### Providing the Mapping
|
|
245
|
+
|
|
246
|
+
Connections are configured in `.zapierrc` alongside app version pins, or inline via the `manifest` option:
|
|
247
|
+
|
|
248
|
+
```typescript
|
|
249
|
+
const zapier = createZapierSdk({
|
|
250
|
+
manifest: {
|
|
251
|
+
apps: { slack: { implementationName: "SlackCLIAPI", version: "1.21.1" } },
|
|
252
|
+
connections: {
|
|
253
|
+
slack_work: { connectionId: 12345 },
|
|
254
|
+
google_sheets: { connectionId: 67890 },
|
|
255
|
+
},
|
|
256
|
+
},
|
|
257
|
+
});
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
### Using Named Connections
|
|
261
|
+
|
|
262
|
+
```typescript
|
|
263
|
+
// Per-call with alias
|
|
264
|
+
await zapier.apps.slack.read.channels({ connection: "slack_work" });
|
|
265
|
+
|
|
266
|
+
// Factory binding
|
|
267
|
+
const slack = zapier.apps.slack({ connection: "slack_work" });
|
|
268
|
+
await slack.read.channels({});
|
|
269
|
+
|
|
270
|
+
// Lower-level API
|
|
271
|
+
await zapier.runAction({
|
|
272
|
+
appKey: "slack",
|
|
273
|
+
actionType: "read",
|
|
274
|
+
actionKey: "channels",
|
|
275
|
+
connection: "slack_work",
|
|
276
|
+
});
|
|
277
|
+
|
|
278
|
+
// Direct connectionId also works
|
|
279
|
+
await zapier.apps.slack.read.channels({ connection: 12345 });
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
### Resolution Precedence
|
|
283
|
+
|
|
284
|
+
For `connectionId`: explicit `connectionId` > `connection` alias lookup (strings) or direct use (numbers) > factory binding > deprecated `authenticationId`.
|
|
285
|
+
|
|
286
|
+
App version is always resolved from the `.zapierrc` manifest, not from connections.
|
|
287
|
+
|
|
288
|
+
`connectionId` and `connection` are mutually exclusive in the same call.
|
|
289
|
+
|
|
240
290
|
## Error Handling
|
|
241
291
|
|
|
242
292
|
### Debugging
|
package/README.md
CHANGED
|
@@ -320,14 +320,72 @@ console.log(emojiData.emoji);
|
|
|
320
320
|
|
|
321
321
|
The `createZapierSdk(...)` factory function is the main entry point for the SDK. It provides methods for managing connections, listing apps, running actions, and more.
|
|
322
322
|
|
|
323
|
-
| Name
|
|
324
|
-
|
|
|
325
|
-
| `credentials`
|
|
326
|
-
| `debug`
|
|
327
|
-
| `baseUrl`
|
|
328
|
-
| `trackingBaseUrl`
|
|
329
|
-
| `maxNetworkRetries`
|
|
330
|
-
| `maxNetworkRetryDelayMs`
|
|
323
|
+
| Name | Type | Required | Default | Possible Values | Description |
|
|
324
|
+
| ----------------------------- | -------------------------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
325
|
+
| `credentials` | `string, object, function` | ❌ | — | — | Authentication credentials. Can be a string (token or API key), a client credentials object ({ clientId, clientSecret }), a PKCE object ({ clientId }), or a function returning any of those. |
|
|
326
|
+
| `debug` | `boolean` | ❌ | — | — | Enable debug logging. |
|
|
327
|
+
| `baseUrl` | `string` | ❌ | — | — | Base URL for Zapier API endpoints. |
|
|
328
|
+
| `trackingBaseUrl` | `string` | ❌ | — | — | Base URL for Zapier tracking endpoints. |
|
|
329
|
+
| `maxNetworkRetries` | `number` | ❌ | — | — | Max retries for rate-limited requests (default: 3). |
|
|
330
|
+
| `maxNetworkRetryDelayMs` | `number` | ❌ | — | — | Max delay in ms to wait for retry (default: 60000). |
|
|
331
|
+
| `canIncludeSharedConnections` | `boolean` | ❌ | — | — | Allow listing shared connections. |
|
|
332
|
+
| `canIncludeSharedTables` | `boolean` | ❌ | — | — | Allow listing shared tables. |
|
|
333
|
+
| `canDeleteTables` | `boolean` | ❌ | — | — | Allow deleting tables. |
|
|
334
|
+
|
|
335
|
+
## Named Connections
|
|
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.
|
|
338
|
+
|
|
339
|
+
This is useful when an execution engine or deployment system manages which connections a workflow should use.
|
|
340
|
+
|
|
341
|
+
### Providing the mapping
|
|
342
|
+
|
|
343
|
+
Connections are configured in `.zapierrc` alongside app version pins, or inline via the `manifest` option:
|
|
344
|
+
|
|
345
|
+
```typescript
|
|
346
|
+
const zapier = createZapierSdk({
|
|
347
|
+
manifest: {
|
|
348
|
+
apps: { slack: { implementationName: "SlackCLIAPI", version: "1.21.1" } },
|
|
349
|
+
connections: {
|
|
350
|
+
slack_work: { connectionId: 12345 },
|
|
351
|
+
google_sheets: { connectionId: 67890 },
|
|
352
|
+
},
|
|
353
|
+
},
|
|
354
|
+
});
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
Each connection entry maps a name to a `connectionId`. App version resolution is handled separately via the `apps` section of `.zapierrc`.
|
|
358
|
+
|
|
359
|
+
### Using named connections
|
|
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`.
|
|
362
|
+
|
|
363
|
+
```typescript
|
|
364
|
+
// Per-call with alias
|
|
365
|
+
await zapier.apps.slack.read.channels({ connection: "slack_work" });
|
|
366
|
+
|
|
367
|
+
// Factory binding
|
|
368
|
+
const slack = zapier.apps.slack({ connection: "slack_work" });
|
|
369
|
+
await slack.read.channels({});
|
|
370
|
+
|
|
371
|
+
// Lower-level runAction
|
|
372
|
+
await zapier.runAction({
|
|
373
|
+
appKey: "slack",
|
|
374
|
+
actionType: "read",
|
|
375
|
+
actionKey: "channels",
|
|
376
|
+
connection: "slack_work",
|
|
377
|
+
});
|
|
378
|
+
|
|
379
|
+
// Authenticated fetch
|
|
380
|
+
await zapier.fetch("https://slack.com/api/auth.test", {
|
|
381
|
+
connection: "slack_work",
|
|
382
|
+
});
|
|
383
|
+
|
|
384
|
+
// Direct connectionId also works
|
|
385
|
+
await zapier.apps.slack.read.channels({ connection: 12345 });
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
`connection` and `connectionId` are mutually exclusive in the same call. You can still use `connectionId` directly if you prefer.
|
|
331
389
|
|
|
332
390
|
## Available Functions
|
|
333
391
|
|
|
@@ -561,18 +619,19 @@ Execute an action with the given inputs
|
|
|
561
619
|
|
|
562
620
|
**Parameters:**
|
|
563
621
|
|
|
564
|
-
| Name | Type | Required | Default | Possible Values | Description
|
|
565
|
-
| ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- |
|
|
566
|
-
| `options` | `object` | ✅ | — | — |
|
|
567
|
-
| ↳ `appKey` | `string` | ✅ | — | — | App key (e.g., 'SlackCLIAPI' or slug like 'github')
|
|
568
|
-
| ↳ `actionType` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type
|
|
569
|
-
| ↳ `actionKey` | `string` | ✅ | — | — | Action key to execute
|
|
570
|
-
| ↳ `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.
|
|
571
|
-
| ↳ `
|
|
572
|
-
| ↳ `
|
|
573
|
-
| ↳ `
|
|
574
|
-
| ↳ `
|
|
575
|
-
| ↳ `
|
|
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 |
|
|
576
635
|
|
|
577
636
|
**Returns:** `Promise<PaginatedResult<ActionResultItem>>`
|
|
578
637
|
|
|
@@ -611,14 +670,15 @@ for await (const actionResult of zapier
|
|
|
611
670
|
|
|
612
671
|
#### `apps.{appKey}`
|
|
613
672
|
|
|
614
|
-
Bind a connection
|
|
673
|
+
Bind a connection alias or numeric connectionId to an app
|
|
615
674
|
|
|
616
675
|
**Parameters:**
|
|
617
676
|
|
|
618
|
-
| Name | Type | Required | Default | Possible Values | Description
|
|
619
|
-
| ---------------- | ---------------- | -------- | ------- | --------------- |
|
|
620
|
-
| `options` | `object` | ✅ | — | — |
|
|
621
|
-
| ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action
|
|
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. |
|
|
622
682
|
|
|
623
683
|
**Returns:** `Promise<AppProxy>`
|
|
624
684
|
|
|
@@ -634,12 +694,13 @@ Execute an action with the given inputs for the bound app, as an alternative to
|
|
|
634
694
|
|
|
635
695
|
**Parameters:**
|
|
636
696
|
|
|
637
|
-
| Name | Type | Required | Default | Possible Values | Description
|
|
638
|
-
| ---------------- | ---------------- | -------- | ------- | --------------- |
|
|
639
|
-
| `options` | `object` | ✅ | — | — |
|
|
640
|
-
| ↳ `inputs` | `object` | ❌ | — | — |
|
|
641
|
-
| ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action
|
|
642
|
-
| ↳ `
|
|
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) |
|
|
643
704
|
|
|
644
705
|
**Returns:** `Promise<PaginatedResult<ActionResultItem>>`
|
|
645
706
|
|
|
@@ -804,15 +865,16 @@ Find the first connection matching the criteria
|
|
|
804
865
|
|
|
805
866
|
**Parameters:**
|
|
806
867
|
|
|
807
|
-
| Name
|
|
808
|
-
|
|
|
809
|
-
| `options`
|
|
810
|
-
| ↳ `search`
|
|
811
|
-
| ↳ `title`
|
|
812
|
-
| ↳ `owner`
|
|
813
|
-
| ↳ `appKey`
|
|
814
|
-
| ↳ `accountId`
|
|
815
|
-
| ↳ `
|
|
868
|
+
| Name | Type | Required | Default | Possible Values | Description |
|
|
869
|
+
| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
870
|
+
| `options` | `object` | ✅ | — | — | |
|
|
871
|
+
| ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
872
|
+
| ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
873
|
+
| ↳ `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 |
|
|
876
|
+
| ↳ `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
|
+
| ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
816
878
|
|
|
817
879
|
**Returns:** `Promise<ConnectionItem>`
|
|
818
880
|
|
|
@@ -828,15 +890,16 @@ Find a unique connection matching the criteria
|
|
|
828
890
|
|
|
829
891
|
**Parameters:**
|
|
830
892
|
|
|
831
|
-
| Name
|
|
832
|
-
|
|
|
833
|
-
| `options`
|
|
834
|
-
| ↳ `search`
|
|
835
|
-
| ↳ `title`
|
|
836
|
-
| ↳ `owner`
|
|
837
|
-
| ↳ `appKey`
|
|
838
|
-
| ↳ `accountId`
|
|
839
|
-
| ↳ `
|
|
893
|
+
| Name | Type | Required | Default | Possible Values | Description |
|
|
894
|
+
| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
895
|
+
| `options` | `object` | ✅ | — | — | |
|
|
896
|
+
| ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
897
|
+
| ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
898
|
+
| ↳ `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 |
|
|
901
|
+
| ↳ `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
|
+
| ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
840
903
|
|
|
841
904
|
**Returns:** `Promise<ConnectionItem>`
|
|
842
905
|
|
|
@@ -871,19 +934,20 @@ List available connections with optional filtering
|
|
|
871
934
|
|
|
872
935
|
**Parameters:**
|
|
873
936
|
|
|
874
|
-
| Name | Type | Required | Default | Possible Values | Description
|
|
875
|
-
| ----------------- | --------- | -------- | ------- | --------------- |
|
|
876
|
-
| `options` | `object` | ✅ | — | — |
|
|
877
|
-
| ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title
|
|
878
|
-
| ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally)
|
|
879
|
-
| ↳ `owner` | `string` | ❌ | — | — | Filter by owner, 'me' for your own connections or a specific user ID
|
|
880
|
-
| ↳ `appKey` | `string` | ❌ | — | — | App key of connections to list (e.g., 'SlackCLIAPI' or slug like 'github')
|
|
881
|
-
| ↳ `connectionIds` | `array` | ❌ | — | — | List of connection IDs to filter by
|
|
882
|
-
| ↳ `accountId` | `string` | ❌ | — | — | Account ID to filter by
|
|
883
|
-
| ↳ `
|
|
884
|
-
| ↳ `
|
|
885
|
-
| ↳ `
|
|
886
|
-
| ↳ `
|
|
937
|
+
| Name | Type | Required | Default | Possible Values | Description |
|
|
938
|
+
| ----------------- | --------- | -------- | ------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
939
|
+
| `options` | `object` | ✅ | — | — | |
|
|
940
|
+
| ↳ `search` | `string` | ❌ | — | — | Search term to filter connections by title |
|
|
941
|
+
| ↳ `title` | `string` | ❌ | — | — | Filter connections by exact title match (searches first, then filters locally) |
|
|
942
|
+
| ↳ `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 |
|
|
946
|
+
| ↳ `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
|
+
| ↳ `isExpired` | `boolean` | ❌ | — | — | Filter by expired status |
|
|
948
|
+
| ↳ `pageSize` | `number` | ❌ | — | — | Number of connections per page |
|
|
949
|
+
| ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
950
|
+
| ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
887
951
|
|
|
888
952
|
**Returns:** `Promise<PaginatedResult<ConnectionItem>>`
|
|
889
953
|
|
|
@@ -912,15 +976,16 @@ Make authenticated HTTP requests to any API through Zapier. Pass a connectionId
|
|
|
912
976
|
|
|
913
977
|
**Parameters:**
|
|
914
978
|
|
|
915
|
-
| Name | Type | Required | Default | Possible Values | Description
|
|
916
|
-
| ---------------- | ------------------------ | -------- | ------- | ---------------------------------------------------------- |
|
|
917
|
-
| `url` | `string, custom` | ✅ | — | — | The full URL of the API endpoint to call (proxied through Zapier's Relay service)
|
|
918
|
-
| `init` | `object` | ❌ | — | — | Request options including method, headers, body, and authentication
|
|
919
|
-
| ↳ `method` | `string` | ❌ | — | `GET`, `POST`, `PUT`, `DELETE`, `PATCH`, `HEAD`, `OPTIONS` | HTTP method for the request (defaults to GET)
|
|
920
|
-
| ↳ `headers` | `object` | ❌ | — | — | HTTP headers to include in the request
|
|
921
|
-
| ↳ `body` | `string, custom, record` | ❌ | — | — | Request body — plain objects and JSON strings are auto-detected and Content-Type is set accordingly
|
|
922
|
-
| ↳ `connectionId` | `string, number` | ❌ | — | — | Connection ID to use for this action
|
|
923
|
-
| ↳ `
|
|
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) |
|
|
924
989
|
|
|
925
990
|
**Returns:** `Promise<Response>`
|
|
926
991
|
|
|
@@ -1204,16 +1269,17 @@ List tables available to the authenticated user
|
|
|
1204
1269
|
|
|
1205
1270
|
**Parameters:**
|
|
1206
1271
|
|
|
1207
|
-
| Name
|
|
1208
|
-
|
|
|
1209
|
-
| `options`
|
|
1210
|
-
| ↳ `tableIds`
|
|
1211
|
-
| ↳ `kind`
|
|
1212
|
-
| ↳ `search`
|
|
1213
|
-
| ↳ `owner`
|
|
1214
|
-
| ↳ `
|
|
1215
|
-
| ↳ `
|
|
1216
|
-
| ↳ `
|
|
1272
|
+
| Name | Type | Required | Default | Possible Values | Description |
|
|
1273
|
+
| ----------------- | --------- | -------- | ------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
|
1274
|
+
| `options` | `object` | ✅ | — | — | |
|
|
1275
|
+
| ↳ `tableIds` | `array` | ❌ | — | — | Filter by specific table IDs |
|
|
1276
|
+
| ↳ `kind` | `string` | ❌ | — | `table`, `virtual_table`, `both` | Filter by table type |
|
|
1277
|
+
| ↳ `search` | `string` | ❌ | — | — | Search term to filter tables by name |
|
|
1278
|
+
| ↳ `owner` | `string` | ❌ | — | — | Filter by table owner. Use "me" for the current user, or a numeric user ID. Requires includeShared to be true. |
|
|
1279
|
+
| ↳ `includeShared` | `boolean` | ❌ | — | — | Include tables shared with you. Without this, only your own tables are returned. |
|
|
1280
|
+
| ↳ `pageSize` | `number` | ❌ | — | — | Number of tables per page |
|
|
1281
|
+
| ↳ `maxItems` | `number` | ❌ | — | — | Maximum total items to return across all pages |
|
|
1282
|
+
| ↳ `cursor` | `string` | ❌ | — | — | Cursor to start from |
|
|
1217
1283
|
|
|
1218
1284
|
**Returns:** `Promise<PaginatedResult<TableItem>>`
|
|
1219
1285
|
|