@commercelayer/cli-plugin-triggers 4.2.0 → 4.3.0

package/README.md

@@ -102,6 +102,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer order:commit_invoice ID`](#commercelayer-ordercommit_invoice-id)
 * [`commercelayer order:create_subscriptions ID`](#commercelayer-ordercreate_subscriptions-id)
 * [`commercelayer order:customer_payment_source_id ID`](#commercelayer-ordercustomer_payment_source_id-id)
+* [`commercelayer order:fulfill ID`](#commercelayer-orderfulfill-id)
 * [`commercelayer order:nullify_payment_source ID`](#commercelayer-ordernullify_payment_source-id)
 * [`commercelayer order:pending ID`](#commercelayer-orderpending-id)
 * [`commercelayer order:place ID`](#commercelayer-orderplace-id)
@@ -149,6 +150,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer satispay_payment:refresh ID`](#commercelayer-satispay_paymentrefresh-id)
 * [`commercelayer shipment ID`](#commercelayer-shipment-id)
 * [`commercelayer shipment:decrement_stock ID`](#commercelayer-shipmentdecrement_stock-id)
+* [`commercelayer shipment:deliver ID`](#commercelayer-shipmentdeliver-id)
 * [`commercelayer shipment:get_rates ID`](#commercelayer-shipmentget_rates-id)
 * [`commercelayer shipment:on_hold ID`](#commercelayer-shipmenton_hold-id)
 * [`commercelayer shipment:packing ID`](#commercelayer-shipmentpacking-id)
@@ -1785,6 +1787,28 @@ DESCRIPTION
 
 _See code: [src/commands/order/customer_payment_source_id.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/customer_payment_source_id.ts)_
 
+### `commercelayer order:fulfill ID`
+
+Send this attribute if you want to mark as fulfilled a shipped/delivered order.
+
+```sh-session
+USAGE
+  $ commercelayer order:fulfill 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 mark as fulfilled a shipped/delivered order.
+```
+
+_See code: [src/commands/order/fulfill.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/fulfill.ts)_
+
 ### `commercelayer order:nullify_payment_source ID`
 
 Send this attribute if you want to nullify the payment source for this order.
@@ -2829,6 +2853,28 @@ DESCRIPTION
 
 _See code: [src/commands/shipment/decrement_stock.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/decrement_stock.ts)_
 
+### `commercelayer shipment:deliver ID`
+
+Send this attribute if you want to mark this shipment as delivered.
+
+```sh-session
+USAGE
+  $ commercelayer shipment:deliver 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 mark this shipment as delivered.
+```
+
+_See code: [src/commands/shipment/deliver.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/deliver.ts)_
+
 ### `commercelayer shipment:get_rates ID`
 
 Send this attribute if you want get the shipping rates from the associated carrier accounts.

package/lib/base.js

@@ -88,7 +88,7 @@ class default_1 extends core_1.Command {
         this.log(cli_core_1.clOutput.formatOutput(res, flags));
     }
     successMessage(resource, action, id) {
-        this.log(`\nAction ${cli_core_1.clColor.api.trigger(action)} executed without errors on ${resource.replace(/_/g, ' ')} ${cli_core_1.clColor.api.id(id)}\n`);
+        this.log(`\nAction ${cli_core_1.clColor.api.trigger(action)} executed without errors on ${cli_core_1.clApi.humanizeResource(resource)} ${cli_core_1.clColor.api.id(id)}\n`);
     }
     async executeAction(resourceType, id, action, flags, fields) {
         return await (0, exec_1.default)(resourceType, id, action, flags, fields, this.config);

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

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class OrderFulfill 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/order/fulfill.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 orders_1 = require("../../triggers/orders");
+const TRIGGER = 'fulfill';
+class OrderFulfill extends base_1.default {
+    static description = orders_1.triggers[TRIGGER].description;
+    static flags = {};
+    static args = {
+        ...base_1.default.args,
+    };
+    async run() {
+        const { args, flags } = await this.parse(OrderFulfill);
+        const res = await this.executeAction('orders', args.id, TRIGGER, flags);
+        if (flags.print)
+            this.printOutput(res, flags);
+        this.successMessage('order', TRIGGER, res.id);
+        return res;
+    }
+}
+exports.default = OrderFulfill;

package/lib/commands/shipment/deliver.d.ts

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class ShipmentDeliver 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/shipment/deliver.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 shipments_1 = require("../../triggers/shipments");
+const TRIGGER = 'deliver';
+class ShipmentDeliver extends base_1.default {
+    static description = shipments_1.triggers[TRIGGER].description;
+    static flags = {};
+    static args = {
+        ...base_1.default.args,
+    };
+    async run() {
+        const { args, flags } = await this.parse(ShipmentDeliver);
+        const res = await this.executeAction('shipments', args.id, TRIGGER, flags);
+        if (flags.print)
+            this.printOutput(res, flags);
+        this.successMessage('shipment', TRIGGER, res.id);
+        return res;
+    }
+}
+exports.default = ShipmentDeliver;

package/lib/exec.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 const cli_core_1 = require("@commercelayer/cli-core");
 const sdk_1 = tslib_1.__importStar(require("@commercelayer/sdk"));
+const errors_1 = require("@oclif/core/lib/errors");
 const commercelayerInit = (flags, config) => {
     const organization = flags.organization;
     const domain = flags.domain;
@@ -17,15 +18,18 @@ const commercelayerInit = (flags, config) => {
 };
 const exec = async (resourceType, id, action, flags, fields, config) => {
     const cl = commercelayerInit(flags, config);
-    const res = { id };
-    const trigger = `_${action}`;
-    res[trigger] = flags.value || true;
+    const resSdk = cl[resourceType];
+    await cl.orders.retrieve(id).catch(err => {
+        const resource = cli_core_1.clApi.humanizeResource(cli_core_1.clText.singularize(resourceType));
+        if (cl.isApiError(err) && (err.status === 404))
+            throw new errors_1.CLIError(`Invalid ${resource} or ${resource} not found: ${cli_core_1.clColor.msg.error(id)}`);
+    });
+    const res = { id, [`_${action}`]: flags.value || true };
     const params = {};
     if (fields && (fields.length > 0)) {
         params.fields = {};
         params.fields[resourceType] = fields;
     }
-    const resSdk = cl[resourceType];
     const result = resSdk.update(res, params).catch((error) => {
         if (sdk_1.CommerceLayerStatic.isApiError(error))
             error.code = `RES_${resourceType}_${id}`;

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' | 'pending' | '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' | 'reset_circuit';
+export type ActionType = 'archive' | 'unarchive' | 'pending' | 'place' | 'cancel' | 'approve' | 'approve_and_capture' | 'authorize' | 'authorization_amount_cents' | 'capture' | 'refund' | 'fulfill' | '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' | 'reset_circuit';

package/lib/triggers/orders.js

@@ -57,6 +57,11 @@ exports.triggers = {
         trigger: '_refund',
         description: 'Send this attribute if you want to refund a captured order.',
     },
+    fulfill: {
+        action: 'fulfill',
+        trigger: '_fulfill',
+        description: 'Send this attribute if you want to mark as fulfilled a shipped/delivered order.',
+    },
     update_taxes: {
         action: 'update_taxes',
         trigger: '_update_taxes',

package/lib/triggers/shipments.d.ts

@@ -1,3 +1,3 @@
 import type { Trigger } from '../common';
 export declare const triggers: Record<string, Trigger>;
-export type ActionType = 'upcoming' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'ship' | 'reserve_stock' | 'release_stock' | 'decrement_stock' | 'get_rates' | 'purchase';
+export type ActionType = 'upcoming' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'ship' | 'deliver' | 'reserve_stock' | 'release_stock' | 'decrement_stock' | 'get_rates' | 'purchase';

package/lib/triggers/shipments.js

@@ -32,6 +32,11 @@ exports.triggers = {
         trigger: '_ship',
         description: 'Send this attribute if you want to mark this shipment as shipped.',
     },
+    deliver: {
+        action: 'deliver',
+        trigger: '_deliver',
+        description: 'Send this attribute if you want to mark this shipment as delivered.',
+    },
     reserve_stock: {
         action: 'reserve_stock',
         trigger: '_reserve_stock',

package/oclif.manifest.json

@@ -6286,6 +6286,94 @@
         "customer_payment_source_id.js"
       ]
     },
+    "order:fulfill": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Send this attribute if you want to mark as fulfilled a shipped/delivered order.",
+      "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": "order:fulfill",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "order",
+        "fulfill.js"
+      ]
+    },
     "order": {
       "aliases": [],
       "args": {
@@ -10431,6 +10519,94 @@
         "decrement_stock.js"
       ]
     },
+    "shipment:deliver": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Send this attribute if you want to mark this shipment as delivered.",
+      "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": "shipment:deliver",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "shipment",
+        "deliver.js"
+      ]
+    },
     "shipment:get_rates": {
       "aliases": [],
       "args": {
@@ -13688,5 +13864,5 @@
       ]
     }
   },
-  "version": "4.2.0"
+  "version": "4.3.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-triggers",
   "description": "Commerce Layer CLI Triggers plugin",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "homepage": "https://github.com/commercelayer/commercelayer-cli-plugin-triggers",
   "repository": "commercelayer/commercelayer-cli-plugin-triggers",
@@ -64,21 +64,21 @@
     "@types/inquirer": "^8.2.10",
     "@types/lodash.snakecase": "^4.1.9",
     "@types/mocha": "^10.0.6",
-    "@types/node": "^20.12.12",
+    "@types/node": "^20.12.13",
     "chai": "^4.4.1",
     "eslint": "^8.57.0",
     "inflector-js": "^1.0.1",
     "lodash.snakecase": "^4.1.1",
     "mocha": "^10.4.0",
     "nyc": "^15.1.0",
-    "oclif": "^4.10.15",
+    "oclif": "^4.11.3",
     "semantic-release": "^22.0.12",
-    "tsx": "^4.10.5",
+    "tsx": "^4.11.0",
     "typescript": "5.3.2"
   },
   "dependencies": {
-    "@commercelayer/cli-core": "^5.0.2",
-    "@commercelayer/sdk": "^6.2.0",
+    "@commercelayer/cli-core": "^5.0.4",
+    "@commercelayer/sdk": "^6.4.0",
     "@oclif/core": "^3.26.6",
     "inquirer": "^8.2.6",
     "tslib": "^2.6.2"