zapier-platform-cli 17.5.0 → 17.6.0

package/oclif.manifest.json

@@ -1705,6 +1705,88 @@
         "clear.js"
       ]
     },
+    "delete:integration": {
+      "aliases": [
+        "delete:app"
+      ],
+      "args": {},
+      "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.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:integration",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "integration.js"
+      ]
+    },
+    "delete:version": {
+      "aliases": [],
+      "args": {
+        "version": {
+          "description": "Specify the version to delete. It must have no users or Zaps.",
+          "name": "version",
+          "required": true
+        }
+      },
+      "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.",
+      "flags": {
+        "debug": {
+          "char": "d",
+          "description": "Show extra debugging output.",
+          "name": "debug",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "invokedFromAnotherCommand": {
+          "hidden": true,
+          "name": "invokedFromAnotherCommand",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "delete:version",
+      "pluginAlias": "zapier-platform-cli",
+      "pluginName": "zapier-platform-cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "skipValidInstallCheck": true,
+      "isESM": false,
+      "relativePath": [
+        "src",
+        "oclif",
+        "commands",
+        "delete",
+        "version.js"
+      ]
+    },
     "canary:create": {
       "aliases": [],
       "args": {
@@ -1719,10 +1801,12 @@
           "required": true
         }
       },
-      "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!**",
+      "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\nTo canary traffic for a specific user, use the --user flag.\n\nTo canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.\n\nTo canary traffic for a specific user within a specific account, use both --user and --account-id flags.\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!**",
       "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"
+        "zapier canary:create 1.0.0 1.1.0 -p 10 -d 3600",
+        "zapier canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com",
+        "zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com",
+        "zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345"
       ],
       "flags": {
         "percent": {
@@ -1743,6 +1827,29 @@
           "multiple": false,
           "type": "option"
         },
+        "user": {
+          "char": "u",
+          "description": "Canary this user (email) across all accounts, unless `account-id` is specified.",
+          "name": "user",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "account-id": {
+          "char": "a",
+          "description": "The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.",
+          "name": "account-id",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "force-include-all": {
+          "char": "f",
+          "description": "Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.",
+          "name": "force-include-all",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -1868,88 +1975,6 @@
         "list.js"
       ]
     },
-    "delete:integration": {
-      "aliases": [
-        "delete:app"
-      ],
-      "args": {},
-      "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.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:integration",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "integration.js"
-      ]
-    },
-    "delete:version": {
-      "aliases": [],
-      "args": {
-        "version": {
-          "description": "Specify the version to delete. It must have no users or Zaps.",
-          "name": "version",
-          "required": true
-        }
-      },
-      "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.",
-      "flags": {
-        "debug": {
-          "char": "d",
-          "description": "Show extra debugging output.",
-          "name": "debug",
-          "allowNo": false,
-          "type": "boolean"
-        },
-        "invokedFromAnotherCommand": {
-          "hidden": true,
-          "name": "invokedFromAnotherCommand",
-          "allowNo": false,
-          "type": "boolean"
-        }
-      },
-      "hasDynamicHelp": false,
-      "hiddenAliases": [],
-      "id": "delete:version",
-      "pluginAlias": "zapier-platform-cli",
-      "pluginName": "zapier-platform-cli",
-      "pluginType": "core",
-      "strict": true,
-      "enableJsonFlag": false,
-      "skipValidInstallCheck": true,
-      "isESM": false,
-      "relativePath": [
-        "src",
-        "oclif",
-        "commands",
-        "delete",
-        "version.js"
-      ]
-    },
     "env:get": {
       "aliases": [],
       "args": {
@@ -2126,9 +2151,9 @@
         "unset.js"
       ]
     },
-    "team:add": {
+    "users:add": {
       "aliases": [
-        "team:invite"
+        "users:invite"
       ],
       "args": {
         "email": {
@@ -2136,28 +2161,24 @@
           "name": "email",
           "required": true
         },
-        "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.",
-          "name": "role",
-          "options": [
-            "admin",
-            "collaborator",
-            "subscriber"
-          ],
-          "required": true
-        },
-        "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.",
-          "name": "message"
+        "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.",
+          "name": "version"
         }
       },
-      "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.",
+      "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.",
       "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.\""
+        "zapier users:add bruce@wayne.com",
+        "zapier users:add alfred@wayne.com 1.2.3"
       ],
       "flags": {
+        "force": {
+          "char": "f",
+          "description": "Skip confirmation. Useful for running programatically.",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -2174,7 +2195,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "team:add",
+      "id": "users:add",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2186,16 +2207,16 @@
         "src",
         "oclif",
         "commands",
-        "team",
+        "users",
         "add.js"
       ]
     },
-    "team:get": {
+    "users:get": {
       "aliases": [
-        "team:list"
+        "users:list"
       ],
       "args": {},
-      "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",
+      "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.",
       "flags": {
         "debug": {
           "char": "d",
@@ -2229,7 +2250,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "team:get",
+      "id": "users:get",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2241,16 +2262,14 @@
         "src",
         "oclif",
         "commands",
-        "team",
+        "users",
         "get.js"
       ]
     },
-    "team:remove": {
-      "aliases": [
-        "team:delete"
-      ],
+    "users:links": {
+      "aliases": [],
       "args": {},
-      "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.",
+      "description": "Get a list of links that are used to invite users to your integration.",
       "flags": {
         "debug": {
           "char": "d",
@@ -2259,6 +2278,22 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "format": {
+          "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.",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "plain",
+            "json",
+            "raw",
+            "row",
+            "table"
+          ],
+          "type": "option"
+        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -2268,7 +2303,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "team:remove",
+      "id": "users:links",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2280,34 +2315,26 @@
         "src",
         "oclif",
         "commands",
-        "team",
-        "remove.js"
+        "users",
+        "links.js"
       ]
     },
-    "users:add": {
+    "users:remove": {
       "aliases": [
-        "users:invite"
+        "users:delete"
       ],
       "args": {
         "email": {
-          "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
+          "description": "The user to be removed.",
           "name": "email",
           "required": true
-        },
-        "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.",
-          "name": "version"
         }
       },
-      "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.",
-      "examples": [
-        "zapier users:add bruce@wayne.com",
-        "zapier users:add alfred@wayne.com 1.2.3"
-      ],
+      "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.",
       "flags": {
         "force": {
           "char": "f",
-          "description": "Skip confirmation. Useful for running programatically.",
+          "description": "Skips confirmation. Useful for running programatically.",
           "name": "force",
           "allowNo": false,
           "type": "boolean"
@@ -2328,7 +2355,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "users:add",
+      "id": "users:remove",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2341,15 +2368,40 @@
         "oclif",
         "commands",
         "users",
-        "add.js"
+        "remove.js"
       ]
     },
-    "users:get": {
+    "team:add": {
       "aliases": [
-        "users:list"
+        "team:invite"
+      ],
+      "args": {
+        "email": {
+          "description": "The user to be invited. If they don't have a Zapier account, they'll be prompted to create one.",
+          "name": "email",
+          "required": true
+        },
+        "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.",
+          "name": "role",
+          "options": [
+            "admin",
+            "collaborator",
+            "subscriber"
+          ],
+          "required": true
+        },
+        "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.",
+          "name": "message"
+        }
+      },
+      "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.",
+      "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.\""
       ],
-      "args": {},
-      "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.",
       "flags": {
         "debug": {
           "char": "d",
@@ -2358,22 +2410,6 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "format": {
-          "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.",
-          "name": "format",
-          "default": "table",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "plain",
-            "json",
-            "raw",
-            "row",
-            "table"
-          ],
-          "type": "option"
-        },
         "invokedFromAnotherCommand": {
           "hidden": true,
           "name": "invokedFromAnotherCommand",
@@ -2383,7 +2419,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "users:get",
+      "id": "team:add",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2395,14 +2431,16 @@
         "src",
         "oclif",
         "commands",
-        "users",
-        "get.js"
+        "team",
+        "add.js"
       ]
     },
-    "users:links": {
-      "aliases": [],
+    "team:get": {
+      "aliases": [
+        "team:list"
+      ],
       "args": {},
-      "description": "Get a list of links that are used to invite users to your integration.",
+      "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",
       "flags": {
         "debug": {
           "char": "d",
@@ -2436,7 +2474,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "users:links",
+      "id": "team:get",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2448,30 +2486,17 @@
         "src",
         "oclif",
         "commands",
-        "users",
-        "links.js"
+        "team",
+        "get.js"
       ]
     },
-    "users:remove": {
+    "team:remove": {
       "aliases": [
-        "users:delete"
+        "team:delete"
       ],
-      "args": {
-        "email": {
-          "description": "The user to be removed.",
-          "name": "email",
-          "required": true
-        }
-      },
-      "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.",
+      "args": {},
+      "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.",
       "flags": {
-        "force": {
-          "char": "f",
-          "description": "Skips confirmation. Useful for running programatically.",
-          "name": "force",
-          "allowNo": false,
-          "type": "boolean"
-        },
         "debug": {
           "char": "d",
           "description": "Show extra debugging output.",
@@ -2488,7 +2513,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "users:remove",
+      "id": "team:remove",
       "pluginAlias": "zapier-platform-cli",
       "pluginName": "zapier-platform-cli",
       "pluginType": "core",
@@ -2500,10 +2525,10 @@
         "src",
         "oclif",
         "commands",
-        "users",
+        "team",
         "remove.js"
       ]
     }
   },
-  "version": "17.5.0"
+  "version": "17.6.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zapier-platform-cli",
-  "version": "17.5.0",
+  "version": "17.6.0",
   "description": "The CLI for managing integrations in Zapier Developer Platform.",
   "repository": "zapier/zapier-platform",
   "homepage": "https://platform.zapier.com/",

package/src/oclif/commands/canary/create.js

@@ -8,6 +8,9 @@ class CanaryCreateCommand extends ZapierBaseCommand {
     const { versionFrom, versionTo } = this.args;
     const percent = this.flags.percent;
     const duration = this.flags.duration;
+    const user = this.flags.user;
+    const accountId = this.flags['account-id'];
+    const forceIncludeAll = this.flags['force-include-all'];
 
     this.validateVersions(versionFrom, versionTo);
     this.validatePercent(percent);
@@ -25,13 +28,34 @@ If you would like to stop this canary now, run \`zapier canary:delete ${existing
       return;
     }
 
-    this.startSpinner(`Creating canary deployment
+    let createCanaryMessage = `Creating canary deployment
     - From version: ${versionFrom}
     - To version: ${versionTo}
-    - Traffic amount: ${percent}%
-    - Duration: ${duration} seconds`);
+    - Percentage: ${percent}%
+    - Duration: ${duration} seconds`;
 
-    await createCanary(versionFrom, versionTo, percent, duration);
+    const body = {
+      percent,
+      duration,
+    };
+
+    if (user) {
+      body.user = user;
+      createCanaryMessage += `\n    - User: ${user}`;
+    }
+
+    if (accountId) {
+      body.account_id = parseInt(accountId);
+      createCanaryMessage += `\n    - Account ID: ${accountId}`;
+    }
+
+    if (forceIncludeAll) {
+      body.force_include_all = true;
+      createCanaryMessage += `\n    - Force Include All: true`;
+    }
+
+    this.startSpinner(createCanaryMessage);
+    await createCanary(versionFrom, versionTo, body);
 
     this.stopSpinner();
     this.log('Canary deployment created successfully.');
@@ -71,6 +95,21 @@ CanaryCreateCommand.flags = buildFlags({
       description: 'Duration of the canary in seconds',
       required: true,
     }),
+    user: Flags.string({
+      char: 'u',
+      description:
+        'Canary this user (email) across all accounts, unless `account-id` is specified.',
+    }),
+    'account-id': Flags.string({
+      char: 'a',
+      description:
+        'The account ID to target. If user is specified, only canary the user within this account. If user is not specified, then this argument is only permitted for Zapier staff.',
+    }),
+    'force-include-all': Flags.boolean({
+      char: 'f',
+      description:
+        'Overrides any default filters the canary system imposes. This argument is only permitted for Zapier staff.',
+    }),
   },
 });
 
@@ -89,13 +128,21 @@ CanaryCreateCommand.description = `Create a new canary deployment, diverting a s
 
 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\`.
 
+To canary traffic for a specific user, use the --user flag.
+
+To canary traffic for an entire account, use the --account-id. Note: this scenario is only permitted for Zapier staff.
+
+To canary traffic for a specific user within a specific account, use both --user and --account-id flags.
+
 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.
 
 **Only use this command to canary traffic between non-breaking versions!**`;
 
 CanaryCreateCommand.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',
+  'zapier canary:create 1.0.0 1.1.0 -p 10 -d 3600',
+  'zapier canary:create 2.0.0 2.1.0 --percent 25 --duration 1800 --user user@example.com',
+  'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345 -u user@example.com',
+  'zapier canary:create 2.0.0 2.1.0 -p 15 -d 7200 -a 12345',
 ];
 CanaryCreateCommand.skipValidInstallCheck = true;
 

package/src/oclif/commands/canary/list.js

@@ -12,6 +12,8 @@ class CanaryListCommand extends ZapierBaseCommand {
       to_version: c.to_version,
       percent: c.percent,
       seconds_remaining: c.until_timestamp - Math.floor(Date.now() / 1000),
+      user: c.user,
+      account_id: c.account_id,
     }));
 
     this.log(bold('Active Canaries') + '\n');
@@ -22,6 +24,8 @@ class CanaryListCommand extends ZapierBaseCommand {
         ['To Version', 'to_version'],
         ['Traffic Amount', 'percent'],
         ['Seconds Remaining', 'seconds_remaining'],
+        ['User', 'user'],
+        ['Account ID', 'account_id'],
       ],
       emptyMessage: grey(`No active canary deployments found.`),
     });

package/src/utils/api.js

@@ -154,17 +154,14 @@ const createCredentials = (username, password, totpCode) => {
   );
 };
 
-const createCanary = async (versionFrom, versionTo, percent, duration) => {
+const createCanary = async (versionFrom, versionTo, body) => {
   const linkedAppId = (await getLinkedAppConfig(undefined, true))?.id;
 
   return callAPI(
     `/apps/${linkedAppId}/versions/${versionFrom}/canary-to/${versionTo}`,
     {
       method: 'POST',
-      body: {
-        percent,
-        duration,
-      },
+      body,
     },
   );
 };