@commercelayer/cli-plugin-triggers 3.3.1 → 3.4.0

package/README.md

@@ -16,11 +16,17 @@ Commerce Layer CLI Triggers plugin
 <!-- usage -->
 
 ```sh-session
-$ commercelayer COMMAND
+commercelayer COMMAND
 
-$ commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
+commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
 ```
 <!-- usagestop -->
+To install as a Commerce Layer CLI plugin run the following command:
+
+```sh-session
+$ commercelayer plugins:install triggers
+```
+
 ## Commands
 <!-- commands -->
 
@@ -79,6 +85,9 @@ $ commercelayer [COMMAND] (--help | -h) for detailed information about plugin co
 * [`commercelayer order_subscription:activate ID`](#commercelayer-order_subscriptionactivate-id)
 * [`commercelayer order_subscription:cancel ID`](#commercelayer-order_subscriptioncancel-id)
 * [`commercelayer order_subscription:deactivate ID`](#commercelayer-order_subscriptiondeactivate-id)
+* [`commercelayer payment_method ID`](#commercelayer-payment_method-id)
+* [`commercelayer payment_method:disable ID`](#commercelayer-payment_methoddisable-id)
+* [`commercelayer payment_method:enable ID`](#commercelayer-payment_methodenable-id)
 * [`commercelayer return ID`](#commercelayer-return-id)
 * [`commercelayer return:approve ID`](#commercelayer-returnapprove-id)
 * [`commercelayer return:archive ID`](#commercelayer-returnarchive-id)
@@ -99,6 +108,9 @@ $ commercelayer [COMMAND] (--help | -h) for detailed information about plugin co
 * [`commercelayer shipment:purchase ID`](#commercelayer-shipmentpurchase-id)
 * [`commercelayer shipment:ready_to_ship ID`](#commercelayer-shipmentready_to_ship-id)
 * [`commercelayer shipment:ship ID`](#commercelayer-shipmentship-id)
+* [`commercelayer shipping_method ID`](#commercelayer-shipping_method-id)
+* [`commercelayer shipping_method:disable ID`](#commercelayer-shipping_methoddisable-id)
+* [`commercelayer shipping_method:enable ID`](#commercelayer-shipping_methodenable-id)
 * [`commercelayer stock_transfer ID`](#commercelayer-stock_transfer-id)
 * [`commercelayer stock_transfer:cancel ID`](#commercelayer-stock_transfercancel-id)
 * [`commercelayer stock_transfer:complete ID`](#commercelayer-stock_transfercomplete-id)
@@ -945,7 +957,7 @@ _See code: [src/commands/order/cancel.ts](https://github.com/commercelayer/comme
 
 ### `commercelayer order:capture ID`
 
-Send this attribute if you want to capture an approved order.
+Send this attribute if you want to capture an authorized order.
 
 ```sh-session
 USAGE
@@ -961,7 +973,7 @@ FLAGS
   -u, --unformatted           print JSON output without indentation
 
 DESCRIPTION
-  Send this attribute if you want to capture an approved order.
+  Send this attribute if you want to capture an authorized order.
 ```
 
 _See code: [src/commands/order/capture.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/capture.ts)_
@@ -1388,6 +1400,75 @@ DESCRIPTION
 
 _See code: [src/commands/order_subscription/deactivate.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order_subscription/deactivate.ts)_
 
+### `commercelayer payment_method ID`
+
+Execute an action on a resource of type payment_methods.
+
+```sh-session
+USAGE
+  $ commercelayer payment_method [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  execute an action on a resource of type payment_methods
+```
+
+_See code: [src/commands/payment_method/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/payment_method/index.ts)_
+
+### `commercelayer payment_method:disable ID`
+
+Send this attribute if you want to mark the payment method as disabled.
+
+```sh-session
+USAGE
+  $ commercelayer payment_method:disable [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  Send this attribute if you want to mark the payment method as disabled.
+```
+
+_See code: [src/commands/payment_method/disable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/payment_method/disable.ts)_
+
+### `commercelayer payment_method:enable ID`
+
+Send this attribute if you want to mark the payment method as enabled.
+
+```sh-session
+USAGE
+  $ commercelayer payment_method:enable [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  Send this attribute if you want to mark the payment method as enabled.
+```
+
+_See code: [src/commands/payment_method/enable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/payment_method/enable.ts)_
+
 ### `commercelayer return ID`
 
 Execute an action on a resource of type returns.
@@ -1848,6 +1929,75 @@ DESCRIPTION
 
 _See code: [src/commands/shipment/ship.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipment/ship.ts)_
 
+### `commercelayer shipping_method ID`
+
+Execute an action on a resource of type shipping_methods.
+
+```sh-session
+USAGE
+  $ commercelayer shipping_method [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  execute an action on a resource of type shipping_methods
+```
+
+_See code: [src/commands/shipping_method/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipping_method/index.ts)_
+
+### `commercelayer shipping_method:disable ID`
+
+Send this attribute if you want to mark the shipping method as disabled.
+
+```sh-session
+USAGE
+  $ commercelayer shipping_method:disable [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  Send this attribute if you want to mark the shipping method as disabled.
+```
+
+_See code: [src/commands/shipping_method/disable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipping_method/disable.ts)_
+
+### `commercelayer shipping_method:enable ID`
+
+Send this attribute if you want to mark the shipping method as enabled.
+
+```sh-session
+USAGE
+  $ commercelayer shipping_method:enable [ID] -o <value> [-u [-j -p]]
+
+ARGUMENTS
+  ID  the unique id of the resource
+
+FLAGS
+  -j, --json                  print result in JSON format
+  -o, --organization=<value>  (required) the slug of your organization
+  -p, --print                 print out the modified resource
+  -u, --unformatted           print JSON output without indentation
+
+DESCRIPTION
+  Send this attribute if you want to mark the shipping method as enabled.
+```
+
+_See code: [src/commands/shipping_method/enable.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/shipping_method/enable.ts)_
+
 ### `commercelayer stock_transfer ID`
 
 Execute an action on a resource of type stock_transfers.

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class PaymentMethodDisable extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/payment_method/disable.js

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

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class PaymentMethodEnable extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/payment_method/enable.js

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

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class PaymentMethodIndex extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/payment_method/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 chalk_1 = tslib_1.__importDefault(require("chalk"));
+const payment_methods_1 = require("../../triggers/payment_methods");
+const promptAction = async (id) => {
+    const answers = await inquirer_1.default.prompt([{
+            type: 'list',
+            name: 'trigger',
+            message: `Select an action to execute on payment method ${chalk_1.default.yellowBright(id)}:`,
+            choices: Object.keys(payment_methods_1.triggers).sort().map(a => {
+                return { name: a, value: a };
+            }),
+            loop: false,
+            pageSize: 10,
+        }]);
+    return answers.trigger;
+};
+class PaymentMethodIndex extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(PaymentMethodIndex);
+        const id = args.id;
+        const action = await promptAction(id);
+        const fields = [];
+        const res = await (0, exec_1.default)('payment_methods', id, action, flags, fields);
+        this.log();
+        this.printOutput(res, flags);
+        this.successMessage('payment method', action, res.id);
+        return res;
+    }
+}
+exports.default = PaymentMethodIndex;
+PaymentMethodIndex.description = 'execute an action on a resource of type payment_methods';
+PaymentMethodIndex.flags = Object.assign({}, base_1.default.flags);
+PaymentMethodIndex.args = [
+    ...base_1.default.args,
+];

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class ShippingMethodDisable extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/shipping_method/disable.js

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

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class ShippingMethodEnable extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/shipping_method/enable.js

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

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

@@ -0,0 +1,18 @@
+import Command from '../../base';
+export default class ShippingMethodIndex extends Command {
+    static description: string;
+    static flags: {
+        organization: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        domain: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined>;
+        accessToken: import("@oclif/core/lib/interfaces").OptionFlag<string>;
+        print: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        json: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        unformatted: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+    };
+    static args: {
+        name: string;
+        description: string;
+        required: boolean;
+    }[];
+    run(): Promise<any>;
+}

package/lib/commands/shipping_method/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 chalk_1 = tslib_1.__importDefault(require("chalk"));
+const shipping_methods_1 = require("../../triggers/shipping_methods");
+const promptAction = async (id) => {
+    const answers = await inquirer_1.default.prompt([{
+            type: 'list',
+            name: 'trigger',
+            message: `Select an action to execute on shipping method ${chalk_1.default.yellowBright(id)}:`,
+            choices: Object.keys(shipping_methods_1.triggers).sort().map(a => {
+                return { name: a, value: a };
+            }),
+            loop: false,
+            pageSize: 10,
+        }]);
+    return answers.trigger;
+};
+class ShippingMethodIndex extends base_1.default {
+    async run() {
+        const { args, flags } = await this.parse(ShippingMethodIndex);
+        const id = args.id;
+        const action = await promptAction(id);
+        const fields = [];
+        const res = await (0, exec_1.default)('shipping_methods', id, action, flags, fields);
+        this.log();
+        this.printOutput(res, flags);
+        this.successMessage('shipping method', action, res.id);
+        return res;
+    }
+}
+exports.default = ShippingMethodIndex;
+ShippingMethodIndex.description = 'execute an action on a resource of type shipping_methods';
+ShippingMethodIndex.flags = Object.assign({}, base_1.default.flags);
+ShippingMethodIndex.args = [
+    ...base_1.default.args,
+];

package/lib/exec.d.ts

@@ -1,2 +1,2 @@
-declare const executeAction: (resourceType: string, id: string, action: string, flags: any, fields?: string[] | undefined) => Promise<any>;
+declare const executeAction: (resourceType: string, id: string, action: string, flags: any, fields?: string[]) => Promise<any>;
 export default executeAction;

package/lib/triggers/orders.js

@@ -45,7 +45,7 @@ exports.triggers = {
     capture: {
         action: 'capture',
         trigger: '_capture',
-        description: 'Send this attribute if you want to capture an approved order.',
+        description: 'Send this attribute if you want to capture an authorized order.',
     },
     refund: {
         action: 'refund',

package/lib/triggers/payment_methods.d.ts

@@ -0,0 +1,5 @@
+import type { Trigger } from '../common';
+export declare const triggers: {
+    [key: string]: Trigger;
+};
+export declare type ActionType = 'disable' | 'enable';

package/lib/triggers/payment_methods.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 the payment method as disabled.',
+    },
+    enable: {
+        action: 'enable',
+        trigger: '_enable',
+        description: 'Send this attribute if you want to mark the payment method as enabled.',
+    },
+};

package/lib/triggers/shipping_methods.d.ts

@@ -0,0 +1,5 @@
+import type { Trigger } from '../common';
+export declare const triggers: {
+    [key: string]: Trigger;
+};
+export declare type ActionType = 'disable' | 'enable';

package/lib/triggers/shipping_methods.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 the shipping method as disabled.',
+    },
+    enable: {
+        action: 'enable',
+        trigger: '_enable',
+        description: 'Send this attribute if you want to mark the shipping method as enabled.',
+    },
+};