zapier-platform-cli 15.19.0 → 16.1.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 (74) hide show
  1. package/oclif.manifest.json +2316 -1
  2. package/package.json +39 -32
  3. package/src/bin/run +4 -4
  4. package/src/bin/run.cmd +0 -3
  5. package/src/constants.js +2 -2
  6. package/src/generators/index.js +11 -11
  7. package/src/generators/templates/dynamic-dropdown/README.md +1 -1
  8. package/src/generators/templates/dynamic-dropdown/triggers/people.js +2 -2
  9. package/src/generators/templates/dynamic-dropdown/triggers/species.js +2 -2
  10. package/src/index.js +1 -1
  11. package/src/oclif/ZapierBaseCommand.js +52 -45
  12. package/src/oclif/buildFlags.js +14 -16
  13. package/src/oclif/commands/analytics.js +6 -6
  14. package/src/oclif/commands/build.js +6 -6
  15. package/src/oclif/commands/cache/clear.js +13 -13
  16. package/src/oclif/commands/canary/create.js +27 -20
  17. package/src/oclif/commands/canary/delete.js +26 -16
  18. package/src/oclif/commands/canary/list.js +5 -7
  19. package/src/oclif/commands/convert.js +16 -16
  20. package/src/oclif/commands/delete/version.js +6 -6
  21. package/src/oclif/commands/deprecate.js +10 -11
  22. package/src/oclif/commands/describe.js +5 -5
  23. package/src/oclif/commands/env/get.js +5 -5
  24. package/src/oclif/commands/env/set.js +11 -12
  25. package/src/oclif/commands/env/unset.js +9 -10
  26. package/src/oclif/commands/history.js +1 -0
  27. package/src/oclif/commands/init.js +12 -13
  28. package/src/oclif/commands/invoke.js +67 -69
  29. package/src/oclif/commands/jobs.js +1 -1
  30. package/src/oclif/commands/link.js +2 -2
  31. package/src/oclif/commands/login.js +15 -15
  32. package/src/oclif/commands/logout.js +1 -1
  33. package/src/oclif/commands/logs.js +9 -9
  34. package/src/oclif/commands/migrate.js +19 -22
  35. package/src/oclif/commands/promote.js +25 -27
  36. package/src/oclif/commands/push.js +2 -2
  37. package/src/oclif/commands/register.js +31 -32
  38. package/src/oclif/commands/scaffold.js +15 -17
  39. package/src/oclif/commands/team/add.js +12 -15
  40. package/src/oclif/commands/team/get.js +2 -2
  41. package/src/oclif/commands/team/remove.js +6 -6
  42. package/src/oclif/commands/test.js +8 -8
  43. package/src/oclif/commands/upload.js +1 -1
  44. package/src/oclif/commands/users/add.js +9 -11
  45. package/src/oclif/commands/users/get.js +7 -7
  46. package/src/oclif/commands/users/links.js +4 -4
  47. package/src/oclif/commands/users/remove.js +8 -9
  48. package/src/oclif/commands/validate.js +29 -21
  49. package/src/oclif/commands/versions.js +26 -1
  50. package/src/oclif/hooks/checkValidNodeVersion.js +1 -1
  51. package/src/oclif/hooks/deprecated.js +1 -1
  52. package/src/oclif/hooks/getAppRegistrationFieldChoices.js +4 -4
  53. package/src/oclif/hooks/renderMarkdownHelp.js +6 -7
  54. package/src/oclif/hooks/versionInfo.js +2 -2
  55. package/src/utils/analytics.js +20 -7
  56. package/src/utils/api.js +27 -30
  57. package/src/utils/ast.js +15 -15
  58. package/src/utils/auth-files-codegen.js +102 -99
  59. package/src/utils/build.js +27 -28
  60. package/src/utils/changelog.js +1 -1
  61. package/src/utils/check-missing-app-info.js +2 -2
  62. package/src/utils/convert.js +26 -20
  63. package/src/utils/credentials.js +1 -1
  64. package/src/utils/display.js +31 -8
  65. package/src/utils/files.js +3 -3
  66. package/src/utils/ignore.js +2 -2
  67. package/src/utils/local.js +1 -1
  68. package/src/utils/metadata.js +1 -1
  69. package/src/utils/misc.js +21 -22
  70. package/src/utils/promisify.js +1 -1
  71. package/src/utils/scaffold.js +12 -12
  72. package/src/utils/team.js +3 -3
  73. package/src/utils/xdg.js +3 -3
  74. package/src/version-store.js +1 -0
@@ -1 +1,2316 @@
1
- {"version":"15.19.0","commands":{"analytics":{"id":"analytics","description":"Show the status of the analytics that are collected. Also used to change what is collected.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier analytics --mode enabled"],"flags":{"mode":{"name":"mode","type":"option","char":"m","description":"Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes.","options":["enabled","anonymous","disabled"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"build":{"id":"build","description":"Build a pushable zip from the current directory.\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via browserify (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier upload`.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"disable-dependency-detection":{"name":"disable-dependency-detection","type":"boolean","description":"Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.","allowNo":false},"skip-npm-install":{"name":"skip-npm-install","type":"boolean","description":"Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.","hidden":true,"allowNo":false},"skip-validation":{"name":"skip-validation","type":"boolean","description":"Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.","hidden":true,"allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"convert":{"id":"convert","description":"Convert a Visual Builder integration to a CLI integration.\n\nThe resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!\n\nIf you re-run this command on an existing directory it will leave existing files alone and not clobber them.\n\nYou'll need to do a `zapier push` before the new version is visible in the editor, but otherwise you're good to go.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"version":{"name":"version","type":"option","char":"v","description":"Convert a specific version. Required when converting a Visual Builder integration.","required":true},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"integrationId","description":"To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.","required":true},{"name":"path","description":"Relative to your current path - IE: `.` for current directory.","required":true}]},"deprecate":{"id":"deprecate","description":"Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nZapier will send an email warning users of the deprecation once a date is set, they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nAfter the deprecation date has passed it will be safe to delete that integration version.\n\nDo not use this if you have non-breaking changes, such as fixing help text.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier deprecate 1.2.3 2011-10-01"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"The version to deprecate.","required":true},{"name":"date","description":"The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.","required":true}]},"describe":{"id":"describe","description":"Describe the current integration.\n\nThis command prints a human readable enumeration of your integrations's\ntriggers, searches, and creates as seen by Zapier. Useful to understand how your\nresources convert and relate to different actions.\n\n* **Noun**: your action's noun\n* **Label**: your action's label\n* **Resource**: the resource (if any) this action is tied to\n* **Available Methods**: testable methods for this action","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"history":{"id":"history","description":"Get the history of your integration.\n\nHistory 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.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"init":{"id":"init","description":"Initialize a new Zapier integration with a project template.\n\nAfter running this, you'll have a new integration in the specified directory. If you re-run this command on an existing directory, it will prompt before overwriting any existing files.\n\nThis doesn't register or deploy the integration with Zapier - try the `zapier register` and `zapier push` commands for that!","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier init myapp","zapier init ./path/myapp --template oauth2"],"flags":{"template":{"name":"template","type":"option","char":"t","description":"The template to start your integration with.","options":["basic-auth","callback","custom-auth","digest-auth","dynamic-dropdown","files","minimal","oauth1-trello","oauth2","search-or-create","session-auth","typescript"]},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"path","description":"Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation","required":true}]},"integrations":{"id":"integrations","description":"List integrations you have admin access to.\n\nThis command also checks the current directory for a linked integration.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["apps"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"invoke":{"id":"invoke","description":"Invoke an auth operation, a trigger, or a create/search action locally.\n\nThis command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier invoke auth test # invokes authentication.test method\nzapier invoke auth label # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier invoke auth refresh`.\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier invoke trigger new_recipe\n```\n\nTo add input data, use the `--inputData` flag. The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\nThe following is a non-exhaustive list of current limitations and may be supported in the future:\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Line items\n- Output hydration\n- File upload\n- Dynamic dropdown pagination\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- Field choices\n- autoRefresh for OAuth2 and session auth\n","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier invoke","zapier invoke auth start","zapier invoke auth refresh","zapier invoke auth test","zapier invoke auth label","zapier invoke trigger new_recipe","zapier invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'","zapier invoke search find_recipe -i @file.json","cat file.json | zapier invoke trigger new_recipe -i @-"],"flags":{"inputData":{"name":"inputData","type":"option","char":"i","description":"The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-."},"isFillingDynamicDropdown":{"name":"isFillingDynamicDropdown","type":"boolean","description":"Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.","allowNo":false},"isLoadingSample":{"name":"isLoadingSample","type":"boolean","description":"Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.","allowNo":false},"isPopulatingDedupe":{"name":"isPopulatingDedupe","type":"boolean","description":"Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.","allowNo":false},"limit":{"name":"limit","type":"option","description":"Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit.","default":-1},"page":{"name":"page","type":"option","char":"p","description":"Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should fetch. First page is 0.","default":0},"non-interactive":{"name":"non-interactive","type":"boolean","description":"Do not show interactive prompts.","allowNo":false},"timezone":{"name":"timezone","type":"option","char":"z","description":"Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier production behavior. Find the list timezone names at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.","default":"America/Chicago"},"redirect-uri":{"name":"redirect-uri","type":"option","description":"Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this should match the one configured in your server's OAuth2 application settings. A local HTTP server will be started to listen for the OAuth2 callback. If your server requires a non-localhost or HTTPS address for the redirect URI, you can set up port forwarding to route the non-localhost or HTTPS address to localhost.","default":"http://localhost:9000"},"local-port":{"name":"local-port","type":"option","description":"Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAuth2 callback. This port can be different from the one in the redirect URI if you have port forwarding set up.","default":9000},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"actionType","description":"The action type you want to invoke.","options":["auth","trigger","search","create"]},{"name":"actionKey","description":"The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\"."}]},"jobs":{"id":"jobs","description":"Lists ongoing migration or promotion jobs for the current integration.\n\nA job represents a background process that will be queued up when users execute a \"migrate\" or \"promote\" command for the current integration.\n\nEach 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\".\n\nJob stages will then move to \"estimating\", \"in_progress\" and finally one of four \"end\" stages: \"complete\", \"aborted\", \"errored\" or \"paused\".\n\nJob times will vary as it depends on the size of the queue and how many users your integration has.\n\nJobs are returned from oldest to newest.\n","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier jobs"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"link":{"id":"link","description":"Link the current directory with an existing integration.\n\nThis command generates a `.zapierapprc` file in the directory in which it's ran. This file ties this code to an integration and is referenced frequently during `push` and `validate` operations. This file should be checked into source control.\n\nIf you're starting an integration from scratch, use `zapier init` instead.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"login":{"id":"login","description":"Configure your `~/.zapierrc` with a deploy key.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"sso":{"name":"sso","type":"boolean","char":"s","description":"Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"logout":{"id":"logout","description":"Deactivate your active deploy key and reset `~/.zapierrc`.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"logs":{"id":"logs","description":"Print recent logs.\n\nLogs are created when your integration is run as part of a Zap. They come from explicit calls to `z.console.log()`, usage of `z.request()`, and any runtime errors.\n\nThis won't show logs from running locally with `zapier test`, since those never hit our server.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"version":{"name":"version","type":"option","char":"v","description":"Filter logs to the specified version."},"status":{"name":"status","type":"option","char":"s","description":"Filter logs to only see errors or successes","options":["any","success","error"],"default":"any"},"type":{"name":"type","type":"option","char":"t","description":"See logs of the specified type","options":["console","bundle","http"],"default":"console"},"detailed":{"name":"detailed","type":"boolean","description":"See extra info, like request/response body and headers.","allowNo":false},"user":{"name":"user","type":"option","char":"u","description":"Only show logs for this user. Defaults to your account.","default":"me"},"limit":{"name":"limit","type":"option","description":"Cap the number of logs returned. Max is 50 (also the default)","default":50},"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"migrate":{"id":"migrate","description":"Migrate a percentage of users or a single user from one version of your integration to another.\n\nStart a migration to move users between different versions of your integration. You may also \"revert\" by simply swapping the from/to verion strings in the command line arguments (i.e. `zapier migrate 1.0.1 1.0.0`).\n\n**Only use this command to migrate users between non-breaking versions, use `zapier deprecate` if you have breaking changes!**\n\nMigration time varies based on the number of affected Zaps. Be patient and check `zapier jobs` to track the status. Or use `zapier history` if you want to see older jobs.\n\nSince a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.\n\nWe recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.\n\nYou can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 --user=user@example.com`). This will migrate Zaps that are private for that user. Zaps that are\n\n - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),\n - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or\n - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)\n\nwill **not** be migrated.\n\nAlternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 --account=account@example.com`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.\n\n**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**\n\nYou cannot pass both `PERCENT` and `--user` or `--account`.\n\nYou cannot pass both `--user` and `--account`.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier migrate 1.0.0 1.0.1","zapier migrate 1.0.1 2.0.0 10","zapier migrate 2.0.0 2.0.1 --user=user@example.com","zapier migrate 2.0.0 2.0.1 --account=account@example.com"],"flags":{"user":{"name":"user","type":"option","description":"Migrates all of a users' Private Zaps within all accounts for which the specified user is a member"},"account":{"name":"account","type":"option","description":"Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"fromVersion","description":"The version FROM which to migrate users.","required":true},{"name":"toVersion","description":"The version TO which to migrate users.","required":true},{"name":"percent","description":"Percentage (between 1 and 100) of users to migrate.","default":100}]},"promote":{"id":"promote","description":"Promote a specific version to public access.\n\nPromote an integration version into production (non-private) rotation, which means new users can use this integration version.\n\n* This **does** mark the version as the official public version - all other versions & users are grandfathered.\n* This does **NOT** build/upload or deploy a version to Zapier - you should `zapier push` first.\n* This does **NOT** move old users over to this version - `zapier migrate 1.0.0 1.0.1` does that.\n* This does **NOT** recommend old users stop using this version - `zapier deprecate 1.0.0 2017-01-01` does that.\n\nPromotes are an inherently safe operation for all existing users of your integration.\n\nAfter a promotion, go to your developer platform to [close issues that were resolved](https://platform.zapier.com/manage/user-feedback#3-close-resolved-issues) in the updated version.\n\nIf your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.\n\nCheck `zapier jobs` to track the status of the promotion. Or use `zapier history` if you want to see older jobs.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier promote 1.0.0"],"flags":{"yes":{"name":"yes","type":"boolean","char":"y","description":"Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"The version you want to promote.","required":true}]},"pull":{"id":"pull","description":"Retrieve and update your local integration files with the latest version.\n\nThis command updates your local integration files with the latest version. You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"push":{"id":"push","description":"Build and upload the current integration.\n\nThis command is the same as running `zapier build` and `zapier upload` in sequence. See those for more info.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"disable-dependency-detection":{"name":"disable-dependency-detection","type":"boolean","description":"Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.","allowNo":false},"skip-npm-install":{"name":"skip-npm-install","type":"boolean","description":"Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.","hidden":true,"allowNo":false},"skip-validation":{"name":"skip-validation","type":"boolean","description":"Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.","hidden":true,"allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"register":{"id":"register","description":"Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\nThis command creates a new integration and links it in the `./.zapierapprc` file. If `.zapierapprc` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.\n\nAfter registering a new integration, you can run `zapier push` to build and upload your integration for use in the Zapier editor. This will change `.zapierapprc`, which identifies this directory as holding code for a specific integration.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier register","zapier register \"My Cool Integration\"","zapier register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe","zapier register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation","zapier register --subscribe"],"flags":{"desc":{"name":"desc","type":"option","char":"D","description":"A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\""},"url":{"name":"url","type":"option","char":"u","description":"The homepage URL of your app, e.g., https://example.com."},"audience":{"name":"audience","type":"option","char":"a","description":"Are you building a public or private integration?"},"role":{"name":"role","type":"option","char":"r","description":"What is your relationship with the app you're integrating with Zapier?"},"category":{"name":"category","type":"option","char":"c","description":"How would you categorize your app? Choose the most appropriate option for your app's core features."},"subscribe":{"name":"subscribe","type":"boolean","char":"s","description":"Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.","allowNo":true},"yes":{"name":"yes","type":"boolean","char":"y","description":"Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"title","description":"Your integration's public title. Asked interactively if not present."}]},"scaffold":{"id":"scaffold","description":"Add a starting trigger, create, search, or resource to your integration.\n\nThe first argument should be one of `trigger|search|create|resource` followed by the noun that this will act on (something like \"contact\" or \"deal\").\n\nThe scaffold command does two general things:\n\n* Creates a new file (such as `triggers/contact.js`)\n* Imports and registers it inside your `index.js`\n\nYou can mix and match several options to customize the created scaffold for your project.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier scaffold trigger contact","zapier scaffold search contact --dest=my_src/searches","zapier scaffold create contact --entry=src/index.js","zapier scaffold resource contact --force"],"flags":{"dest":{"name":"dest","type":"option","char":"d","description":"Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`."},"test-dest":{"name":"test-dest","type":"option","description":"Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`."},"entry":{"name":"entry","type":"option","char":"e","description":"Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided."},"force":{"name":"force","type":"boolean","char":"f","description":"Should we overwrite an existing trigger/search/create file?","allowNo":false},"no-help":{"name":"no-help","type":"boolean","description":"When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"actionType","required":true,"options":["trigger","search","create","resource"]},{"name":"noun","required":true}]},"test":{"id":"test","description":"Test your integration via the \"test\" script in your \"package.json\".\n\nThis command is a wrapper around `npm test` that also validates the structure of your integration and sets up extra environment variables.\n\nYou can pass any args/flags after a `--`; they will get forwarded onto your test script.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier test","zapier test --skip-validate -- -t 30000 --grep api","zapier test -- -fo --testNamePattern \"auth pass\""],"flags":{"skip-validate":{"name":"skip-validate","type":"boolean","description":"Forgo running `zapier validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.","allowNo":false},"yarn":{"name":"yarn","type":"boolean","description":"Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.","allowNo":false},"pnpm":{"name":"pnpm","type":"boolean","description":"Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"upload":{"id":"upload","description":"Upload the latest build of your integration to Zapier.\n\nThis command sends both build/build.zip and build/source.zip to Zapier for use.\n\nTypically we recommend using `zapier push`, which does a build and upload, rather than `upload` by itself.\n","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"validate":{"id":"validate","description":"Validate your integration.\n\nRun 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`.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier validate","zapier validate --without-style","zapier validate --format json"],"flags":{"without-style":{"name":"without-style","type":"boolean","description":"Forgo pinging the Zapier server to run further checks.","allowNo":false},"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"versions":{"id":"versions","description":"List the versions of your integration available for use in the Zapier editor.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"cache:clear":{"id":"cache:clear","description":"Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier cache:clear","zapier cache:clear 2"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"majorVersion","description":"(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.","required":false}]},"canary:create":{"id":"canary:create","description":"Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier canary:create 1.0.0 1.1.0 -p 25 -d 720","zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"],"flags":{"percent":{"name":"percent","type":"option","char":"p","description":"Percent of traffic to route to new version","required":true},"duration":{"name":"duration","type":"option","char":"d","description":"Duration of the canary in seconds","required":true},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"versionFrom","description":"Version to route traffic from","required":true},{"name":"versionTo","description":"Version to canary traffic to","required":true}]},"canary:delete":{"id":"canary:delete","description":"Delete an active canary deployment","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier canary:delete 1.0.0 1.1.0"],"flags":{},"args":[{"name":"versionFrom","description":"Version to route traffic from","required":true},{"name":"versionTo","description":"Version canary traffic is routed to","required":true}]},"canary:list":{"id":"canary:list","description":"List all active canary deployments","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier canary:list"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"delete:integration":{"id":"delete:integration","description":"Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["delete:app"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"delete:version":{"id":"delete:version","description":"Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"Specify the version to delete. It must have no users or Zaps.","required":true}]},"env:get":{"id":"env:get","description":"Get environment variables for a version.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier env:get 1.2.3"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"The version to get the environment for.","required":true}]},"env:set":{"id":"env:set","description":"Set environment variables for a version.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier env:set 1.2.3 SECRET=12345 OTHER=4321"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.","required":true},{"name":"key-value pairs...","description":"The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`"}]},"env:unset":{"id":"env:unset","description":"Unset environment variables for a version.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"examples":["zapier env:unset 1.2.3 SECRET OTHER"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"version","description":"The version to set the environment for.","required":true},{"name":"keys...","description":"The keys to unset. Keys are case-insensitive."}]},"team:add":{"id":"team:add","description":"Add a team member to your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["team:invite"],"examples":["zapier team:add bruce@wayne.com admin","zapier team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"","zapier team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\""],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"email","description":"The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.","required":true},{"name":"role","description":"The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.","required":true,"options":["admin","collaborator","subscriber"]},{"name":"message","description":"A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved."}]},"team:get":{"id":"team:get","description":"Get team members involved with your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier team:add` and `zapier team:remove` commands to modify your team.\n","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["team:list"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"team:remove":{"id":"team:remove","description":"Remove a team member from all versions of your integration.\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["team:delete"],"flags":{"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"users:add":{"id":"users:add","description":"Add a user to some or all versions of your integration.\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["users:invite"],"examples":["zapier users:add bruce@wayne.com","zapier users:add alfred@wayne.com 1.2.3"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Skip confirmation. Useful for running programatically.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"email","description":"The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.","required":true},{"name":"version","description":"A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions."}]},"users:get":{"id":"users:get","description":"Get a list of users who have been invited to your integration.\n\nNote 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 `\u001b[36mzapier users:add\u001b[39m` command or the web UI). Users who joined by clicking links generated using the `\u001b[36mzapier user:links\u001b[39m` command won't show up here.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["users:list"],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"users:links":{"id":"users:links","description":"Get a list of links that are used to invite users to your integration.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":[],"flags":{"format":{"name":"format","type":"option","char":"f","description":"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.","options":["plain","json","raw","row","table"],"default":"table"},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[]},"users:remove":{"id":"users:remove","description":"Remove a user from all versions of your integration.\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.","pluginName":"zapier-platform-cli","pluginType":"core","aliases":["users:delete"],"flags":{"force":{"name":"force","type":"boolean","char":"f","description":"Skips confirmation. Useful for running programatically.","allowNo":false},"debug":{"name":"debug","type":"boolean","char":"d","description":"Show extra debugging output.","allowNo":false},"invokedFromAnotherCommand":{"name":"invokedFromAnotherCommand","type":"boolean","hidden":true,"allowNo":false}},"args":[{"name":"email","description":"The user to be removed.","required":true}]}}}
1
+ {
2
+ "commands": {
3
+ "analytics": {
4
+ "aliases": [],
5
+ "args": {},
6
+ "description": "Show the status of the analytics that are collected. Also used to change what is collected.",
7
+ "examples": [
8
+ "zapier analytics --mode enabled"
9
+ ],
10
+ "flags": {
11
+ "mode": {
12
+ "char": "m",
13
+ "description": "Choose how much information to share. Anonymous mode drops the OS type and Zapier user id, but keeps command info. Identifying information is used only for debugging purposes.",
14
+ "name": "mode",
15
+ "hasDynamicHelp": false,
16
+ "multiple": false,
17
+ "options": [
18
+ "enabled",
19
+ "anonymous",
20
+ "disabled"
21
+ ],
22
+ "type": "option"
23
+ },
24
+ "debug": {
25
+ "char": "d",
26
+ "description": "Show extra debugging output.",
27
+ "name": "debug",
28
+ "allowNo": false,
29
+ "type": "boolean"
30
+ },
31
+ "invokedFromAnotherCommand": {
32
+ "hidden": true,
33
+ "name": "invokedFromAnotherCommand",
34
+ "allowNo": false,
35
+ "type": "boolean"
36
+ }
37
+ },
38
+ "hasDynamicHelp": false,
39
+ "hiddenAliases": [],
40
+ "id": "analytics",
41
+ "pluginAlias": "zapier-platform-cli",
42
+ "pluginName": "zapier-platform-cli",
43
+ "pluginType": "core",
44
+ "strict": true,
45
+ "enableJsonFlag": false,
46
+ "skipValidInstallCheck": true,
47
+ "isESM": false,
48
+ "relativePath": [
49
+ "src",
50
+ "oclif",
51
+ "commands",
52
+ "analytics.js"
53
+ ]
54
+ },
55
+ "build": {
56
+ "aliases": [],
57
+ "args": {},
58
+ "description": "Build a pushable zip from the current directory.\n\nThis command does the following:\n\n* Creates a temporary folder\n* Copies all code into the temporary folder\n* Adds an entry point: `zapierwrapper.js`\n* Generates and validates app definition.\n* Detects dependencies via browserify (optional, on by default)\n* Zips up all needed `.js` files. If you want to include more files, add a \"includeInBuild\" property (array with strings of regexp paths) to your `.zapierapprc`.\n* Moves the zip to `build/build.zip` and `build/source.zip` and deletes the temp folder\n\nThis command is typically followed by `zapier upload`.",
59
+ "flags": {
60
+ "disable-dependency-detection": {
61
+ "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
62
+ "name": "disable-dependency-detection",
63
+ "allowNo": false,
64
+ "type": "boolean"
65
+ },
66
+ "skip-npm-install": {
67
+ "description": "Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.",
68
+ "hidden": true,
69
+ "name": "skip-npm-install",
70
+ "allowNo": false,
71
+ "type": "boolean"
72
+ },
73
+ "skip-validation": {
74
+ "description": "Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.",
75
+ "hidden": true,
76
+ "name": "skip-validation",
77
+ "allowNo": false,
78
+ "type": "boolean"
79
+ },
80
+ "debug": {
81
+ "char": "d",
82
+ "description": "Show extra debugging output.",
83
+ "name": "debug",
84
+ "allowNo": false,
85
+ "type": "boolean"
86
+ },
87
+ "invokedFromAnotherCommand": {
88
+ "hidden": true,
89
+ "name": "invokedFromAnotherCommand",
90
+ "allowNo": false,
91
+ "type": "boolean"
92
+ }
93
+ },
94
+ "hasDynamicHelp": false,
95
+ "hiddenAliases": [],
96
+ "id": "build",
97
+ "pluginAlias": "zapier-platform-cli",
98
+ "pluginName": "zapier-platform-cli",
99
+ "pluginType": "core",
100
+ "strict": true,
101
+ "enableJsonFlag": false,
102
+ "skipValidInstallCheck": false,
103
+ "isESM": false,
104
+ "relativePath": [
105
+ "src",
106
+ "oclif",
107
+ "commands",
108
+ "build.js"
109
+ ]
110
+ },
111
+ "convert": {
112
+ "aliases": [],
113
+ "args": {
114
+ "integrationId": {
115
+ "description": "To get the integration/app ID, go to \"https://developer.zapier.com\", click on an integration, and copy the number directly after \"/app/\" in the URL.",
116
+ "name": "integrationId",
117
+ "required": true
118
+ },
119
+ "path": {
120
+ "description": "Relative to your current path - IE: `.` for current directory.",
121
+ "name": "path",
122
+ "required": true
123
+ }
124
+ },
125
+ "description": "Convert a Visual Builder integration to a CLI integration.\n\nThe resulting CLI integration will be identical to its Visual Builder version and ready to push and use immediately!\n\nIf you re-run this command on an existing directory it will leave existing files alone and not clobber them.\n\nYou'll need to do a `zapier push` before the new version is visible in the editor, but otherwise you're good to go.",
126
+ "flags": {
127
+ "version": {
128
+ "char": "v",
129
+ "description": "Convert a specific version. Required when converting a Visual Builder integration.",
130
+ "name": "version",
131
+ "required": true,
132
+ "hasDynamicHelp": false,
133
+ "multiple": false,
134
+ "type": "option"
135
+ },
136
+ "debug": {
137
+ "char": "d",
138
+ "description": "Show extra debugging output.",
139
+ "name": "debug",
140
+ "allowNo": false,
141
+ "type": "boolean"
142
+ },
143
+ "invokedFromAnotherCommand": {
144
+ "hidden": true,
145
+ "name": "invokedFromAnotherCommand",
146
+ "allowNo": false,
147
+ "type": "boolean"
148
+ }
149
+ },
150
+ "hasDynamicHelp": false,
151
+ "hiddenAliases": [],
152
+ "id": "convert",
153
+ "pluginAlias": "zapier-platform-cli",
154
+ "pluginName": "zapier-platform-cli",
155
+ "pluginType": "core",
156
+ "strict": true,
157
+ "enableJsonFlag": false,
158
+ "skipValidInstallCheck": true,
159
+ "isESM": false,
160
+ "relativePath": [
161
+ "src",
162
+ "oclif",
163
+ "commands",
164
+ "convert.js"
165
+ ]
166
+ },
167
+ "deprecate": {
168
+ "aliases": [],
169
+ "args": {
170
+ "version": {
171
+ "description": "The version to deprecate.",
172
+ "name": "version",
173
+ "required": true
174
+ },
175
+ "date": {
176
+ "description": "The date (YYYY-MM-DD) when Zapier will make the specified version unavailable.",
177
+ "name": "date",
178
+ "required": true
179
+ }
180
+ },
181
+ "description": "Mark a non-production version of your integration as deprecated, with removal by a certain date.\n\nUse this when an integration version will not be supported or start breaking at a known date.\n\nZapier will send an email warning users of the deprecation once a date is set, they'll start seeing it as \"Deprecated\" in the UI, and once the deprecation date arrives, if the Zaps weren't updated, they'll be paused and the users will be emailed again explaining what happened.\n\nAfter the deprecation date has passed it will be safe to delete that integration version.\n\nDo not use this if you have non-breaking changes, such as fixing help text.",
182
+ "examples": [
183
+ "zapier deprecate 1.2.3 2011-10-01"
184
+ ],
185
+ "flags": {
186
+ "debug": {
187
+ "char": "d",
188
+ "description": "Show extra debugging output.",
189
+ "name": "debug",
190
+ "allowNo": false,
191
+ "type": "boolean"
192
+ },
193
+ "invokedFromAnotherCommand": {
194
+ "hidden": true,
195
+ "name": "invokedFromAnotherCommand",
196
+ "allowNo": false,
197
+ "type": "boolean"
198
+ }
199
+ },
200
+ "hasDynamicHelp": false,
201
+ "hiddenAliases": [],
202
+ "id": "deprecate",
203
+ "pluginAlias": "zapier-platform-cli",
204
+ "pluginName": "zapier-platform-cli",
205
+ "pluginType": "core",
206
+ "strict": true,
207
+ "enableJsonFlag": false,
208
+ "skipValidInstallCheck": true,
209
+ "isESM": false,
210
+ "relativePath": [
211
+ "src",
212
+ "oclif",
213
+ "commands",
214
+ "deprecate.js"
215
+ ]
216
+ },
217
+ "describe": {
218
+ "aliases": [],
219
+ "args": {},
220
+ "description": "Describe the current integration.\n\nThis command prints a human readable enumeration of your integrations's\ntriggers, searches, and creates as seen by Zapier. Useful to understand how your\nresources convert and relate to different actions.\n\n* **Noun**: your action's noun\n* **Label**: your action's label\n* **Resource**: the resource (if any) this action is tied to\n* **Available Methods**: testable methods for this action",
221
+ "flags": {
222
+ "debug": {
223
+ "char": "d",
224
+ "description": "Show extra debugging output.",
225
+ "name": "debug",
226
+ "allowNo": false,
227
+ "type": "boolean"
228
+ },
229
+ "format": {
230
+ "char": "f",
231
+ "description": "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.",
232
+ "name": "format",
233
+ "default": "table",
234
+ "hasDynamicHelp": false,
235
+ "multiple": false,
236
+ "options": [
237
+ "plain",
238
+ "json",
239
+ "raw",
240
+ "row",
241
+ "table"
242
+ ],
243
+ "type": "option"
244
+ },
245
+ "invokedFromAnotherCommand": {
246
+ "hidden": true,
247
+ "name": "invokedFromAnotherCommand",
248
+ "allowNo": false,
249
+ "type": "boolean"
250
+ }
251
+ },
252
+ "hasDynamicHelp": false,
253
+ "hiddenAliases": [],
254
+ "id": "describe",
255
+ "pluginAlias": "zapier-platform-cli",
256
+ "pluginName": "zapier-platform-cli",
257
+ "pluginType": "core",
258
+ "strict": true,
259
+ "enableJsonFlag": false,
260
+ "skipValidInstallCheck": false,
261
+ "isESM": false,
262
+ "relativePath": [
263
+ "src",
264
+ "oclif",
265
+ "commands",
266
+ "describe.js"
267
+ ]
268
+ },
269
+ "history": {
270
+ "aliases": [],
271
+ "args": {},
272
+ "description": "Get the history of your integration.\n\nHistory 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.",
273
+ "flags": {
274
+ "debug": {
275
+ "char": "d",
276
+ "description": "Show extra debugging output.",
277
+ "name": "debug",
278
+ "allowNo": false,
279
+ "type": "boolean"
280
+ },
281
+ "format": {
282
+ "char": "f",
283
+ "description": "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.",
284
+ "name": "format",
285
+ "default": "table",
286
+ "hasDynamicHelp": false,
287
+ "multiple": false,
288
+ "options": [
289
+ "plain",
290
+ "json",
291
+ "raw",
292
+ "row",
293
+ "table"
294
+ ],
295
+ "type": "option"
296
+ },
297
+ "invokedFromAnotherCommand": {
298
+ "hidden": true,
299
+ "name": "invokedFromAnotherCommand",
300
+ "allowNo": false,
301
+ "type": "boolean"
302
+ }
303
+ },
304
+ "hasDynamicHelp": false,
305
+ "hiddenAliases": [],
306
+ "id": "history",
307
+ "pluginAlias": "zapier-platform-cli",
308
+ "pluginName": "zapier-platform-cli",
309
+ "pluginType": "core",
310
+ "strict": true,
311
+ "enableJsonFlag": false,
312
+ "skipValidInstallCheck": true,
313
+ "isESM": false,
314
+ "relativePath": [
315
+ "src",
316
+ "oclif",
317
+ "commands",
318
+ "history.js"
319
+ ]
320
+ },
321
+ "init": {
322
+ "aliases": [],
323
+ "args": {
324
+ "path": {
325
+ "description": "Where to create the new integration. If the directory doesn't exist, it will be created. If the directory isn't empty, we'll ask for confirmation",
326
+ "name": "path",
327
+ "required": true
328
+ }
329
+ },
330
+ "description": "Initialize a new Zapier integration with a project template.\n\nAfter running this, you'll have a new integration in the specified directory. If you re-run this command on an existing directory, it will prompt before overwriting any existing files.\n\nThis doesn't register or deploy the integration with Zapier - try the `zapier register` and `zapier push` commands for that!",
331
+ "examples": [
332
+ "zapier init myapp",
333
+ "zapier init ./path/myapp --template oauth2"
334
+ ],
335
+ "flags": {
336
+ "template": {
337
+ "char": "t",
338
+ "description": "The template to start your integration with.",
339
+ "name": "template",
340
+ "hasDynamicHelp": false,
341
+ "multiple": false,
342
+ "options": [
343
+ "basic-auth",
344
+ "callback",
345
+ "custom-auth",
346
+ "digest-auth",
347
+ "dynamic-dropdown",
348
+ "files",
349
+ "minimal",
350
+ "oauth1-trello",
351
+ "oauth2",
352
+ "search-or-create",
353
+ "session-auth",
354
+ "typescript"
355
+ ],
356
+ "type": "option"
357
+ },
358
+ "debug": {
359
+ "char": "d",
360
+ "description": "Show extra debugging output.",
361
+ "name": "debug",
362
+ "allowNo": false,
363
+ "type": "boolean"
364
+ },
365
+ "invokedFromAnotherCommand": {
366
+ "hidden": true,
367
+ "name": "invokedFromAnotherCommand",
368
+ "allowNo": false,
369
+ "type": "boolean"
370
+ }
371
+ },
372
+ "hasDynamicHelp": false,
373
+ "hiddenAliases": [],
374
+ "id": "init",
375
+ "pluginAlias": "zapier-platform-cli",
376
+ "pluginName": "zapier-platform-cli",
377
+ "pluginType": "core",
378
+ "strict": true,
379
+ "enableJsonFlag": false,
380
+ "skipValidInstallCheck": true,
381
+ "isESM": false,
382
+ "relativePath": [
383
+ "src",
384
+ "oclif",
385
+ "commands",
386
+ "init.js"
387
+ ]
388
+ },
389
+ "integrations": {
390
+ "aliases": [
391
+ "apps"
392
+ ],
393
+ "args": {},
394
+ "description": "List integrations you have admin access to.\n\nThis command also checks the current directory for a linked integration.",
395
+ "flags": {
396
+ "debug": {
397
+ "char": "d",
398
+ "description": "Show extra debugging output.",
399
+ "name": "debug",
400
+ "allowNo": false,
401
+ "type": "boolean"
402
+ },
403
+ "format": {
404
+ "char": "f",
405
+ "description": "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.",
406
+ "name": "format",
407
+ "default": "table",
408
+ "hasDynamicHelp": false,
409
+ "multiple": false,
410
+ "options": [
411
+ "plain",
412
+ "json",
413
+ "raw",
414
+ "row",
415
+ "table"
416
+ ],
417
+ "type": "option"
418
+ },
419
+ "invokedFromAnotherCommand": {
420
+ "hidden": true,
421
+ "name": "invokedFromAnotherCommand",
422
+ "allowNo": false,
423
+ "type": "boolean"
424
+ }
425
+ },
426
+ "hasDynamicHelp": false,
427
+ "hiddenAliases": [],
428
+ "id": "integrations",
429
+ "pluginAlias": "zapier-platform-cli",
430
+ "pluginName": "zapier-platform-cli",
431
+ "pluginType": "core",
432
+ "strict": true,
433
+ "enableJsonFlag": false,
434
+ "skipValidInstallCheck": true,
435
+ "isESM": false,
436
+ "relativePath": [
437
+ "src",
438
+ "oclif",
439
+ "commands",
440
+ "integrations.js"
441
+ ]
442
+ },
443
+ "invoke": {
444
+ "aliases": [],
445
+ "args": {
446
+ "actionType": {
447
+ "description": "The action type you want to invoke.",
448
+ "name": "actionType",
449
+ "options": [
450
+ "auth",
451
+ "trigger",
452
+ "search",
453
+ "create"
454
+ ]
455
+ },
456
+ "actionKey": {
457
+ "description": "The trigger/action key you want to invoke. If ACTIONTYPE is \"auth\", this can be \"label\", \"refresh\", \"start\", or \"test\".",
458
+ "name": "actionKey"
459
+ }
460
+ },
461
+ "description": "Invoke an auth operation, a trigger, or a create/search action locally.\n\nThis command emulates how Zapier production environment would invoke your integration. It runs code locally, so you can use this command to quickly test your integration without deploying it to Zapier. This is especially useful for debugging and development.\n\nThis command loads environment variables and `authData` from the `.env` file in the current directory. If you don't have a `.env` file yet, you can use the `zapier invoke auth start` command to help you initialize it, or you can manually create it.\n\nThe `zapier invoke auth start` subcommand will prompt you for the necessary auth fields and save them to the `.env` file. For OAuth2, it will start a local HTTP server, open the authorization URL in the browser, wait for the OAuth2 redirect, and get the access token.\n\nEach line in the `.env` file should follow one of these formats:\n\n* `VAR_NAME=VALUE` for environment variables\n* `authData_FIELD_KEY=VALUE` for auth data fields\n\nFor example, a `.env` file for an OAuth2 integration might look like this:\n\n```\nCLIENT_ID='your_client_id'\nCLIENT_SECRET='your_client_secret'\nauthData_access_token='1234567890'\nauthData_refresh_token='abcdefg'\nauthData_account_name='zapier'\n```\n\nTo test if the auth data is correct, run either one of these:\n\n```\nzapier invoke auth test # invokes authentication.test method\nzapier invoke auth label # invokes authentication.test and renders connection label\n```\n\nTo refresh stale auth data for OAuth2 or session auth, run `zapier invoke auth refresh`.\n\nOnce you have the correct auth data, you can test an trigger, a search, or a create action. For example, here's how you invoke a trigger with the key `new_recipe`:\n\n```\nzapier invoke trigger new_recipe\n```\n\nTo add input data, use the `--inputData` flag. The input data can come from the command directly, a file, or stdin. See **EXAMPLES** below.\n\nWhen you miss any command arguments, such as ACTIONTYPE or ACTIONKEY, the command will prompt you interactively. If you don't want to get interactive prompts, use the `--non-interactive` flag.\n\nThe `--debug` flag will show you the HTTP request logs and any console logs you have in your code.\n\nThe following is a non-exhaustive list of current limitations and may be supported in the future:\n\n- Hook triggers, including REST hook subscribe/unsubscribe\n- Line items\n- Output hydration\n- File upload\n- Dynamic dropdown pagination\n- Function-based connection label\n- Buffered create actions\n- Search-or-create actions\n- Search-powered fields\n- Field choices\n- autoRefresh for OAuth2 and session auth\n",
462
+ "examples": [
463
+ "zapier invoke",
464
+ "zapier invoke auth start",
465
+ "zapier invoke auth refresh",
466
+ "zapier invoke auth test",
467
+ "zapier invoke auth label",
468
+ "zapier invoke trigger new_recipe",
469
+ "zapier invoke create add_recipe --inputData '{\"title\": \"Pancakes\"}'",
470
+ "zapier invoke search find_recipe -i @file.json",
471
+ "cat file.json | zapier invoke trigger new_recipe -i @-"
472
+ ],
473
+ "flags": {
474
+ "inputData": {
475
+ "char": "i",
476
+ "description": "The input data to pass to the action. Must be a JSON-encoded object. The data can be passed from the command directly like '{\"key\": \"value\"}', read from a file like @file.json, or read from stdin like @-.",
477
+ "name": "inputData",
478
+ "hasDynamicHelp": false,
479
+ "multiple": false,
480
+ "type": "option"
481
+ },
482
+ "isFillingDynamicDropdown": {
483
+ "description": "Set bundle.meta.isFillingDynamicDropdown to true. Only makes sense for a polling trigger. When true in production, this poll is being used to populate a dynamic dropdown.",
484
+ "name": "isFillingDynamicDropdown",
485
+ "allowNo": false,
486
+ "type": "boolean"
487
+ },
488
+ "isLoadingSample": {
489
+ "description": "Set bundle.meta.isLoadingSample to true. When true in production, this run is initiated by the user in the Zap editor trying to pull a sample.",
490
+ "name": "isLoadingSample",
491
+ "allowNo": false,
492
+ "type": "boolean"
493
+ },
494
+ "isPopulatingDedupe": {
495
+ "description": "Set bundle.meta.isPopulatingDedupe to true. Only makes sense for a polling trigger. When true in production, the results of this poll will be used initialize the deduplication list rather than trigger a Zap. This happens when a user enables a Zap.",
496
+ "name": "isPopulatingDedupe",
497
+ "allowNo": false,
498
+ "type": "boolean"
499
+ },
500
+ "limit": {
501
+ "description": "Set bundle.meta.limit. Only makes sense for a trigger. When used in production, this indicates the number of items you should fetch. -1 means no limit.",
502
+ "name": "limit",
503
+ "default": -1,
504
+ "hasDynamicHelp": false,
505
+ "multiple": false,
506
+ "type": "option"
507
+ },
508
+ "page": {
509
+ "char": "p",
510
+ "description": "Set bundle.meta.page. Only makes sense for a trigger. When used in production, this indicates which page of items you should fetch. First page is 0.",
511
+ "name": "page",
512
+ "default": 0,
513
+ "hasDynamicHelp": false,
514
+ "multiple": false,
515
+ "type": "option"
516
+ },
517
+ "non-interactive": {
518
+ "description": "Do not show interactive prompts.",
519
+ "name": "non-interactive",
520
+ "allowNo": false,
521
+ "type": "boolean"
522
+ },
523
+ "timezone": {
524
+ "char": "z",
525
+ "description": "Set the default timezone for datetime field interpretation. If not set, defaults to America/Chicago, which matches Zapier production behavior. Find the list timezone names at https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.",
526
+ "name": "timezone",
527
+ "default": "America/Chicago",
528
+ "hasDynamicHelp": false,
529
+ "multiple": false,
530
+ "type": "option"
531
+ },
532
+ "redirect-uri": {
533
+ "description": "Only used by `auth start` subcommand. The redirect URI that will be passed to the OAuth2 authorization URL. Usually this should match the one configured in your server's OAuth2 application settings. A local HTTP server will be started to listen for the OAuth2 callback. If your server requires a non-localhost or HTTPS address for the redirect URI, you can set up port forwarding to route the non-localhost or HTTPS address to localhost.",
534
+ "name": "redirect-uri",
535
+ "default": "http://localhost:9000",
536
+ "hasDynamicHelp": false,
537
+ "multiple": false,
538
+ "type": "option"
539
+ },
540
+ "local-port": {
541
+ "description": "Only used by `auth start` subcommand. The local port that will be used to start the local HTTP server to listen for the OAuth2 callback. This port can be different from the one in the redirect URI if you have port forwarding set up.",
542
+ "name": "local-port",
543
+ "default": 9000,
544
+ "hasDynamicHelp": false,
545
+ "multiple": false,
546
+ "type": "option"
547
+ },
548
+ "debug": {
549
+ "char": "d",
550
+ "description": "Show extra debugging output.",
551
+ "name": "debug",
552
+ "allowNo": false,
553
+ "type": "boolean"
554
+ },
555
+ "invokedFromAnotherCommand": {
556
+ "hidden": true,
557
+ "name": "invokedFromAnotherCommand",
558
+ "allowNo": false,
559
+ "type": "boolean"
560
+ }
561
+ },
562
+ "hasDynamicHelp": false,
563
+ "hiddenAliases": [],
564
+ "id": "invoke",
565
+ "pluginAlias": "zapier-platform-cli",
566
+ "pluginName": "zapier-platform-cli",
567
+ "pluginType": "core",
568
+ "strict": true,
569
+ "enableJsonFlag": false,
570
+ "skipValidInstallCheck": false,
571
+ "isESM": false,
572
+ "relativePath": [
573
+ "src",
574
+ "oclif",
575
+ "commands",
576
+ "invoke.js"
577
+ ]
578
+ },
579
+ "jobs": {
580
+ "aliases": [],
581
+ "args": {},
582
+ "description": "Lists ongoing migration or promotion jobs for the current integration.\n\nA job represents a background process that will be queued up when users execute a \"migrate\" or \"promote\" command for the current integration.\n\nEach 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\".\n\nJob stages will then move to \"estimating\", \"in_progress\" and finally one of four \"end\" stages: \"complete\", \"aborted\", \"errored\" or \"paused\".\n\nJob times will vary as it depends on the size of the queue and how many users your integration has.\n\nJobs are returned from oldest to newest.\n",
583
+ "examples": [
584
+ "zapier jobs"
585
+ ],
586
+ "flags": {
587
+ "debug": {
588
+ "char": "d",
589
+ "description": "Show extra debugging output.",
590
+ "name": "debug",
591
+ "allowNo": false,
592
+ "type": "boolean"
593
+ },
594
+ "format": {
595
+ "char": "f",
596
+ "description": "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.",
597
+ "name": "format",
598
+ "default": "table",
599
+ "hasDynamicHelp": false,
600
+ "multiple": false,
601
+ "options": [
602
+ "plain",
603
+ "json",
604
+ "raw",
605
+ "row",
606
+ "table"
607
+ ],
608
+ "type": "option"
609
+ },
610
+ "invokedFromAnotherCommand": {
611
+ "hidden": true,
612
+ "name": "invokedFromAnotherCommand",
613
+ "allowNo": false,
614
+ "type": "boolean"
615
+ }
616
+ },
617
+ "hasDynamicHelp": false,
618
+ "hiddenAliases": [],
619
+ "id": "jobs",
620
+ "pluginAlias": "zapier-platform-cli",
621
+ "pluginName": "zapier-platform-cli",
622
+ "pluginType": "core",
623
+ "strict": true,
624
+ "enableJsonFlag": false,
625
+ "skipValidInstallCheck": true,
626
+ "isESM": false,
627
+ "relativePath": [
628
+ "src",
629
+ "oclif",
630
+ "commands",
631
+ "jobs.js"
632
+ ]
633
+ },
634
+ "link": {
635
+ "aliases": [],
636
+ "args": {},
637
+ "description": "Link the current directory with an existing integration.\n\nThis command generates a `.zapierapprc` file in the directory in which it's ran. This file ties this code to an integration and is referenced frequently during `push` and `validate` operations. This file should be checked into source control.\n\nIf you're starting an integration from scratch, use `zapier init` instead.",
638
+ "flags": {
639
+ "debug": {
640
+ "char": "d",
641
+ "description": "Show extra debugging output.",
642
+ "name": "debug",
643
+ "allowNo": false,
644
+ "type": "boolean"
645
+ },
646
+ "invokedFromAnotherCommand": {
647
+ "hidden": true,
648
+ "name": "invokedFromAnotherCommand",
649
+ "allowNo": false,
650
+ "type": "boolean"
651
+ }
652
+ },
653
+ "hasDynamicHelp": false,
654
+ "hiddenAliases": [],
655
+ "id": "link",
656
+ "pluginAlias": "zapier-platform-cli",
657
+ "pluginName": "zapier-platform-cli",
658
+ "pluginType": "core",
659
+ "strict": true,
660
+ "enableJsonFlag": false,
661
+ "skipValidInstallCheck": true,
662
+ "isESM": false,
663
+ "relativePath": [
664
+ "src",
665
+ "oclif",
666
+ "commands",
667
+ "link.js"
668
+ ]
669
+ },
670
+ "login": {
671
+ "aliases": [],
672
+ "args": {},
673
+ "description": "Configure your `~/.zapierrc` with a deploy key.",
674
+ "flags": {
675
+ "sso": {
676
+ "char": "s",
677
+ "description": "Use this flag if you log into Zapier a Single Sign-On (SSO) button and don't have a Zapier password.",
678
+ "name": "sso",
679
+ "allowNo": false,
680
+ "type": "boolean"
681
+ },
682
+ "debug": {
683
+ "char": "d",
684
+ "description": "Show extra debugging output.",
685
+ "name": "debug",
686
+ "allowNo": false,
687
+ "type": "boolean"
688
+ },
689
+ "invokedFromAnotherCommand": {
690
+ "hidden": true,
691
+ "name": "invokedFromAnotherCommand",
692
+ "allowNo": false,
693
+ "type": "boolean"
694
+ }
695
+ },
696
+ "hasDynamicHelp": false,
697
+ "hiddenAliases": [],
698
+ "id": "login",
699
+ "pluginAlias": "zapier-platform-cli",
700
+ "pluginName": "zapier-platform-cli",
701
+ "pluginType": "core",
702
+ "strict": true,
703
+ "enableJsonFlag": false,
704
+ "skipValidInstallCheck": true,
705
+ "isESM": false,
706
+ "relativePath": [
707
+ "src",
708
+ "oclif",
709
+ "commands",
710
+ "login.js"
711
+ ]
712
+ },
713
+ "logout": {
714
+ "aliases": [],
715
+ "args": {},
716
+ "description": "Deactivate your active deploy key and reset `~/.zapierrc`.",
717
+ "flags": {
718
+ "debug": {
719
+ "char": "d",
720
+ "description": "Show extra debugging output.",
721
+ "name": "debug",
722
+ "allowNo": false,
723
+ "type": "boolean"
724
+ },
725
+ "invokedFromAnotherCommand": {
726
+ "hidden": true,
727
+ "name": "invokedFromAnotherCommand",
728
+ "allowNo": false,
729
+ "type": "boolean"
730
+ }
731
+ },
732
+ "hasDynamicHelp": false,
733
+ "hiddenAliases": [],
734
+ "id": "logout",
735
+ "pluginAlias": "zapier-platform-cli",
736
+ "pluginName": "zapier-platform-cli",
737
+ "pluginType": "core",
738
+ "strict": true,
739
+ "enableJsonFlag": false,
740
+ "skipValidInstallCheck": true,
741
+ "isESM": false,
742
+ "relativePath": [
743
+ "src",
744
+ "oclif",
745
+ "commands",
746
+ "logout.js"
747
+ ]
748
+ },
749
+ "logs": {
750
+ "aliases": [],
751
+ "args": {},
752
+ "description": "Print recent logs.\n\nLogs are created when your integration is run as part of a Zap. They come from explicit calls to `z.console.log()`, usage of `z.request()`, and any runtime errors.\n\nThis won't show logs from running locally with `zapier test`, since those never hit our server.",
753
+ "flags": {
754
+ "version": {
755
+ "char": "v",
756
+ "description": "Filter logs to the specified version.",
757
+ "name": "version",
758
+ "hasDynamicHelp": false,
759
+ "multiple": false,
760
+ "type": "option"
761
+ },
762
+ "status": {
763
+ "char": "s",
764
+ "description": "Filter logs to only see errors or successes",
765
+ "name": "status",
766
+ "default": "any",
767
+ "hasDynamicHelp": false,
768
+ "multiple": false,
769
+ "options": [
770
+ "any",
771
+ "success",
772
+ "error"
773
+ ],
774
+ "type": "option"
775
+ },
776
+ "type": {
777
+ "char": "t",
778
+ "description": "See logs of the specified type",
779
+ "name": "type",
780
+ "default": "console",
781
+ "hasDynamicHelp": false,
782
+ "multiple": false,
783
+ "options": [
784
+ "console",
785
+ "bundle",
786
+ "http"
787
+ ],
788
+ "type": "option"
789
+ },
790
+ "detailed": {
791
+ "description": "See extra info, like request/response body and headers.",
792
+ "name": "detailed",
793
+ "allowNo": false,
794
+ "type": "boolean"
795
+ },
796
+ "user": {
797
+ "char": "u",
798
+ "description": "Only show logs for this user. Defaults to your account.",
799
+ "name": "user",
800
+ "default": "me",
801
+ "hasDynamicHelp": false,
802
+ "multiple": false,
803
+ "type": "option"
804
+ },
805
+ "limit": {
806
+ "description": "Cap the number of logs returned. Max is 50 (also the default)",
807
+ "name": "limit",
808
+ "default": 50,
809
+ "hasDynamicHelp": false,
810
+ "multiple": false,
811
+ "type": "option"
812
+ },
813
+ "debug": {
814
+ "char": "d",
815
+ "description": "Show extra debugging output.",
816
+ "name": "debug",
817
+ "allowNo": false,
818
+ "type": "boolean"
819
+ },
820
+ "format": {
821
+ "char": "f",
822
+ "description": "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.",
823
+ "name": "format",
824
+ "default": "table",
825
+ "hasDynamicHelp": false,
826
+ "multiple": false,
827
+ "options": [
828
+ "plain",
829
+ "json",
830
+ "raw",
831
+ "row",
832
+ "table"
833
+ ],
834
+ "type": "option"
835
+ },
836
+ "invokedFromAnotherCommand": {
837
+ "hidden": true,
838
+ "name": "invokedFromAnotherCommand",
839
+ "allowNo": false,
840
+ "type": "boolean"
841
+ }
842
+ },
843
+ "hasDynamicHelp": false,
844
+ "hiddenAliases": [],
845
+ "id": "logs",
846
+ "pluginAlias": "zapier-platform-cli",
847
+ "pluginName": "zapier-platform-cli",
848
+ "pluginType": "core",
849
+ "strict": true,
850
+ "enableJsonFlag": false,
851
+ "skipValidInstallCheck": true,
852
+ "isESM": false,
853
+ "relativePath": [
854
+ "src",
855
+ "oclif",
856
+ "commands",
857
+ "logs.js"
858
+ ]
859
+ },
860
+ "migrate": {
861
+ "aliases": [],
862
+ "args": {
863
+ "fromVersion": {
864
+ "description": "The version FROM which to migrate users.",
865
+ "name": "fromVersion",
866
+ "required": true
867
+ },
868
+ "toVersion": {
869
+ "description": "The version TO which to migrate users.",
870
+ "name": "toVersion",
871
+ "required": true
872
+ },
873
+ "percent": {
874
+ "default": 100,
875
+ "description": "Percentage (between 1 and 100) of users to migrate.",
876
+ "name": "percent"
877
+ }
878
+ },
879
+ "description": "Migrate a percentage of users or a single user from one version of your integration to another.\n\nStart a migration to move users between different versions of your integration. You may also \"revert\" by simply swapping the from/to verion strings in the command line arguments (i.e. `zapier migrate 1.0.1 1.0.0`).\n\n**Only use this command to migrate users between non-breaking versions, use `zapier deprecate` if you have breaking changes!**\n\nMigration time varies based on the number of affected Zaps. Be patient and check `zapier jobs` to track the status. Or use `zapier history` if you want to see older jobs.\n\nSince a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.\n\nWe recommend migrating a small subset of users first, via the percent argument, then watching error logs of the new version for any sort of odd behavior. When you feel confident there are no bugs, go ahead and migrate everyone. If you see unexpected errors, you can revert.\n\nYou can migrate a specific user's Zaps by using `--user` (i.e. `zapier migrate 1.0.0 1.0.1 --user=user@example.com`). This will migrate Zaps that are private for that user. Zaps that are\n\n - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),\n - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or\n - in a [team/company account](https://help.zapier.com/hc/en-us/articles/22330977078157-Collaborate-with-members-of-your-Team-or-Company-account)\n\nwill **not** be migrated.\n\nAlternatively, you can pass the `--account` flag, (i.e. `zapier migrate 1.0.0 1.0.1 --account=account@example.com`). This will migrate all Zaps owned by the user, Private & Shared, within all accounts for which the specified user is a member.\n\n**The `--account` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**\n\nYou cannot pass both `PERCENT` and `--user` or `--account`.\n\nYou cannot pass both `--user` and `--account`.",
880
+ "examples": [
881
+ "zapier migrate 1.0.0 1.0.1",
882
+ "zapier migrate 1.0.1 2.0.0 10",
883
+ "zapier migrate 2.0.0 2.0.1 --user=user@example.com",
884
+ "zapier migrate 2.0.0 2.0.1 --account=account@example.com"
885
+ ],
886
+ "flags": {
887
+ "user": {
888
+ "description": "Migrates all of a users' Private Zaps within all accounts for which the specified user is a member",
889
+ "name": "user",
890
+ "hasDynamicHelp": false,
891
+ "multiple": false,
892
+ "type": "option"
893
+ },
894
+ "account": {
895
+ "description": "Migrates all of a users' Zaps, Private & Shared, within all accounts for which the specified user is a member",
896
+ "name": "account",
897
+ "hasDynamicHelp": false,
898
+ "multiple": false,
899
+ "type": "option"
900
+ },
901
+ "debug": {
902
+ "char": "d",
903
+ "description": "Show extra debugging output.",
904
+ "name": "debug",
905
+ "allowNo": false,
906
+ "type": "boolean"
907
+ },
908
+ "invokedFromAnotherCommand": {
909
+ "hidden": true,
910
+ "name": "invokedFromAnotherCommand",
911
+ "allowNo": false,
912
+ "type": "boolean"
913
+ }
914
+ },
915
+ "hasDynamicHelp": false,
916
+ "hiddenAliases": [],
917
+ "id": "migrate",
918
+ "pluginAlias": "zapier-platform-cli",
919
+ "pluginName": "zapier-platform-cli",
920
+ "pluginType": "core",
921
+ "strict": true,
922
+ "enableJsonFlag": false,
923
+ "skipValidInstallCheck": true,
924
+ "isESM": false,
925
+ "relativePath": [
926
+ "src",
927
+ "oclif",
928
+ "commands",
929
+ "migrate.js"
930
+ ]
931
+ },
932
+ "promote": {
933
+ "aliases": [],
934
+ "args": {
935
+ "version": {
936
+ "description": "The version you want to promote.",
937
+ "name": "version",
938
+ "required": true
939
+ }
940
+ },
941
+ "description": "Promote a specific version to public access.\n\nPromote an integration version into production (non-private) rotation, which means new users can use this integration version.\n\n* This **does** mark the version as the official public version - all other versions & users are grandfathered.\n* This does **NOT** build/upload or deploy a version to Zapier - you should `zapier push` first.\n* This does **NOT** move old users over to this version - `zapier migrate 1.0.0 1.0.1` does that.\n* This does **NOT** recommend old users stop using this version - `zapier deprecate 1.0.0 2017-01-01` does that.\n\nPromotes are an inherently safe operation for all existing users of your integration.\n\nAfter a promotion, go to your developer platform to [close issues that were resolved](https://platform.zapier.com/manage/user-feedback#3-close-resolved-issues) in the updated version.\n\nIf your integration is private and passes our integration checks, this will give you a URL to a form where you can fill in additional information for your integration to go public. After reviewing, the Zapier team will approve to make it public if there are no issues or decline with feedback.\n\nCheck `zapier jobs` to track the status of the promotion. Or use `zapier history` if you want to see older jobs.",
942
+ "examples": [
943
+ "zapier promote 1.0.0"
944
+ ],
945
+ "flags": {
946
+ "yes": {
947
+ "char": "y",
948
+ "description": "Automatically answer \"yes\" to any prompts. Useful if you want to avoid interactive prompts to run this command in CI.",
949
+ "name": "yes",
950
+ "allowNo": false,
951
+ "type": "boolean"
952
+ },
953
+ "debug": {
954
+ "char": "d",
955
+ "description": "Show extra debugging output.",
956
+ "name": "debug",
957
+ "allowNo": false,
958
+ "type": "boolean"
959
+ },
960
+ "invokedFromAnotherCommand": {
961
+ "hidden": true,
962
+ "name": "invokedFromAnotherCommand",
963
+ "allowNo": false,
964
+ "type": "boolean"
965
+ }
966
+ },
967
+ "hasDynamicHelp": false,
968
+ "hiddenAliases": [],
969
+ "id": "promote",
970
+ "pluginAlias": "zapier-platform-cli",
971
+ "pluginName": "zapier-platform-cli",
972
+ "pluginType": "core",
973
+ "strict": true,
974
+ "enableJsonFlag": false,
975
+ "skipValidInstallCheck": true,
976
+ "isESM": false,
977
+ "relativePath": [
978
+ "src",
979
+ "oclif",
980
+ "commands",
981
+ "promote.js"
982
+ ]
983
+ },
984
+ "pull": {
985
+ "aliases": [],
986
+ "args": {},
987
+ "description": "Retrieve and update your local integration files with the latest version.\n\nThis command updates your local integration files with the latest version. You will be prompted with a confirmation dialog before continuing if there any destructive file changes.\n\nZapier may release new versions of your integration with bug fixes or new features. In the event this occurs, you will be unable to do the following until your local files are updated by running `zapier pull`:\n\n* push to the promoted version\n* promote a new version\n* migrate users from one version to another",
988
+ "flags": {
989
+ "debug": {
990
+ "char": "d",
991
+ "description": "Show extra debugging output.",
992
+ "name": "debug",
993
+ "allowNo": false,
994
+ "type": "boolean"
995
+ },
996
+ "invokedFromAnotherCommand": {
997
+ "hidden": true,
998
+ "name": "invokedFromAnotherCommand",
999
+ "allowNo": false,
1000
+ "type": "boolean"
1001
+ }
1002
+ },
1003
+ "hasDynamicHelp": false,
1004
+ "hiddenAliases": [],
1005
+ "id": "pull",
1006
+ "pluginAlias": "zapier-platform-cli",
1007
+ "pluginName": "zapier-platform-cli",
1008
+ "pluginType": "core",
1009
+ "strict": true,
1010
+ "enableJsonFlag": false,
1011
+ "skipValidInstallCheck": true,
1012
+ "isESM": false,
1013
+ "relativePath": [
1014
+ "src",
1015
+ "oclif",
1016
+ "commands",
1017
+ "pull.js"
1018
+ ]
1019
+ },
1020
+ "push": {
1021
+ "aliases": [],
1022
+ "args": {},
1023
+ "description": "Build and upload the current integration.\n\nThis command is the same as running `zapier build` and `zapier upload` in sequence. See those for more info.",
1024
+ "flags": {
1025
+ "disable-dependency-detection": {
1026
+ "description": "Disable \"smart\" file inclusion. By default, Zapier only includes files that are required by `index.js`. If you (or your dependencies) require files dynamically (such as with `require(someVar)`), then you may see \"Cannot find module\" errors. Disabling this may make your `build.zip` too large. If that's the case, try using the `includeInBuild` option in your `.zapierapprc`. See the docs about `includeInBuild` for more info.",
1027
+ "name": "disable-dependency-detection",
1028
+ "allowNo": false,
1029
+ "type": "boolean"
1030
+ },
1031
+ "skip-npm-install": {
1032
+ "description": "Skips installing a fresh copy of npm dependencies on build. Helpful for using `yarn` or local copies of dependencies.",
1033
+ "hidden": true,
1034
+ "name": "skip-npm-install",
1035
+ "allowNo": false,
1036
+ "type": "boolean"
1037
+ },
1038
+ "skip-validation": {
1039
+ "description": "Skips local pre-push validation checks, and remote validation check of the CLI app's schema and AppVersion integrity.",
1040
+ "hidden": true,
1041
+ "name": "skip-validation",
1042
+ "allowNo": false,
1043
+ "type": "boolean"
1044
+ },
1045
+ "debug": {
1046
+ "char": "d",
1047
+ "description": "Show extra debugging output.",
1048
+ "name": "debug",
1049
+ "allowNo": false,
1050
+ "type": "boolean"
1051
+ },
1052
+ "invokedFromAnotherCommand": {
1053
+ "hidden": true,
1054
+ "name": "invokedFromAnotherCommand",
1055
+ "allowNo": false,
1056
+ "type": "boolean"
1057
+ }
1058
+ },
1059
+ "hasDynamicHelp": false,
1060
+ "hiddenAliases": [],
1061
+ "id": "push",
1062
+ "pluginAlias": "zapier-platform-cli",
1063
+ "pluginName": "zapier-platform-cli",
1064
+ "pluginType": "core",
1065
+ "strict": true,
1066
+ "enableJsonFlag": false,
1067
+ "skipValidInstallCheck": false,
1068
+ "isESM": false,
1069
+ "relativePath": [
1070
+ "src",
1071
+ "oclif",
1072
+ "commands",
1073
+ "push.js"
1074
+ ]
1075
+ },
1076
+ "register": {
1077
+ "aliases": [],
1078
+ "args": {
1079
+ "title": {
1080
+ "description": "Your integration's public title. Asked interactively if not present.",
1081
+ "name": "title"
1082
+ }
1083
+ },
1084
+ "description": "Register a new integration in your account, or update the existing one if a `.zapierapprc` file is found.\n\nThis command creates a new integration and links it in the `./.zapierapprc` file. If `.zapierapprc` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.\n\nAfter registering a new integration, you can run `zapier push` to build and upload your integration for use in the Zapier editor. This will change `.zapierapprc`, which identifies this directory as holding code for a specific integration.",
1085
+ "examples": [
1086
+ "zapier register",
1087
+ "zapier register \"My Cool Integration\"",
1088
+ "zapier register \"My Cool Integration\" --desc \"My Cool Integration helps you integrate your apps with the apps that you need.\" --no-subscribe",
1089
+ "zapier register \"My Cool Integration\" --url \"https://www.zapier.com\" --audience private --role employee --category marketing-automation",
1090
+ "zapier register --subscribe"
1091
+ ],
1092
+ "flags": {
1093
+ "desc": {
1094
+ "char": "D",
1095
+ "description": "A sentence describing your app in 140 characters or less, e.g. \"Trello is a team collaboration tool to organize tasks and keep projects on track.\"",
1096
+ "name": "desc",
1097
+ "hasDynamicHelp": false,
1098
+ "multiple": false,
1099
+ "type": "option"
1100
+ },
1101
+ "url": {
1102
+ "char": "u",
1103
+ "description": "The homepage URL of your app, e.g., https://example.com.",
1104
+ "name": "url",
1105
+ "hasDynamicHelp": false,
1106
+ "multiple": false,
1107
+ "type": "option"
1108
+ },
1109
+ "audience": {
1110
+ "char": "a",
1111
+ "description": "Are you building a public or private integration?",
1112
+ "name": "audience",
1113
+ "hasDynamicHelp": false,
1114
+ "multiple": false,
1115
+ "type": "option"
1116
+ },
1117
+ "role": {
1118
+ "char": "r",
1119
+ "description": "What is your relationship with the app you're integrating with Zapier?",
1120
+ "name": "role",
1121
+ "hasDynamicHelp": false,
1122
+ "multiple": false,
1123
+ "type": "option"
1124
+ },
1125
+ "category": {
1126
+ "char": "c",
1127
+ "description": "How would you categorize your app? Choose the most appropriate option for your app's core features.",
1128
+ "name": "category",
1129
+ "hasDynamicHelp": false,
1130
+ "multiple": false,
1131
+ "type": "option"
1132
+ },
1133
+ "subscribe": {
1134
+ "char": "s",
1135
+ "description": "Get tips and recommendations about this integration along with our monthly newsletter that details the performance of your integration and the latest Zapier news.",
1136
+ "name": "subscribe",
1137
+ "allowNo": true,
1138
+ "type": "boolean"
1139
+ },
1140
+ "yes": {
1141
+ "char": "y",
1142
+ "description": "Assume yes for all yes/no prompts. This flag will also update an existing integration (as opposed to registering a new one) if a .zapierapprc file is found.",
1143
+ "name": "yes",
1144
+ "allowNo": false,
1145
+ "type": "boolean"
1146
+ },
1147
+ "debug": {
1148
+ "char": "d",
1149
+ "description": "Show extra debugging output.",
1150
+ "name": "debug",
1151
+ "allowNo": false,
1152
+ "type": "boolean"
1153
+ },
1154
+ "invokedFromAnotherCommand": {
1155
+ "hidden": true,
1156
+ "name": "invokedFromAnotherCommand",
1157
+ "allowNo": false,
1158
+ "type": "boolean"
1159
+ }
1160
+ },
1161
+ "hasDynamicHelp": false,
1162
+ "hiddenAliases": [],
1163
+ "id": "register",
1164
+ "pluginAlias": "zapier-platform-cli",
1165
+ "pluginName": "zapier-platform-cli",
1166
+ "pluginType": "core",
1167
+ "strict": true,
1168
+ "enableJsonFlag": false,
1169
+ "skipValidInstallCheck": true,
1170
+ "isESM": false,
1171
+ "relativePath": [
1172
+ "src",
1173
+ "oclif",
1174
+ "commands",
1175
+ "register.js"
1176
+ ]
1177
+ },
1178
+ "scaffold": {
1179
+ "aliases": [],
1180
+ "args": {
1181
+ "actionType": {
1182
+ "name": "actionType",
1183
+ "options": [
1184
+ "trigger",
1185
+ "search",
1186
+ "create",
1187
+ "resource"
1188
+ ],
1189
+ "required": true
1190
+ },
1191
+ "noun": {
1192
+ "name": "noun",
1193
+ "required": true
1194
+ }
1195
+ },
1196
+ "description": "Add a starting trigger, create, search, or resource to your integration.\n\nThe first argument should be one of `trigger|search|create|resource` followed by the noun that this will act on (something like \"contact\" or \"deal\").\n\nThe scaffold command does two general things:\n\n* Creates a new file (such as `triggers/contact.js`)\n* Imports and registers it inside your `index.js`\n\nYou can mix and match several options to customize the created scaffold for your project.",
1197
+ "examples": [
1198
+ "zapier scaffold trigger contact",
1199
+ "zapier scaffold search contact --dest=my_src/searches",
1200
+ "zapier scaffold create contact --entry=src/index.js",
1201
+ "zapier scaffold resource contact --force"
1202
+ ],
1203
+ "flags": {
1204
+ "dest": {
1205
+ "char": "d",
1206
+ "description": "Specify the new file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `[triggers|searches|creates]/{noun}`.",
1207
+ "name": "dest",
1208
+ "hasDynamicHelp": false,
1209
+ "multiple": false,
1210
+ "type": "option"
1211
+ },
1212
+ "test-dest": {
1213
+ "description": "Specify the new test file's directory. Use this flag when you want to create a different folder structure such as `src/triggers` instead of the default `triggers`. Defaults to `test/[triggers|searches|creates]/{noun}`.",
1214
+ "name": "test-dest",
1215
+ "hasDynamicHelp": false,
1216
+ "multiple": false,
1217
+ "type": "option"
1218
+ },
1219
+ "entry": {
1220
+ "char": "e",
1221
+ "description": "Supply the path to your integration's entry point (`index.js` or `src/index.ts`). This will try to automatically detect the correct file if not provided.",
1222
+ "name": "entry",
1223
+ "hasDynamicHelp": false,
1224
+ "multiple": false,
1225
+ "type": "option"
1226
+ },
1227
+ "force": {
1228
+ "char": "f",
1229
+ "description": "Should we overwrite an existing trigger/search/create file?",
1230
+ "name": "force",
1231
+ "allowNo": false,
1232
+ "type": "boolean"
1233
+ },
1234
+ "no-help": {
1235
+ "description": "When scaffolding, should we skip adding helpful intro comments? Useful if this isn't your first rodeo.",
1236
+ "name": "no-help",
1237
+ "allowNo": false,
1238
+ "type": "boolean"
1239
+ },
1240
+ "debug": {
1241
+ "char": "d",
1242
+ "description": "Show extra debugging output.",
1243
+ "name": "debug",
1244
+ "allowNo": false,
1245
+ "type": "boolean"
1246
+ },
1247
+ "invokedFromAnotherCommand": {
1248
+ "hidden": true,
1249
+ "name": "invokedFromAnotherCommand",
1250
+ "allowNo": false,
1251
+ "type": "boolean"
1252
+ }
1253
+ },
1254
+ "hasDynamicHelp": false,
1255
+ "hiddenAliases": [],
1256
+ "id": "scaffold",
1257
+ "pluginAlias": "zapier-platform-cli",
1258
+ "pluginName": "zapier-platform-cli",
1259
+ "pluginType": "core",
1260
+ "strict": true,
1261
+ "enableJsonFlag": false,
1262
+ "skipValidInstallCheck": true,
1263
+ "isESM": false,
1264
+ "relativePath": [
1265
+ "src",
1266
+ "oclif",
1267
+ "commands",
1268
+ "scaffold.js"
1269
+ ]
1270
+ },
1271
+ "test": {
1272
+ "aliases": [],
1273
+ "args": {},
1274
+ "description": "Test your integration via the \"test\" script in your \"package.json\".\n\nThis command is a wrapper around `npm test` that also validates the structure of your integration and sets up extra environment variables.\n\nYou can pass any args/flags after a `--`; they will get forwarded onto your test script.",
1275
+ "examples": [
1276
+ "zapier test",
1277
+ "zapier test --skip-validate -- -t 30000 --grep api",
1278
+ "zapier test -- -fo --testNamePattern \"auth pass\""
1279
+ ],
1280
+ "flags": {
1281
+ "skip-validate": {
1282
+ "description": "Forgo running `zapier validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.",
1283
+ "name": "skip-validate",
1284
+ "allowNo": false,
1285
+ "type": "boolean"
1286
+ },
1287
+ "yarn": {
1288
+ "description": "Use `yarn` instead of `npm`. This happens automatically if there's a `yarn.lock` file, but you can manually force `yarn` if you run tests from a sub-directory.",
1289
+ "name": "yarn",
1290
+ "allowNo": false,
1291
+ "type": "boolean"
1292
+ },
1293
+ "pnpm": {
1294
+ "description": "Use `pnpm` instead of `npm`. This happens automatically if there's a `pnpm-lock.yaml` file, but you can manually force `pnpm` if you run tests from a sub-directory.",
1295
+ "name": "pnpm",
1296
+ "allowNo": false,
1297
+ "type": "boolean"
1298
+ },
1299
+ "debug": {
1300
+ "char": "d",
1301
+ "description": "Show extra debugging output.",
1302
+ "name": "debug",
1303
+ "allowNo": false,
1304
+ "type": "boolean"
1305
+ },
1306
+ "invokedFromAnotherCommand": {
1307
+ "hidden": true,
1308
+ "name": "invokedFromAnotherCommand",
1309
+ "allowNo": false,
1310
+ "type": "boolean"
1311
+ }
1312
+ },
1313
+ "hasDynamicHelp": false,
1314
+ "hiddenAliases": [],
1315
+ "id": "test",
1316
+ "pluginAlias": "zapier-platform-cli",
1317
+ "pluginName": "zapier-platform-cli",
1318
+ "pluginType": "core",
1319
+ "strict": false,
1320
+ "enableJsonFlag": false,
1321
+ "skipValidInstallCheck": false,
1322
+ "isESM": false,
1323
+ "relativePath": [
1324
+ "src",
1325
+ "oclif",
1326
+ "commands",
1327
+ "test.js"
1328
+ ]
1329
+ },
1330
+ "upload": {
1331
+ "aliases": [],
1332
+ "args": {},
1333
+ "description": "Upload the latest build of your integration to Zapier.\n\nThis command sends both build/build.zip and build/source.zip to Zapier for use.\n\nTypically we recommend using `zapier push`, which does a build and upload, rather than `upload` by itself.\n",
1334
+ "flags": {
1335
+ "debug": {
1336
+ "char": "d",
1337
+ "description": "Show extra debugging output.",
1338
+ "name": "debug",
1339
+ "allowNo": false,
1340
+ "type": "boolean"
1341
+ },
1342
+ "invokedFromAnotherCommand": {
1343
+ "hidden": true,
1344
+ "name": "invokedFromAnotherCommand",
1345
+ "allowNo": false,
1346
+ "type": "boolean"
1347
+ }
1348
+ },
1349
+ "hasDynamicHelp": false,
1350
+ "hiddenAliases": [],
1351
+ "id": "upload",
1352
+ "pluginAlias": "zapier-platform-cli",
1353
+ "pluginName": "zapier-platform-cli",
1354
+ "pluginType": "core",
1355
+ "strict": true,
1356
+ "enableJsonFlag": false,
1357
+ "skipValidInstallCheck": true,
1358
+ "isESM": false,
1359
+ "relativePath": [
1360
+ "src",
1361
+ "oclif",
1362
+ "commands",
1363
+ "upload.js"
1364
+ ]
1365
+ },
1366
+ "validate": {
1367
+ "aliases": [],
1368
+ "args": {},
1369
+ "description": "Validate your integration.\n\nRun 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`.",
1370
+ "examples": [
1371
+ "zapier validate",
1372
+ "zapier validate --without-style",
1373
+ "zapier validate --format json"
1374
+ ],
1375
+ "flags": {
1376
+ "without-style": {
1377
+ "description": "Forgo pinging the Zapier server to run further checks.",
1378
+ "name": "without-style",
1379
+ "allowNo": false,
1380
+ "type": "boolean"
1381
+ },
1382
+ "debug": {
1383
+ "char": "d",
1384
+ "description": "Show extra debugging output.",
1385
+ "name": "debug",
1386
+ "allowNo": false,
1387
+ "type": "boolean"
1388
+ },
1389
+ "format": {
1390
+ "char": "f",
1391
+ "description": "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.",
1392
+ "name": "format",
1393
+ "default": "table",
1394
+ "hasDynamicHelp": false,
1395
+ "multiple": false,
1396
+ "options": [
1397
+ "plain",
1398
+ "json",
1399
+ "raw",
1400
+ "row",
1401
+ "table"
1402
+ ],
1403
+ "type": "option"
1404
+ },
1405
+ "invokedFromAnotherCommand": {
1406
+ "hidden": true,
1407
+ "name": "invokedFromAnotherCommand",
1408
+ "allowNo": false,
1409
+ "type": "boolean"
1410
+ }
1411
+ },
1412
+ "hasDynamicHelp": false,
1413
+ "hiddenAliases": [],
1414
+ "id": "validate",
1415
+ "pluginAlias": "zapier-platform-cli",
1416
+ "pluginName": "zapier-platform-cli",
1417
+ "pluginType": "core",
1418
+ "strict": true,
1419
+ "enableJsonFlag": false,
1420
+ "skipValidInstallCheck": false,
1421
+ "isESM": false,
1422
+ "relativePath": [
1423
+ "src",
1424
+ "oclif",
1425
+ "commands",
1426
+ "validate.js"
1427
+ ]
1428
+ },
1429
+ "versions": {
1430
+ "aliases": [],
1431
+ "args": {},
1432
+ "description": "List the versions of your integration available for use in the Zapier editor.",
1433
+ "flags": {
1434
+ "debug": {
1435
+ "char": "d",
1436
+ "description": "Show extra debugging output.",
1437
+ "name": "debug",
1438
+ "allowNo": false,
1439
+ "type": "boolean"
1440
+ },
1441
+ "format": {
1442
+ "char": "f",
1443
+ "description": "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.",
1444
+ "name": "format",
1445
+ "default": "table",
1446
+ "hasDynamicHelp": false,
1447
+ "multiple": false,
1448
+ "options": [
1449
+ "plain",
1450
+ "json",
1451
+ "raw",
1452
+ "row",
1453
+ "table"
1454
+ ],
1455
+ "type": "option"
1456
+ },
1457
+ "invokedFromAnotherCommand": {
1458
+ "hidden": true,
1459
+ "name": "invokedFromAnotherCommand",
1460
+ "allowNo": false,
1461
+ "type": "boolean"
1462
+ }
1463
+ },
1464
+ "hasDynamicHelp": false,
1465
+ "hiddenAliases": [],
1466
+ "id": "versions",
1467
+ "pluginAlias": "zapier-platform-cli",
1468
+ "pluginName": "zapier-platform-cli",
1469
+ "pluginType": "core",
1470
+ "strict": true,
1471
+ "enableJsonFlag": false,
1472
+ "skipValidInstallCheck": true,
1473
+ "isESM": false,
1474
+ "relativePath": [
1475
+ "src",
1476
+ "oclif",
1477
+ "commands",
1478
+ "versions.js"
1479
+ ]
1480
+ },
1481
+ "cache:clear": {
1482
+ "aliases": [],
1483
+ "args": {
1484
+ "majorVersion": {
1485
+ "description": "(Optional) The cache data will be deleted for this major version. If not provided, you must pick from a list of major versions for this integration.",
1486
+ "name": "majorVersion",
1487
+ "required": false
1488
+ }
1489
+ },
1490
+ "description": "Clear the cache data for a major version. \n\nThis command clears the cache data for a major version of your integration.\nThe job will be run in the background and may take some time to complete.\nYou can check `zapier history` to see the job status.\n",
1491
+ "examples": [
1492
+ "zapier cache:clear",
1493
+ "zapier cache:clear 2"
1494
+ ],
1495
+ "flags": {
1496
+ "debug": {
1497
+ "char": "d",
1498
+ "description": "Show extra debugging output.",
1499
+ "name": "debug",
1500
+ "allowNo": false,
1501
+ "type": "boolean"
1502
+ },
1503
+ "invokedFromAnotherCommand": {
1504
+ "hidden": true,
1505
+ "name": "invokedFromAnotherCommand",
1506
+ "allowNo": false,
1507
+ "type": "boolean"
1508
+ }
1509
+ },
1510
+ "hasDynamicHelp": false,
1511
+ "hiddenAliases": [],
1512
+ "id": "cache:clear",
1513
+ "pluginAlias": "zapier-platform-cli",
1514
+ "pluginName": "zapier-platform-cli",
1515
+ "pluginType": "core",
1516
+ "strict": true,
1517
+ "enableJsonFlag": false,
1518
+ "skipValidInstallCheck": true,
1519
+ "hide": true,
1520
+ "isESM": false,
1521
+ "relativePath": [
1522
+ "src",
1523
+ "oclif",
1524
+ "commands",
1525
+ "cache",
1526
+ "clear.js"
1527
+ ]
1528
+ },
1529
+ "canary:create": {
1530
+ "aliases": [],
1531
+ "args": {
1532
+ "versionFrom": {
1533
+ "description": "Version to route traffic from",
1534
+ "name": "versionFrom",
1535
+ "required": true
1536
+ },
1537
+ "versionTo": {
1538
+ "description": "Version to canary traffic to",
1539
+ "name": "versionTo",
1540
+ "required": true
1541
+ }
1542
+ },
1543
+ "description": "Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.\n\nOnly one canary can be active at the same time. You can run `zapier canary:list` to check. If you would like to create a new canary with different parameters, you can wait for the canary to finish, or delete it using `zapier canary:delete a.b.c x.y.z`.\n\nNote: this is similar to `zapier migrate` but different in that this is temporary and will \"revert\" the changes once the specified duration is expired.\n\n**Only use this command to canary traffic between non-breaking versions!**",
1544
+ "examples": [
1545
+ "zapier canary:create 1.0.0 1.1.0 -p 25 -d 720",
1546
+ "zapier canary:create 2.0.0 2.1.0 --percent 50 --duration 300"
1547
+ ],
1548
+ "flags": {
1549
+ "percent": {
1550
+ "char": "p",
1551
+ "description": "Percent of traffic to route to new version",
1552
+ "name": "percent",
1553
+ "required": true,
1554
+ "hasDynamicHelp": false,
1555
+ "multiple": false,
1556
+ "type": "option"
1557
+ },
1558
+ "duration": {
1559
+ "char": "d",
1560
+ "description": "Duration of the canary in seconds",
1561
+ "name": "duration",
1562
+ "required": true,
1563
+ "hasDynamicHelp": false,
1564
+ "multiple": false,
1565
+ "type": "option"
1566
+ },
1567
+ "debug": {
1568
+ "char": "d",
1569
+ "description": "Show extra debugging output.",
1570
+ "name": "debug",
1571
+ "allowNo": false,
1572
+ "type": "boolean"
1573
+ },
1574
+ "invokedFromAnotherCommand": {
1575
+ "hidden": true,
1576
+ "name": "invokedFromAnotherCommand",
1577
+ "allowNo": false,
1578
+ "type": "boolean"
1579
+ }
1580
+ },
1581
+ "hasDynamicHelp": false,
1582
+ "hiddenAliases": [],
1583
+ "id": "canary:create",
1584
+ "pluginAlias": "zapier-platform-cli",
1585
+ "pluginName": "zapier-platform-cli",
1586
+ "pluginType": "core",
1587
+ "strict": true,
1588
+ "enableJsonFlag": false,
1589
+ "skipValidInstallCheck": true,
1590
+ "isESM": false,
1591
+ "relativePath": [
1592
+ "src",
1593
+ "oclif",
1594
+ "commands",
1595
+ "canary",
1596
+ "create.js"
1597
+ ]
1598
+ },
1599
+ "canary:delete": {
1600
+ "aliases": [],
1601
+ "args": {
1602
+ "versionFrom": {
1603
+ "description": "Version to route traffic from",
1604
+ "name": "versionFrom",
1605
+ "required": true
1606
+ },
1607
+ "versionTo": {
1608
+ "description": "Version canary traffic is routed to",
1609
+ "name": "versionTo",
1610
+ "required": true
1611
+ }
1612
+ },
1613
+ "description": "Delete an active canary deployment",
1614
+ "examples": [
1615
+ "zapier canary:delete 1.0.0 1.1.0"
1616
+ ],
1617
+ "flags": {},
1618
+ "hasDynamicHelp": false,
1619
+ "hiddenAliases": [],
1620
+ "id": "canary:delete",
1621
+ "pluginAlias": "zapier-platform-cli",
1622
+ "pluginName": "zapier-platform-cli",
1623
+ "pluginType": "core",
1624
+ "strict": true,
1625
+ "enableJsonFlag": false,
1626
+ "skipValidInstallCheck": true,
1627
+ "isESM": false,
1628
+ "relativePath": [
1629
+ "src",
1630
+ "oclif",
1631
+ "commands",
1632
+ "canary",
1633
+ "delete.js"
1634
+ ]
1635
+ },
1636
+ "canary:list": {
1637
+ "aliases": [],
1638
+ "args": {},
1639
+ "description": "List all active canary deployments",
1640
+ "examples": [
1641
+ "zapier canary:list"
1642
+ ],
1643
+ "flags": {
1644
+ "debug": {
1645
+ "char": "d",
1646
+ "description": "Show extra debugging output.",
1647
+ "name": "debug",
1648
+ "allowNo": false,
1649
+ "type": "boolean"
1650
+ },
1651
+ "format": {
1652
+ "char": "f",
1653
+ "description": "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.",
1654
+ "name": "format",
1655
+ "default": "table",
1656
+ "hasDynamicHelp": false,
1657
+ "multiple": false,
1658
+ "options": [
1659
+ "plain",
1660
+ "json",
1661
+ "raw",
1662
+ "row",
1663
+ "table"
1664
+ ],
1665
+ "type": "option"
1666
+ },
1667
+ "invokedFromAnotherCommand": {
1668
+ "hidden": true,
1669
+ "name": "invokedFromAnotherCommand",
1670
+ "allowNo": false,
1671
+ "type": "boolean"
1672
+ }
1673
+ },
1674
+ "hasDynamicHelp": false,
1675
+ "hiddenAliases": [],
1676
+ "id": "canary:list",
1677
+ "pluginAlias": "zapier-platform-cli",
1678
+ "pluginName": "zapier-platform-cli",
1679
+ "pluginType": "core",
1680
+ "strict": true,
1681
+ "enableJsonFlag": false,
1682
+ "skipValidInstallCheck": true,
1683
+ "isESM": false,
1684
+ "relativePath": [
1685
+ "src",
1686
+ "oclif",
1687
+ "commands",
1688
+ "canary",
1689
+ "list.js"
1690
+ ]
1691
+ },
1692
+ "delete:integration": {
1693
+ "aliases": [
1694
+ "delete:app"
1695
+ ],
1696
+ "args": {},
1697
+ "description": "Delete your integration (including all versions).\n\nThis only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the `zapier delete:version` command instead. It's unlikely that you'll be able to run this on an app that you've pushed publicly, since there are usually still users.",
1698
+ "flags": {
1699
+ "debug": {
1700
+ "char": "d",
1701
+ "description": "Show extra debugging output.",
1702
+ "name": "debug",
1703
+ "allowNo": false,
1704
+ "type": "boolean"
1705
+ },
1706
+ "invokedFromAnotherCommand": {
1707
+ "hidden": true,
1708
+ "name": "invokedFromAnotherCommand",
1709
+ "allowNo": false,
1710
+ "type": "boolean"
1711
+ }
1712
+ },
1713
+ "hasDynamicHelp": false,
1714
+ "hiddenAliases": [],
1715
+ "id": "delete:integration",
1716
+ "pluginAlias": "zapier-platform-cli",
1717
+ "pluginName": "zapier-platform-cli",
1718
+ "pluginType": "core",
1719
+ "strict": true,
1720
+ "enableJsonFlag": false,
1721
+ "skipValidInstallCheck": true,
1722
+ "isESM": false,
1723
+ "relativePath": [
1724
+ "src",
1725
+ "oclif",
1726
+ "commands",
1727
+ "delete",
1728
+ "integration.js"
1729
+ ]
1730
+ },
1731
+ "delete:version": {
1732
+ "aliases": [],
1733
+ "args": {
1734
+ "version": {
1735
+ "description": "Specify the version to delete. It must have no users or Zaps.",
1736
+ "name": "version",
1737
+ "required": true
1738
+ }
1739
+ },
1740
+ "description": "Delete a specific version of your integration.\n\nThis only works if there are no users or Zaps on that version. You will probably need to have run `zapier migrate` and `zapier deprecate` before this command will work.",
1741
+ "flags": {
1742
+ "debug": {
1743
+ "char": "d",
1744
+ "description": "Show extra debugging output.",
1745
+ "name": "debug",
1746
+ "allowNo": false,
1747
+ "type": "boolean"
1748
+ },
1749
+ "invokedFromAnotherCommand": {
1750
+ "hidden": true,
1751
+ "name": "invokedFromAnotherCommand",
1752
+ "allowNo": false,
1753
+ "type": "boolean"
1754
+ }
1755
+ },
1756
+ "hasDynamicHelp": false,
1757
+ "hiddenAliases": [],
1758
+ "id": "delete:version",
1759
+ "pluginAlias": "zapier-platform-cli",
1760
+ "pluginName": "zapier-platform-cli",
1761
+ "pluginType": "core",
1762
+ "strict": true,
1763
+ "enableJsonFlag": false,
1764
+ "skipValidInstallCheck": true,
1765
+ "isESM": false,
1766
+ "relativePath": [
1767
+ "src",
1768
+ "oclif",
1769
+ "commands",
1770
+ "delete",
1771
+ "version.js"
1772
+ ]
1773
+ },
1774
+ "env:get": {
1775
+ "aliases": [],
1776
+ "args": {
1777
+ "version": {
1778
+ "description": "The version to get the environment for.",
1779
+ "name": "version",
1780
+ "required": true
1781
+ }
1782
+ },
1783
+ "description": "Get environment variables for a version.",
1784
+ "examples": [
1785
+ "zapier env:get 1.2.3"
1786
+ ],
1787
+ "flags": {
1788
+ "debug": {
1789
+ "char": "d",
1790
+ "description": "Show extra debugging output.",
1791
+ "name": "debug",
1792
+ "allowNo": false,
1793
+ "type": "boolean"
1794
+ },
1795
+ "format": {
1796
+ "char": "f",
1797
+ "description": "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.",
1798
+ "name": "format",
1799
+ "default": "table",
1800
+ "hasDynamicHelp": false,
1801
+ "multiple": false,
1802
+ "options": [
1803
+ "plain",
1804
+ "json",
1805
+ "raw",
1806
+ "row",
1807
+ "table"
1808
+ ],
1809
+ "type": "option"
1810
+ },
1811
+ "invokedFromAnotherCommand": {
1812
+ "hidden": true,
1813
+ "name": "invokedFromAnotherCommand",
1814
+ "allowNo": false,
1815
+ "type": "boolean"
1816
+ }
1817
+ },
1818
+ "hasDynamicHelp": false,
1819
+ "hiddenAliases": [],
1820
+ "id": "env:get",
1821
+ "pluginAlias": "zapier-platform-cli",
1822
+ "pluginName": "zapier-platform-cli",
1823
+ "pluginType": "core",
1824
+ "strict": true,
1825
+ "enableJsonFlag": false,
1826
+ "skipValidInstallCheck": true,
1827
+ "isESM": false,
1828
+ "relativePath": [
1829
+ "src",
1830
+ "oclif",
1831
+ "commands",
1832
+ "env",
1833
+ "get.js"
1834
+ ]
1835
+ },
1836
+ "env:set": {
1837
+ "aliases": [],
1838
+ "args": {
1839
+ "version": {
1840
+ "description": "The version to set the environment for. Values are copied forward when a new version is created, but this command will only ever affect the specified version.",
1841
+ "name": "version",
1842
+ "required": true
1843
+ },
1844
+ "key-value pairs...": {
1845
+ "description": "The key-value pairs to set. Keys are case-insensitive. Each pair should be space separated and pairs should be separated by an `=`. For example: `A=123 B=456`",
1846
+ "name": "key-value pairs..."
1847
+ }
1848
+ },
1849
+ "description": "Set environment variables for a version.",
1850
+ "examples": [
1851
+ "zapier env:set 1.2.3 SECRET=12345 OTHER=4321"
1852
+ ],
1853
+ "flags": {
1854
+ "debug": {
1855
+ "char": "d",
1856
+ "description": "Show extra debugging output.",
1857
+ "name": "debug",
1858
+ "allowNo": false,
1859
+ "type": "boolean"
1860
+ },
1861
+ "invokedFromAnotherCommand": {
1862
+ "hidden": true,
1863
+ "name": "invokedFromAnotherCommand",
1864
+ "allowNo": false,
1865
+ "type": "boolean"
1866
+ }
1867
+ },
1868
+ "hasDynamicHelp": false,
1869
+ "hiddenAliases": [],
1870
+ "id": "env:set",
1871
+ "pluginAlias": "zapier-platform-cli",
1872
+ "pluginName": "zapier-platform-cli",
1873
+ "pluginType": "core",
1874
+ "strict": false,
1875
+ "enableJsonFlag": false,
1876
+ "skipValidInstallCheck": true,
1877
+ "isESM": false,
1878
+ "relativePath": [
1879
+ "src",
1880
+ "oclif",
1881
+ "commands",
1882
+ "env",
1883
+ "set.js"
1884
+ ]
1885
+ },
1886
+ "env:unset": {
1887
+ "aliases": [],
1888
+ "args": {
1889
+ "version": {
1890
+ "description": "The version to set the environment for.",
1891
+ "name": "version",
1892
+ "required": true
1893
+ },
1894
+ "keys...": {
1895
+ "description": "The keys to unset. Keys are case-insensitive.",
1896
+ "name": "keys..."
1897
+ }
1898
+ },
1899
+ "description": "Unset environment variables for a version.",
1900
+ "examples": [
1901
+ "zapier env:unset 1.2.3 SECRET OTHER"
1902
+ ],
1903
+ "flags": {
1904
+ "debug": {
1905
+ "char": "d",
1906
+ "description": "Show extra debugging output.",
1907
+ "name": "debug",
1908
+ "allowNo": false,
1909
+ "type": "boolean"
1910
+ },
1911
+ "invokedFromAnotherCommand": {
1912
+ "hidden": true,
1913
+ "name": "invokedFromAnotherCommand",
1914
+ "allowNo": false,
1915
+ "type": "boolean"
1916
+ }
1917
+ },
1918
+ "hasDynamicHelp": false,
1919
+ "hiddenAliases": [],
1920
+ "id": "env:unset",
1921
+ "pluginAlias": "zapier-platform-cli",
1922
+ "pluginName": "zapier-platform-cli",
1923
+ "pluginType": "core",
1924
+ "strict": false,
1925
+ "enableJsonFlag": false,
1926
+ "skipValidInstallCheck": true,
1927
+ "isESM": false,
1928
+ "relativePath": [
1929
+ "src",
1930
+ "oclif",
1931
+ "commands",
1932
+ "env",
1933
+ "unset.js"
1934
+ ]
1935
+ },
1936
+ "team:add": {
1937
+ "aliases": [
1938
+ "team:invite"
1939
+ ],
1940
+ "args": {
1941
+ "email": {
1942
+ "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
1943
+ "name": "email",
1944
+ "required": true
1945
+ },
1946
+ "role": {
1947
+ "description": "The level the invited team member should be at. Admins can edit everything and get email updates. Collaborators have read-access to the app and get email updates. Subscribers only get email updates.",
1948
+ "name": "role",
1949
+ "options": [
1950
+ "admin",
1951
+ "collaborator",
1952
+ "subscriber"
1953
+ ],
1954
+ "required": true
1955
+ },
1956
+ "message": {
1957
+ "description": "A message sent in the email to your team member, if you need to provide context. Wrap the message in quotes to ensure spaces get saved.",
1958
+ "name": "message"
1959
+ }
1960
+ },
1961
+ "description": "Add a team member to your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nTeam members can be freely added and removed.",
1962
+ "examples": [
1963
+ "zapier team:add bruce@wayne.com admin",
1964
+ "zapier team:add robin@wayne.com collaborator \"Hey Robin, check out this app.\"",
1965
+ "zapier team:add alfred@wayne.com subscriber \"Hey Alfred, check out this app.\""
1966
+ ],
1967
+ "flags": {
1968
+ "debug": {
1969
+ "char": "d",
1970
+ "description": "Show extra debugging output.",
1971
+ "name": "debug",
1972
+ "allowNo": false,
1973
+ "type": "boolean"
1974
+ },
1975
+ "invokedFromAnotherCommand": {
1976
+ "hidden": true,
1977
+ "name": "invokedFromAnotherCommand",
1978
+ "allowNo": false,
1979
+ "type": "boolean"
1980
+ }
1981
+ },
1982
+ "hasDynamicHelp": false,
1983
+ "hiddenAliases": [],
1984
+ "id": "team:add",
1985
+ "pluginAlias": "zapier-platform-cli",
1986
+ "pluginName": "zapier-platform-cli",
1987
+ "pluginType": "core",
1988
+ "strict": true,
1989
+ "enableJsonFlag": false,
1990
+ "skipValidInstallCheck": true,
1991
+ "isESM": false,
1992
+ "relativePath": [
1993
+ "src",
1994
+ "oclif",
1995
+ "commands",
1996
+ "team",
1997
+ "add.js"
1998
+ ]
1999
+ },
2000
+ "team:get": {
2001
+ "aliases": [
2002
+ "team:list"
2003
+ ],
2004
+ "args": {},
2005
+ "description": "Get team members involved with your integration.\n\nThese users come in three levels:\n\n * `admin`, who can edit everything about the integration\n * `collaborator`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.\n * `subscriber`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.\n\nUse the `zapier team:add` and `zapier team:remove` commands to modify your team.\n",
2006
+ "flags": {
2007
+ "debug": {
2008
+ "char": "d",
2009
+ "description": "Show extra debugging output.",
2010
+ "name": "debug",
2011
+ "allowNo": false,
2012
+ "type": "boolean"
2013
+ },
2014
+ "format": {
2015
+ "char": "f",
2016
+ "description": "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.",
2017
+ "name": "format",
2018
+ "default": "table",
2019
+ "hasDynamicHelp": false,
2020
+ "multiple": false,
2021
+ "options": [
2022
+ "plain",
2023
+ "json",
2024
+ "raw",
2025
+ "row",
2026
+ "table"
2027
+ ],
2028
+ "type": "option"
2029
+ },
2030
+ "invokedFromAnotherCommand": {
2031
+ "hidden": true,
2032
+ "name": "invokedFromAnotherCommand",
2033
+ "allowNo": false,
2034
+ "type": "boolean"
2035
+ }
2036
+ },
2037
+ "hasDynamicHelp": false,
2038
+ "hiddenAliases": [],
2039
+ "id": "team:get",
2040
+ "pluginAlias": "zapier-platform-cli",
2041
+ "pluginName": "zapier-platform-cli",
2042
+ "pluginType": "core",
2043
+ "strict": true,
2044
+ "enableJsonFlag": false,
2045
+ "skipValidInstallCheck": true,
2046
+ "isESM": false,
2047
+ "relativePath": [
2048
+ "src",
2049
+ "oclif",
2050
+ "commands",
2051
+ "team",
2052
+ "get.js"
2053
+ ]
2054
+ },
2055
+ "team:remove": {
2056
+ "aliases": [
2057
+ "team:delete"
2058
+ ],
2059
+ "args": {},
2060
+ "description": "Remove a team member from all versions of your integration.\n\nAdmins will immediately lose write access to the integration.\nCollaborators will immediately lose read access to the integration.\nSubscribers won't receive future email updates.",
2061
+ "flags": {
2062
+ "debug": {
2063
+ "char": "d",
2064
+ "description": "Show extra debugging output.",
2065
+ "name": "debug",
2066
+ "allowNo": false,
2067
+ "type": "boolean"
2068
+ },
2069
+ "invokedFromAnotherCommand": {
2070
+ "hidden": true,
2071
+ "name": "invokedFromAnotherCommand",
2072
+ "allowNo": false,
2073
+ "type": "boolean"
2074
+ }
2075
+ },
2076
+ "hasDynamicHelp": false,
2077
+ "hiddenAliases": [],
2078
+ "id": "team:remove",
2079
+ "pluginAlias": "zapier-platform-cli",
2080
+ "pluginName": "zapier-platform-cli",
2081
+ "pluginType": "core",
2082
+ "strict": true,
2083
+ "enableJsonFlag": false,
2084
+ "skipValidInstallCheck": true,
2085
+ "isESM": false,
2086
+ "relativePath": [
2087
+ "src",
2088
+ "oclif",
2089
+ "commands",
2090
+ "team",
2091
+ "remove.js"
2092
+ ]
2093
+ },
2094
+ "users:add": {
2095
+ "aliases": [
2096
+ "users:invite"
2097
+ ],
2098
+ "args": {
2099
+ "email": {
2100
+ "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
2101
+ "name": "email",
2102
+ "required": true
2103
+ },
2104
+ "version": {
2105
+ "description": "A version string (like 1.2.3). Optional, used only if you want to invite a user to a specific version instead of all versions.",
2106
+ "name": "version"
2107
+ }
2108
+ },
2109
+ "description": "Add a user to some or all versions of your integration.\n\nWhen this command is run, we'll send an email to the user inviting them to try your integration. You can track the status of that invite using the `zapier users:get` command.\n\nInvited users will be able to see your integration's name, logo, and description. They'll also be able to create Zaps using any available triggers and actions.",
2110
+ "examples": [
2111
+ "zapier users:add bruce@wayne.com",
2112
+ "zapier users:add alfred@wayne.com 1.2.3"
2113
+ ],
2114
+ "flags": {
2115
+ "force": {
2116
+ "char": "f",
2117
+ "description": "Skip confirmation. Useful for running programatically.",
2118
+ "name": "force",
2119
+ "allowNo": false,
2120
+ "type": "boolean"
2121
+ },
2122
+ "debug": {
2123
+ "char": "d",
2124
+ "description": "Show extra debugging output.",
2125
+ "name": "debug",
2126
+ "allowNo": false,
2127
+ "type": "boolean"
2128
+ },
2129
+ "invokedFromAnotherCommand": {
2130
+ "hidden": true,
2131
+ "name": "invokedFromAnotherCommand",
2132
+ "allowNo": false,
2133
+ "type": "boolean"
2134
+ }
2135
+ },
2136
+ "hasDynamicHelp": false,
2137
+ "hiddenAliases": [],
2138
+ "id": "users:add",
2139
+ "pluginAlias": "zapier-platform-cli",
2140
+ "pluginName": "zapier-platform-cli",
2141
+ "pluginType": "core",
2142
+ "strict": true,
2143
+ "enableJsonFlag": false,
2144
+ "skipValidInstallCheck": true,
2145
+ "isESM": false,
2146
+ "relativePath": [
2147
+ "src",
2148
+ "oclif",
2149
+ "commands",
2150
+ "users",
2151
+ "add.js"
2152
+ ]
2153
+ },
2154
+ "users:get": {
2155
+ "aliases": [
2156
+ "users:list"
2157
+ ],
2158
+ "args": {},
2159
+ "description": "Get a list of users who have been invited to your integration.\n\nNote 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 `\u001b[36mzapier users:add\u001b[39m` command or the web UI). Users who joined by clicking links generated using the `\u001b[36mzapier user:links\u001b[39m` command won't show up here.",
2160
+ "flags": {
2161
+ "debug": {
2162
+ "char": "d",
2163
+ "description": "Show extra debugging output.",
2164
+ "name": "debug",
2165
+ "allowNo": false,
2166
+ "type": "boolean"
2167
+ },
2168
+ "format": {
2169
+ "char": "f",
2170
+ "description": "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.",
2171
+ "name": "format",
2172
+ "default": "table",
2173
+ "hasDynamicHelp": false,
2174
+ "multiple": false,
2175
+ "options": [
2176
+ "plain",
2177
+ "json",
2178
+ "raw",
2179
+ "row",
2180
+ "table"
2181
+ ],
2182
+ "type": "option"
2183
+ },
2184
+ "invokedFromAnotherCommand": {
2185
+ "hidden": true,
2186
+ "name": "invokedFromAnotherCommand",
2187
+ "allowNo": false,
2188
+ "type": "boolean"
2189
+ }
2190
+ },
2191
+ "hasDynamicHelp": false,
2192
+ "hiddenAliases": [],
2193
+ "id": "users:get",
2194
+ "pluginAlias": "zapier-platform-cli",
2195
+ "pluginName": "zapier-platform-cli",
2196
+ "pluginType": "core",
2197
+ "strict": true,
2198
+ "enableJsonFlag": false,
2199
+ "skipValidInstallCheck": true,
2200
+ "isESM": false,
2201
+ "relativePath": [
2202
+ "src",
2203
+ "oclif",
2204
+ "commands",
2205
+ "users",
2206
+ "get.js"
2207
+ ]
2208
+ },
2209
+ "users:links": {
2210
+ "aliases": [],
2211
+ "args": {},
2212
+ "description": "Get a list of links that are used to invite users to your integration.",
2213
+ "flags": {
2214
+ "debug": {
2215
+ "char": "d",
2216
+ "description": "Show extra debugging output.",
2217
+ "name": "debug",
2218
+ "allowNo": false,
2219
+ "type": "boolean"
2220
+ },
2221
+ "format": {
2222
+ "char": "f",
2223
+ "description": "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.",
2224
+ "name": "format",
2225
+ "default": "table",
2226
+ "hasDynamicHelp": false,
2227
+ "multiple": false,
2228
+ "options": [
2229
+ "plain",
2230
+ "json",
2231
+ "raw",
2232
+ "row",
2233
+ "table"
2234
+ ],
2235
+ "type": "option"
2236
+ },
2237
+ "invokedFromAnotherCommand": {
2238
+ "hidden": true,
2239
+ "name": "invokedFromAnotherCommand",
2240
+ "allowNo": false,
2241
+ "type": "boolean"
2242
+ }
2243
+ },
2244
+ "hasDynamicHelp": false,
2245
+ "hiddenAliases": [],
2246
+ "id": "users:links",
2247
+ "pluginAlias": "zapier-platform-cli",
2248
+ "pluginName": "zapier-platform-cli",
2249
+ "pluginType": "core",
2250
+ "strict": true,
2251
+ "enableJsonFlag": false,
2252
+ "skipValidInstallCheck": true,
2253
+ "isESM": false,
2254
+ "relativePath": [
2255
+ "src",
2256
+ "oclif",
2257
+ "commands",
2258
+ "users",
2259
+ "links.js"
2260
+ ]
2261
+ },
2262
+ "users:remove": {
2263
+ "aliases": [
2264
+ "users:delete"
2265
+ ],
2266
+ "args": {
2267
+ "email": {
2268
+ "description": "The user to be removed.",
2269
+ "name": "email",
2270
+ "required": true
2271
+ }
2272
+ },
2273
+ "description": "Remove a user from all versions of your integration.\n\nWhen this command is run, their Zaps will immediately turn off. They won't be able to use your app again until they're re-invited or it has gone public. In practice, this command isn't run often as it's very disruptive to users.",
2274
+ "flags": {
2275
+ "force": {
2276
+ "char": "f",
2277
+ "description": "Skips confirmation. Useful for running programatically.",
2278
+ "name": "force",
2279
+ "allowNo": false,
2280
+ "type": "boolean"
2281
+ },
2282
+ "debug": {
2283
+ "char": "d",
2284
+ "description": "Show extra debugging output.",
2285
+ "name": "debug",
2286
+ "allowNo": false,
2287
+ "type": "boolean"
2288
+ },
2289
+ "invokedFromAnotherCommand": {
2290
+ "hidden": true,
2291
+ "name": "invokedFromAnotherCommand",
2292
+ "allowNo": false,
2293
+ "type": "boolean"
2294
+ }
2295
+ },
2296
+ "hasDynamicHelp": false,
2297
+ "hiddenAliases": [],
2298
+ "id": "users:remove",
2299
+ "pluginAlias": "zapier-platform-cli",
2300
+ "pluginName": "zapier-platform-cli",
2301
+ "pluginType": "core",
2302
+ "strict": true,
2303
+ "enableJsonFlag": false,
2304
+ "skipValidInstallCheck": true,
2305
+ "isESM": false,
2306
+ "relativePath": [
2307
+ "src",
2308
+ "oclif",
2309
+ "commands",
2310
+ "users",
2311
+ "remove.js"
2312
+ ]
2313
+ }
2314
+ },
2315
+ "version": "16.1.0"
2316
+ }