zapier-platform-cli/lib/commands/invite.js

The CLI for apps in the Zapier Developer Platform.

'use strict';

var utils = require('../utils');

var makeAccess = require('./_access');

var invite = makeAccess('invite', 'invitee');
invite.help = 'Manage the invitees/testers on your project. Can optionally --remove.';
invite.example = 'zapier invite [user@example.com]';
invite.docs = '\nInvite any user registered on Zapier to test your app. Commonly, this is useful for teammates, contractors, or other team members who might want to test, QA, or view your apps. If you\'d like to provide full admin access, try `zapier collaborate`.\n\n> Send an email directly, which contains a one-time use link for them only - or share the public URL to "bulk" invite folks!\n\n**Arguments**\n\n* _none_ -- print all invitees\n' + utils.argsFragment(invite.argsSpec) + '\n' + utils.argOptsFragment(invite.argOptsSpec) + '\n' + utils.defaultArgOptsFragment() + '\n\n' + '```' + 'bash\n$ zapier invite\n# The invitees on your app listed below.\n#\n# \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u252C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n# \u2502 Email            \u2502 Role    \u2502 Status   \u2502\n# \u251C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u253C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2524\n# \u2502 user@example.com \u2502 invitee \u2502 accepted \u2502\n# \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2534\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n#\n# Don\'t want to send individual invite emails? Use this public link and share with anyone on the web:\n#\n#   https://zapier.com/platform/public-invite/1/222dcd03aed943a8676dc80e2427a40d/\n\n$ zapier invite user@example.com\n# Preparing to add invitee user@example.com to your app "Example".\n#\n#   Adding user@example.com - done!\n#\n# Invitees updated! Try viewing them with `zapier invite`.\n\n$ zapier invite user@example.com --remove\n# Preparing to remove invitee user@example.com from your app "Example".\n#\n#   Removing user@example.com - done!\n#\n# Invitees updated! Try viewing them with `zapier invite`.\n' + '```' + '\n';

module.exports = invite;