@nevermined-io/cli 1.10.0 → 1.11.1

package/dist/commands/organizations/onboard-customer.d.ts

@@ -0,0 +1,16 @@
+import { BaseCommand } from '../../base-command.js';
+/**
+ * Onboard a **white-label customer** into the organization (#2418). Provisions a Nevermined account for `email` under the caller's organization without consuming a member seat, and returns a usable, scoped NVM API key the org can use to transparently act on the customer's behalf (purchase plans / redeem credits). The customer is recorded in the org's Customers list. If the email already belongs to an account the org does NOT own, no key is issued: an email challenge is sent to the owner and the result carries `consentRequired: true`. Call again once the owner has consented to complete onboarding.
+ */
+export default class OnboardCustomer extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        email: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        profile: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        format: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        verbose: import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+}
+//# sourceMappingURL=onboard-customer.d.ts.map

package/dist/commands/organizations/onboard-customer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboard-customer.d.ts","sourceRoot":"","sources":["../../../src/commands/organizations/onboard-customer.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAW;IACtD,OAAgB,WAAW,SAA8lB;IAEznB,OAAgB,QAAQ,WAEvB;IAED,OAAgB,KAAK;;;;;MAGpB;IAIY,GAAG,IAAI,OAAO,CAAC,IAAI,CAAC;CAalC"}

package/dist/commands/organizations/onboard-customer.js

@@ -0,0 +1,27 @@
+import { Flags } from '@oclif/core';
+import { BaseCommand } from '../../base-command.js';
+/**
+ * Onboard a **white-label customer** into the organization (#2418). Provisions a Nevermined account for `email` under the caller's organization without consuming a member seat, and returns a usable, scoped NVM API key the org can use to transparently act on the customer's behalf (purchase plans / redeem credits). The customer is recorded in the org's Customers list. If the email already belongs to an account the org does NOT own, no key is issued: an email challenge is sent to the owner and the result carries `consentRequired: true`. Call again once the owner has consented to complete onboarding.
+ */
+export default class OnboardCustomer extends BaseCommand {
+    static description = "Onboard a **white-label customer** into the organization (#2418). Provisions a Nevermined account for `email` under the caller's organization without consuming a member seat, and returns a usable, scoped NVM API key the org can use to transparently act on the customer's behalf (purchase plans / redeem credits). The customer is recorded in the org's Customers list. If the email already belongs to an account the org does NOT own, no key is issued: an email challenge is sent to the owner and the result carries `consentRequired: true`. Call again once the owner has consented to complete onboarding.";
+    static examples = [
+        '$ nevermined organizations onboard-customer'
+    ];
+    static flags = {
+        ...BaseCommand.baseFlags,
+        'email': Flags.string({ required: true }),
+    };
+    async run() {
+        const { flags } = await this.parse(this.constructor);
+        const payments = await this.initPayments();
+        try {
+            const result = await payments.organizations.onboardCustomer(flags['email']);
+            this.formatter.output(result);
+        }
+        catch (error) {
+            this.handleError(error);
+        }
+    }
+}
+//# sourceMappingURL=onboard-customer.js.map

package/dist/commands/organizations/onboard-customer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboard-customer.js","sourceRoot":"","sources":["../../../src/commands/organizations/onboard-customer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAEnD;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,eAAgB,SAAQ,WAAW;IACtD,MAAM,CAAU,WAAW,GAAG,2lBAA2lB,CAAA;IAEznB,MAAM,CAAU,QAAQ,GAAG;QACzB,6CAA6C;KAC9C,CAAA;IAED,MAAM,CAAU,KAAK,GAAG;QACtB,GAAG,WAAW,CAAC,SAAS;QACxB,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;KAC1C,CAAA;IAIM,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAkB,CAAC,CAAA;QAE3D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,YAAY,EAAE,CAAA;QAE1C,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,aAAa,CAAC,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAA;YAE3E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QAC/B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,CAAA;QACzB,CAAC;IACH,CAAC"}

package/oclif.manifest.json

@@ -993,13 +993,13 @@
         "setup.js"
       ]
     },
-    "config:init": {
+    "delegation:list-payment-methods": {
       "aliases": [],
       "args": {},
-      "description": "Initialize CLI configuration",
+      "description": "List enrolled credit/debit cards available for card-delegation (fiat) payments.",
       "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --profile production"
+        "$ nevermined delegation list-payment-methods",
+        "$ nevermined delegation list-payment-methods --format json"
       ],
       "flags": {
         "profile": {
@@ -1031,40 +1031,11 @@
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
-        },
-        "api-key": {
-          "description": "Nevermined API key",
-          "name": "api-key",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "environment": {
-          "description": "Environment to use",
-          "name": "environment",
-          "required": false,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "options": [
-            "sandbox",
-            "live",
-            "staging_sandbox",
-            "staging_live"
-          ],
-          "type": "option"
-        },
-        "interactive": {
-          "char": "i",
-          "description": "Interactive mode",
-          "name": "interactive",
-          "allowNo": false,
-          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:init",
+      "id": "delegation:list-payment-methods",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1074,33 +1045,16 @@
       "relativePath": [
         "dist",
         "commands",
-        "config",
-        "init.js"
+        "delegation",
+        "list-payment-methods.js"
       ]
     },
-    "config:set": {
+    "facilitator:settle-permissions": {
       "aliases": [],
-      "args": {
-        "key": {
-          "description": "Configuration key (nvmApiKey, environment)",
-          "name": "key",
-          "options": [
-            "nvmApiKey",
-            "environment"
-          ],
-          "required": true
-        },
-        "value": {
-          "description": "Configuration value",
-          "name": "value",
-          "required": true
-        }
-      },
-      "description": "Set a configuration value",
+      "args": {},
+      "description": "Settle (burn) credits from a subscriber's payment plan. This method executes the actual credit consumption, burning the specified number of credits from the subscriber's balance. If the subscriber doesn't have enough credits, it will attempt to order more before settling. The planId and subscriberAddress are extracted from the x402AccessToken.",
       "examples": [
-        "<%= config.bin %> <%= command.id %> nvmApiKey sandbox:eyJxxxxaaaabbbbbbbb",
-        "<%= config.bin %> <%= command.id %> environment sandbox",
-        "<%= config.bin %> <%= command.id %> nvmApiKey nvm-yyy --profile production"
+        "$ nevermined facilitator settle-permissions"
       ],
       "flags": {
         "profile": {
@@ -1132,11 +1086,19 @@
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
+        },
+        "params": {
+          "description": "params as JSON string",
+          "name": "params",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:set",
+      "id": "facilitator:settle-permissions",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1146,18 +1108,16 @@
       "relativePath": [
         "dist",
         "commands",
-        "config",
-        "set.js"
+        "facilitator",
+        "settle-permissions.js"
       ]
     },
-    "config:show": {
+    "facilitator:verify-permissions": {
       "aliases": [],
       "args": {},
-      "description": "Display current configuration",
+      "description": "Verify if a subscriber has permission to use credits from a payment plan. This method simulates the credit usage without actually burning credits, checking if the subscriber has sufficient balance and permissions. The planId and subscriberAddress are extracted from the x402AccessToken.",
       "examples": [
-        "<%= config.bin %> <%= command.id %>",
-        "<%= config.bin %> <%= command.id %> --profile production",
-        "<%= config.bin %> <%= command.id %> --all"
+        "$ nevermined facilitator verify-permissions"
       ],
       "flags": {
         "profile": {
@@ -1190,17 +1150,18 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "all": {
-          "char": "a",
-          "description": "Show all profiles",
-          "name": "all",
-          "allowNo": false,
-          "type": "boolean"
+        "params": {
+          "description": "params as JSON string",
+          "name": "params",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "config:show",
+      "id": "facilitator:verify-permissions",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1210,17 +1171,17 @@
       "relativePath": [
         "dist",
         "commands",
-        "config",
-        "show.js"
+        "facilitator",
+        "verify-permissions.js"
       ]
     },
-    "delegation:list-payment-methods": {
+    "config:init": {
       "aliases": [],
       "args": {},
-      "description": "List enrolled credit/debit cards available for card-delegation (fiat) payments.",
+      "description": "Initialize CLI configuration",
       "examples": [
-        "$ nevermined delegation list-payment-methods",
-        "$ nevermined delegation list-payment-methods --format json"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile production"
       ],
       "flags": {
         "profile": {
@@ -1252,11 +1213,40 @@
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
+        },
+        "api-key": {
+          "description": "Nevermined API key",
+          "name": "api-key",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "environment": {
+          "description": "Environment to use",
+          "name": "environment",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "sandbox",
+            "live",
+            "staging_sandbox",
+            "staging_live"
+          ],
+          "type": "option"
+        },
+        "interactive": {
+          "char": "i",
+          "description": "Interactive mode",
+          "name": "interactive",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "delegation:list-payment-methods",
+      "id": "config:init",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1266,16 +1256,33 @@
       "relativePath": [
         "dist",
         "commands",
-        "delegation",
-        "list-payment-methods.js"
+        "config",
+        "init.js"
       ]
     },
-    "facilitator:settle-permissions": {
+    "config:set": {
       "aliases": [],
-      "args": {},
-      "description": "Settle (burn) credits from a subscriber's payment plan. This method executes the actual credit consumption, burning the specified number of credits from the subscriber's balance. If the subscriber doesn't have enough credits, it will attempt to order more before settling. The planId and subscriberAddress are extracted from the x402AccessToken.",
+      "args": {
+        "key": {
+          "description": "Configuration key (nvmApiKey, environment)",
+          "name": "key",
+          "options": [
+            "nvmApiKey",
+            "environment"
+          ],
+          "required": true
+        },
+        "value": {
+          "description": "Configuration value",
+          "name": "value",
+          "required": true
+        }
+      },
+      "description": "Set a configuration value",
       "examples": [
-        "$ nevermined facilitator settle-permissions"
+        "<%= config.bin %> <%= command.id %> nvmApiKey sandbox:eyJxxxxaaaabbbbbbbb",
+        "<%= config.bin %> <%= command.id %> environment sandbox",
+        "<%= config.bin %> <%= command.id %> nvmApiKey nvm-yyy --profile production"
       ],
       "flags": {
         "profile": {
@@ -1307,19 +1314,11 @@
           "name": "verbose",
           "allowNo": false,
           "type": "boolean"
-        },
-        "params": {
-          "description": "params as JSON string",
-          "name": "params",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "facilitator:settle-permissions",
+      "id": "config:set",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1329,16 +1328,18 @@
       "relativePath": [
         "dist",
         "commands",
-        "facilitator",
-        "settle-permissions.js"
+        "config",
+        "set.js"
       ]
     },
-    "facilitator:verify-permissions": {
+    "config:show": {
       "aliases": [],
       "args": {},
-      "description": "Verify if a subscriber has permission to use credits from a payment plan. This method simulates the credit usage without actually burning credits, checking if the subscriber has sufficient balance and permissions. The planId and subscriberAddress are extracted from the x402AccessToken.",
+      "description": "Display current configuration",
       "examples": [
-        "$ nevermined facilitator verify-permissions"
+        "<%= config.bin %> <%= command.id %>",
+        "<%= config.bin %> <%= command.id %> --profile production",
+        "<%= config.bin %> <%= command.id %> --all"
       ],
       "flags": {
         "profile": {
@@ -1371,18 +1372,17 @@
           "allowNo": false,
           "type": "boolean"
         },
-        "params": {
-          "description": "params as JSON string",
-          "name": "params",
-          "required": true,
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
+        "all": {
+          "char": "a",
+          "description": "Show all profiles",
+          "name": "all",
+          "allowNo": false,
+          "type": "boolean"
         }
       },
       "hasDynamicHelp": false,
       "hiddenAliases": [],
-      "id": "facilitator:verify-permissions",
+      "id": "config:show",
       "pluginAlias": "@nevermined-io/cli",
       "pluginName": "@nevermined-io/cli",
       "pluginType": "core",
@@ -1392,8 +1392,8 @@
       "relativePath": [
         "dist",
         "commands",
-        "facilitator",
-        "verify-permissions.js"
+        "config",
+        "show.js"
       ]
     },
     "organizations:connect-stripe-account": {
@@ -1746,6 +1746,68 @@
         "get-organization-activity.js"
       ]
     },
+    "organizations:onboard-customer": {
+      "aliases": [],
+      "args": {},
+      "description": "Onboard a **white-label customer** into the organization (#2418). Provisions a Nevermined account for `email` under the caller's organization without consuming a member seat, and returns a usable, scoped NVM API key the org can use to transparently act on the customer's behalf (purchase plans / redeem credits). The customer is recorded in the org's Customers list. If the email already belongs to an account the org does NOT own, no key is issued: an email challenge is sent to the owner and the result carries `consentRequired: true`. Call again once the owner has consented to complete onboarding.",
+      "examples": [
+        "$ nevermined organizations onboard-customer"
+      ],
+      "flags": {
+        "profile": {
+          "char": "p",
+          "description": "Configuration profile to use",
+          "name": "profile",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "format": {
+          "char": "f",
+          "description": "Output format",
+          "name": "format",
+          "default": "table",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "table",
+            "json",
+            "quiet"
+          ],
+          "type": "option"
+        },
+        "verbose": {
+          "char": "v",
+          "description": "Verbose output",
+          "name": "verbose",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "email": {
+          "name": "email",
+          "required": true,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "organizations:onboard-customer",
+      "pluginAlias": "@nevermined-io/cli",
+      "pluginName": "@nevermined-io/cli",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "organizations",
+        "onboard-customer.js"
+      ]
+    },
     "x402token:get-x402-access-token": {
       "aliases": [],
       "args": {
@@ -3793,5 +3855,5 @@
       ]
     }
   },
-  "version": "1.10.0"
+  "version": "1.11.1"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nevermined-io/cli",
-  "version": "1.10.0",
+  "version": "1.11.1",
   "description": "CLI for Nevermined Payments SDK",
   "author": "Nevermined AG",
   "license": "Apache-2.0",