@commercelayer/cli-plugin-triggers 3.12.0 → 3.13.0

package/README.md

@@ -88,6 +88,8 @@ $ commercelayer plugins:install triggers
 * [`commercelayer order:save_shipping_address_to_customer_address_book ID`](#commercelayer-ordersave_shipping_address_to_customer_address_book-id)
 * [`commercelayer order:shipping_address_clone_id ID`](#commercelayer-ordershipping_address_clone_id-id)
 * [`commercelayer order:shipping_address_same_as_billing ID`](#commercelayer-ordershipping_address_same_as_billing-id)
+* [`commercelayer order:start_editing ID`](#commercelayer-orderstart_editing-id)
+* [`commercelayer order:stop_editing ID`](#commercelayer-orderstop_editing-id)
 * [`commercelayer order:unarchive ID`](#commercelayer-orderunarchive-id)
 * [`commercelayer order:update_taxes ID`](#commercelayer-orderupdate_taxes-id)
 * [`commercelayer order:validate ID`](#commercelayer-ordervalidate-id)
@@ -1426,6 +1428,51 @@ DESCRIPTION
 
 _See code: [src/commands/order/shipping_address_same_as_billing.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/shipping_address_same_as_billing.ts)_
 
+### `commercelayer order:start_editing ID`
+
+Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount.
+
+```sh-session
+USAGE
+  $ commercelayer order:start_editing 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 edit the order after it is placed. Remember you cannot exceed the original total
+  amount.
+```
+
+_See code: [src/commands/order/start_editing.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/start_editing.ts)_
+
+### `commercelayer order:stop_editing ID`
+
+Send this attribute to stop the editing for the order and return back to placed status.
+
+```sh-session
+USAGE
+  $ commercelayer order:stop_editing 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 to stop the editing for the order and return back to placed status.
+```
+
+_See code: [src/commands/order/stop_editing.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/stop_editing.ts)_
+
 ### `commercelayer order:unarchive ID`
 
 Send this attribute if you want to unarchive the order.

package/lib/commands/order/start_editing.d.ts

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

package/lib/commands/order/start_editing.js

@@ -0,0 +1,21 @@
+"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 orders_1 = require("../../triggers/orders");
+const TRIGGER = 'start_editing';
+class OrderStartEditing extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(OrderStartEditing);
+        const res = await (0, exec_1.default)('orders', args.id, TRIGGER, flags);
+        if (flags.print)
+            this.printOutput(res, flags);
+        this.successMessage('order', TRIGGER, res.id);
+        return res;
+    }
+}
+OrderStartEditing.description = orders_1.triggers[TRIGGER].description;
+OrderStartEditing.flags = {};
+OrderStartEditing.args = Object.assign({}, base_1.default.args);
+exports.default = OrderStartEditing;

package/lib/commands/order/stop_editing.d.ts

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

package/lib/commands/order/stop_editing.js

@@ -0,0 +1,21 @@
+"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 orders_1 = require("../../triggers/orders");
+const TRIGGER = 'stop_editing';
+class OrderStopEditing extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(OrderStopEditing);
+        const res = await (0, exec_1.default)('orders', args.id, TRIGGER, flags);
+        if (flags.print)
+            this.printOutput(res, flags);
+        this.successMessage('order', TRIGGER, res.id);
+        return res;
+    }
+}
+OrderStopEditing.description = orders_1.triggers[TRIGGER].description;
+OrderStopEditing.flags = {};
+OrderStopEditing.args = Object.assign({}, base_1.default.args);
+exports.default = OrderStopEditing;

package/lib/triggers/orders.d.ts

@@ -1,3 +1,3 @@
 import type { Trigger } from '../common';
 export declare const triggers: Record<string, Trigger>;
-export type ActionType = 'archive' | 'unarchive' | 'place' | 'cancel' | 'approve' | 'approve_and_capture' | 'authorize' | 'authorization_amount_cents' | 'capture' | 'refund' | 'update_taxes' | 'nullify_payment_source' | 'billing_address_clone_id' | 'shipping_address_clone_id' | 'customer_payment_source_id' | 'shipping_address_same_as_billing' | 'billing_address_same_as_shipping' | 'commit_invoice' | 'refund_invoice' | 'save_payment_source_to_customer_wallet' | 'save_shipping_address_to_customer_address_book' | 'save_billing_address_to_customer_address_book' | 'refresh' | 'validate' | 'create_subscriptions';
+export type ActionType = 'archive' | 'unarchive' | 'place' | 'cancel' | 'approve' | 'approve_and_capture' | 'authorize' | 'authorization_amount_cents' | 'capture' | 'refund' | 'update_taxes' | 'nullify_payment_source' | 'billing_address_clone_id' | 'shipping_address_clone_id' | 'customer_payment_source_id' | 'shipping_address_same_as_billing' | 'billing_address_same_as_shipping' | 'commit_invoice' | 'refund_invoice' | 'save_payment_source_to_customer_wallet' | 'save_shipping_address_to_customer_address_book' | 'save_billing_address_to_customer_address_book' | 'refresh' | 'validate' | 'create_subscriptions' | 'start_editing' | 'stop_editing';

package/lib/triggers/orders.js

@@ -127,4 +127,14 @@ exports.triggers = {
         trigger: '_create_subscriptions',
         description: 'Send this attribute if you want to create order subscriptions from the recurring line items upon/after placing the order. Subscriptions are generated according to associated subscription model strategy.',
     },
+    start_editing: {
+        action: 'start_editing',
+        trigger: '_start_editing',
+        description: 'Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount.',
+    },
+    stop_editing: {
+        action: 'stop_editing',
+        trigger: '_stop_editing',
+        description: 'Send this attribute to stop the editing for the order and return back to placed status.',
+    },
 };

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "3.12.0",
+  "version": "3.13.0",
   "commands": {
     "noc": {
       "id": "noc",
@@ -4212,6 +4212,150 @@
         }
       }
     },
+    "order:start_editing": {
+      "id": "order:start_editing",
+      "description": "Send this attribute if you want to edit the order after it is placed. Remember you cannot exceed the original total amount.",
+      "strict": true,
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "organization": {
+          "name": "organization",
+          "type": "option",
+          "char": "o",
+          "description": "the slug of your organization",
+          "hidden": true,
+          "required": true,
+          "multiple": false
+        },
+        "domain": {
+          "name": "domain",
+          "type": "option",
+          "char": "d",
+          "hidden": true,
+          "required": false,
+          "multiple": false,
+          "dependsOn": [
+            "organization"
+          ]
+        },
+        "accessToken": {
+          "name": "accessToken",
+          "type": "option",
+          "hidden": true,
+          "required": true,
+          "multiple": false
+        },
+        "print": {
+          "name": "print",
+          "type": "boolean",
+          "char": "p",
+          "description": "print out the modified resource",
+          "allowNo": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "print result in JSON format",
+          "allowNo": false,
+          "dependsOn": [
+            "print"
+          ]
+        },
+        "unformatted": {
+          "name": "unformatted",
+          "type": "boolean",
+          "char": "u",
+          "description": "print JSON output without indentation",
+          "allowNo": false,
+          "dependsOn": [
+            "json"
+          ]
+        }
+      },
+      "args": {
+        "id": {
+          "name": "id",
+          "description": "the unique id of the resource",
+          "required": true
+        }
+      }
+    },
+    "order:stop_editing": {
+      "id": "order:stop_editing",
+      "description": "Send this attribute to stop the editing for the order and return back to placed status.",
+      "strict": true,
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "aliases": [],
+      "flags": {
+        "organization": {
+          "name": "organization",
+          "type": "option",
+          "char": "o",
+          "description": "the slug of your organization",
+          "hidden": true,
+          "required": true,
+          "multiple": false
+        },
+        "domain": {
+          "name": "domain",
+          "type": "option",
+          "char": "d",
+          "hidden": true,
+          "required": false,
+          "multiple": false,
+          "dependsOn": [
+            "organization"
+          ]
+        },
+        "accessToken": {
+          "name": "accessToken",
+          "type": "option",
+          "hidden": true,
+          "required": true,
+          "multiple": false
+        },
+        "print": {
+          "name": "print",
+          "type": "boolean",
+          "char": "p",
+          "description": "print out the modified resource",
+          "allowNo": false
+        },
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "char": "j",
+          "description": "print result in JSON format",
+          "allowNo": false,
+          "dependsOn": [
+            "print"
+          ]
+        },
+        "unformatted": {
+          "name": "unformatted",
+          "type": "boolean",
+          "char": "u",
+          "description": "print JSON output without indentation",
+          "allowNo": false,
+          "dependsOn": [
+            "json"
+          ]
+        }
+      },
+      "args": {
+        "id": {
+          "name": "id",
+          "description": "the unique id of the resource",
+          "required": true
+        }
+      }
+    },
     "order:unarchive": {
       "id": "order:unarchive",
       "description": "Send this attribute if you want to unarchive the order.",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-triggers",
   "description": "Commerce Layer CLI Triggers plugin",
-  "version": "3.12.0",
+  "version": "3.13.0",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "bugs": "https://github.com/commercelayer/commercelayer-cli-plugin-triggers/issues",
   "engines": {
@@ -51,7 +51,7 @@
     "@types/inquirer": "^8.2.6",
     "@types/lodash": "^4.14.195",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^20.3.3",
+    "@types/node": "^20.4.0",
     "chai": "^4.3.7",
     "eslint": "^8.44.0",
     "inflector-js": "^1.0.1",
@@ -64,7 +64,7 @@
   "dependencies": {
     "@commercelayer/cli-core": "^3.10.0",
     "@commercelayer/js-auth": "^2.3.0",
-    "@commercelayer/sdk": "^5.6.0",
+    "@commercelayer/sdk": "^5.7.0",
     "@oclif/core": "^2.8.11",
     "inquirer": "^8.2.5",
     "tslib": "^2.6.0"