zapier-platform-cli 18.5.0 → 18.5.1

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 (38) hide show
  1. package/package.json +3 -3
  2. package/src/oclif/ZapierBaseCommand.js +1 -1
  3. package/src/oclif/commands/analytics.js +1 -1
  4. package/src/oclif/commands/build.js +3 -3
  5. package/src/oclif/commands/cache/clear.js +5 -2
  6. package/src/oclif/commands/canary/create.js +7 -7
  7. package/src/oclif/commands/canary/delete.js +1 -1
  8. package/src/oclif/commands/canary/list.js +1 -1
  9. package/src/oclif/commands/convert.js +1 -1
  10. package/src/oclif/commands/delete/integration.js +1 -1
  11. package/src/oclif/commands/delete/version.js +1 -1
  12. package/src/oclif/commands/deprecate.js +4 -4
  13. package/src/oclif/commands/describe.js +3 -3
  14. package/src/oclif/commands/env/get.js +2 -2
  15. package/src/oclif/commands/env/set.js +3 -1
  16. package/src/oclif/commands/env/unset.js +1 -1
  17. package/src/oclif/commands/init.js +5 -5
  18. package/src/oclif/commands/integrations.js +2 -1
  19. package/src/oclif/commands/invoke/auth/refresh.js +1 -1
  20. package/src/oclif/commands/jobs.js +2 -2
  21. package/src/oclif/commands/legacy.js +1 -1
  22. package/src/oclif/commands/link.js +2 -2
  23. package/src/oclif/commands/logs.js +3 -3
  24. package/src/oclif/commands/migrate.js +10 -10
  25. package/src/oclif/commands/promote.js +5 -5
  26. package/src/oclif/commands/pull.js +1 -1
  27. package/src/oclif/commands/push.js +5 -2
  28. package/src/oclif/commands/register.js +8 -8
  29. package/src/oclif/commands/scaffold.js +4 -4
  30. package/src/oclif/commands/team/add.js +3 -3
  31. package/src/oclif/commands/team/get.js +2 -2
  32. package/src/oclif/commands/test.js +4 -4
  33. package/src/oclif/commands/upload.js +1 -1
  34. package/src/oclif/commands/users/add.js +3 -3
  35. package/src/oclif/commands/users/get.js +4 -4
  36. package/src/oclif/commands/users/links.js +1 -1
  37. package/src/oclif/commands/validate.js +5 -5
  38. package/src/oclif/commands/versions.js +1 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zapier-platform-cli",
3
- "version": "18.5.0",
3
+ "version": "18.5.1",
4
4
  "description": "The CLI for managing integrations in Zapier Developer Platform.",
5
5
  "repository": "zapier/zapier-platform",
6
6
  "homepage": "https://platform.zapier.com/",
@@ -87,8 +87,8 @@
87
87
  "additionalVersionFlags": [
88
88
  "-v"
89
89
  ],
90
- "bin": "zapier",
91
- "dirname": "zapier",
90
+ "bin": "zapier-platform",
91
+ "dirname": "zapier-platform",
92
92
  "plugins": [
93
93
  "@oclif/plugin-autocomplete",
94
94
  "@oclif/plugin-help",
@@ -267,7 +267,7 @@ class ZapierBaseCommand extends Command {
267
267
  }));
268
268
  const visibleArgv = argv.filter((arg) => !arg.hidden);
269
269
 
270
- return ['zapier', name, ...visibleArgv.map(formatArg)].join(' ');
270
+ return ['zapier-platform', name, ...visibleArgv.map(formatArg)].join(' ');
271
271
  }
272
272
 
273
273
  // this is fine for now but we'll want to hack into https://github.com/oclif/plugin-help/blob/master/src/command.ts at some point
@@ -40,7 +40,7 @@ AnalyticsCommand.flags = buildFlags({
40
40
  }),
41
41
  },
42
42
  });
43
- AnalyticsCommand.examples = ['zapier analytics --mode enabled'];
43
+ AnalyticsCommand.examples = ['zapier-platform analytics --mode enabled'];
44
44
  AnalyticsCommand.description = `Show the status of the analytics that are collected. Also used to change what is collected.`;
45
45
  AnalyticsCommand.skipValidInstallCheck = true;
46
46
 
@@ -24,12 +24,12 @@ class BuildCommand extends BaseCommand {
24
24
 
25
25
  this.log(
26
26
  `\nBuild complete! Created ${BUILD_PATH} and ${SOURCE_PATH}.\n` +
27
- `Now you can upload them with the ${colors.bold.underline('zapier upload')} command.`,
27
+ `Now you can upload them with the ${colors.bold.underline('zapier-platform upload')} command.`,
28
28
  );
29
29
 
30
30
  if (!skipDepInstall) {
31
31
  this.log(
32
- `\nTip: Try ${colors.bold.underline('zapier build --skip-dep-install')} for faster builds.`,
32
+ `\nTip: Try ${colors.bold.underline('zapier-platform build --skip-dep-install')} for faster builds.`,
33
33
  );
34
34
  }
35
35
  }
@@ -64,6 +64,6 @@ This command does the following:
64
64
  * 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 \`${CURRENT_APP_FILE}\`.
65
65
  * Moves the zip to \`${BUILD_PATH}\` and \`${SOURCE_PATH}\` and deletes the temp folder
66
66
 
67
- This command is typically followed by \`zapier upload\`.`;
67
+ This command is typically followed by \`zapier-platform upload\`.`;
68
68
 
69
69
  module.exports = BuildCommand;
@@ -104,9 +104,12 @@ ClearCacheCommand.description = `Clear the cache data for a major version.
104
104
 
105
105
  This command clears the cache data for a major version of your integration.
106
106
  The job will be run in the background and may take some time to complete.
107
- You can check \`zapier history\` to see the job status.
107
+ You can check \`zapier-platform history\` to see the job status.
108
108
  `;
109
- ClearCacheCommand.examples = [`zapier cache:clear`, `zapier cache:clear 2`];
109
+ ClearCacheCommand.examples = [
110
+ `zapier-platform cache:clear`,
111
+ `zapier-platform cache:clear 2`,
112
+ ];
110
113
  ClearCacheCommand.skipValidInstallCheck = true;
111
114
  ClearCacheCommand.hide = true;
112
115
 
@@ -24,7 +24,7 @@ class CanaryCreateCommand extends ZapierBaseCommand {
24
24
  this
25
25
  .log(`A canary deployment already exists from version ${existingCanary.from_version} to version ${existingCanary.to_version}, there are ${secondsRemaining} seconds remaining.
26
26
 
27
- If you would like to stop this canary now, run \`zapier canary:delete ${existingCanary.from_version} ${existingCanary.to_version}\``);
27
+ If you would like to stop this canary now, run \`zapier-platform canary:delete ${existingCanary.from_version} ${existingCanary.to_version}\``);
28
28
  return;
29
29
  }
30
30
 
@@ -126,7 +126,7 @@ CanaryCreateCommand.args = {
126
126
 
127
127
  CanaryCreateCommand.description = `Create a new canary deployment, diverting a specified percentage of traffic from one version to another for a specified duration.
128
128
 
129
- Only 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\`.
129
+ Only one canary can be active at the same time. You can run \`zapier-platform 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-platform canary:delete a.b.c x.y.z\`.
130
130
 
131
131
  To canary traffic for a specific user, use the --user flag.
132
132
 
@@ -134,15 +134,15 @@ To canary traffic for an entire account, use the --account-id. Note: this scenar
134
134
 
135
135
  To canary traffic for a specific user within a specific account, use both --user and --account-id flags.
136
136
 
137
- Note: this is similar to \`zapier migrate\` but different in that this is temporary and will "revert" the changes once the specified duration is expired.
137
+ Note: this is similar to \`zapier-platform migrate\` but different in that this is temporary and will "revert" the changes once the specified duration is expired.
138
138
 
139
139
  **Only use this command to canary traffic between non-breaking versions!**`;
140
140
 
141
141
  CanaryCreateCommand.examples = [
142
- 'zapier canary:create 1.0.0 1.1.0 -p 10 -d 3600',
143
- 'zapier canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com',
144
- 'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com',
145
- 'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345',
142
+ 'zapier-platform canary:create 1.0.0 1.1.0 -p 10 -d 3600',
143
+ 'zapier-platform canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com',
144
+ 'zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com',
145
+ 'zapier-platform canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345',
146
146
  ];
147
147
  CanaryCreateCommand.skipValidInstallCheck = true;
148
148
 
@@ -63,7 +63,7 @@ CanaryDeleteCommand.args = {
63
63
  }),
64
64
  };
65
65
  CanaryDeleteCommand.description = 'Delete an active canary deployment';
66
- CanaryDeleteCommand.examples = ['zapier canary:delete 1.0.0 1.1.0'];
66
+ CanaryDeleteCommand.examples = ['zapier-platform canary:delete 1.0.0 1.1.0'];
67
67
  CanaryDeleteCommand.skipValidInstallCheck = true;
68
68
 
69
69
  module.exports = CanaryDeleteCommand;
@@ -34,7 +34,7 @@ class CanaryListCommand extends ZapierBaseCommand {
34
34
 
35
35
  CanaryListCommand.flags = buildFlags({ opts: { format: true } });
36
36
  CanaryListCommand.description = 'List all active canary deployments';
37
- CanaryListCommand.examples = ['zapier canary:list'];
37
+ CanaryListCommand.examples = ['zapier-platform canary:list'];
38
38
  CanaryListCommand.skipValidInstallCheck = true;
39
39
 
40
40
  module.exports = CanaryListCommand;
@@ -156,7 +156,7 @@ The resulting CLI integration will be identical to its Visual Builder version an
156
156
 
157
157
  If you re-run this command on an existing directory it will leave existing files alone and not clobber them.
158
158
 
159
- You'll need to do a \`zapier push\` before the new version is visible in the editor, but otherwise you're good to go.`;
159
+ You'll need to do a \`zapier-platform push\` before the new version is visible in the editor, but otherwise you're good to go.`;
160
160
 
161
161
  ConvertCommand.skipValidInstallCheck = true;
162
162
 
@@ -17,7 +17,7 @@ class DeleteAppCommand extends BaseCommand {
17
17
  DeleteAppCommand.flags = buildFlags();
18
18
  DeleteAppCommand.description = `Delete your integration (including all versions).
19
19
 
20
- This 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.`;
20
+ This only works if there are no active users or Zaps on any version. If you only want to delete certain versions, use the \`zapier-platform 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.`;
21
21
  DeleteAppCommand.aliases = ['delete:app'];
22
22
  DeleteAppCommand.skipValidInstallCheck = true;
23
23
 
@@ -27,6 +27,6 @@ DeleteVersionCommand.flags = buildFlags();
27
27
  DeleteVersionCommand.skipValidInstallCheck = true;
28
28
  DeleteVersionCommand.description = `Delete a specific version of your integration.
29
29
 
30
- This 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.`;
30
+ This only works if there are no users or Zaps on that version. You will probably need to have run \`zapier-platform migrate\` and \`zapier-platform deprecate\` before this command will work.`;
31
31
 
32
32
  module.exports = DeleteVersionCommand;
@@ -23,7 +23,7 @@ class DeprecateCommand extends BaseCommand {
23
23
 
24
24
  this.log(
25
25
  `${colors.yellow('Warning: Deprecation is an irreversible action that will eventually block access to this version.')}\n` +
26
- `${colors.yellow('If all your changes are non-breaking, use `zapier migrate` instead to move users over to a newer version.')}\n`,
26
+ `${colors.yellow('If all your changes are non-breaking, use `zapier-platform migrate` instead to move users over to a newer version.')}\n`,
27
27
  );
28
28
 
29
29
  // Get deprecation reason - either from flag or prompt user
@@ -118,9 +118,9 @@ DeprecateCommand.args = {
118
118
  }),
119
119
  };
120
120
  DeprecateCommand.examples = [
121
- 'zapier deprecate 1.2.3 2011-10-01',
122
- 'zapier deprecate 1.2.3 2011-10-01 --reason=security_vulnerability',
123
- 'zapier deprecate 1.2.3 2011-10-01 -r critical_bug',
121
+ 'zapier-platform deprecate 1.2.3 2011-10-01',
122
+ 'zapier-platform deprecate 1.2.3 2011-10-01 --reason=security_vulnerability',
123
+ 'zapier-platform deprecate 1.2.3 2011-10-01 -r critical_bug',
124
124
  ];
125
125
  DeprecateCommand.description = `Mark a non-production version of your integration as deprecated, with removal by a certain date.
126
126
 
@@ -95,7 +95,7 @@ class DescribeCommand extends BaseCommand {
95
95
  authentication.redirect_uri = version.oauth_redirect_uri;
96
96
  } else {
97
97
  authentication.redirect_uri = grey(
98
- 'Run `zapier push` to see the redirect_uri.',
98
+ 'Run `zapier-platform push` to see the redirect_uri.',
99
99
  );
100
100
  }
101
101
  }
@@ -182,13 +182,13 @@ class DescribeCommand extends BaseCommand {
182
182
  ['Available Methods', 'paths', grey('n/a')],
183
183
  ],
184
184
  emptyMessage: grey(
185
- `Nothing found for ${type}. Use the \`zapier scaffold\` command to add one.`,
185
+ `Nothing found for ${type}. Use the \`zapier-platform scaffold\` command to add one.`,
186
186
  ),
187
187
  });
188
188
 
189
189
  this.log();
190
190
 
191
- this.log('To add more, use the `zapier scaffold` command.');
191
+ this.log('To add more, use the `zapier-platform scaffold` command.');
192
192
  });
193
193
  }
194
194
  }
@@ -19,7 +19,7 @@ class GetEnvCommand extends BaseCommand {
19
19
  emptyMessage: `Version ${version} has no environment values set`,
20
20
  });
21
21
 
22
- this.log('Set new values with `zapier env:set`');
22
+ this.log('Set new values with `zapier-platform env:set`');
23
23
  }
24
24
  }
25
25
 
@@ -31,7 +31,7 @@ GetEnvCommand.args = {
31
31
  };
32
32
  GetEnvCommand.flags = buildFlags({ opts: { format: true } });
33
33
  GetEnvCommand.description = `Get environment variables for a version.`;
34
- GetEnvCommand.examples = [`zapier env:get 1.2.3`];
34
+ GetEnvCommand.examples = [`zapier-platform env:get 1.2.3`];
35
35
  GetEnvCommand.skipValidInstallCheck = true;
36
36
 
37
37
  module.exports = GetEnvCommand;
@@ -104,7 +104,9 @@ SetEnvCommand.flags = buildFlags({
104
104
  },
105
105
  });
106
106
  SetEnvCommand.description = `Set environment variables for a version.`;
107
- SetEnvCommand.examples = [`zapier env:set 1.2.3 SECRET=12345 OTHER=4321`];
107
+ SetEnvCommand.examples = [
108
+ `zapier-platform env:set 1.2.3 SECRET=12345 OTHER=4321`,
109
+ ];
108
110
  SetEnvCommand.strict = false;
109
111
  SetEnvCommand.skipValidInstallCheck = true;
110
112
 
@@ -90,7 +90,7 @@ UnsetEnvCommand.flags = buildFlags({
90
90
  },
91
91
  });
92
92
  UnsetEnvCommand.description = `Unset environment variables for a version.`;
93
- UnsetEnvCommand.examples = [`zapier env:unset 1.2.3 SECRET OTHER`];
93
+ UnsetEnvCommand.examples = [`zapier-platform env:unset 1.2.3 SECRET OTHER`];
94
94
  UnsetEnvCommand.strict = false;
95
95
  UnsetEnvCommand.skipValidInstallCheck = true;
96
96
 
@@ -56,16 +56,16 @@ InitCommand.args = {
56
56
  }),
57
57
  };
58
58
  InitCommand.examples = [
59
- 'zapier init myapp',
60
- 'zapier init ./path/myapp --template oauth2',
61
- 'zapier init ./path/myapp --template minimal --module esm',
62
- 'zapier init ./path/myapp --template oauth2 --language typescript',
59
+ 'zapier-platform init myapp',
60
+ 'zapier-platform init ./path/myapp --template oauth2',
61
+ 'zapier-platform init ./path/myapp --template minimal --module esm',
62
+ 'zapier-platform init ./path/myapp --template oauth2 --language typescript',
63
63
  ];
64
64
  InitCommand.description = `Initialize a new Zapier integration with a project template.
65
65
 
66
66
  After 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.
67
67
 
68
- This doesn't register or deploy the integration with Zapier - try the \`zapier register\` and \`zapier push\` commands for that!`;
68
+ This doesn't register or deploy the integration with Zapier - try the \`zapier-platform register\` and \`zapier-platform push\` commands for that!`;
69
69
 
70
70
  InitCommand.skipValidInstallCheck = true;
71
71
 
@@ -19,7 +19,8 @@ class IntegrationsCommand extends BaseCommand {
19
19
  ['Date Created', 'date'],
20
20
  ['Linked', 'linked'],
21
21
  ],
22
- emptyMessage: 'No integrations found, try the `zapier register` command.',
22
+ emptyMessage:
23
+ 'No integrations found, try the `zapier-platform register` command.',
23
24
  });
24
25
  }
25
26
  }
@@ -69,7 +69,7 @@ const refreshAuth = async (context) => {
69
69
  }
70
70
  if (_.isEmpty(context.authData)) {
71
71
  throw new Error(
72
- 'No auth data found in the .env file. Run `zapier invoke auth start` first to initialize the auth data.',
72
+ 'No auth data found in the .env file. Run `zapier-platform invoke auth start` first to initialize the auth data.',
73
73
  );
74
74
  }
75
75
  switch (authentication.type) {
@@ -75,12 +75,12 @@ class JobsCommand extends BaseCommand {
75
75
  ['Errors', 'error_message'],
76
76
  ],
77
77
  emptyMessage:
78
- 'No recent migration or promotion jobs found. Try `zapier history` if you see older jobs.',
78
+ 'No recent migration or promotion jobs found. Try `zapier-platform history` if you see older jobs.',
79
79
  });
80
80
  }
81
81
  }
82
82
 
83
- JobsCommand.examples = ['zapier jobs'];
83
+ JobsCommand.examples = ['zapier-platform jobs'];
84
84
  JobsCommand.description = `Lists ongoing migration or promotion jobs for the current integration.
85
85
 
86
86
  A job represents a background process that will be queued up when users execute a "migrate" or "promote" command for the current integration.
@@ -45,7 +45,7 @@ LegacyCommand.args = {
45
45
  required: true,
46
46
  }),
47
47
  };
48
- LegacyCommand.examples = ['zapier legacy 1.2.3'];
48
+ LegacyCommand.examples = ['zapier-platform legacy 1.2.3'];
49
49
  LegacyCommand.description = `Mark a non-production version of your integration as legacy.
50
50
 
51
51
  Use this when an integration version is no longer recommended for new users, but you don't want to block existing users from using it.
@@ -37,7 +37,7 @@ class LinkCommand extends BaseCommand {
37
37
  this.startSpinner(`Setting up ${CURRENT_APP_FILE}`);
38
38
  await writeLinkedAppConfig(chosenApp);
39
39
  this.stopSpinner();
40
- this.log(`Done! Now you can \`${cyan('zapier push')}\``);
40
+ this.log(`Done! Now you can \`${cyan('zapier-platform push')}\``);
41
41
  }
42
42
  }
43
43
 
@@ -47,6 +47,6 @@ LinkCommand.description = `Link the current directory with an existing integrati
47
47
 
48
48
  This command generates a \`${CURRENT_APP_FILE}\` 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.
49
49
 
50
- If you're starting an integration from scratch, use \`zapier init\` instead.`;
50
+ If you're starting an integration from scratch, use \`zapier-platform init\` instead.`;
51
51
 
52
52
  module.exports = LinkCommand;
@@ -93,7 +93,7 @@ class LogsCommand extends BaseCommand {
93
93
  rows: logs.reverse(), // oldest logs first
94
94
  headers,
95
95
  emptyMessage:
96
- 'No logs found. Try adding some `z.request()`, `z.console.log()` and doing a `zapier push`!\n',
96
+ 'No logs found. Try adding some `z.request()`, `z.console.log()` and doing a `zapier-platform push`!\n',
97
97
  });
98
98
 
99
99
  if (hasLogs) {
@@ -102,7 +102,7 @@ class LogsCommand extends BaseCommand {
102
102
  if (this.flags.type === 'http' && !this.flags.detailed) {
103
103
  this.log(
104
104
  grey(
105
- ' TIP: Use `zapier logs --type=http --detailed` to include response information.',
105
+ ' TIP: Use `zapier-platform logs --type=http --detailed` to include response information.',
106
106
  ),
107
107
  );
108
108
  }
@@ -119,6 +119,6 @@ LogsCommand.description = `Print recent logs.
119
119
 
120
120
  Logs 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.
121
121
 
122
- This won't show logs from running locally with \`zapier test\`, since those never hit our server.`;
122
+ This won't show logs from running locally with \`zapier-platform test\`, since those never hit our server.`;
123
123
 
124
124
  module.exports = LogsCommand;
@@ -143,7 +143,7 @@ class MigrateCommand extends BaseCommand {
143
143
  this.stopSpinner();
144
144
 
145
145
  this.log(
146
- `\nMigration successfully queued, check ${colors.bold.underline('zapier jobs')} to track the status. Migrations usually take between 5-10 minutes.`,
146
+ `\nMigration successfully queued, check ${colors.bold.underline('zapier-platform jobs')} to track the status. Migrations usually take between 5-10 minutes.`,
147
147
  );
148
148
  }
149
149
  }
@@ -184,24 +184,24 @@ MigrateCommand.args = {
184
184
 
185
185
  MigrateCommand.skipValidInstallCheck = true;
186
186
  MigrateCommand.examples = [
187
- 'zapier migrate 1.0.0 1.0.1',
188
- 'zapier migrate 1.0.1 2.0.0 10',
189
- 'zapier migrate 2.0.0 2.0.1 --user=user@example.com',
190
- 'zapier migrate 2.0.0 2.0.1 --account=account@example.com',
187
+ 'zapier-platform migrate 1.0.0 1.0.1',
188
+ 'zapier-platform migrate 1.0.1 2.0.0 10',
189
+ 'zapier-platform migrate 2.0.0 2.0.1 --user=user@example.com',
190
+ 'zapier-platform migrate 2.0.0 2.0.1 --account=account@example.com',
191
191
  ];
192
192
  MigrateCommand.description = `Migrate a percentage of users or a single user from one version of your integration to another.
193
193
 
194
- Start 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\`).
194
+ Start 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-platform migrate 1.0.1 1.0.0\`).
195
195
 
196
- **Only use this command to migrate users between non-breaking versions, use \`zapier deprecate\` if you have breaking changes!**
196
+ **Only use this command to migrate users between non-breaking versions, use \`zapier-platform deprecate\` if you have breaking changes!**
197
197
 
198
- Migration 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.
198
+ Migration time varies based on the number of affected Zaps. Be patient and check \`zapier-platform jobs\` to track the status. Or use \`zapier-platform history\` if you want to see older jobs.
199
199
 
200
200
  Since a migration is only for non-breaking changes, users are not emailed about the update/migration. It will be a transparent process for them.
201
201
 
202
202
  We 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.
203
203
 
204
- You 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
204
+ You can migrate a specific user's Zaps by using \`--user\` (i.e. \`zapier-platform migrate 1.0.0 1.0.1 --user=user@example.com\`). This will migrate Zaps that are private for that user. Zaps that are
205
205
 
206
206
  - [shared across the team](https://help.zapier.com/hc/en-us/articles/8496277647629),
207
207
  - [shared app connections](https://help.zapier.com/hc/en-us/articles/8496326497037-Share-app-connections-with-your-team), or
@@ -209,7 +209,7 @@ You can migrate a specific user's Zaps by using \`--user\` (i.e. \`zapier migrat
209
209
 
210
210
  will **not** be migrated.
211
211
 
212
- Alternatively, 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.
212
+ Alternatively, you can pass the \`--account\` flag, (i.e. \`zapier-platform 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.
213
213
 
214
214
  **The \`--account\` flag should be used cautiously as it can break shared Zaps for other users in Team or Enterprise accounts.**
215
215
 
@@ -279,15 +279,15 @@ PromoteCommand.args = {
279
279
  };
280
280
 
281
281
  PromoteCommand.skipValidInstallCheck = true;
282
- PromoteCommand.examples = ['zapier promote 1.0.0'];
282
+ PromoteCommand.examples = ['zapier-platform promote 1.0.0'];
283
283
  PromoteCommand.description = `Promote a specific version to public access.
284
284
 
285
285
  Promote an integration version into production (non-private) rotation, which means new users can use this integration version.
286
286
 
287
287
  * This **does** mark the version as the official public version - all other versions & users are grandfathered.
288
- * This does **NOT** build/upload or deploy a version to Zapier - you should \`zapier push\` first.
289
- * This does **NOT** move old users over to this version - \`zapier migrate 1.0.0 1.0.1\` does that.
290
- * This does **NOT** recommend old users stop using this version - \`zapier deprecate 1.0.0 2017-01-01\` does that.
288
+ * This does **NOT** build/upload or deploy a version to Zapier - you should \`zapier-platform push\` first.
289
+ * This does **NOT** move old users over to this version - \`zapier-platform migrate 1.0.0 1.0.1\` does that.
290
+ * This does **NOT** recommend old users stop using this version - \`zapier-platform deprecate 1.0.0 2017-01-01\` does that.
291
291
 
292
292
  Promotes are an inherently safe operation for all existing users of your integration.
293
293
 
@@ -295,6 +295,6 @@ After a promotion, go to your developer platform to [close issues that were reso
295
295
 
296
296
  If 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.
297
297
 
298
- Check \`zapier jobs\` to track the status of the promotion. Or use \`zapier history\` if you want to see older jobs.`;
298
+ Check \`zapier-platform jobs\` to track the status of the promotion. Or use \`zapier-platform history\` if you want to see older jobs.`;
299
299
 
300
300
  module.exports = PromoteCommand;
@@ -58,7 +58,7 @@ PullCommand.description = `Retrieve and update your local integration files with
58
58
 
59
59
  This command updates your local integration files with the promoted version (or latest version if not public). You will be prompted with a confirmation dialog before continuing if there any destructive file changes.
60
60
 
61
- Zapier 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\`:
61
+ Zapier 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-platform pull\`:
62
62
 
63
63
  * push to the promoted version
64
64
  * promote a new version
@@ -56,9 +56,12 @@ PushCommand.flags = {
56
56
  'Pass in a label to create a snapshot version of this integration for development and testing purposes. The version will be created as: 0.0.0-MY-LABEL',
57
57
  }),
58
58
  };
59
- PushCommand.examples = ['zapier push', 'zapier push --snapshot MY-LABEL'];
59
+ PushCommand.examples = [
60
+ 'zapier-platform push',
61
+ 'zapier-platform push --snapshot MY-LABEL',
62
+ ];
60
63
  PushCommand.description = `Build and upload the current integration.
61
64
 
62
- This command is the same as running \`zapier build\` and \`zapier upload\` in sequence. See those for more info.`;
65
+ This command is the same as running \`zapier-platform build\` and \`zapier-platform upload\` in sequence. See those for more info.`;
63
66
 
64
67
  module.exports = PushCommand;
@@ -18,7 +18,7 @@ const {
18
18
 
19
19
  class RegisterCommand extends ZapierBaseCommand {
20
20
  /**
21
- * Entry point function that runs when user runs `zapier register`
21
+ * Entry point function that runs when user runs `zapier-platform register`
22
22
  */
23
23
  async perform() {
24
24
  // Flag validation
@@ -73,7 +73,7 @@ class RegisterCommand extends ZapierBaseCommand {
73
73
  await writeLinkedAppConfig(app, process.cwd());
74
74
  this.stopSpinner();
75
75
  this.log(
76
- '\nFinished! Now that your integration is registered with Zapier, you can `zapier push`!',
76
+ '\nFinished! Now that your integration is registered with Zapier, you can `zapier-platform push`!',
77
77
  );
78
78
  break;
79
79
  }
@@ -297,16 +297,16 @@ RegisterCommand.flags = buildFlags({
297
297
  },
298
298
  });
299
299
  RegisterCommand.examples = [
300
- 'zapier register',
301
- 'zapier register "My Cool Integration"',
302
- 'zapier register "My Cool Integration" --desc "My Cool Integration helps you integrate your apps with the apps that you need." --no-subscribe',
303
- 'zapier register "My Cool Integration" --url "https://www.zapier.com" --audience private --role employee --category marketing-automation',
304
- 'zapier register --subscribe',
300
+ 'zapier-platform register',
301
+ 'zapier-platform register "My Cool Integration"',
302
+ 'zapier-platform register "My Cool Integration" --desc "My Cool Integration helps you integrate your apps with the apps that you need." --no-subscribe',
303
+ 'zapier-platform register "My Cool Integration" --url "https://www.zapier.com" --audience private --role employee --category marketing-automation',
304
+ 'zapier-platform register --subscribe',
305
305
  ];
306
306
  RegisterCommand.description = `Register a new integration in your account, or update the existing one if a \`${CURRENT_APP_FILE}\` file is found.
307
307
 
308
308
  This command creates a new integration and links it in the \`./${CURRENT_APP_FILE}\` file. If \`${CURRENT_APP_FILE}\` already exists, it will ask you if you want to update the currently-linked integration, as opposed to creating a new one.
309
309
 
310
- After registering a new integration, you can run \`zapier push\` to build and upload your integration for use in the Zapier editor. This will change \`${CURRENT_APP_FILE}\`, which identifies this directory as holding code for a specific integration.`;
310
+ After registering a new integration, you can run \`zapier-platform push\` to build and upload your integration for use in the Zapier editor. This will change \`${CURRENT_APP_FILE}\`, which identifies this directory as holding code for a specific integration.`;
311
311
 
312
312
  module.exports = RegisterCommand;
@@ -203,10 +203,10 @@ ScaffoldCommand.flags = buildFlags({
203
203
  });
204
204
 
205
205
  ScaffoldCommand.examples = [
206
- 'zapier scaffold trigger contact',
207
- 'zapier scaffold search contact --dest=my_src/searches',
208
- 'zapier scaffold create contact --entry=src/index.js',
209
- 'zapier scaffold resource contact --force',
206
+ 'zapier-platform scaffold trigger contact',
207
+ 'zapier-platform scaffold search contact --dest=my_src/searches',
208
+ 'zapier-platform scaffold create contact --entry=src/index.js',
209
+ 'zapier-platform scaffold resource contact --force',
210
210
  ];
211
211
 
212
212
  ScaffoldCommand.description = `Add a starting trigger, create, search, or resource to your integration.
@@ -83,9 +83,9 @@ These users come in three levels:
83
83
  Team members can be freely added and removed.`;
84
84
 
85
85
  TeamAddCommand.examples = [
86
- 'zapier team:add bruce@wayne.com admin',
87
- 'zapier team:add robin@wayne.com collaborator "Hey Robin, check out this app."',
88
- 'zapier team:add alfred@wayne.com subscriber "Hey Alfred, check out this app."',
86
+ 'zapier-platform team:add bruce@wayne.com admin',
87
+ 'zapier-platform team:add robin@wayne.com collaborator "Hey Robin, check out this app."',
88
+ 'zapier-platform team:add alfred@wayne.com subscriber "Hey Alfred, check out this app."',
89
89
  ];
90
90
  TeamAddCommand.aliases = ['team:invite'];
91
91
  TeamAddCommand.skipValidInstallCheck = true;
@@ -34,7 +34,7 @@ class TeamListCommand extends ZapierBaseCommand {
34
34
 
35
35
  this.log(
36
36
  `To invite more team members, use the \`${cyan(
37
- 'zapier team:add',
37
+ 'zapier-platform team:add',
38
38
  )}\` command.`,
39
39
  );
40
40
  }
@@ -49,7 +49,7 @@ These users come in three levels:
49
49
  * \`collaborator\`, who has read-only access for the app, and will receive periodic email updates. These updates include quarterly health scores and more.
50
50
  * \`subscriber\`, who can't directly access the app, but will receive periodic email updates. These updates include quarterly health scores and more.
51
51
 
52
- Use the \`zapier team:add\` and \`zapier team:remove\` commands to modify your team.
52
+ Use the \`zapier-platform team:add\` and \`zapier-platform team:remove\` commands to modify your team.
53
53
  `;
54
54
  TeamListCommand.aliases = ['team:list'];
55
55
  TeamListCommand.skipValidInstallCheck = true;
@@ -73,7 +73,7 @@ TestCommand.flags = buildFlags({
73
73
  commandFlags: {
74
74
  'skip-validate': Flags.boolean({
75
75
  description:
76
- "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.",
76
+ "Forgo running `zapier-platform validate` before tests are run. This will speed up tests if you're modifying functionality of an existing integration rather than adding new actions.",
77
77
  }),
78
78
  yarn: Flags.boolean({
79
79
  description:
@@ -89,9 +89,9 @@ TestCommand.flags = buildFlags({
89
89
  TestCommand.skipValidInstallCheck = false;
90
90
  TestCommand.strict = false;
91
91
  TestCommand.examples = [
92
- 'zapier test',
93
- 'zapier test --skip-validate -- -t 30000 --grep api',
94
- 'zapier test -- -fo --testNamePattern "auth pass"',
92
+ 'zapier-platform test',
93
+ 'zapier-platform test --skip-validate -- -t 30000 --grep api',
94
+ 'zapier-platform test -- -fo --testNamePattern "auth pass"',
95
95
  ];
96
96
  TestCommand.description = `Test your integration via the "test" script in your "package.json".
97
97
 
@@ -21,7 +21,7 @@ UploadCommand.description = `Upload the latest build of your integration to Zapi
21
21
 
22
22
  This command sends both ${BUILD_PATH} and ${SOURCE_PATH} to Zapier for use.
23
23
 
24
- Typically we recommend using \`zapier push\`, which does a build and upload, rather than \`upload\` by itself.
24
+ Typically we recommend using \`zapier-platform push\`, which does a build and upload, rather than \`upload\` by itself.
25
25
  `;
26
26
 
27
27
  module.exports = UploadCommand;
@@ -49,12 +49,12 @@ UsersAddCommand.flags = buildFlags({
49
49
  },
50
50
  });
51
51
  UsersAddCommand.examples = [
52
- 'zapier users:add bruce@wayne.com',
53
- 'zapier users:add alfred@wayne.com 1.2.3',
52
+ 'zapier-platform users:add bruce@wayne.com',
53
+ 'zapier-platform users:add alfred@wayne.com 1.2.3',
54
54
  ];
55
55
  UsersAddCommand.description = `Add a user to some or all versions of your integration.
56
56
 
57
- When 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.
57
+ When 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-platform users:get\` command.
58
58
 
59
59
  Invited 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.`;
60
60
  UsersAddCommand.aliases = ['users:invite'];
@@ -33,9 +33,9 @@ class UsersListCommand extends ZapierBaseCommand {
33
33
 
34
34
  this.log(
35
35
  `\nTo invite users via a link, use the \`${cyan(
36
- 'zapier users:links',
36
+ 'zapier-platform users:links',
37
37
  )}\` command. To invite a specific user by email, use the \`${cyan(
38
- 'zapier users:add',
38
+ 'zapier-platform users:add',
39
39
  )}\` command.`,
40
40
  );
41
41
  }
@@ -45,9 +45,9 @@ UsersListCommand.flags = buildFlags({ opts: { format: true } });
45
45
  UsersListCommand.description = `Get a list of users who have been invited to your integration.
46
46
 
47
47
  Note that this list of users is NOT a comprehensive list of everyone who is using your integration. It only includes users who were invited directly by email (using the \`${cyan(
48
- 'zapier users:add',
48
+ 'zapier-platform users:add',
49
49
  )}\` command or the web UI). Users who joined by clicking links generated using the \`${cyan(
50
- 'zapier user:links',
50
+ 'zapier-platform user:links',
51
51
  )}\` command won't show up here.`;
52
52
  UsersListCommand.aliases = ['users:list'];
53
53
  UsersListCommand.skipValidInstallCheck = true;
@@ -33,7 +33,7 @@ class UsersLinksCommand extends ZapierBaseCommand {
33
33
  });
34
34
 
35
35
  this.log(
36
- '\nTo invite a specific user by email, use the `zapier users:add` command.',
36
+ '\nTo invite a specific user by email, use the `zapier-platform users:add` command.',
37
37
  );
38
38
  }
39
39
  }
@@ -144,13 +144,13 @@ ValidateCommand.flags = buildFlags({
144
144
  });
145
145
 
146
146
  ValidateCommand.examples = [
147
- 'zapier validate',
148
- 'zapier validate --without-style',
149
- 'zapier validate --skip-build',
150
- 'zapier validate --format json',
147
+ 'zapier-platform validate',
148
+ 'zapier-platform validate --without-style',
149
+ 'zapier-platform validate --skip-build',
150
+ 'zapier-platform validate --format json',
151
151
  ];
152
152
  ValidateCommand.description = `Validate your integration.
153
153
 
154
- Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during \`zapier build\`, \`zapier upload\`, \`zapier push\` or even as a test in \`zapier test\`.`;
154
+ Run the standard validation routine powered by json-schema that checks your integration for any structural errors. This is the same routine that runs during \`zapier-platform build\`, \`zapier-platform upload\`, \`zapier-platform push\` or even as a test in \`zapier-platform test\`.`;
155
155
 
156
156
  module.exports = ValidateCommand;
@@ -31,7 +31,7 @@ class VersionsCommand extends BaseCommand {
31
31
  ['Updated at', 'last_changed'],
32
32
  ],
33
33
  emptyMessage:
34
- 'No versions to show. Try adding one with the `zapier push` command',
34
+ 'No versions to show. Try adding one with the `zapier-platform push` command',
35
35
  });
36
36
 
37
37
  if (versions.map((v) => v.user_count).filter((c) => c === null).length) {