diff --git a/docs/cli.html b/docs/cli.html index ef0354646..d48bdd3d5 100644 --- a/docs/cli.html +++ b/docs/cli.html @@ -434,8 +434,8 @@

canary:list

List all active canary deployments

Usage: zapier canary:list

Flags

Examples

@@ -567,8 +567,8 @@

describe

  • Resource: the resource (if any) this action is tied to
  • Available Methods: testable methods for this action
  • Flags

    @@ -592,8 +592,8 @@

    env:get

    Usage: zapier env:get VERSION

    Arguments

    Flags

    Examples

    @@ -671,8 +671,8 @@

    history

    Get the history of your integration.

    Usage: zapier history

    History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.

    Flags

    @@ -722,8 +722,8 @@

    integrations

    List integrations you have admin access to.

    Usage: zapier integrations

    This command also checks the current directory for a linked integration.

    Flags

    Aliases

    @@ -842,8 +842,8 @@

    jobs

    Lists ongoing migration or promotion jobs for the current integration.

    Usage: zapier jobs

    A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.

    Each job will be added to the end of a queue of "promote" and "migration" jobs where the "Job Stage" will then be initialized with "requested".

    Job stages will then move to "estimating", "in_progress" and finally one of four "end" stages: "complete", "aborted", "errored" or "paused".

    Job times will vary as it depends on the size of the queue and how many users your integration has.

    Jobs are returned from oldest to newest.

    Flags

    Examples

    @@ -940,8 +940,8 @@

    logs

  • --detailed | See extra info, like request/response body and headers.
  • -u, --user | Only show logs for this user. Defaults to your account. Defaults to me.
  • --limit | Cap the number of logs returned. Max is 50 (also the default) Defaults to 50.
  • -
  • -f, --format | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]. Defaults to table.
  • -d, --debug | Show extra debugging output.
  • +
  • -f, --format | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]. Defaults to table.
  • @@ -1196,8 +1196,8 @@

    team:get

  • collaborator, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.
  • subscriber, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.
  • Use the zapier team:add and zapier team:remove commands to modify your team.

    Flags

    Aliases

    @@ -1329,8 +1329,8 @@

    users:get

    Get a list of users who have been invited to your integration.

    Usage: zapier users:get

    Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the zapier users:add command or the web UI). Users who joined by clicking links generated using the zapier user:links command won't show up here.

    Flags

    Aliases

    @@ -1354,8 +1354,8 @@

    Get a list of links that are used to invite users to your integration.

    Usage: zapier users:links

    Flags

    @@ -1405,8 +1405,8 @@

    validate

    Validate your integration.

    Usage: zapier validate

    Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during zapier build, zapier upload, zapier push or even as a test in zapier test.

    Flags

    Examples

    diff --git a/docs/cli.md b/docs/cli.md index 7baebca81..b710525f2 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -94,8 +94,8 @@ Note: this is similar to `zapier migrate` but different in that this is temporar **Usage**: `zapier canary:list` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier canary:list` @@ -193,8 +193,8 @@ resources convert and relate to different actions. * **Available Methods**: testable methods for this action **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## env:get @@ -207,8 +207,8 @@ resources convert and relate to different actions. * (required) `version` | The version to get the environment for. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier env:get 1.2.3` @@ -257,8 +257,8 @@ resources convert and relate to different actions. History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## init @@ -292,8 +292,8 @@ This doesn't register or deploy the integration with Zapier - try the `zapier re This command also checks the current directory for a linked integration. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `apps` @@ -409,8 +409,8 @@ Jobs are returned from oldest to newest. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier jobs` @@ -468,8 +468,8 @@ This won't show logs from running locally with `zapier test`, since those never * `--detailed` | See extra info, like request/response body and headers. * `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`. * `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`. -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## migrate @@ -696,8 +696,8 @@ Use the `zapier team:add` and `zapier team:remove` commands to modify your team. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `team:list` @@ -792,8 +792,8 @@ Invited users will be able to see your integration's name, logo, and description Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `zapier users:add` command or the web UI). Users who joined by clicking links generated using the `zapier user:links` command won't show up here. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `users:list` @@ -806,8 +806,8 @@ Note that this list of users is NOT a comprehensive list of everyone who is usin **Usage**: `zapier users:links` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## users:remove @@ -839,8 +839,8 @@ Run the standard validation routine powered by json-schema that checks your inte **Flags** * `--without-style` | Forgo pinging the Zapier server to run further checks. -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier validate` @@ -855,5 +855,5 @@ Run the standard validation routine powered by json-schema that checks your inte **Usage**: `zapier versions` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. diff --git a/packages/cli/docs/cli.html b/packages/cli/docs/cli.html index ef0354646..d48bdd3d5 100644 --- a/packages/cli/docs/cli.html +++ b/packages/cli/docs/cli.html @@ -434,8 +434,8 @@

    canary:list

    List all active canary deployments

    Usage: zapier canary:list

    Flags

    Examples

    @@ -567,8 +567,8 @@

    describe

  • Resource: the resource (if any) this action is tied to
  • Available Methods: testable methods for this action
  • Flags

    @@ -592,8 +592,8 @@

    env:get

    Usage: zapier env:get VERSION

    Arguments

    Flags

    Examples

    @@ -671,8 +671,8 @@

    history

    Get the history of your integration.

    Usage: zapier history

    History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when.

    Flags

    @@ -722,8 +722,8 @@

    integrations

    List integrations you have admin access to.

    Usage: zapier integrations

    This command also checks the current directory for a linked integration.

    Flags

    Aliases

    @@ -842,8 +842,8 @@

    jobs

    Lists ongoing migration or promotion jobs for the current integration.

    Usage: zapier jobs

    A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.

    Each job will be added to the end of a queue of "promote" and "migration" jobs where the "Job Stage" will then be initialized with "requested".

    Job stages will then move to "estimating", "in_progress" and finally one of four "end" stages: "complete", "aborted", "errored" or "paused".

    Job times will vary as it depends on the size of the queue and how many users your integration has.

    Jobs are returned from oldest to newest.

    Flags

    Examples

    @@ -940,8 +940,8 @@

    logs

  • --detailed | See extra info, like request/response body and headers.
  • -u, --user | Only show logs for this user. Defaults to your account. Defaults to me.
  • --limit | Cap the number of logs returned. Max is 50 (also the default) Defaults to 50.
  • -
  • -f, --format | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]. Defaults to table.
  • -d, --debug | Show extra debugging output.
  • +
  • -f, --format | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of [plain | json | raw | row | table]. Defaults to table.
  • @@ -1196,8 +1196,8 @@

    team:get

  • collaborator, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.
  • subscriber, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.
  • Use the zapier team:add and zapier team:remove commands to modify your team.

    Flags

    Aliases

    @@ -1329,8 +1329,8 @@

    users:get

    Get a list of users who have been invited to your integration.

    Usage: zapier users:get

    Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the zapier users:add command or the web UI). Users who joined by clicking links generated using the zapier user:links command won't show up here.

    Flags

    Aliases

    @@ -1354,8 +1354,8 @@

    Get a list of links that are used to invite users to your integration.

    Usage: zapier users:links

    Flags

    @@ -1405,8 +1405,8 @@

    validate

    Validate your integration.

    Usage: zapier validate

    Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during zapier build, zapier upload, zapier push or even as a test in zapier test.

    Flags

    Examples

    diff --git a/packages/cli/docs/cli.md b/packages/cli/docs/cli.md index 7baebca81..b710525f2 100644 --- a/packages/cli/docs/cli.md +++ b/packages/cli/docs/cli.md @@ -94,8 +94,8 @@ Note: this is similar to `zapier migrate` but different in that this is temporar **Usage**: `zapier canary:list` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier canary:list` @@ -193,8 +193,8 @@ resources convert and relate to different actions. * **Available Methods**: testable methods for this action **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## env:get @@ -207,8 +207,8 @@ resources convert and relate to different actions. * (required) `version` | The version to get the environment for. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier env:get 1.2.3` @@ -257,8 +257,8 @@ resources convert and relate to different actions. History includes all the changes made over the lifetime of your integration. This includes everything from creation, updates, migrations, admins, and invitee changes, as well as who made the change and when. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## init @@ -292,8 +292,8 @@ This doesn't register or deploy the integration with Zapier - try the `zapier re This command also checks the current directory for a linked integration. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `apps` @@ -409,8 +409,8 @@ Jobs are returned from oldest to newest. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier jobs` @@ -468,8 +468,8 @@ This won't show logs from running locally with `zapier test`, since those never * `--detailed` | See extra info, like request/response body and headers. * `-u, --user` | Only show logs for this user. Defaults to your account. Defaults to `me`. * `--limit` | Cap the number of logs returned. Max is 50 (also the default) Defaults to `50`. -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## migrate @@ -696,8 +696,8 @@ Use the `zapier team:add` and `zapier team:remove` commands to modify your team. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `team:list` @@ -792,8 +792,8 @@ Invited users will be able to see your integration's name, logo, and description Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the `zapier users:add` command or the web UI). Users who joined by clicking links generated using the `zapier user:links` command won't show up here. **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Aliases** * `users:list` @@ -806,8 +806,8 @@ Note that this list of users is NOT a comprehensive list of everyone who is usin **Usage**: `zapier users:links` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. ## users:remove @@ -839,8 +839,8 @@ Run the standard validation routine powered by json-schema that checks your inte **Flags** * `--without-style` | Forgo pinging the Zapier server to run further checks. -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. **Examples** * `zapier validate` @@ -855,5 +855,5 @@ Run the standard validation routine powered by json-schema that checks your inte **Usage**: `zapier versions` **Flags** -* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`. * `-d, --debug` | Show extra debugging output. +* `-f, --format` | Change the way structured data is presented. If "json" or "raw", you can pipe the output of the command into other tools, such as jq. One of `[plain | json | raw | row | table]`. Defaults to `table`.