@commercelayer/cli-plugin-triggers 4.4.0 → 4.5.0

package/README.md

@@ -152,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)
@@ -2899,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/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/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',