@zapier/zapier-sdk-cli 0.70.0 → 0.71.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 +20 -0
- package/README.md +40 -0
- package/dist/cli.cjs +2 -2
- package/dist/cli.mjs +2 -2
- package/dist/experimental.cjs +1 -1
- package/dist/experimental.mjs +1 -1
- package/dist/index.cjs +2 -2
- package/dist/index.mjs +2 -2
- package/package.json +3 -3
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,25 @@
|
|
|
1
1
|
# @zapier/zapier-sdk-cli
|
|
2
2
|
|
|
3
|
+
## 0.71.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- d700196: Added `createActionRun` and `getActionRun`, the two halves of `runAction` as separately callable methods:
|
|
8
|
+
- `createActionRun({ app, actionType, action, connection?, inputs?, page?, callbackUrl? })` — starts an action run and returns `{ id, implementation_id }` right away, without waiting for it to finish. `implementation_id` is the versioned implementation the run was started against, matching `implementation_id` on an app from `getApp` / `listApps`.
|
|
9
|
+
- `getActionRun({ run })` — returns that run's state: `{ id, status, results, errors, next_page? }`. It is a point-in-time read that answers immediately, so a run that is still executing comes back with `status: "waiting"` and it is up to the caller to check again. Unlike `runAction`, a failed run is reported as `status: "error"` with the details in `errors` rather than thrown.
|
|
10
|
+
|
|
11
|
+
To page a bulk read, pass the `next_page` from `getActionRun` back as the `page` for the next `createActionRun`. The pair uses the same page terminology in both directions, and `next_page` is always a string so it can be handed straight back. `runAction` is a paginated list method, so it keeps the SDK's usual `cursor` / `nextCursor` pair.
|
|
12
|
+
|
|
13
|
+
Pass `callbackUrl` to `createActionRun` to skip polling altogether: Zapier posts the finished run to that URL. It must use HTTPS and resolve to a public host. The delivered body matches what `getActionRun` returns, and carries a `Zapier-Callback-Signature` header holding an RS256 JWT you can verify against `https://zapier.com/.well-known/jwks.json`. Delivery is retried, so the same run can arrive more than once.
|
|
14
|
+
|
|
15
|
+
`runAction` is unchanged and is still the right call for most cases — it starts a run and waits for the result in one step. Reach for the pair when you don't want to block on the result: fan out many runs and collect them later, hand a run ID to another process, or pick a run back up after a restart. Run results are retained for seven days.
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- Updated dependencies [d700196]
|
|
20
|
+
- @zapier/zapier-sdk@0.94.0
|
|
21
|
+
- @zapier/zapier-sdk-mcp@0.19.0
|
|
22
|
+
|
|
3
23
|
## 0.70.0
|
|
4
24
|
|
|
5
25
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -13,8 +13,10 @@
|
|
|
13
13
|
- [`logout`](#logout)
|
|
14
14
|
- [`signup`](#signup)
|
|
15
15
|
- [Actions](#actions)
|
|
16
|
+
- [`create-action-run`](#create-action-run)
|
|
16
17
|
- [`get-action`](#get-action)
|
|
17
18
|
- [`get-action-input-fields-schema`](#get-action-input-fields-schema)
|
|
19
|
+
- [`get-action-run`](#get-action-run)
|
|
18
20
|
- [`list-action-input-field-choices`](#list-action-input-field-choices)
|
|
19
21
|
- [`list-action-input-fields`](#list-action-input-fields)
|
|
20
22
|
- [`list-actions`](#list-actions)
|
|
@@ -264,6 +266,28 @@ npx zapier-sdk signup [--timeout] [--use-approvals] [--non-interactive] [--headl
|
|
|
264
266
|
|
|
265
267
|
### Actions
|
|
266
268
|
|
|
269
|
+
#### `create-action-run`
|
|
270
|
+
|
|
271
|
+
Start an action run and return its ID without waiting for the result. Running an action is asynchronous: this hands back a run ID immediately, and `getActionRun` fetches the outcome. Reach for this pair when you want to start work and collect it later (fan out many runs, hand the ID to another process, survive a restart). `runAction` is the one-call form that starts a run and waits for its result.
|
|
272
|
+
|
|
273
|
+
**Options:**
|
|
274
|
+
|
|
275
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
276
|
+
| ---------------- | ---------------- | -------- | ------- | ---------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
277
|
+
| `<app>` | `string` | ✅ | — | — | App slug (e.g., 'github'), implementation name (e.g., 'SlackCLIAPI'), or versioned ID (e.g., 'github@1.2.3') |
|
|
278
|
+
| `<action-type>` | `string` | ✅ | — | `read`, `read_bulk`, `write`, `run`, `search`, `search_or_write`, `search_and_write`, `filter` | Action type that matches the action's defined type |
|
|
279
|
+
| `<action>` | `string` | ✅ | — | — | Action key (e.g., 'send_message' or 'find_row') |
|
|
280
|
+
| `--connection` | `string, number` | ❌ | — | — | Connection alias or connection ID (UUID or positive integer). Required if the action needs a connection to authenticate and interact with the service. Strings that match a key in the connections map are resolved against it; otherwise the value is used as a connection ID directly. |
|
|
281
|
+
| `--inputs` | `object` | ❌ | — | — | Input parameters for the action |
|
|
282
|
+
| `--page` | `string` | ❌ | — | — | Page to fetch for bulk read actions. Pass the `next_page` a previous run returned to fetch the following page. |
|
|
283
|
+
| `--callback-url` | `string` | ❌ | — | — | URL Zapier posts the finished run to, so you do not have to poll for it. Must use HTTPS and resolve to a public host, so a local receiver needs a tunnel. The body matches what `getActionRun` returns. Verify the `Zapier-Callback-Signature` header, and expect the same run to arrive more than once. |
|
|
284
|
+
|
|
285
|
+
**Usage:**
|
|
286
|
+
|
|
287
|
+
```bash
|
|
288
|
+
npx zapier-sdk create-action-run <app> <action-type> <action> [--connection] [--inputs] [--page] [--callback-url]
|
|
289
|
+
```
|
|
290
|
+
|
|
267
291
|
#### `get-action`
|
|
268
292
|
|
|
269
293
|
Get detailed information about a specific action
|
|
@@ -302,6 +326,22 @@ Get the JSON Schema representation of input fields for an action. Returns a JSON
|
|
|
302
326
|
npx zapier-sdk get-action-input-fields-schema <app> <action-type> <action> [--connection] [--inputs]
|
|
303
327
|
```
|
|
304
328
|
|
|
329
|
+
#### `get-action-run`
|
|
330
|
+
|
|
331
|
+
Fetch the current state of an action run started by `createActionRun`. This is a point-in-time read that returns immediately: a run Zapier has not finished executing comes back with status `waiting`, so call again to check for a result. `runAction` starts a run and waits for its result in one call. Results are stored for seven days after the run was created.
|
|
332
|
+
|
|
333
|
+
**Options:**
|
|
334
|
+
|
|
335
|
+
| Option | Type | Required | Default | Possible Values | Description |
|
|
336
|
+
| ------- | -------- | -------- | ------- | --------------- | ------------------------------------------- |
|
|
337
|
+
| `<run>` | `string` | ✅ | — | — | Action run ID returned by `createActionRun` |
|
|
338
|
+
|
|
339
|
+
**Usage:**
|
|
340
|
+
|
|
341
|
+
```bash
|
|
342
|
+
npx zapier-sdk get-action-run <run>
|
|
343
|
+
```
|
|
344
|
+
|
|
305
345
|
#### `list-action-input-field-choices`
|
|
306
346
|
|
|
307
347
|
Get the available choices for a dynamic dropdown input field
|
package/dist/cli.cjs
CHANGED
|
@@ -602,7 +602,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
|
|
|
602
602
|
|
|
603
603
|
// package.json
|
|
604
604
|
var package_default = {
|
|
605
|
-
version: "0.
|
|
605
|
+
version: "0.71.0"};
|
|
606
606
|
var PACKAGE_MANAGERS = ["npm", "pnpm", "yarn", "bun"];
|
|
607
607
|
var LOCKFILES = [
|
|
608
608
|
["pnpm-lock.yaml", "pnpm"],
|
|
@@ -8341,7 +8341,7 @@ function buildBoxLines(message) {
|
|
|
8341
8341
|
// package.json with { type: 'json' }
|
|
8342
8342
|
var package_default2 = {
|
|
8343
8343
|
name: "@zapier/zapier-sdk-cli",
|
|
8344
|
-
version: "0.
|
|
8344
|
+
version: "0.71.0"};
|
|
8345
8345
|
|
|
8346
8346
|
// src/sdk.ts
|
|
8347
8347
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
package/dist/cli.mjs
CHANGED
|
@@ -558,7 +558,7 @@ var SHARED_COMMAND_CLI_OPTIONS = [
|
|
|
558
558
|
|
|
559
559
|
// package.json
|
|
560
560
|
var package_default = {
|
|
561
|
-
version: "0.
|
|
561
|
+
version: "0.71.0"};
|
|
562
562
|
var PACKAGE_MANAGERS = ["npm", "pnpm", "yarn", "bun"];
|
|
563
563
|
var LOCKFILES = [
|
|
564
564
|
["pnpm-lock.yaml", "pnpm"],
|
|
@@ -8297,7 +8297,7 @@ function buildBoxLines(message) {
|
|
|
8297
8297
|
// package.json with { type: 'json' }
|
|
8298
8298
|
var package_default2 = {
|
|
8299
8299
|
name: "@zapier/zapier-sdk-cli",
|
|
8300
|
-
version: "0.
|
|
8300
|
+
version: "0.71.0"};
|
|
8301
8301
|
|
|
8302
8302
|
// src/sdk.ts
|
|
8303
8303
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
package/dist/experimental.cjs
CHANGED
|
@@ -6861,7 +6861,7 @@ function collectDeprecationNoticeAndForward(event, onEvent) {
|
|
|
6861
6861
|
// package.json with { type: 'json' }
|
|
6862
6862
|
var package_default = {
|
|
6863
6863
|
name: "@zapier/zapier-sdk-cli",
|
|
6864
|
-
version: "0.
|
|
6864
|
+
version: "0.71.0"};
|
|
6865
6865
|
|
|
6866
6866
|
// src/sdk.ts
|
|
6867
6867
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
package/dist/experimental.mjs
CHANGED
|
@@ -6820,7 +6820,7 @@ function collectDeprecationNoticeAndForward(event, onEvent) {
|
|
|
6820
6820
|
// package.json with { type: 'json' }
|
|
6821
6821
|
var package_default = {
|
|
6822
6822
|
name: "@zapier/zapier-sdk-cli",
|
|
6823
|
-
version: "0.
|
|
6823
|
+
version: "0.71.0"};
|
|
6824
6824
|
|
|
6825
6825
|
// src/sdk.ts
|
|
6826
6826
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
package/dist/index.cjs
CHANGED
|
@@ -6862,7 +6862,7 @@ function collectDeprecationNoticeAndForward(event, onEvent) {
|
|
|
6862
6862
|
// package.json with { type: 'json' }
|
|
6863
6863
|
var package_default = {
|
|
6864
6864
|
name: "@zapier/zapier-sdk-cli",
|
|
6865
|
-
version: "0.
|
|
6865
|
+
version: "0.71.0"};
|
|
6866
6866
|
|
|
6867
6867
|
// src/sdk.ts
|
|
6868
6868
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
|
@@ -6946,7 +6946,7 @@ function createZapierCliSdk(options = {}) {
|
|
|
6946
6946
|
|
|
6947
6947
|
// package.json
|
|
6948
6948
|
var package_default2 = {
|
|
6949
|
-
version: "0.
|
|
6949
|
+
version: "0.71.0"};
|
|
6950
6950
|
|
|
6951
6951
|
// src/telemetry/builders.ts
|
|
6952
6952
|
function createCliBaseEvent(context = {}) {
|
package/dist/index.mjs
CHANGED
|
@@ -6821,7 +6821,7 @@ function collectDeprecationNoticeAndForward(event, onEvent) {
|
|
|
6821
6821
|
// package.json with { type: 'json' }
|
|
6822
6822
|
var package_default = {
|
|
6823
6823
|
name: "@zapier/zapier-sdk-cli",
|
|
6824
|
-
version: "0.
|
|
6824
|
+
version: "0.71.0"};
|
|
6825
6825
|
|
|
6826
6826
|
// src/sdk.ts
|
|
6827
6827
|
var warnedDeprecatedMethods = /* @__PURE__ */ new Set();
|
|
@@ -6905,7 +6905,7 @@ function createZapierCliSdk(options = {}) {
|
|
|
6905
6905
|
|
|
6906
6906
|
// package.json
|
|
6907
6907
|
var package_default2 = {
|
|
6908
|
-
version: "0.
|
|
6908
|
+
version: "0.71.0"};
|
|
6909
6909
|
|
|
6910
6910
|
// src/telemetry/builders.ts
|
|
6911
6911
|
function createCliBaseEvent(context = {}) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zapier/zapier-sdk-cli",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.71.0",
|
|
4
4
|
"description": "Command line interface for Zapier SDK",
|
|
5
5
|
"main": "dist/index.cjs",
|
|
6
6
|
"module": "dist/index.mjs",
|
|
@@ -95,8 +95,8 @@
|
|
|
95
95
|
"typescript": "^5.8.3",
|
|
96
96
|
"wrap-ansi": "^10.0.0",
|
|
97
97
|
"zod": "4.3.6",
|
|
98
|
-
"@zapier/zapier-sdk": "0.
|
|
99
|
-
"@zapier/zapier-sdk-mcp": "0.
|
|
98
|
+
"@zapier/zapier-sdk": "0.94.0",
|
|
99
|
+
"@zapier/zapier-sdk-mcp": "0.19.0"
|
|
100
100
|
},
|
|
101
101
|
"devDependencies": {
|
|
102
102
|
"@types/cross-spawn": "^6.0.6",
|