@commercelayer/cli-plugin-triggers 4.3.0 → 4.5.0

package/README.md

@@ -86,6 +86,9 @@ $ commercelayer plugins:install triggers
 * [`commercelayer line_item:external_price ID`](#commercelayer-line_itemexternal_price-id)
 * [`commercelayer line_item:reserve_stock ID`](#commercelayer-line_itemreserve_stock-id)
 * [`commercelayer line_item:reset_circuit ID`](#commercelayer-line_itemreset_circuit-id)
+* [`commercelayer link ID`](#commercelayer-link-id)
+* [`commercelayer link:disable ID`](#commercelayer-linkdisable-id)
+* [`commercelayer link:enable ID`](#commercelayer-linkenable-id)
 * [`commercelayer market ID`](#commercelayer-market-id)
 * [`commercelayer market:disable ID`](#commercelayer-marketdisable-id)
 * [`commercelayer market:enable ID`](#commercelayer-marketenable-id)
@@ -149,6 +152,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer satispay_payment ID`](#commercelayer-satispay_payment-id)
 * [`commercelayer satispay_payment:refresh ID`](#commercelayer-satispay_paymentrefresh-id)
 * [`commercelayer shipment ID`](#commercelayer-shipment-id)
+* [`commercelayer shipment:cancel ID`](#commercelayer-shipmentcancel-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)
@@ -1431,6 +1435,72 @@ DESCRIPTION
 
 _See code: [src/commands/line_item/reset_circuit.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/line_item/reset_circuit.ts)_
 
+### `commercelayer link ID`
+
+Execute an action on a resource of type links.
+
+```sh-session
+USAGE
+  $ commercelayer link 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 links
+```
+
+_See code: [src/commands/link/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/link/index.ts)_
+
+### `commercelayer link:disable ID`
+
+Send this attribute if you want to mark this resource as disabled.
+
+```sh-session
+USAGE
+  $ commercelayer link:disable 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 resource as disabled.
+```
+
+_See code: [src/commands/link/disable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/link/disable.ts)_
+
+### `commercelayer link:enable ID`
+
+Send this attribute if you want to mark this resource as enabled.
+
+```sh-session
+USAGE
+  $ commercelayer link:enable 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 resource as enabled.
+```
+
+_See code: [src/commands/link/enable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/link/enable.ts)_
+
 ### `commercelayer market ID`
 
 Execute an action on a resource of type markets.
@@ -2830,6 +2900,28 @@ DESCRIPTION
 
 _See code: [src/commands/shipment/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/index.ts)_
 
+### `commercelayer shipment:cancel ID`
+
+Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered).
+
+```sh-session
+USAGE
+  $ commercelayer shipment:cancel 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 cancelled (unless already shipped or delivered).
+```
+
+_See code: [src/commands/shipment/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/cancel.ts)_
+
 ### `commercelayer shipment:decrement_stock ID`
 
 Send this attribute if you want to automatically decrement and release the stock for each of the associated stock line item. Can be done only when fulfillment is in progress.

package/lib/commands/link/disable.d.ts

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

package/lib/commands/link/enable.d.ts

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

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

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class LinkIndex 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/link/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 links_1 = require("../../triggers/links");
+const promptAction = async (id) => {
+    const answers = await inquirer_1.default.prompt([{
+            type: 'list',
+            name: 'trigger',
+            message: `Select an action to execute on link ${cli_core_1.clColor.api.id(id)}:`,
+            choices: Object.keys(links_1.triggers).sort().map(a => {
+                return { name: a, value: a };
+            }),
+            loop: false,
+            pageSize: 10,
+        }]);
+    return answers.trigger;
+};
+class LinkIndex extends base_1.default {
+    static description = 'execute an action on a resource of type links';
+    static flags = {};
+    static args = {
+        ...base_1.default.args,
+    };
+    async run() {
+        const { args, flags } = await this.parse(LinkIndex);
+        const id = args.id;
+        const action = await promptAction(id);
+        const fields = [];
+        const res = await (0, exec_1.default)('links', id, action, flags, fields);
+        this.log();
+        this.printOutput(res, flags);
+        this.successMessage('link', action, res.id);
+        return res;
+    }
+}
+exports.default = LinkIndex;

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

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class ShipmentCancel 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/cancel.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 = 'cancel';
+class ShipmentCancel 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(ShipmentCancel);
+        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 = ShipmentCancel;

package/lib/triggers/links.d.ts

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

package/lib/triggers/links.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.triggers = void 0;
+exports.triggers = {
+    disable: {
+        action: 'disable',
+        trigger: '_disable',
+        description: 'Send this attribute if you want to mark this resource as disabled.',
+    },
+    enable: {
+        action: 'enable',
+        trigger: '_enable',
+        description: 'Send this attribute if you want to mark this resource as enabled.',
+    },
+};

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' | 'deliver' | 'reserve_stock' | 'release_stock' | 'decrement_stock' | 'get_rates' | 'purchase';
+export type ActionType = 'upcoming' | 'cancel' | 'on_hold' | 'picking' | 'packing' | 'ready_to_ship' | 'ship' | 'deliver' | 'reserve_stock' | 'release_stock' | 'decrement_stock' | 'get_rates' | 'purchase';

package/lib/triggers/shipments.js

@@ -7,6 +7,11 @@ exports.triggers = {
         trigger: '_upcoming',
         description: 'Send this attribute if you want to mark this shipment as upcoming.',
     },
+    cancel: {
+        action: 'cancel',
+        trigger: '_cancel',
+        description: 'Send this attribute if you want to mark this shipment as cancelled (unless already shipped or delivered).',
+    },
     on_hold: {
         action: 'on_hold',
         trigger: '_on_hold',