@commercelayer/cli-plugin-triggers 4.6.0 → 4.7.0

package/README.md

@@ -54,6 +54,8 @@ $ commercelayer plugins:install triggers
 * [`commercelayer checkout_com_payment:refresh ID`](#commercelayer-checkout_com_paymentrefresh-id)
 * [`commercelayer customer_password_reset ID`](#commercelayer-customer_password_reset-id)
 * [`commercelayer customer_password_reset:reset_password_token ID`](#commercelayer-customer_password_resetreset_password_token-id)
+* [`commercelayer event ID`](#commercelayer-event-id)
+* [`commercelayer event:trigger ID`](#commercelayer-eventtrigger-id)
 * [`commercelayer external_gateway ID`](#commercelayer-external_gateway-id)
 * [`commercelayer external_gateway:reset_circuit ID`](#commercelayer-external_gatewayreset_circuit-id)
 * [`commercelayer external_promotion ID`](#commercelayer-external_promotion-id)
@@ -308,7 +310,7 @@ _See code: [src/commands/authorization/capture_amount_cents.ts](https://github.c
 
 ### `commercelayer authorization:forward ID`
 
-Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.
+Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
 
 ```sh-session
 USAGE
@@ -323,7 +325,7 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states
+  Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states
   accordingly.
 ```
 
@@ -553,7 +555,7 @@ _See code: [src/commands/capture/index.ts](https://github.com/commercelayer/comm
 
 ### `commercelayer capture:forward ID`
 
-Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.
+Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.
 
 ```sh-session
 USAGE
@@ -568,7 +570,7 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states
+  Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states
   accordingly.
 ```
 
@@ -728,6 +730,50 @@ DESCRIPTION
 
 _See code: [src/commands/customer_password_reset/reset_password_token.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/customer_password_reset/reset_password_token.ts)_
 
+### `commercelayer event ID`
+
+Execute an action on a resource of type events.
+
+```sh-session
+USAGE
+  $ commercelayer event ID [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json         print result in JSON format
+  -p, --print        print out the modified resource
+  -u, --unformatted  print JSON output without indentation
+
+DESCRIPTION
+  execute an action on a resource of type events
+```
+
+_See code: [src/commands/event/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/event/index.ts)_
+
+### `commercelayer event:trigger ID`
+
+Send this attribute if you want to force webhooks execution for this event.
+
+```sh-session
+USAGE
+  $ commercelayer event:trigger ID [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json         print result in JSON format
+  -p, --print        print out the modified resource
+  -u, --unformatted  print JSON output without indentation
+
+DESCRIPTION
+  Send this attribute if you want to force webhooks execution for this event.
+```
+
+_See code: [src/commands/event/trigger.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/event/trigger.ts)_
+
 ### `commercelayer external_gateway ID`
 
 Execute an action on a resource of type external_gateways.
@@ -1909,7 +1955,7 @@ _See code: [src/commands/order/customer_payment_source_id.ts](https://github.com
 
 ### `commercelayer order:fulfill ID`
 
-Send this attribute if you want to mark as fulfilled a shipped/delivered order.
+Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered).
 
 ```sh-session
 USAGE
@@ -1924,7 +1970,7 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  Send this attribute if you want to mark as fulfilled a shipped/delivered order.
+  Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered).
 ```
 
 _See code: [src/commands/order/fulfill.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/fulfill.ts)_

package/lib/commands/event/index.d.ts

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class EventIndex extends Command {
+    static description: string;
+    static flags: {};
+    static args: {
+        id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<any>;
+}

package/lib/commands/event/index.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = tslib_1.__importDefault(require("../../base"));
+const exec_1 = tslib_1.__importDefault(require("../../exec"));
+const inquirer_1 = tslib_1.__importDefault(require("inquirer"));
+const cli_core_1 = require("@commercelayer/cli-core");
+const events_1 = require("../../triggers/events");
+const promptAction = async (id) => {
+    const answers = await inquirer_1.default.prompt([{
+            type: 'list',
+            name: 'trigger',
+            message: `Select an action to execute on event ${cli_core_1.clColor.api.id(id)}:`,
+            choices: Object.keys(events_1.triggers).sort().map(a => {
+                return { name: a, value: a };
+            }),
+            loop: false,
+            pageSize: 10,
+        }]);
+    return answers.trigger;
+};
+class EventIndex extends base_1.default {
+    static description = 'execute an action on a resource of type events';
+    static flags = {};
+    static args = {
+        ...base_1.default.args,
+    };
+    async run() {
+        const { args, flags } = await this.parse(EventIndex);
+        const id = args.id;
+        const action = await promptAction(id);
+        const fields = [];
+        const res = await (0, exec_1.default)('events', id, action, flags, fields);
+        this.log();
+        this.printOutput(res, flags);
+        this.successMessage('event', action, res.id);
+        return res;
+    }
+}
+exports.default = EventIndex;

package/lib/commands/event/trigger.d.ts

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class EventTrigger extends Command {
+    static description: string;
+    static flags: {};
+    static args: {
+        id: import("@oclif/core/lib/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<any>;
+}

package/lib/commands/event/trigger.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const base_1 = tslib_1.__importDefault(require("../../base"));
+const events_1 = require("../../triggers/events");
+const TRIGGER = 'trigger';
+class EventTrigger extends base_1.default {
+    static description = events_1.triggers[TRIGGER].description;
+    static flags = {};
+    static args = {
+        ...base_1.default.args,
+    };
+    async run() {
+        const { args, flags } = await this.parse(EventTrigger);
+        const res = await this.executeAction('events', args.id, TRIGGER, flags);
+        if (flags.print)
+            this.printOutput(res, flags);
+        this.successMessage('event', TRIGGER, res.id);
+        return res;
+    }
+}
+exports.default = EventTrigger;

package/lib/triggers/authorizations.js

@@ -5,7 +5,7 @@ exports.triggers = {
     forward: {
         action: 'forward',
         trigger: '_forward',
-        description: 'Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.',
+        description: 'Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.',
     },
     capture: {
         action: 'capture',

package/lib/triggers/captures.js

@@ -5,7 +5,7 @@ exports.triggers = {
     forward: {
         action: 'forward',
         trigger: '_forward',
-        description: 'Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.',
+        description: 'Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.',
     },
     refund: {
         action: 'refund',

package/lib/triggers/events.d.ts

@@ -0,0 +1,3 @@
+import type { Trigger } from '../common';
+export declare const triggers: Record<string, Trigger>;
+export type ActionType = 'trigger';

package/lib/triggers/events.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triggers = void 0;
+exports.triggers = {
+    trigger: {
+        action: 'trigger',
+        trigger: '_trigger',
+        description: 'Send this attribute if you want to force webhooks execution for this event.',
+    },
+};

package/lib/triggers/orders.js

@@ -60,7 +60,7 @@ exports.triggers = {
     fulfill: {
         action: 'fulfill',
         trigger: '_fulfill',
-        description: 'Send this attribute if you want to mark as fulfilled a shipped/delivered order.',
+        description: 'Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered).',
     },
     update_taxes: {
         action: 'update_taxes',

package/oclif.manifest.json

@@ -196,7 +196,7 @@
         "index.js"
       ]
     },
-    "authorization:capture": {
+    "axerve_payment": {
       "aliases": [],
       "args": {
         "id": {
@@ -205,7 +205,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to create a capture for this authorization.",
+      "description": "execute an action on a resource of type axerve_payments",
       "flags": {
         "organization": {
           "char": "o",
@@ -270,7 +270,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:capture",
+      "id": "axerve_payment",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -280,11 +280,11 @@
       "relativePath": [
         "lib",
         "commands",
-        "authorization",
-        "capture.js"
+        "axerve_payment",
+        "index.js"
       ]
     },
-    "authorization:capture_amount_cents": {
+    "axerve_payment:update": {
       "aliases": [],
       "args": {
         "id": {
@@ -293,7 +293,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute as a value in cents if you want to overwrite the amount to be captured.",
+      "description": "Send this attribute if you want to update the payment with fresh order data.",
       "flags": {
         "organization": {
           "char": "o",
@@ -358,7 +358,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:capture_amount_cents",
+      "id": "axerve_payment:update",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -368,11 +368,11 @@
       "relativePath": [
         "lib",
         "commands",
-        "authorization",
-        "capture_amount_cents.js"
+        "axerve_payment",
+        "update.js"
       ]
     },
-    "authorization:forward": {
+    "authorization:capture": {
       "aliases": [],
       "args": {
         "id": {
@@ -381,7 +381,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.",
+      "description": "Send this attribute if you want to create a capture for this authorization.",
       "flags": {
         "organization": {
           "char": "o",
@@ -446,7 +446,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:forward",
+      "id": "authorization:capture",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -457,10 +457,10 @@
         "lib",
         "commands",
         "authorization",
-        "forward.js"
+        "capture.js"
       ]
     },
-    "authorization": {
+    "authorization:capture_amount_cents": {
       "aliases": [],
       "args": {
         "id": {
@@ -469,7 +469,7 @@
           "required": true
         }
       },
-      "description": "execute an action on a resource of type authorizations",
+      "description": "Send this attribute as a value in cents if you want to overwrite the amount to be captured.",
       "flags": {
         "organization": {
           "char": "o",
@@ -534,7 +534,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization",
+      "id": "authorization:capture_amount_cents",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -545,10 +545,10 @@
         "lib",
         "commands",
         "authorization",
-        "index.js"
+        "capture_amount_cents.js"
       ]
     },
-    "authorization:void": {
+    "authorization:forward": {
       "aliases": [],
       "args": {
         "id": {
@@ -557,7 +557,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to create a void for this authorization.",
+      "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.",
       "flags": {
         "organization": {
           "char": "o",
@@ -622,7 +622,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:void",
+      "id": "authorization:forward",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -633,10 +633,10 @@
         "lib",
         "commands",
         "authorization",
-        "void.js"
+        "forward.js"
       ]
     },
-    "axerve_payment": {
+    "authorization": {
       "aliases": [],
       "args": {
         "id": {
@@ -645,7 +645,7 @@
           "required": true
         }
       },
-      "description": "execute an action on a resource of type axerve_payments",
+      "description": "execute an action on a resource of type authorizations",
       "flags": {
         "organization": {
           "char": "o",
@@ -710,7 +710,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "axerve_payment",
+      "id": "authorization",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -720,11 +720,11 @@
       "relativePath": [
         "lib",
         "commands",
-        "axerve_payment",
+        "authorization",
         "index.js"
       ]
     },
-    "axerve_payment:update": {
+    "authorization:void": {
       "aliases": [],
       "args": {
         "id": {
@@ -733,7 +733,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to update the payment with fresh order data.",
+      "description": "Send this attribute if you want to create a void for this authorization.",
       "flags": {
         "organization": {
           "char": "o",
@@ -798,7 +798,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "axerve_payment:update",
+      "id": "authorization:void",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -808,8 +808,8 @@
       "relativePath": [
         "lib",
         "commands",
-        "axerve_payment",
-        "update.js"
+        "authorization",
+        "void.js"
       ]
     },
     "bundle:compute_compare_at_amount": {
@@ -1349,7 +1349,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.",
+      "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.",
       "flags": {
         "organization": {
           "char": "o",
@@ -2132,6 +2132,182 @@
         "reset_password_token.js"
       ]
     },
+    "event": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "execute an action on a resource of type events",
+      "flags": {
+        "organization": {
+          "char": "o",
+          "description": "the slug of your organization",
+          "env": "CL_CLI_ORGANIZATION",
+          "hidden": true,
+          "name": "organization",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "char": "d",
+          "dependsOn": [
+            "organization"
+          ],
+          "env": "CL_CLI_DOMAIN",
+          "hidden": true,
+          "name": "domain",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "accessToken": {
+          "env": "CL_CLI_ACCESS_TOKEN",
+          "hidden": true,
+          "name": "accessToken",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "print": {
+          "char": "p",
+          "description": "print out the modified resource",
+          "name": "print",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "json": {
+          "char": "j",
+          "dependsOn": [
+            "print"
+          ],
+          "description": "print result in JSON format",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "unformatted": {
+          "char": "u",
+          "dependsOn": [
+            "json"
+          ],
+          "description": "print JSON output without indentation",
+          "name": "unformatted",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "event",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "event",
+        "index.js"
+      ]
+    },
+    "event:trigger": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Send this attribute if you want to force webhooks execution for this event.",
+      "flags": {
+        "organization": {
+          "char": "o",
+          "description": "the slug of your organization",
+          "env": "CL_CLI_ORGANIZATION",
+          "hidden": true,
+          "name": "organization",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "domain": {
+          "char": "d",
+          "dependsOn": [
+            "organization"
+          ],
+          "env": "CL_CLI_DOMAIN",
+          "hidden": true,
+          "name": "domain",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "accessToken": {
+          "env": "CL_CLI_ACCESS_TOKEN",
+          "hidden": true,
+          "name": "accessToken",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "print": {
+          "char": "p",
+          "description": "print out the modified resource",
+          "name": "print",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "json": {
+          "char": "j",
+          "dependsOn": [
+            "print"
+          ],
+          "description": "print result in JSON format",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "unformatted": {
+          "char": "u",
+          "dependsOn": [
+            "json"
+          ],
+          "description": "print JSON output without indentation",
+          "name": "unformatted",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "event:trigger",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "event",
+        "trigger.js"
+      ]
+    },
     "external_gateway": {
       "aliases": [],
       "args": {
@@ -6735,7 +6911,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to mark as fulfilled a shipped/delivered order.",
+      "description": "Send this attribute if you want to mark as fulfilled the order (shipments must be cancelled, shipped or delivered).",
       "flags": {
         "organization": {
           "char": "o",
@@ -14568,5 +14744,5 @@
       ]
     }
   },
-  "version": "4.6.0"
+  "version": "4.7.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-triggers",
   "description": "Commerce Layer CLI Triggers plugin",
-  "version": "4.6.0",
+  "version": "4.7.0",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "homepage": "https://github.com/commercelayer/commercelayer-cli-plugin-triggers",
   "repository": "commercelayer/commercelayer-cli-plugin-triggers",