@commercelayer/cli-plugin-triggers 4.8.0 → 4.9.0

package/README.md

@@ -33,6 +33,7 @@ $ commercelayer plugins:install triggers
 * [`commercelayer adyen_payment ID`](#commercelayer-adyen_payment-id)
 * [`commercelayer adyen_payment:details ID`](#commercelayer-adyen_paymentdetails-id)
 * [`commercelayer authorization ID`](#commercelayer-authorization-id)
+* [`commercelayer authorization:cancel ID`](#commercelayer-authorizationcancel-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)
@@ -46,6 +47,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:cancel ID`](#commercelayer-capturecancel-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)
@@ -271,6 +273,28 @@ DESCRIPTION
 
 _See code: [src/commands/authorization/index.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/index.ts)_
 
+### `commercelayer authorization:cancel ID`
+
+Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid).
+
+```sh-session
+USAGE
+  $ commercelayer authorization: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 void a succeeded authorization of a pending order (which is left unpaid).
+```
+
+_See code: [src/commands/authorization/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/authorization/cancel.ts)_
+
 ### `commercelayer authorization:capture ID`
 
 Send this attribute if you want to create a capture for this authorization.
@@ -560,6 +584,28 @@ 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:cancel ID`
+
+Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).
+
+```sh-session
+USAGE
+  $ commercelayer capture: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 refund a succeeded capture of a pending order (which is left unpaid).
+```
+
+_See code: [src/commands/capture/cancel.ts](https://github.com/commercelayer/commercelayer-cli-plugin-triggers/blob/main/src/commands/capture/cancel.ts)_
+
 ### `commercelayer capture:forward ID`
 
 Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.

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

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class AuthorizationCancel 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/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 authorizations_1 = require("../../triggers/authorizations");
+const TRIGGER = 'cancel';
+class AuthorizationCancel 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(AuthorizationCancel);
+        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 = AuthorizationCancel;

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

@@ -0,0 +1,9 @@
+import Command from '../../base';
+export default class CaptureCancel 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/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 captures_1 = require("../../triggers/captures");
+const TRIGGER = 'cancel';
+class CaptureCancel 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(CaptureCancel);
+        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 = CaptureCancel;

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 = 'forward' | 'capture' | 'capture_amount_cents' | 'void';
+export type ActionType = 'forward' | 'capture' | 'capture_amount_cents' | 'void' | 'cancel';

package/lib/triggers/authorizations.js

@@ -22,4 +22,9 @@ exports.triggers = {
         trigger: '_void',
         description: 'Send this attribute if you want to create a void for this authorization.',
     },
+    cancel: {
+        action: 'cancel',
+        trigger: '_cancel',
+        description: 'Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid).',
+    },
 };

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 = 'forward' | 'refund' | 'refund_amount_cents';
+export type ActionType = 'forward' | 'refund' | 'refund_amount_cents' | 'cancel';

package/lib/triggers/captures.js

@@ -17,4 +17,9 @@ exports.triggers = {
         trigger: '_refund_amount_cents',
         description: 'Send this attribute as a value in cents if you want to overwrite the amount to be refunded.',
     },
+    cancel: {
+        action: 'cancel',
+        trigger: '_cancel',
+        description: 'Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).',
+    },
 };

package/oclif.manifest.json

@@ -196,7 +196,7 @@
         "index.js"
       ]
     },
-    "authorization:capture": {
+    "axerve_payment": {
       "aliases": [],
       "args": {
         "id": {
@@ -205,7 +205,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to create a capture for this authorization.",
+      "description": "execute an action on a resource of type axerve_payments",
       "flags": {
         "organization": {
           "char": "o",
@@ -270,7 +270,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:capture",
+      "id": "axerve_payment",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -280,11 +280,11 @@
       "relativePath": [
         "lib",
         "commands",
-        "authorization",
-        "capture.js"
+        "axerve_payment",
+        "index.js"
       ]
     },
-    "authorization:capture_amount_cents": {
+    "axerve_payment:update": {
       "aliases": [],
       "args": {
         "id": {
@@ -293,7 +293,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute as a value in cents if you want to overwrite the amount to be captured.",
+      "description": "Send this attribute if you want to update the payment with fresh order data.",
       "flags": {
         "organization": {
           "char": "o",
@@ -358,7 +358,95 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:capture_amount_cents",
+      "id": "axerve_payment:update",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "axerve_payment",
+        "update.js"
+      ]
+    },
+    "authorization:cancel": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Send this attribute if you want to void a succeeded authorization of a pending order (which is left unpaid).",
+      "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": "authorization:cancel",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -369,10 +457,10 @@
         "lib",
         "commands",
         "authorization",
-        "capture_amount_cents.js"
+        "cancel.js"
       ]
     },
-    "authorization:forward": {
+    "authorization:capture": {
       "aliases": [],
       "args": {
         "id": {
@@ -381,7 +469,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.",
+      "description": "Send this attribute if you want to create a capture for this authorization.",
       "flags": {
         "organization": {
           "char": "o",
@@ -446,7 +534,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:forward",
+      "id": "authorization:capture",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -457,10 +545,10 @@
         "lib",
         "commands",
         "authorization",
-        "forward.js"
+        "capture.js"
       ]
     },
-    "authorization": {
+    "authorization:capture_amount_cents": {
       "aliases": [],
       "args": {
         "id": {
@@ -469,7 +557,7 @@
           "required": true
         }
       },
-      "description": "execute an action on a resource of type authorizations",
+      "description": "Send this attribute as a value in cents if you want to overwrite the amount to be captured.",
       "flags": {
         "organization": {
           "char": "o",
@@ -534,7 +622,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization",
+      "id": "authorization:capture_amount_cents",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -545,10 +633,10 @@
         "lib",
         "commands",
         "authorization",
-        "index.js"
+        "capture_amount_cents.js"
       ]
     },
-    "authorization:void": {
+    "authorization:forward": {
       "aliases": [],
       "args": {
         "id": {
@@ -557,7 +645,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to create a void for this authorization.",
+      "description": "Send this attribute if you want to forward a stuck transaction to succeeded and update associated order states accordingly.",
       "flags": {
         "organization": {
           "char": "o",
@@ -622,7 +710,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "authorization:void",
+      "id": "authorization:forward",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -633,10 +721,10 @@
         "lib",
         "commands",
         "authorization",
-        "void.js"
+        "forward.js"
       ]
     },
-    "axerve_payment": {
+    "authorization": {
       "aliases": [],
       "args": {
         "id": {
@@ -645,7 +733,7 @@
           "required": true
         }
       },
-      "description": "execute an action on a resource of type axerve_payments",
+      "description": "execute an action on a resource of type authorizations",
       "flags": {
         "organization": {
           "char": "o",
@@ -710,7 +798,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "axerve_payment",
+      "id": "authorization",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -720,11 +808,11 @@
       "relativePath": [
         "lib",
         "commands",
-        "axerve_payment",
+        "authorization",
         "index.js"
       ]
     },
-    "axerve_payment:update": {
+    "authorization:void": {
       "aliases": [],
       "args": {
         "id": {
@@ -733,7 +821,7 @@
           "required": true
         }
       },
-      "description": "Send this attribute if you want to update the payment with fresh order data.",
+      "description": "Send this attribute if you want to create a void for this authorization.",
       "flags": {
         "organization": {
           "char": "o",
@@ -798,7 +886,7 @@
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "axerve_payment:update",
+      "id": "authorization:void",
       "pluginAlias": "@commercelayer/cli-plugin-triggers",
       "pluginName": "@commercelayer/cli-plugin-triggers",
       "pluginType": "core",
@@ -808,8 +896,8 @@
       "relativePath": [
         "lib",
         "commands",
-        "axerve_payment",
-        "update.js"
+        "authorization",
+        "void.js"
       ]
     },
     "bundle:compute_compare_at_amount": {
@@ -1340,6 +1428,94 @@
         "index.js"
       ]
     },
+    "capture:cancel": {
+      "aliases": [],
+      "args": {
+        "id": {
+          "description": "the unique id of the resource",
+          "name": "id",
+          "required": true
+        }
+      },
+      "description": "Send this attribute if you want to refund a succeeded capture of a pending order (which is left unpaid).",
+      "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": "capture:cancel",
+      "pluginAlias": "@commercelayer/cli-plugin-triggers",
+      "pluginName": "@commercelayer/cli-plugin-triggers",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": false,
+      "relativePath": [
+        "lib",
+        "commands",
+        "capture",
+        "cancel.js"
+      ]
+    },
     "capture:forward": {
       "aliases": [],
       "args": {
@@ -15360,5 +15536,5 @@
       ]
     }
   },
-  "version": "4.8.0"
+  "version": "4.9.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@commercelayer/cli-plugin-triggers",
   "description": "Commerce Layer CLI Triggers plugin",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "author": "Pierluigi Viti <pierluigi@commercelayer.io>",
   "homepage": "https://github.com/commercelayer/commercelayer-cli-plugin-triggers",
   "repository": "commercelayer/commercelayer-cli-plugin-triggers",
@@ -64,14 +64,14 @@
     "@types/inquirer": "^8.2.10",
     "@types/lodash.snakecase": "^4.1.9",
     "@types/mocha": "^10.0.9",
-    "@types/node": "^22.7.7",
+    "@types/node": "^22.7.9",
     "chai": "^4.5.0",
     "eslint": "^8.57.1",
     "inflector-js": "^1.0.1",
     "lodash.snakecase": "^4.1.1",
     "mocha": "^10.7.3",
     "nyc": "^15.1.0",
-    "oclif": "^4.15.9",
+    "oclif": "^4.15.12",
     "semantic-release": "^24.1.3",
     "tsx": "^4.19.1",
     "typescript": "5.5.4"