@commercelayer/cli-plugin-triggers 4.5.0 → 4.6.0

package/README.md

@@ -35,6 +35,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer authorization ID`](#commercelayer-authorization-id)
 * [`commercelayer authorization:capture ID`](#commercelayer-authorizationcapture-id)
 * [`commercelayer authorization:capture_amount_cents ID`](#commercelayer-authorizationcapture_amount_cents-id)
+* [`commercelayer authorization:forward ID`](#commercelayer-authorizationforward-id)
 * [`commercelayer authorization:void ID`](#commercelayer-authorizationvoid-id)
 * [`commercelayer axerve_payment ID`](#commercelayer-axerve_payment-id)
 * [`commercelayer axerve_payment:update ID`](#commercelayer-axerve_paymentupdate-id)
@@ -45,6 +46,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer buy_x_pay_y_promotion:disable ID`](#commercelayer-buy_x_pay_y_promotiondisable-id)
 * [`commercelayer buy_x_pay_y_promotion:enable ID`](#commercelayer-buy_x_pay_y_promotionenable-id)
 * [`commercelayer capture ID`](#commercelayer-capture-id)
+* [`commercelayer capture:forward ID`](#commercelayer-captureforward-id)
 * [`commercelayer capture:refund ID`](#commercelayer-capturerefund-id)
 * [`commercelayer capture:refund_amount_cents ID`](#commercelayer-capturerefund_amount_cents-id)
 * [`commercelayer checkout_com_payment ID`](#commercelayer-checkout_com_payment-id)
@@ -142,6 +144,8 @@ $ commercelayer plugins:install triggers
 * [`commercelayer return:archive ID`](#commercelayer-returnarchive-id)
 * [`commercelayer return:cancel ID`](#commercelayer-returncancel-id)
 * [`commercelayer return:receive ID`](#commercelayer-returnreceive-id)
+* [`commercelayer return:refund ID`](#commercelayer-returnrefund-id)
+* [`commercelayer return:refund_amount_cents ID`](#commercelayer-returnrefund_amount_cents-id)
 * [`commercelayer return:reject ID`](#commercelayer-returnreject-id)
 * [`commercelayer return:request ID`](#commercelayer-returnrequest-id)
 * [`commercelayer return:restock ID`](#commercelayer-returnrestock-id)
@@ -282,7 +286,7 @@ _See code: [src/commands/authorization/capture.ts](https://github.com/commercela
 
 ### `commercelayer authorization:capture_amount_cents ID`
 
-The associated capture amount, in cents.
+Send this attribute as a value in cents if you want to overwrite the amount to be captured.
 
 ```sh-session
 USAGE
@@ -297,11 +301,34 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  The associated capture amount, in cents.
+  Send this attribute as a value in cents if you want to overwrite the amount to be captured.
 ```
 
 _See code: [src/commands/authorization/capture_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/capture_amount_cents.ts)_
 
+### `commercelayer authorization:forward ID`
+
+Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.
+
+```sh-session
+USAGE
+  $ commercelayer authorization:forward 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 forwrad a stuck transaction to succeeded and update associated order states
+  accordingly.
+```
+
+_See code: [src/commands/authorization/forward.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/forward.ts)_
+
 ### `commercelayer authorization:void ID`
 
 Send this attribute if you want to create a void for this authorization.
@@ -524,6 +551,29 @@ DESCRIPTION
 
 _See code: [src/commands/capture/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/index.ts)_
 
+### `commercelayer capture:forward ID`
+
+Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.
+
+```sh-session
+USAGE
+  $ commercelayer capture:forward 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 forwrad a stuck transaction to succeeded and update associated order states
+  accordingly.
+```
+
+_See code: [src/commands/capture/forward.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/forward.ts)_
+
 ### `commercelayer capture:refund ID`
 
 Send this attribute if you want to create a refund for this capture.
@@ -548,7 +598,7 @@ _See code: [src/commands/capture/refund.ts](https://github.com/commercelayer/com
 
 ### `commercelayer capture:refund_amount_cents ID`
 
-The associated refund amount, in cents.
+Send this attribute as a value in cents if you want to overwrite the amount to be refunded.
 
 ```sh-session
 USAGE
@@ -563,7 +613,7 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  The associated refund amount, in cents.
+  Send this attribute as a value in cents if you want to overwrite the amount to be refunded.
 ```
 
 _See code: [src/commands/capture/refund_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/refund_amount_cents.ts)_
@@ -1657,7 +1707,7 @@ _See code: [src/commands/order/archive.ts](https://github.com/commercelayer/comm
 
 ### `commercelayer order:authorization_amount_cents ID`
 
-The authorization amount, in cents.
+Send this attribute as a value in cents if you want to overwrite the amount to be authorized.
 
 ```sh-session
 USAGE
@@ -1672,7 +1722,7 @@ FLAGS
   -u, --unformatted  print JSON output without indentation
 
 DESCRIPTION
-  The authorization amount, in cents.
+  Send this attribute as a value in cents if you want to overwrite the amount to be authorized.
 ```
 
 _See code: [src/commands/order/authorization_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/order/authorization_amount_cents.ts)_
@@ -2680,6 +2730,50 @@ DESCRIPTION
 
 _See code: [src/commands/return/receive.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/receive.ts)_
 
+### `commercelayer return:refund ID`
+
+Send this attribute if you want to create a refund for this return.
+
+```sh-session
+USAGE
+  $ commercelayer return:refund 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 create a refund for this return.
+```
+
+_See code: [src/commands/return/refund.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/refund.ts)_
+
+### `commercelayer return:refund_amount_cents ID`
+
+Send this attribute as a value in cents to specify the amount to be refunded.
+
+```sh-session
+USAGE
+  $ commercelayer return:refund_amount_cents 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 as a value in cents to specify the amount to be refunded.
+```
+
+_See code: [src/commands/return/refund_amount_cents.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/return/refund_amount_cents.ts)_
+
 ### `commercelayer return:reject ID`
 
 Send this attribute if you want to mark this return as rejected.

package/lib/commands/authorization/forward.d.ts

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

package/lib/commands/capture/forward.d.ts

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

package/lib/commands/return/refund.d.ts

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

package/lib/commands/return/refund_amount_cents.d.ts

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

package/lib/exec.js

@@ -19,10 +19,11 @@ const commercelayerInit = (flags, config) => {
 const exec = async (resourceType, id, action, flags, fields, config) => {
     const cl = commercelayerInit(flags, config);
     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))
+    await resSdk.retrieve(id).catch((err) => {
+        if (cl.isApiError(err) && (err.status === 404)) {
+            const resource = cli_core_1.clApi.humanizeResource(cli_core_1.clText.singularize(resourceType));
             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 = {};

package/lib/triggers/authorizations.d.ts

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

package/lib/triggers/authorizations.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.triggers = void 0;
 exports.triggers = {
+    forward: {
+        action: 'forward',
+        trigger: '_forward',
+        description: 'Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.',
+    },
     capture: {
         action: 'capture',
         trigger: '_capture',
@@ -10,7 +15,7 @@ exports.triggers = {
     capture_amount_cents: {
         action: 'capture_amount_cents',
         trigger: '_capture_amount_cents',
-        description: 'The associated capture amount, in cents.',
+        description: 'Send this attribute as a value in cents if you want to overwrite the amount to be captured.',
     },
     void: {
         action: 'void',

package/lib/triggers/captures.d.ts

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

package/lib/triggers/captures.js

@@ -2,6 +2,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.triggers = void 0;
 exports.triggers = {
+    forward: {
+        action: 'forward',
+        trigger: '_forward',
+        description: 'Send this attribute if you want to forwrad a stuck transaction to succeeded and update associated order states accordingly.',
+    },
     refund: {
         action: 'refund',
         trigger: '_refund',
@@ -10,6 +15,6 @@ exports.triggers = {
     refund_amount_cents: {
         action: 'refund_amount_cents',
         trigger: '_refund_amount_cents',
-        description: 'The associated refund amount, in cents.',
+        description: 'Send this attribute as a value in cents if you want to overwrite the amount to be refunded.',
     },
 };

package/lib/triggers/orders.js

@@ -45,7 +45,7 @@ exports.triggers = {
     authorization_amount_cents: {
         action: 'authorization_amount_cents',
         trigger: '_authorization_amount_cents',
-        description: 'The authorization amount, in cents.',
+        description: 'Send this attribute as a value in cents if you want to overwrite the amount to be authorized.',
     },
     capture: {
         action: 'capture',

package/lib/triggers/returns.d.ts

@@ -1,3 +1,3 @@
 import type { Trigger } from '../common';
 export declare const triggers: Record<string, Trigger>;
-export type ActionType = 'request' | 'approve' | 'cancel' | 'ship' | 'reject' | 'receive' | 'restock' | 'archive' | 'unarchive';
+export type ActionType = 'request' | 'approve' | 'cancel' | 'ship' | 'reject' | 'receive' | 'restock' | 'archive' | 'unarchive' | 'refund' | 'refund_amount_cents';

package/lib/triggers/returns.js

@@ -47,4 +47,14 @@ exports.triggers = {
         trigger: '_unarchive',
         description: 'Send this attribute if you want to unarchive the return.',
     },
+    refund: {
+        action: 'refund',
+        trigger: '_refund',
+        description: 'Send this attribute if you want to create a refund for this return.',
+    },
+    refund_amount_cents: {
+        action: 'refund_amount_cents',
+        trigger: '_refund_amount_cents',
+        description: 'Send this attribute as a value in cents to specify the amount to be refunded.',
+    },
 };