@contrail/cli 2.1.4 → 2.1.5

package/README.md

@@ -15,7 +15,7 @@ $ npm install -g @contrail/cli
 $ contrail COMMAND
 running command...
 $ contrail (--version)
-@contrail/cli/2.1.4 darwin-arm64 node-v18.13.0
+@contrail/cli/2.1.5 darwin-arm64 node-v18.13.0
 $ contrail --help [COMMAND]
 USAGE
   $ contrail COMMAND
@@ -80,6 +80,10 @@ To get instructions on how to set up autocomplete for your shell, run `contrail
 * [`contrail types uploadUsageInfo`](#contrail-types-uploadusageinfo)
 * [`contrail users export`](#contrail-users-export)
 * [`contrail users upload USERSFILE`](#contrail-users-upload-usersfile)
+* [`contrail webhooks create`](#contrail-webhooks-create)
+* [`contrail webhooks delete [WEBHOOKID]`](#contrail-webhooks-delete-webhookid)
+* [`contrail webhooks getWebhookTrigger [WEBHOOKID]`](#contrail-webhooks-getwebhooktrigger-webhookid)
+* [`contrail webhooks list`](#contrail-webhooks-list)
 * [`contrail workflow-template-definitions install`](#contrail-workflow-template-definitions-install)
 * [`contrail workflow-template-definitions list`](#contrail-workflow-template-definitions-list)
 * [`contrail workflow-templates delete`](#contrail-workflow-templates-delete)
@@ -1143,6 +1147,85 @@ EXAMPLES
   $ contrail users import <USERS_FILE>
 ```
 
+## `contrail webhooks create`
+
+Create a new webhook
+
+```
+USAGE
+  $ contrail webhooks create [-j]
+
+FLAGS
+  -j, --json  output in json format
+
+DESCRIPTION
+  Create a new webhook
+
+EXAMPLES
+  $ contrail webhooks create
+```
+
+## `contrail webhooks delete [WEBHOOKID]`
+
+Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value for the ID, and select multiple using the interactive selector
+
+```
+USAGE
+  $ contrail webhooks delete [WEBHOOKID] [-j]
+
+ARGUMENTS
+  WEBHOOKID  The id of the webhook to delete
+
+FLAGS
+  -j, --json  output in json format
+
+DESCRIPTION
+  Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value
+  for the ID, and select multiple using the interactive selector
+
+EXAMPLES
+  $ contrail webhooks delete
+
+  $ contrail webhooks delete 12345abcd-1234-abcd-1234-12345abcde
+```
+
+## `contrail webhooks getWebhookTrigger [WEBHOOKID]`
+
+Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or event workflow. It is only a utility for generating a webhook trigger.
+
+```
+USAGE
+  $ contrail webhooks getWebhookTrigger [WEBHOOKID]
+
+ARGUMENTS
+  WEBHOOKID  The id of the webhook to delete
+
+DESCRIPTION
+  Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or
+  event workflow. It is only a utility for generating a webhook trigger.
+
+EXAMPLES
+  $ contrail webhooks getWebhookTrigger 1234-abcd-1234-abcd-1234abcd
+```
+
+## `contrail webhooks list`
+
+List current webhooks
+
+```
+USAGE
+  $ contrail webhooks list [-j]
+
+FLAGS
+  -j, --json  output in json format
+
+DESCRIPTION
+  List current webhooks
+
+EXAMPLES
+  $ contrail webhooks list
+```
+
 ## `contrail workflow-template-definitions install`
 
 Install the template definitions of an app to your org

package/dist/api/webhooks.d.ts

@@ -0,0 +1,4 @@
+import { Webhook } from '../interfaces';
+export declare function getWebhooks(): Promise<Webhook[]>;
+export declare function createWebhook(webhook: Webhook): Promise<Webhook>;
+export declare function deleteWebhook(webhookId: string): Promise<Webhook>;

package/dist/api/webhooks.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deleteWebhook = exports.createWebhook = exports.getWebhooks = void 0;
+const sdk_1 = require("@contrail/sdk");
+async function getWebhooks() {
+    return await new sdk_1.Entities().get({ entityName: 'webhook' });
+}
+exports.getWebhooks = getWebhooks;
+async function createWebhook(webhook) {
+    return await new sdk_1.Entities().create({ entityName: 'webhook', object: webhook });
+}
+exports.createWebhook = createWebhook;
+async function deleteWebhook(webhookId) {
+    return await new sdk_1.Entities().delete({ entityName: 'webhook', id: webhookId });
+}
+exports.deleteWebhook = deleteWebhook;

package/dist/commands/webhooks/create.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class CreateWebhooks extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/webhooks/create.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const login_1 = require("../../auth/login");
+const webhooks_1 = require("../../api/webhooks");
+class CreateWebhooks extends core_1.Command {
+    async run() {
+        const { flags } = await this.parse(CreateWebhooks);
+        await (0, login_1.authUser)();
+        const webhook = await (0, webhooks_1.createWebhook)({});
+        if (flags.json) {
+            console.log(JSON.stringify(webhook, null, 2));
+        }
+        else {
+            console.log(webhook.id);
+        }
+    }
+}
+exports.default = CreateWebhooks;
+CreateWebhooks.description = 'Create a new webhook';
+CreateWebhooks.examples = [
+    'contrail webhooks create',
+];
+CreateWebhooks.flags = {
+    json: core_1.Flags.boolean({ char: 'j', description: 'output in json format', default: false }),
+};

package/dist/commands/webhooks/delete.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+export default class DeleteWebhooks extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        webhookId: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/webhooks/delete.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const login_1 = require("../../auth/login");
+const webhooks_1 = require("../../api/webhooks");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+class DeleteWebhooks extends core_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(DeleteWebhooks);
+        await (0, login_1.authUser)();
+        const webhooks = await (0, webhooks_1.getWebhooks)();
+        const deletedWebhooks = [];
+        if (args.webhookId) {
+            const toDelete = webhooks.find(x => x.id === args.webhookId);
+            if (!toDelete) {
+                throw new Error(`No webhook found with id ${args.webhookId}`);
+            }
+            deletedWebhooks.push(await (0, webhooks_1.deleteWebhook)(toDelete.id));
+        }
+        else {
+            const answer = await inquirer_1.default.prompt({
+                type: 'checkbox',
+                name: 'webhookIds',
+                message: 'which webhook(s) would you like to delete?',
+                choices: webhooks.map(x => ({ name: x.id, value: x.id })),
+            });
+            for (const id of answer.webhookIds) {
+                deletedWebhooks.push(await (0, webhooks_1.deleteWebhook)(id));
+            }
+        }
+        if (flags.json) {
+            console.log(JSON.stringify(deletedWebhooks, null, 2));
+        }
+        else {
+            console.log(deletedWebhooks.map(x => x.id).join('\n'));
+        }
+    }
+}
+exports.default = DeleteWebhooks;
+DeleteWebhooks.description = 'Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value for the ID, and select multiple using the interactive selector';
+DeleteWebhooks.examples = [
+    'contrail webhooks delete',
+    'contrail webhooks delete 12345abcd-1234-abcd-1234-12345abcde',
+];
+DeleteWebhooks.flags = {
+    json: core_1.Flags.boolean({ char: 'j', description: 'output in json format', default: false }),
+};
+DeleteWebhooks.args = {
+    webhookId: core_1.Args.string({ description: 'The id of the webhook to delete', required: false }),
+};

package/dist/commands/webhooks/getWebhookTrigger.d.ts

@@ -0,0 +1,9 @@
+import { Command } from '@oclif/core';
+export default class GetWebhookTrigger extends Command {
+    static description: string;
+    static examples: string[];
+    static args: {
+        webhookId: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/webhooks/getWebhookTrigger.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const core_1 = require("@oclif/core");
+const login_1 = require("../../auth/login");
+const webhooks_1 = require("../../api/webhooks");
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+class GetWebhookTrigger extends core_1.Command {
+    async run() {
+        const { args } = await this.parse(GetWebhookTrigger);
+        await (0, login_1.authUser)();
+        const webhooks = await (0, webhooks_1.getWebhooks)();
+        if (args.webhookId) {
+            const foundWebhook = webhooks.find(x => x.id === args.webhookId);
+            if (!foundWebhook) {
+                throw new Error(`No webhook found with id ${args.webhookId}`);
+            }
+            console.log(`webhookId:${foundWebhook.id}`);
+        }
+        else {
+            const answer = await inquirer_1.default.prompt({
+                type: 'list',
+                name: 'webhookId',
+                message: 'For which webhook would you like ot generate an event tirgger?',
+                choices: webhooks.map(x => ({ name: x.id, value: x.id })),
+            });
+            console.log(`webhookId:${answer.webhookId}`);
+        }
+    }
+}
+exports.default = GetWebhookTrigger;
+GetWebhookTrigger.description = 'Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or event workflow. It is only a utility for generating a webhook trigger.';
+GetWebhookTrigger.examples = [
+    'contrail webhooks getWebhookTrigger 1234-abcd-1234-abcd-1234abcd',
+];
+GetWebhookTrigger.args = {
+    webhookId: core_1.Args.string({ description: 'The id of the webhook to delete', required: false }),
+};

package/dist/commands/webhooks/list.d.ts

@@ -0,0 +1,10 @@
+import { Command } from '@oclif/core';
+export default class ListWebhooks extends Command {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {};
+    run(): Promise<void>;
+}

package/dist/commands/webhooks/list.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@oclif/core");
+const login_1 = require("../../auth/login");
+const webhooks_1 = require("../../api/webhooks");
+class ListWebhooks extends core_1.Command {
+    async run() {
+        const { flags } = await this.parse(ListWebhooks);
+        await (0, login_1.authUser)();
+        const webhooks = await (0, webhooks_1.getWebhooks)();
+        if (flags.json) {
+            console.log(JSON.stringify(webhooks, null, 2));
+        }
+        else {
+            console.log(webhooks.map(x => x.id).join('\n'));
+        }
+    }
+}
+exports.default = ListWebhooks;
+ListWebhooks.description = 'List current webhooks';
+ListWebhooks.examples = [
+    'contrail webhooks list',
+];
+ListWebhooks.flags = {
+    // // flag with a value (-n, --name=VALUE)
+    // name: Flags.string({char: 'n', description: 'name to print'}),
+    // flag with no value (-f, --force)
+    json: core_1.Flags.boolean({ char: 'j', description: 'output in json format', default: false }),
+};
+ListWebhooks.args = {
+// file: Args.string({description: 'file to read'}),
+};

package/dist/interfaces.d.ts

@@ -127,6 +127,13 @@ export interface AppOrg {
     apiKey?: AppApiKey;
     appConfig?: any;
 }
+export interface Webhook {
+    id?: string;
+    createdOn?: Date;
+    createdById?: string;
+    createdBy?: any;
+    orgId?: string;
+}
 export interface AppCodePackage {
     id: string;
     appId: string;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "2.1.4",
+  "version": "2.1.5",
   "commands": {
     "app:create": {
       "id": "app:create",
@@ -1014,6 +1014,99 @@
         }
       }
     },
+    "webhooks:create": {
+      "id": "webhooks:create",
+      "description": "Create a new webhook",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "contrail webhooks create"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json format",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
+    "webhooks:delete": {
+      "id": "webhooks:delete",
+      "description": "Delete an existing webhook. To delete a single webhook, pass its ID. To delete multiple webhooks, do not pass a value for the ID, and select multiple using the interactive selector",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "contrail webhooks delete",
+        "contrail webhooks delete 12345abcd-1234-abcd-1234-12345abcde"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json format",
+          "allowNo": false
+        }
+      },
+      "args": {
+        "webhookId": {
+          "name": "webhookId",
+          "description": "The id of the webhook to delete",
+          "required": false
+        }
+      }
+    },
+    "webhooks:getWebhookTrigger": {
+      "id": "webhooks:getWebhookTrigger",
+      "description": "Crafts a webhook trigger that can be used for event workflows. This command does not alter the state of any webhook or event workflow. It is only a utility for generating a webhook trigger.",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "contrail webhooks getWebhookTrigger 1234-abcd-1234-abcd-1234abcd"
+      ],
+      "flags": {},
+      "args": {
+        "webhookId": {
+          "name": "webhookId",
+          "description": "The id of the webhook to delete",
+          "required": false
+        }
+      }
+    },
+    "webhooks:list": {
+      "id": "webhooks:list",
+      "description": "List current webhooks",
+      "strict": true,
+      "pluginName": "@contrail/cli",
+      "pluginAlias": "@contrail/cli",
+      "pluginType": "core",
+      "aliases": [],
+      "examples": [
+        "contrail webhooks list"
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "output in json format",
+          "allowNo": false
+        }
+      },
+      "args": {}
+    },
     "workflow-template-definitions:install": {
       "id": "workflow-template-definitions:install",
       "description": "Install the template definitions of an app to your org",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/cli",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "VibeIQ's Contrail Platform CLI.",
   "bin": {
     "contrail-cli": "./bin/run",