@hyperline/cli 0.1.0-build.1.6ef0732 → 0.1.0-build.1.6f3cd3a
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/bin/hyperline-main.js +390 -319
- package/package.json +5 -5
|
@@ -4462,7 +4462,7 @@ var require_types = __commonJS({
|
|
|
4462
4462
|
...processCreateParams(params)
|
|
4463
4463
|
});
|
|
4464
4464
|
};
|
|
4465
|
-
exports.BRAND = Symbol("zod_brand");
|
|
4465
|
+
exports.BRAND = /* @__PURE__ */ Symbol("zod_brand");
|
|
4466
4466
|
var ZodBranded = class extends ZodType2 {
|
|
4467
4467
|
_parse(input) {
|
|
4468
4468
|
const { ctx } = this._processInputParams(input);
|
|
@@ -4693,14 +4693,14 @@ var require_types = __commonJS({
|
|
|
4693
4693
|
var oboolean = () => booleanType().optional();
|
|
4694
4694
|
exports.oboolean = oboolean;
|
|
4695
4695
|
exports.coerce = {
|
|
4696
|
-
string: (arg) => ZodString2.create({ ...arg, coerce: true }),
|
|
4697
|
-
number: (arg) => ZodNumber2.create({ ...arg, coerce: true }),
|
|
4698
|
-
boolean: (arg) => ZodBoolean2.create({
|
|
4696
|
+
string: ((arg) => ZodString2.create({ ...arg, coerce: true })),
|
|
4697
|
+
number: ((arg) => ZodNumber2.create({ ...arg, coerce: true })),
|
|
4698
|
+
boolean: ((arg) => ZodBoolean2.create({
|
|
4699
4699
|
...arg,
|
|
4700
4700
|
coerce: true
|
|
4701
|
-
}),
|
|
4702
|
-
bigint: (arg) => ZodBigInt2.create({ ...arg, coerce: true }),
|
|
4703
|
-
date: (arg) => ZodDate2.create({ ...arg, coerce: true })
|
|
4701
|
+
})),
|
|
4702
|
+
bigint: ((arg) => ZodBigInt2.create({ ...arg, coerce: true })),
|
|
4703
|
+
date: ((arg) => ZodDate2.create({ ...arg, coerce: true }))
|
|
4704
4704
|
};
|
|
4705
4705
|
exports.NEVER = parseUtil_1.INVALID;
|
|
4706
4706
|
}
|
|
@@ -4710,7 +4710,7 @@ var require_types = __commonJS({
|
|
|
4710
4710
|
var require_external = __commonJS({
|
|
4711
4711
|
"../../node_modules/@hyperline/shared/node_modules/zod/lib/external.js"(exports) {
|
|
4712
4712
|
"use strict";
|
|
4713
|
-
var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
|
|
4713
|
+
var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) {
|
|
4714
4714
|
if (k2 === void 0) k2 = k;
|
|
4715
4715
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
4716
4716
|
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
@@ -4719,10 +4719,10 @@ var require_external = __commonJS({
|
|
|
4719
4719
|
} };
|
|
4720
4720
|
}
|
|
4721
4721
|
Object.defineProperty(o, k2, desc);
|
|
4722
|
-
} : function(o, m, k, k2) {
|
|
4722
|
+
}) : (function(o, m, k, k2) {
|
|
4723
4723
|
if (k2 === void 0) k2 = k;
|
|
4724
4724
|
o[k2] = m[k];
|
|
4725
|
-
});
|
|
4725
|
+
}));
|
|
4726
4726
|
var __exportStar = exports && exports.__exportStar || function(m, exports2) {
|
|
4727
4727
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports2, p)) __createBinding(exports2, m, p);
|
|
4728
4728
|
};
|
|
@@ -4740,7 +4740,7 @@ var require_external = __commonJS({
|
|
|
4740
4740
|
var require_lib = __commonJS({
|
|
4741
4741
|
"../../node_modules/@hyperline/shared/node_modules/zod/lib/index.js"(exports) {
|
|
4742
4742
|
"use strict";
|
|
4743
|
-
var __createBinding = exports && exports.__createBinding || (Object.create ? function(o, m, k, k2) {
|
|
4743
|
+
var __createBinding = exports && exports.__createBinding || (Object.create ? (function(o, m, k, k2) {
|
|
4744
4744
|
if (k2 === void 0) k2 = k;
|
|
4745
4745
|
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
4746
4746
|
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
@@ -4749,13 +4749,13 @@ var require_lib = __commonJS({
|
|
|
4749
4749
|
} };
|
|
4750
4750
|
}
|
|
4751
4751
|
Object.defineProperty(o, k2, desc);
|
|
4752
|
-
} : function(o, m, k, k2) {
|
|
4752
|
+
}) : (function(o, m, k, k2) {
|
|
4753
4753
|
if (k2 === void 0) k2 = k;
|
|
4754
4754
|
o[k2] = m[k];
|
|
4755
|
-
});
|
|
4756
|
-
var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? function(o, v) {
|
|
4755
|
+
}));
|
|
4756
|
+
var __setModuleDefault = exports && exports.__setModuleDefault || (Object.create ? (function(o, v) {
|
|
4757
4757
|
Object.defineProperty(o, "default", { enumerable: true, value: v });
|
|
4758
|
-
} : function(o, v) {
|
|
4758
|
+
}) : function(o, v) {
|
|
4759
4759
|
o["default"] = v;
|
|
4760
4760
|
});
|
|
4761
4761
|
var __importStar = exports && exports.__importStar || function(mod2) {
|
|
@@ -5814,7 +5814,7 @@ var require_decimal = __commonJS({
|
|
|
5814
5814
|
Ctor.precision -= k;
|
|
5815
5815
|
return x;
|
|
5816
5816
|
}
|
|
5817
|
-
var divide2 = /* @__PURE__ */ function() {
|
|
5817
|
+
var divide2 = /* @__PURE__ */ (function() {
|
|
5818
5818
|
function multiplyInteger(x, k, base) {
|
|
5819
5819
|
var temp, carry = 0, i = x.length;
|
|
5820
5820
|
for (x = x.slice(); i--; ) {
|
|
@@ -5972,7 +5972,7 @@ var require_decimal = __commonJS({
|
|
|
5972
5972
|
}
|
|
5973
5973
|
return q;
|
|
5974
5974
|
};
|
|
5975
|
-
}();
|
|
5975
|
+
})();
|
|
5976
5976
|
function finalise2(x, sd, rm, isTruncated) {
|
|
5977
5977
|
var digits, i, j, k, rd, roundUp, w, xd, xdi, Ctor = x.constructor;
|
|
5978
5978
|
out: if (sd != null) {
|
|
@@ -6974,7 +6974,7 @@ var require_constants = __commonJS({
|
|
|
6974
6974
|
var secondsInYear = exports.secondsInYear = secondsInDay * daysInYear;
|
|
6975
6975
|
var secondsInMonth = exports.secondsInMonth = secondsInYear / 12;
|
|
6976
6976
|
var secondsInQuarter = exports.secondsInQuarter = secondsInMonth * 3;
|
|
6977
|
-
var constructFromSymbol = exports.constructFromSymbol = Symbol.for("constructDateFrom");
|
|
6977
|
+
var constructFromSymbol = exports.constructFromSymbol = /* @__PURE__ */ Symbol.for("constructDateFrom");
|
|
6978
6978
|
}
|
|
6979
6979
|
});
|
|
6980
6980
|
|
|
@@ -20370,17 +20370,17 @@ var require_shared = __commonJS({
|
|
|
20370
20370
|
var require_react_production_min = __commonJS2({
|
|
20371
20371
|
"../../node_modules/.pnpm/react@18.3.1/node_modules/react/cjs/react.production.min.js"(exports2) {
|
|
20372
20372
|
"use strict";
|
|
20373
|
-
var l = Symbol.for("react.element");
|
|
20374
|
-
var n = Symbol.for("react.portal");
|
|
20375
|
-
var p = Symbol.for("react.fragment");
|
|
20376
|
-
var q = Symbol.for("react.strict_mode");
|
|
20377
|
-
var r = Symbol.for("react.profiler");
|
|
20378
|
-
var t = Symbol.for("react.provider");
|
|
20379
|
-
var u = Symbol.for("react.context");
|
|
20380
|
-
var v = Symbol.for("react.forward_ref");
|
|
20381
|
-
var w = Symbol.for("react.suspense");
|
|
20382
|
-
var x = Symbol.for("react.memo");
|
|
20383
|
-
var y = Symbol.for("react.lazy");
|
|
20373
|
+
var l = /* @__PURE__ */ Symbol.for("react.element");
|
|
20374
|
+
var n = /* @__PURE__ */ Symbol.for("react.portal");
|
|
20375
|
+
var p = /* @__PURE__ */ Symbol.for("react.fragment");
|
|
20376
|
+
var q = /* @__PURE__ */ Symbol.for("react.strict_mode");
|
|
20377
|
+
var r = /* @__PURE__ */ Symbol.for("react.profiler");
|
|
20378
|
+
var t = /* @__PURE__ */ Symbol.for("react.provider");
|
|
20379
|
+
var u = /* @__PURE__ */ Symbol.for("react.context");
|
|
20380
|
+
var v = /* @__PURE__ */ Symbol.for("react.forward_ref");
|
|
20381
|
+
var w = /* @__PURE__ */ Symbol.for("react.suspense");
|
|
20382
|
+
var x = /* @__PURE__ */ Symbol.for("react.memo");
|
|
20383
|
+
var y = /* @__PURE__ */ Symbol.for("react.lazy");
|
|
20384
20384
|
var z11 = Symbol.iterator;
|
|
20385
20385
|
function A(a) {
|
|
20386
20386
|
if (null === a || "object" !== typeof a) return null;
|
|
@@ -20648,19 +20648,19 @@ var require_shared = __commonJS({
|
|
|
20648
20648
|
__REACT_DEVTOOLS_GLOBAL_HOOK__.registerInternalModuleStart(new Error());
|
|
20649
20649
|
}
|
|
20650
20650
|
var ReactVersion = "18.3.1";
|
|
20651
|
-
var REACT_ELEMENT_TYPE = Symbol.for("react.element");
|
|
20652
|
-
var REACT_PORTAL_TYPE = Symbol.for("react.portal");
|
|
20653
|
-
var REACT_FRAGMENT_TYPE = Symbol.for("react.fragment");
|
|
20654
|
-
var REACT_STRICT_MODE_TYPE = Symbol.for("react.strict_mode");
|
|
20655
|
-
var REACT_PROFILER_TYPE = Symbol.for("react.profiler");
|
|
20656
|
-
var REACT_PROVIDER_TYPE = Symbol.for("react.provider");
|
|
20657
|
-
var REACT_CONTEXT_TYPE = Symbol.for("react.context");
|
|
20658
|
-
var REACT_FORWARD_REF_TYPE = Symbol.for("react.forward_ref");
|
|
20659
|
-
var REACT_SUSPENSE_TYPE = Symbol.for("react.suspense");
|
|
20660
|
-
var REACT_SUSPENSE_LIST_TYPE = Symbol.for("react.suspense_list");
|
|
20661
|
-
var REACT_MEMO_TYPE = Symbol.for("react.memo");
|
|
20662
|
-
var REACT_LAZY_TYPE = Symbol.for("react.lazy");
|
|
20663
|
-
var REACT_OFFSCREEN_TYPE = Symbol.for("react.offscreen");
|
|
20651
|
+
var REACT_ELEMENT_TYPE = /* @__PURE__ */ Symbol.for("react.element");
|
|
20652
|
+
var REACT_PORTAL_TYPE = /* @__PURE__ */ Symbol.for("react.portal");
|
|
20653
|
+
var REACT_FRAGMENT_TYPE = /* @__PURE__ */ Symbol.for("react.fragment");
|
|
20654
|
+
var REACT_STRICT_MODE_TYPE = /* @__PURE__ */ Symbol.for("react.strict_mode");
|
|
20655
|
+
var REACT_PROFILER_TYPE = /* @__PURE__ */ Symbol.for("react.profiler");
|
|
20656
|
+
var REACT_PROVIDER_TYPE = /* @__PURE__ */ Symbol.for("react.provider");
|
|
20657
|
+
var REACT_CONTEXT_TYPE = /* @__PURE__ */ Symbol.for("react.context");
|
|
20658
|
+
var REACT_FORWARD_REF_TYPE = /* @__PURE__ */ Symbol.for("react.forward_ref");
|
|
20659
|
+
var REACT_SUSPENSE_TYPE = /* @__PURE__ */ Symbol.for("react.suspense");
|
|
20660
|
+
var REACT_SUSPENSE_LIST_TYPE = /* @__PURE__ */ Symbol.for("react.suspense_list");
|
|
20661
|
+
var REACT_MEMO_TYPE = /* @__PURE__ */ Symbol.for("react.memo");
|
|
20662
|
+
var REACT_LAZY_TYPE = /* @__PURE__ */ Symbol.for("react.lazy");
|
|
20663
|
+
var REACT_OFFSCREEN_TYPE = /* @__PURE__ */ Symbol.for("react.offscreen");
|
|
20664
20664
|
var MAYBE_ITERATOR_SYMBOL = Symbol.iterator;
|
|
20665
20665
|
var FAUX_ITERATOR_SYMBOL = "@@iterator";
|
|
20666
20666
|
function getIteratorFn(maybeIterable) {
|
|
@@ -21624,7 +21624,7 @@ var require_shared = __commonJS({
|
|
|
21624
21624
|
}
|
|
21625
21625
|
var REACT_MODULE_REFERENCE;
|
|
21626
21626
|
{
|
|
21627
|
-
REACT_MODULE_REFERENCE = Symbol.for("react.module.reference");
|
|
21627
|
+
REACT_MODULE_REFERENCE = /* @__PURE__ */ Symbol.for("react.module.reference");
|
|
21628
21628
|
}
|
|
21629
21629
|
function isValidElementType(type) {
|
|
21630
21630
|
if (typeof type === "string" || typeof type === "function") {
|
|
@@ -23710,10 +23710,10 @@ var require_shared = __commonJS({
|
|
|
23710
23710
|
ZodId: () => ZodId,
|
|
23711
23711
|
ZodTranslationsSchemaFn: () => ZodTranslationsSchemaFn
|
|
23712
23712
|
});
|
|
23713
|
-
var
|
|
23713
|
+
var import_zod17 = require_lib();
|
|
23714
23714
|
var countryIds2 = ["all", ...countries.map(({ id }) => id)];
|
|
23715
|
-
var ZodId =
|
|
23716
|
-
var ZodTranslationsSchemaFn = (schema) =>
|
|
23715
|
+
var ZodId = import_zod17.z.enum(countryIds2);
|
|
23716
|
+
var ZodTranslationsSchemaFn = (schema) => import_zod17.z.record(import_zod17.z.string(), schema.optional());
|
|
23717
23717
|
var UsStates = [
|
|
23718
23718
|
{ id: "AA", name: "Armed Forces Americas" },
|
|
23719
23719
|
{ id: "AE", name: "Armed Forces Europe" },
|
|
@@ -26526,10 +26526,12 @@ Examples:
|
|
|
26526
26526
|
baseUrlOverride: resolveIngestBaseUrl(ctx.baseUrl)
|
|
26527
26527
|
});
|
|
26528
26528
|
});
|
|
26529
|
-
resource.command("delete").description(`Delete billable events by record IDs, customer ID, or all events.`).option("--matching <value>", `Matching strategy: record_ids, customer_id, or all`).option("--record-ids <value>", `Comma-separated list of record IDs (when matching=record_ids)`).option("--customer-id <value>", `Customer ID (when matching=customer_id)`).addHelpText("after", `
|
|
26529
|
+
resource.command("delete").description(`Delete billable events by record IDs, customer ID, event type, or all events.`).option("--matching <value>", `Matching strategy: record_ids, customer_id, event_type, or all`).option("--record-ids <value>", `Comma-separated list of record IDs (when matching=record_ids)`).option("--customer-id <value>", `Customer ID (when matching=customer_id)`).option("--event-type <value>", `Event type. Required when matching=event_type, optional narrowing when matching=customer_id`).addHelpText("after", `
|
|
26530
26530
|
Examples:
|
|
26531
26531
|
hyperline events delete --matching record_ids --record-ids evt_1,evt_2
|
|
26532
26532
|
hyperline events delete --matching customer_id --customer-id cus_xyz
|
|
26533
|
+
hyperline events delete --matching customer_id --customer-id cus_xyz --event-type api_call
|
|
26534
|
+
hyperline events delete --matching event_type --event-type api_call
|
|
26533
26535
|
hyperline events delete --matching all`).action(async (opts) => {
|
|
26534
26536
|
const ctx = resource.parent?.opts()._ctx;
|
|
26535
26537
|
if (!ctx) {
|
|
@@ -26537,8 +26539,12 @@ Examples:
|
|
|
26537
26539
|
process.exit(1);
|
|
26538
26540
|
}
|
|
26539
26541
|
const matching = opts.matching;
|
|
26540
|
-
if (!matching || !["record_ids", "customer_id", "all"].includes(matching)) {
|
|
26541
|
-
process.stderr.write("Error: --matching must be one of: record_ids, customer_id, all\n");
|
|
26542
|
+
if (!matching || !["record_ids", "customer_id", "event_type", "all"].includes(matching)) {
|
|
26543
|
+
process.stderr.write("Error: --matching must be one of: record_ids, customer_id, event_type, all\n");
|
|
26544
|
+
process.exit(1);
|
|
26545
|
+
}
|
|
26546
|
+
if (opts.eventType && matching !== "customer_id" && matching !== "event_type") {
|
|
26547
|
+
process.stderr.write("Error: --event-type only applies when --matching is customer_id or event_type\n");
|
|
26542
26548
|
process.exit(1);
|
|
26543
26549
|
}
|
|
26544
26550
|
let body;
|
|
@@ -26556,7 +26562,22 @@ Examples:
|
|
|
26556
26562
|
process.stderr.write("Error: --customer-id is required when matching=customer_id\n");
|
|
26557
26563
|
process.exit(1);
|
|
26558
26564
|
}
|
|
26559
|
-
body = {
|
|
26565
|
+
body = {
|
|
26566
|
+
matching: "customer_id",
|
|
26567
|
+
customer_id: opts.customerId,
|
|
26568
|
+
...opts.eventType ? { event_type: opts.eventType } : {}
|
|
26569
|
+
};
|
|
26570
|
+
} else if (matching === "event_type") {
|
|
26571
|
+
if (!opts.eventType) {
|
|
26572
|
+
process.stderr.write("Error: --event-type is required when matching=event_type\n");
|
|
26573
|
+
process.exit(1);
|
|
26574
|
+
}
|
|
26575
|
+
const confirmed = await confirmPrompt(`Are you sure you want to delete ALL events of type "${opts.eventType}" across every customer? (y/N) `);
|
|
26576
|
+
if (!confirmed) {
|
|
26577
|
+
process.stdout.write("Aborted.\n");
|
|
26578
|
+
return;
|
|
26579
|
+
}
|
|
26580
|
+
body = { matching: "event_type", event_type: opts.eventType };
|
|
26560
26581
|
} else {
|
|
26561
26582
|
const confirmed = await confirmPrompt("Are you sure you want to delete ALL events? (y/N) ");
|
|
26562
26583
|
if (!confirmed) {
|
|
@@ -28401,6 +28422,27 @@ Examples:
|
|
|
28401
28422
|
queryParamKeys: []
|
|
28402
28423
|
});
|
|
28403
28424
|
});
|
|
28425
|
+
resource.command("list").description(`List the client's data exports (customers, invoices, etc.) with pagination. Use take/skip to page through results.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
28426
|
+
Examples:
|
|
28427
|
+
hyperline exports list
|
|
28428
|
+
hyperline exports list --take <take>`).action(async (opts) => {
|
|
28429
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
28430
|
+
if (!ctx) {
|
|
28431
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
28432
|
+
process.exit(1);
|
|
28433
|
+
}
|
|
28434
|
+
const args = {};
|
|
28435
|
+
if (opts.take !== void 0)
|
|
28436
|
+
args.take = Number(opts.take);
|
|
28437
|
+
if (opts.skip !== void 0)
|
|
28438
|
+
args.skip = Number(opts.skip);
|
|
28439
|
+
await ctx.execute({
|
|
28440
|
+
method: "GET",
|
|
28441
|
+
path: "/v1/exports",
|
|
28442
|
+
args,
|
|
28443
|
+
queryParamKeys: ["take", "skip"]
|
|
28444
|
+
});
|
|
28445
|
+
});
|
|
28404
28446
|
resource.command("get").description(`Check the status of an export by ID. Status can be pending, processing, or completed. Use download_export to get the file once completed.`).requiredOption("--export-id <value>", `exportId parameter`).addHelpText("after", `
|
|
28405
28447
|
Examples:
|
|
28406
28448
|
hyperline exports get --export-id <exportId>`).action(async (opts) => {
|
|
@@ -28419,9 +28461,10 @@ Examples:
|
|
|
28419
28461
|
queryParamKeys: []
|
|
28420
28462
|
});
|
|
28421
28463
|
});
|
|
28422
|
-
resource.command("download").description(`Download the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.`).requiredOption("--export-id <value>", `exportId parameter`).addHelpText("after", `
|
|
28464
|
+
resource.command("download").description(`Download the file for a completed export. Supports CSV, JSON, and XLSX formats depending on the export type.`).requiredOption("--export-id <value>", `exportId parameter`).option("--as-redirect <value>", `as_redirect`).addHelpText("after", `
|
|
28423
28465
|
Examples:
|
|
28424
|
-
hyperline exports download --export-id <exportId
|
|
28466
|
+
hyperline exports download --export-id <exportId>
|
|
28467
|
+
hyperline exports download --export-id <exportId> --as-redirect <as_redirect>`).action(async (opts) => {
|
|
28425
28468
|
const ctx = resource.parent?.opts()._ctx;
|
|
28426
28469
|
if (!ctx) {
|
|
28427
28470
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -28430,11 +28473,13 @@ Examples:
|
|
|
28430
28473
|
const args = {};
|
|
28431
28474
|
if (opts.exportId !== void 0)
|
|
28432
28475
|
args.exportId = opts.exportId;
|
|
28476
|
+
if (opts.asRedirect !== void 0)
|
|
28477
|
+
args.as_redirect = opts.asRedirect;
|
|
28433
28478
|
await ctx.execute({
|
|
28434
28479
|
method: "GET",
|
|
28435
28480
|
path: "/v1/exports/{exportId}/download",
|
|
28436
28481
|
args,
|
|
28437
|
-
queryParamKeys: []
|
|
28482
|
+
queryParamKeys: ["as_redirect"]
|
|
28438
28483
|
});
|
|
28439
28484
|
});
|
|
28440
28485
|
}
|
|
@@ -29961,7 +30006,7 @@ Examples:
|
|
|
29961
30006
|
]
|
|
29962
30007
|
});
|
|
29963
30008
|
});
|
|
29964
|
-
resource.command("create").description(`Create a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.`).requiredOption("--name <value>", `Product name.`).option("--description <value>", `Product description.`).option("--description-display-interval-dates", `Indicates if the dates of the interval should be automatically added in the product description on the invoices.`).option("--public-description <value>", `Public description of the product.`).option("--translations <value>", `Product name and description translations.`).option("--is-available-on-demand", `is_available_on_demand`).option("--is-available-on-subscription", `is_available_on_subscription`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--accounting <value>", `Mapping invoicing entity ID/accounting settings.`).requiredOption("--type <value>", `Product type for fixed fee products.`).requiredOption("--price-configurations <value>", `Price configurations for the product.`).option("--aggregator <value>", `Aggregator configuration to automatically count seats from billable events. Only count aggregators are supported for seat products.`).option("--aggregator-id <value>", `ID of an existing aggregator to link to this product.`).option("--unit-name <value>", `Name of the unit (e.g., 'user', 'seat').`).option("--is-connected-seat-item", `When true, the seat count is automatically synced from an external source (e.g., CRM users).`).option("--credit-aggregators <value>", `Multiple aggregators with weights for multi-aggregator credit consumption. Cannot be used together with aggregator or aggregator_id.`).option("--low-credits-threshold <number>", `Threshold indicating a low level of credits.`).addHelpText("after", `
|
|
30009
|
+
resource.command("create").description(`Create a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.`).requiredOption("--name <value>", `Product name.`).option("--description <value>", `Product description.`).option("--description-display-interval-dates", `Indicates if the dates of the interval should be automatically added in the product description on the invoices.`).option("--public-description <value>", `Public description of the product.`).option("--translations <value>", `Product name and description translations.`).option("--is-available-on-demand", `is_available_on_demand`).option("--is-available-on-subscription", `is_available_on_subscription`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--accounting <value>", `Mapping invoicing entity ID/accounting settings.`).requiredOption("--type <value>", `Product type for fixed fee products.`).requiredOption("--price-configurations <value>", `Price configurations for the product.`).option("--aggregator <value>", `Aggregator configuration to automatically count seats from billable events. Only count aggregators are supported for seat products.`).option("--aggregator-id <value>", `ID of an existing aggregator to link to this product.`).option("--unit-name <value>", `Name of the unit (e.g., 'user', 'seat').`).option("--is-connected-seat-item", `When true, the seat count is automatically synced from an external source (e.g., CRM users).`).option("--credit-aggregators <value>", `Multiple aggregators with weights for multi-aggregator credit consumption. Cannot be used together with aggregator or aggregator_id.`).option("--low-credits-threshold <number>", `Threshold indicating a low level of credits.`).option("--display-mode <value>", `How bundle items are displayed on invoices.`).option("--exclusive-items-enabled", `When true, only one item in the bundle can be active at a time.`).option("--bundle-items <value>", `Products included in this bundle. Percentages must sum to 100.`).addHelpText("after", `
|
|
29965
30010
|
Examples:
|
|
29966
30011
|
hyperline products create --name <name> --type <type> --price-configurations <price_configurations>
|
|
29967
30012
|
hyperline products create --name <name> --type <type> --price-configurations <price_configurations> --description <description> --description-display-interval-dates
|
|
@@ -29996,6 +30041,10 @@ Examples:
|
|
|
29996
30041
|
args.unit_name = opts.unitName;
|
|
29997
30042
|
if (opts.creditAggregators !== void 0)
|
|
29998
30043
|
args.credit_aggregators = opts.creditAggregators;
|
|
30044
|
+
if (opts.displayMode !== void 0)
|
|
30045
|
+
args.display_mode = opts.displayMode;
|
|
30046
|
+
if (opts.bundleItems !== void 0)
|
|
30047
|
+
args.bundle_items = opts.bundleItems;
|
|
29999
30048
|
if (opts.lowCreditsThreshold !== void 0)
|
|
30000
30049
|
args.low_credits_threshold = Number(opts.lowCreditsThreshold);
|
|
30001
30050
|
if (opts.descriptionDisplayIntervalDates !== void 0)
|
|
@@ -30006,6 +30055,8 @@ Examples:
|
|
|
30006
30055
|
args.is_available_on_subscription = true;
|
|
30007
30056
|
if (opts.isConnectedSeatItem !== void 0)
|
|
30008
30057
|
args.is_connected_seat_item = true;
|
|
30058
|
+
if (opts.exclusiveItemsEnabled !== void 0)
|
|
30059
|
+
args.exclusive_items_enabled = true;
|
|
30009
30060
|
await ctx.execute({
|
|
30010
30061
|
method: "POST",
|
|
30011
30062
|
path: "/v1/products",
|
|
@@ -30121,7 +30172,7 @@ Quote status.
|
|
|
30121
30172
|
- \`draft\`: The quote is a draft.
|
|
30122
30173
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
30123
30174
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
30124
|
-
`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the quote.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. If not specified, automatically computed from the subscription configuration.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <value>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
30175
|
+
`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the quote.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. If not specified, automatically computed from the subscription configuration.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <value>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
30125
30176
|
|
|
30126
30177
|
- \`all\`: Display all pricing tiers.
|
|
30127
30178
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
@@ -30157,6 +30208,8 @@ Examples:
|
|
|
30157
30208
|
args.require_tax_id = opts.requireTaxId;
|
|
30158
30209
|
if (opts.displayQuoteValue !== void 0)
|
|
30159
30210
|
args.display_quote_value = opts.displayQuoteValue;
|
|
30211
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
30212
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
30160
30213
|
if (opts.displayTaxes !== void 0)
|
|
30161
30214
|
args.display_taxes = opts.displayTaxes;
|
|
30162
30215
|
if (opts.displayPriceTiers !== void 0)
|
|
@@ -30570,10 +30623,10 @@ Examples:
|
|
|
30570
30623
|
queryParamKeys: []
|
|
30571
30624
|
});
|
|
30572
30625
|
});
|
|
30573
|
-
resource.command("create-subscription-update").description(`Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--type <value>", `type`).requiredOption("--payload <value>", `payload`).addHelpText("after", `
|
|
30626
|
+
resource.command("create-subscription-update").description(`Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--type <value>", `type`).requiredOption("--payload <value>", `payload`).addHelpText("after", `
|
|
30574
30627
|
Examples:
|
|
30575
30628
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload>
|
|
30576
|
-
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload> --apply-at <apply_at>
|
|
30629
|
+
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload> --apply-at <apply_at> --charge-at <charge_at>
|
|
30577
30630
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload> --output json`).action(async (opts) => {
|
|
30578
30631
|
const ctx = resource.parent?.opts()._ctx;
|
|
30579
30632
|
if (!ctx) {
|
|
@@ -30589,6 +30642,8 @@ Examples:
|
|
|
30589
30642
|
args.apply_at = opts.applyAt;
|
|
30590
30643
|
if (opts.paymentSchedule !== void 0)
|
|
30591
30644
|
args.payment_schedule = opts.paymentSchedule;
|
|
30645
|
+
if (opts.chargeAt !== void 0)
|
|
30646
|
+
args.charge_at = opts.chargeAt;
|
|
30592
30647
|
if (opts.calculationMethod !== void 0)
|
|
30593
30648
|
args.calculation_method = opts.calculationMethod;
|
|
30594
30649
|
if (opts.type !== void 0)
|
|
@@ -30602,10 +30657,10 @@ Examples:
|
|
|
30602
30657
|
queryParamKeys: []
|
|
30603
30658
|
});
|
|
30604
30659
|
});
|
|
30605
|
-
resource.command("create-subscription-updates").description(`Apply multiple updates at once to an existing subscription in a single atomic operation.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
30660
|
+
resource.command("create-subscription-updates").description(`Apply multiple updates at once to an existing subscription in a single atomic operation.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
30606
30661
|
Examples:
|
|
30607
30662
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
30608
|
-
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at>
|
|
30663
|
+
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at> --charge-at <charge_at>
|
|
30609
30664
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --output json`).action(async (opts) => {
|
|
30610
30665
|
const ctx = resource.parent?.opts()._ctx;
|
|
30611
30666
|
if (!ctx) {
|
|
@@ -30621,6 +30676,8 @@ Examples:
|
|
|
30621
30676
|
args.apply_at = opts.applyAt;
|
|
30622
30677
|
if (opts.paymentSchedule !== void 0)
|
|
30623
30678
|
args.payment_schedule = opts.paymentSchedule;
|
|
30679
|
+
if (opts.chargeAt !== void 0)
|
|
30680
|
+
args.charge_at = opts.chargeAt;
|
|
30624
30681
|
if (opts.calculationMethod !== void 0)
|
|
30625
30682
|
args.calculation_method = opts.calculationMethod;
|
|
30626
30683
|
if (opts.updates !== void 0)
|
|
@@ -30758,10 +30815,10 @@ Examples:
|
|
|
30758
30815
|
queryParamKeys: []
|
|
30759
30816
|
});
|
|
30760
30817
|
});
|
|
30761
|
-
resource.command("simulate-subscription-updates").description(`Preview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
30818
|
+
resource.command("simulate-subscription-updates").description(`Preview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
30762
30819
|
Examples:
|
|
30763
30820
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
30764
|
-
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at>
|
|
30821
|
+
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at> --charge-at <charge_at>
|
|
30765
30822
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --output json`).action(async (opts) => {
|
|
30766
30823
|
const ctx = resource.parent?.opts()._ctx;
|
|
30767
30824
|
if (!ctx) {
|
|
@@ -30777,6 +30834,8 @@ Examples:
|
|
|
30777
30834
|
args.apply_at = opts.applyAt;
|
|
30778
30835
|
if (opts.paymentSchedule !== void 0)
|
|
30779
30836
|
args.payment_schedule = opts.paymentSchedule;
|
|
30837
|
+
if (opts.chargeAt !== void 0)
|
|
30838
|
+
args.charge_at = opts.chargeAt;
|
|
30780
30839
|
if (opts.calculationMethod !== void 0)
|
|
30781
30840
|
args.calculation_method = opts.calculationMethod;
|
|
30782
30841
|
if (opts.updates !== void 0)
|
|
@@ -31098,10 +31157,254 @@ Examples:
|
|
|
31098
31157
|
]
|
|
31099
31158
|
});
|
|
31100
31159
|
});
|
|
31160
|
+
resource.command("get").description(`Retrieve full details of a subscription by ID including phases, products, billing dates, and status. Optionally include live_billing data.`).requiredOption("--id <value>", `id parameter`).option("--include-live-billing <value>", `include_live_billing`).addHelpText("after", `
|
|
31161
|
+
Examples:
|
|
31162
|
+
hyperline subscriptions get --id <id>
|
|
31163
|
+
hyperline subscriptions get --id <id> --include-live-billing <include_live_billing>`).action(async (opts) => {
|
|
31164
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31165
|
+
if (!ctx) {
|
|
31166
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31167
|
+
process.exit(1);
|
|
31168
|
+
}
|
|
31169
|
+
const args = {};
|
|
31170
|
+
if (opts.id !== void 0)
|
|
31171
|
+
args.id = opts.id;
|
|
31172
|
+
if (opts.includeLiveBilling !== void 0)
|
|
31173
|
+
args.include_live_billing = opts.includeLiveBilling;
|
|
31174
|
+
await ctx.execute({
|
|
31175
|
+
method: "GET",
|
|
31176
|
+
path: "/v2/subscriptions/{id}",
|
|
31177
|
+
args,
|
|
31178
|
+
queryParamKeys: ["include_live_billing"]
|
|
31179
|
+
});
|
|
31180
|
+
});
|
|
31181
|
+
resource.command("refresh-subscription-seat-products").description(`Trigger a count update on seat-based products within a subscription using the configured dataloader query.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31182
|
+
Examples:
|
|
31183
|
+
hyperline subscriptions refresh-subscription-seat-products --id <id>
|
|
31184
|
+
hyperline subscriptions refresh-subscription-seat-products --id <id> --output json`).action(async (opts) => {
|
|
31185
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31186
|
+
if (!ctx) {
|
|
31187
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31188
|
+
process.exit(1);
|
|
31189
|
+
}
|
|
31190
|
+
const args = {};
|
|
31191
|
+
if (opts.id !== void 0)
|
|
31192
|
+
args.id = opts.id;
|
|
31193
|
+
await ctx.execute({
|
|
31194
|
+
method: "POST",
|
|
31195
|
+
path: "/v2/subscriptions/{id}/refresh-seat-products",
|
|
31196
|
+
args,
|
|
31197
|
+
queryParamKeys: []
|
|
31198
|
+
});
|
|
31199
|
+
});
|
|
31200
|
+
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Payload mirrors GET response structure.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Subscription custom name.`).option("--purchase-order <value>", `Reference to the purchase order.`).option("--minimum-invoice-fee <number>", `Minimum fee applied to each invoice outside of one time payments.`).option("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).option("--tax-only <value>", `Only tax will be charged on this subscription.`).option("--generate-draft-invoices <value>", `Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent`).option("--generate-document <value>", `Generate non-legal documents instead of invoices.`).option("--document-name <value>", `If \`generate_document\` is turned on, allows you to give a name to your document.`).option("--add-tax-to-document <value>", `If \`generate_document\` is turned on, will add taxes to document.`).option("--do-not-charge-subscription <value>", `Subscription will be invoiced but not charged (invoices/documents will be settled directly).`).option("--invoice-custom-note <value>", `Default custom note added to invoices generated by the subscription.`).option("--invoice-schedule <value>", `
|
|
31201
|
+
Defines when invoices are generated relative to the billing period.
|
|
31202
|
+
|
|
31203
|
+
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
31204
|
+
- \`period_end\`: Invoices are generated at the end of the billing period.
|
|
31205
|
+
`).option("--estimated-arr <number>", `Estimated Annual Recurring Revenue generated by the subscription.`).option("--contract-value <number>", `Contract value of the subscription. This value is overridable by the user.`).option("--starts-at <value>", `Applies only if the activation strategy is \`start_date\`. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--initial-billing-at <value>", `Date when the subscription will start being billed. If not specified, it will correspond to the \`starts_at\` date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--cancel-at <value>", `Subscription cancel date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--display-shipping-details <value>", `Indicates if the shipping details should be displayed on the subscription's invoices.`).option("--phases <value>", `Array of subscription phases. Existing pending phases will be replaced by the ones in the array.`).option("--contract-terms <value>", `Contract terms to update.`).addHelpText("after", `
|
|
31206
|
+
Examples:
|
|
31207
|
+
hyperline subscriptions update --id <id>
|
|
31208
|
+
hyperline subscriptions update --id <id> --name <name> --purchase-order <purchase_order>
|
|
31209
|
+
hyperline subscriptions update --id <id> --output json`).action(async (opts) => {
|
|
31210
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31211
|
+
if (!ctx) {
|
|
31212
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31213
|
+
process.exit(1);
|
|
31214
|
+
}
|
|
31215
|
+
const args = {};
|
|
31216
|
+
if (opts.id !== void 0)
|
|
31217
|
+
args.id = opts.id;
|
|
31218
|
+
if (opts.name !== void 0)
|
|
31219
|
+
args.name = opts.name;
|
|
31220
|
+
if (opts.purchaseOrder !== void 0)
|
|
31221
|
+
args.purchase_order = opts.purchaseOrder;
|
|
31222
|
+
if (opts.crmOpportunityId !== void 0)
|
|
31223
|
+
args.crm_opportunity_id = opts.crmOpportunityId;
|
|
31224
|
+
if (opts.taxOnly !== void 0)
|
|
31225
|
+
args.tax_only = opts.taxOnly;
|
|
31226
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
31227
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
31228
|
+
if (opts.generateDocument !== void 0)
|
|
31229
|
+
args.generate_document = opts.generateDocument;
|
|
31230
|
+
if (opts.documentName !== void 0)
|
|
31231
|
+
args.document_name = opts.documentName;
|
|
31232
|
+
if (opts.addTaxToDocument !== void 0)
|
|
31233
|
+
args.add_tax_to_document = opts.addTaxToDocument;
|
|
31234
|
+
if (opts.doNotChargeSubscription !== void 0)
|
|
31235
|
+
args.do_not_charge_subscription = opts.doNotChargeSubscription;
|
|
31236
|
+
if (opts.invoiceCustomNote !== void 0)
|
|
31237
|
+
args.invoice_custom_note = opts.invoiceCustomNote;
|
|
31238
|
+
if (opts.invoiceSchedule !== void 0)
|
|
31239
|
+
args.invoice_schedule = opts.invoiceSchedule;
|
|
31240
|
+
if (opts.startsAt !== void 0)
|
|
31241
|
+
args.starts_at = opts.startsAt;
|
|
31242
|
+
if (opts.initialBillingAt !== void 0)
|
|
31243
|
+
args.initial_billing_at = opts.initialBillingAt;
|
|
31244
|
+
if (opts.cancelAt !== void 0)
|
|
31245
|
+
args.cancel_at = opts.cancelAt;
|
|
31246
|
+
if (opts.properties !== void 0)
|
|
31247
|
+
args.properties = opts.properties;
|
|
31248
|
+
if (opts.customProperties !== void 0)
|
|
31249
|
+
args.custom_properties = opts.customProperties;
|
|
31250
|
+
if (opts.displayShippingDetails !== void 0)
|
|
31251
|
+
args.display_shipping_details = opts.displayShippingDetails;
|
|
31252
|
+
if (opts.phases !== void 0)
|
|
31253
|
+
args.phases = opts.phases;
|
|
31254
|
+
if (opts.contractTerms !== void 0)
|
|
31255
|
+
args.contract_terms = opts.contractTerms;
|
|
31256
|
+
if (opts.minimumInvoiceFee !== void 0)
|
|
31257
|
+
args.minimum_invoice_fee = Number(opts.minimumInvoiceFee);
|
|
31258
|
+
if (opts.estimatedArr !== void 0)
|
|
31259
|
+
args.estimated_arr = Number(opts.estimatedArr);
|
|
31260
|
+
if (opts.contractValue !== void 0)
|
|
31261
|
+
args.contract_value = Number(opts.contractValue);
|
|
31262
|
+
await ctx.execute({
|
|
31263
|
+
method: "PUT",
|
|
31264
|
+
path: "/v2/subscriptions/{id}",
|
|
31265
|
+
args,
|
|
31266
|
+
queryParamKeys: []
|
|
31267
|
+
});
|
|
31268
|
+
});
|
|
31269
|
+
resource.command("get-subscription-valuation").description(`Compute valuation metrics for a subscription: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown.`).requiredOption("--id <value>", `id parameter`).option("--granularity <value>", `Period granularity for the breakdown. When provided, contract value and recurring contract value include a \`by_period\` array.`).addHelpText("after", `
|
|
31270
|
+
Examples:
|
|
31271
|
+
hyperline subscriptions get-subscription-valuation --id <id>
|
|
31272
|
+
hyperline subscriptions get-subscription-valuation --id <id> --granularity <granularity>`).action(async (opts) => {
|
|
31273
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31274
|
+
if (!ctx) {
|
|
31275
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31276
|
+
process.exit(1);
|
|
31277
|
+
}
|
|
31278
|
+
const args = {};
|
|
31279
|
+
if (opts.id !== void 0)
|
|
31280
|
+
args.id = opts.id;
|
|
31281
|
+
if (opts.granularity !== void 0)
|
|
31282
|
+
args.granularity = opts.granularity;
|
|
31283
|
+
await ctx.execute({
|
|
31284
|
+
method: "GET",
|
|
31285
|
+
path: "/v1/subscriptions/{id}/valuation",
|
|
31286
|
+
args,
|
|
31287
|
+
queryParamKeys: ["granularity"]
|
|
31288
|
+
});
|
|
31289
|
+
});
|
|
31290
|
+
}
|
|
31291
|
+
|
|
31292
|
+
// build/commands/generated/subscriptions-phases.js
|
|
31293
|
+
function registerSubscriptions_PhasesCommands(parent) {
|
|
31294
|
+
const resource = parent.command("subscriptions-phases").description("Manage subscriptions > phases");
|
|
31295
|
+
resource.command("list-subscription-phases").description(`List all phases of a subscription. Phases define time-bound product configurations within a subscription.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31296
|
+
Examples:
|
|
31297
|
+
hyperline subscriptions-phases list-subscription-phases --id <id>`).action(async (opts) => {
|
|
31298
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31299
|
+
if (!ctx) {
|
|
31300
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31301
|
+
process.exit(1);
|
|
31302
|
+
}
|
|
31303
|
+
const args = {};
|
|
31304
|
+
if (opts.id !== void 0)
|
|
31305
|
+
args.id = opts.id;
|
|
31306
|
+
await ctx.execute({
|
|
31307
|
+
method: "GET",
|
|
31308
|
+
path: "/v2/subscriptions/{id}/phases",
|
|
31309
|
+
args,
|
|
31310
|
+
queryParamKeys: []
|
|
31311
|
+
});
|
|
31312
|
+
});
|
|
31313
|
+
resource.command("get-subscription-phase").description(`Retrieve details of a specific phase within a subscription, including its products and billing configuration.`).requiredOption("--id <value>", `id parameter`).requiredOption("--phase-id <value>", `phaseId parameter`).addHelpText("after", `
|
|
31314
|
+
Examples:
|
|
31315
|
+
hyperline subscriptions-phases get-subscription-phase --id <id> --phase-id <phaseId>`).action(async (opts) => {
|
|
31316
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31317
|
+
if (!ctx) {
|
|
31318
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31319
|
+
process.exit(1);
|
|
31320
|
+
}
|
|
31321
|
+
const args = {};
|
|
31322
|
+
if (opts.id !== void 0)
|
|
31323
|
+
args.id = opts.id;
|
|
31324
|
+
if (opts.phaseId !== void 0)
|
|
31325
|
+
args.phaseId = opts.phaseId;
|
|
31326
|
+
await ctx.execute({
|
|
31327
|
+
method: "GET",
|
|
31328
|
+
path: "/v2/subscriptions/{id}/phases/{phaseId}",
|
|
31329
|
+
args,
|
|
31330
|
+
queryParamKeys: []
|
|
31331
|
+
});
|
|
31332
|
+
});
|
|
31333
|
+
resource.command("transition-subscription").description(`Transition a subscription to its next configured phase at a specified date.`).requiredOption("--id <value>", `id parameter`).option("--transition-date <value>", `Date of application of the transition. Use it if different than immediately to calculate pro-rata and display past or future dates on invoices. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).addHelpText("after", `
|
|
31334
|
+
Examples:
|
|
31335
|
+
hyperline subscriptions-phases transition-subscription --id <id>
|
|
31336
|
+
hyperline subscriptions-phases transition-subscription --id <id> --transition-date <transition_date>
|
|
31337
|
+
hyperline subscriptions-phases transition-subscription --id <id> --output json`).action(async (opts) => {
|
|
31338
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31339
|
+
if (!ctx) {
|
|
31340
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31341
|
+
process.exit(1);
|
|
31342
|
+
}
|
|
31343
|
+
const args = {};
|
|
31344
|
+
if (opts.id !== void 0)
|
|
31345
|
+
args.id = opts.id;
|
|
31346
|
+
if (opts.transitionDate !== void 0)
|
|
31347
|
+
args.transition_date = opts.transitionDate;
|
|
31348
|
+
await ctx.execute({
|
|
31349
|
+
method: "POST",
|
|
31350
|
+
path: "/v2/subscriptions/{id}/next-phase",
|
|
31351
|
+
args,
|
|
31352
|
+
queryParamKeys: []
|
|
31353
|
+
});
|
|
31354
|
+
});
|
|
31355
|
+
}
|
|
31356
|
+
|
|
31357
|
+
// build/commands/generated/subscriptions-templates.js
|
|
31358
|
+
function registerSubscriptions_TemplatesCommands(parent) {
|
|
31359
|
+
const resource = parent.command("subscriptions-templates").description("Manage subscriptions > templates");
|
|
31360
|
+
resource.command("list-subscription-templates").description(`List subscription templates with pagination. Templates define reusable subscription configurations with pre-configured products, phases, and billing settings.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
31361
|
+
Examples:
|
|
31362
|
+
hyperline subscriptions-templates list-subscription-templates
|
|
31363
|
+
hyperline subscriptions-templates list-subscription-templates --take <take>`).action(async (opts) => {
|
|
31364
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31365
|
+
if (!ctx) {
|
|
31366
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31367
|
+
process.exit(1);
|
|
31368
|
+
}
|
|
31369
|
+
const args = {};
|
|
31370
|
+
if (opts.take !== void 0)
|
|
31371
|
+
args.take = Number(opts.take);
|
|
31372
|
+
if (opts.skip !== void 0)
|
|
31373
|
+
args.skip = Number(opts.skip);
|
|
31374
|
+
await ctx.execute({
|
|
31375
|
+
method: "GET",
|
|
31376
|
+
path: "/v1/subscriptions/templates",
|
|
31377
|
+
args,
|
|
31378
|
+
queryParamKeys: ["take", "skip"]
|
|
31379
|
+
});
|
|
31380
|
+
});
|
|
31381
|
+
resource.command("get-subscription-template").description(`Retrieve a subscription template by ID with its full configuration including products, phases, and pricing details.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31382
|
+
Examples:
|
|
31383
|
+
hyperline subscriptions-templates get-subscription-template --id <id>`).action(async (opts) => {
|
|
31384
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31385
|
+
if (!ctx) {
|
|
31386
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31387
|
+
process.exit(1);
|
|
31388
|
+
}
|
|
31389
|
+
const args = {};
|
|
31390
|
+
if (opts.id !== void 0)
|
|
31391
|
+
args.id = opts.id;
|
|
31392
|
+
await ctx.execute({
|
|
31393
|
+
method: "GET",
|
|
31394
|
+
path: "/v1/subscriptions/templates/{id}",
|
|
31395
|
+
args,
|
|
31396
|
+
queryParamKeys: []
|
|
31397
|
+
});
|
|
31398
|
+
});
|
|
31399
|
+
}
|
|
31400
|
+
|
|
31401
|
+
// build/commands/generated/subscriptions-transitions.js
|
|
31402
|
+
function registerSubscriptions_TransitionsCommands(parent) {
|
|
31403
|
+
const resource = parent.command("subscriptions-transitions").description("Manage subscriptions > transitions");
|
|
31101
31404
|
resource.command("list-subscription-transitions").description(`List subscription transitions (migrations from one subscription to another). Filterable and paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--status <value>", `status`).option("--status.in <value>", `status__in`).option("--source-subscription-id <value>", `source_subscription_id`).option("--source-subscription-id.not <value>", `source_subscription_id__not`).option("--source-subscription-id.is-null <value>", `source_subscription_id__isNull`).option("--source-subscription-id.is-not-null <value>", `source_subscription_id__isNotNull`).option("--source-subscription-id.equals <value>", `source_subscription_id__equals`).option("--source-subscription-id.contains <value>", `source_subscription_id__contains`).option("--source-subscription-id.starts-with <value>", `source_subscription_id__startsWith`).option("--source-subscription-id.end-with <value>", `source_subscription_id__endWith`).option("--base-subscription-id <value>", `base_subscription_id`).option("--base-subscription-id.not <value>", `base_subscription_id__not`).option("--base-subscription-id.is-null <value>", `base_subscription_id__isNull`).option("--base-subscription-id.is-not-null <value>", `base_subscription_id__isNotNull`).option("--base-subscription-id.equals <value>", `base_subscription_id__equals`).option("--base-subscription-id.contains <value>", `base_subscription_id__contains`).option("--base-subscription-id.starts-with <value>", `base_subscription_id__startsWith`).option("--base-subscription-id.end-with <value>", `base_subscription_id__endWith`).option("--target-subscription-id <value>", `target_subscription_id`).option("--target-subscription-id.not <value>", `target_subscription_id__not`).option("--target-subscription-id.is-null <value>", `target_subscription_id__isNull`).option("--target-subscription-id.is-not-null <value>", `target_subscription_id__isNotNull`).option("--target-subscription-id.equals <value>", `target_subscription_id__equals`).option("--target-subscription-id.contains <value>", `target_subscription_id__contains`).option("--target-subscription-id.starts-with <value>", `target_subscription_id__startsWith`).option("--target-subscription-id.end-with <value>", `target_subscription_id__endWith`).option("--transition-date <value>", `transition_date`).option("--transition-date.not <value>", `transition_date__not`).option("--transition-date.is-null <value>", `transition_date__isNull`).option("--transition-date.is-not-null <value>", `transition_date__isNotNull`).option("--transition-date.equals <value>", `transition_date__equals`).option("--transition-date.lt <value>", `transition_date__lt`).option("--transition-date.lte <value>", `transition_date__lte`).option("--transition-date.gt <value>", `transition_date__gt`).option("--transition-date.gte <value>", `transition_date__gte`).option("--transitioned-at <value>", `transitioned_at`).option("--transitioned-at.not <value>", `transitioned_at__not`).option("--transitioned-at.is-null <value>", `transitioned_at__isNull`).option("--transitioned-at.is-not-null <value>", `transitioned_at__isNotNull`).option("--transitioned-at.equals <value>", `transitioned_at__equals`).option("--transitioned-at.lt <value>", `transitioned_at__lt`).option("--transitioned-at.lte <value>", `transitioned_at__lte`).option("--transitioned-at.gt <value>", `transitioned_at__gt`).option("--transitioned-at.gte <value>", `transitioned_at__gte`).addHelpText("after", `
|
|
31102
31405
|
Examples:
|
|
31103
|
-
hyperline subscriptions list-subscription-transitions
|
|
31104
|
-
hyperline subscriptions list-subscription-transitions --take <take> --status <status>`).action(async (opts) => {
|
|
31406
|
+
hyperline subscriptions-transitions list-subscription-transitions
|
|
31407
|
+
hyperline subscriptions-transitions list-subscription-transitions --take <take> --status <status>`).action(async (opts) => {
|
|
31105
31408
|
const ctx = resource.parent?.opts()._ctx;
|
|
31106
31409
|
if (!ctx) {
|
|
31107
31410
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31254,180 +31557,11 @@ Examples:
|
|
|
31254
31557
|
]
|
|
31255
31558
|
});
|
|
31256
31559
|
});
|
|
31257
|
-
resource.command("
|
|
31258
|
-
Examples:
|
|
31259
|
-
hyperline subscriptions get --id <id>
|
|
31260
|
-
hyperline subscriptions get --id <id> --include-live-billing <include_live_billing>`).action(async (opts) => {
|
|
31261
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31262
|
-
if (!ctx) {
|
|
31263
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31264
|
-
process.exit(1);
|
|
31265
|
-
}
|
|
31266
|
-
const args = {};
|
|
31267
|
-
if (opts.id !== void 0)
|
|
31268
|
-
args.id = opts.id;
|
|
31269
|
-
if (opts.includeLiveBilling !== void 0)
|
|
31270
|
-
args.include_live_billing = opts.includeLiveBilling;
|
|
31271
|
-
await ctx.execute({
|
|
31272
|
-
method: "GET",
|
|
31273
|
-
path: "/v2/subscriptions/{id}",
|
|
31274
|
-
args,
|
|
31275
|
-
queryParamKeys: ["include_live_billing"]
|
|
31276
|
-
});
|
|
31277
|
-
});
|
|
31278
|
-
resource.command("list-subscription-phases").description(`List all phases of a subscription. Phases define time-bound product configurations within a subscription.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31279
|
-
Examples:
|
|
31280
|
-
hyperline subscriptions list-subscription-phases --id <id>`).action(async (opts) => {
|
|
31281
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31282
|
-
if (!ctx) {
|
|
31283
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31284
|
-
process.exit(1);
|
|
31285
|
-
}
|
|
31286
|
-
const args = {};
|
|
31287
|
-
if (opts.id !== void 0)
|
|
31288
|
-
args.id = opts.id;
|
|
31289
|
-
await ctx.execute({
|
|
31290
|
-
method: "GET",
|
|
31291
|
-
path: "/v2/subscriptions/{id}/phases",
|
|
31292
|
-
args,
|
|
31293
|
-
queryParamKeys: []
|
|
31294
|
-
});
|
|
31295
|
-
});
|
|
31296
|
-
resource.command("get-subscription-phase").description(`Retrieve details of a specific phase within a subscription, including its products and billing configuration.`).requiredOption("--id <value>", `id parameter`).requiredOption("--phase-id <value>", `phaseId parameter`).addHelpText("after", `
|
|
31297
|
-
Examples:
|
|
31298
|
-
hyperline subscriptions get-subscription-phase --id <id> --phase-id <phaseId>`).action(async (opts) => {
|
|
31299
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31300
|
-
if (!ctx) {
|
|
31301
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31302
|
-
process.exit(1);
|
|
31303
|
-
}
|
|
31304
|
-
const args = {};
|
|
31305
|
-
if (opts.id !== void 0)
|
|
31306
|
-
args.id = opts.id;
|
|
31307
|
-
if (opts.phaseId !== void 0)
|
|
31308
|
-
args.phaseId = opts.phaseId;
|
|
31309
|
-
await ctx.execute({
|
|
31310
|
-
method: "GET",
|
|
31311
|
-
path: "/v2/subscriptions/{id}/phases/{phaseId}",
|
|
31312
|
-
args,
|
|
31313
|
-
queryParamKeys: []
|
|
31314
|
-
});
|
|
31315
|
-
});
|
|
31316
|
-
resource.command("refresh-subscription-seat-products").description(`Trigger a count update on seat-based products within a subscription using the configured dataloader query.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31560
|
+
resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.`).requiredOption("--source-subscription-id <value>", `The ID of the subscription to transition from`).option("--name <value>", `An optional name for the transition`).option("--calculation-method <value>", `The calculation method to use for the transition. 'do_not_charge' will not generate any transition invoice. 'pro_rata' will generate a prorated invoice for the remaining period.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `Whether the transition should be applied 'immediately' or 'scheduled' for a specific date. Past dates within the current billing period are supported and will be applied immediately.`).option("--transition-date <value>", `The date at which the transition should occur. Only applicable if the application schedule is 'scheduled'. Can be a past date within the current billing period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).requiredOption("--target-subscription <value>", `The configuration of the subscription to transition to`).addHelpText("after", `
|
|
31317
31561
|
Examples:
|
|
31318
|
-
hyperline subscriptions
|
|
31319
|
-
hyperline subscriptions
|
|
31320
|
-
|
|
31321
|
-
if (!ctx) {
|
|
31322
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31323
|
-
process.exit(1);
|
|
31324
|
-
}
|
|
31325
|
-
const args = {};
|
|
31326
|
-
if (opts.id !== void 0)
|
|
31327
|
-
args.id = opts.id;
|
|
31328
|
-
await ctx.execute({
|
|
31329
|
-
method: "POST",
|
|
31330
|
-
path: "/v2/subscriptions/{id}/refresh-seat-products",
|
|
31331
|
-
args,
|
|
31332
|
-
queryParamKeys: []
|
|
31333
|
-
});
|
|
31334
|
-
});
|
|
31335
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Payload mirrors GET response structure.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Subscription custom name.`).option("--purchase-order <value>", `Reference to the purchase order.`).option("--minimum-invoice-fee <number>", `Minimum fee applied to each invoice outside of one time payments.`).option("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).option("--tax-only <value>", `Only tax will be charged on this subscription.`).option("--generate-draft-invoices <value>", `Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent`).option("--generate-document <value>", `Generate non-legal documents instead of invoices.`).option("--document-name <value>", `If \`generate_document\` is turned on, allows you to give a name to your document.`).option("--add-tax-to-document <value>", `If \`generate_document\` is turned on, will add taxes to document.`).option("--do-not-charge-subscription <value>", `Subscription will be invoiced but not charged (invoices/documents will be settled directly).`).option("--invoice-custom-note <value>", `Default custom note added to invoices generated by the subscription.`).option("--invoice-schedule <value>", `
|
|
31336
|
-
Defines when invoices are generated relative to the billing period.
|
|
31337
|
-
|
|
31338
|
-
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
31339
|
-
- \`period_end\`: Invoices are generated at the end of the billing period.
|
|
31340
|
-
`).option("--estimated-arr <number>", `Estimated Annual Recurring Revenue generated by the subscription.`).option("--contract-value <number>", `Contract value of the subscription. This value is overridable by the user.`).option("--starts-at <value>", `Applies only if the activation strategy is \`start_date\`. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--initial-billing-at <value>", `Date when the subscription will start being billed. If not specified, it will correspond to the \`starts_at\` date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--cancel-at <value>", `Subscription cancel date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--display-shipping-details <value>", `Indicates if the shipping details should be displayed on the subscription's invoices.`).option("--phases <value>", `Array of subscription phases. Existing pending phases will be replaced by the ones in the array.`).option("--contract-terms <value>", `Contract terms to update.`).addHelpText("after", `
|
|
31341
|
-
Examples:
|
|
31342
|
-
hyperline subscriptions update --id <id>
|
|
31343
|
-
hyperline subscriptions update --id <id> --name <name> --purchase-order <purchase_order>
|
|
31344
|
-
hyperline subscriptions update --id <id> --output json`).action(async (opts) => {
|
|
31345
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31346
|
-
if (!ctx) {
|
|
31347
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31348
|
-
process.exit(1);
|
|
31349
|
-
}
|
|
31350
|
-
const args = {};
|
|
31351
|
-
if (opts.id !== void 0)
|
|
31352
|
-
args.id = opts.id;
|
|
31353
|
-
if (opts.name !== void 0)
|
|
31354
|
-
args.name = opts.name;
|
|
31355
|
-
if (opts.purchaseOrder !== void 0)
|
|
31356
|
-
args.purchase_order = opts.purchaseOrder;
|
|
31357
|
-
if (opts.crmOpportunityId !== void 0)
|
|
31358
|
-
args.crm_opportunity_id = opts.crmOpportunityId;
|
|
31359
|
-
if (opts.taxOnly !== void 0)
|
|
31360
|
-
args.tax_only = opts.taxOnly;
|
|
31361
|
-
if (opts.generateDraftInvoices !== void 0)
|
|
31362
|
-
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
31363
|
-
if (opts.generateDocument !== void 0)
|
|
31364
|
-
args.generate_document = opts.generateDocument;
|
|
31365
|
-
if (opts.documentName !== void 0)
|
|
31366
|
-
args.document_name = opts.documentName;
|
|
31367
|
-
if (opts.addTaxToDocument !== void 0)
|
|
31368
|
-
args.add_tax_to_document = opts.addTaxToDocument;
|
|
31369
|
-
if (opts.doNotChargeSubscription !== void 0)
|
|
31370
|
-
args.do_not_charge_subscription = opts.doNotChargeSubscription;
|
|
31371
|
-
if (opts.invoiceCustomNote !== void 0)
|
|
31372
|
-
args.invoice_custom_note = opts.invoiceCustomNote;
|
|
31373
|
-
if (opts.invoiceSchedule !== void 0)
|
|
31374
|
-
args.invoice_schedule = opts.invoiceSchedule;
|
|
31375
|
-
if (opts.startsAt !== void 0)
|
|
31376
|
-
args.starts_at = opts.startsAt;
|
|
31377
|
-
if (opts.initialBillingAt !== void 0)
|
|
31378
|
-
args.initial_billing_at = opts.initialBillingAt;
|
|
31379
|
-
if (opts.cancelAt !== void 0)
|
|
31380
|
-
args.cancel_at = opts.cancelAt;
|
|
31381
|
-
if (opts.properties !== void 0)
|
|
31382
|
-
args.properties = opts.properties;
|
|
31383
|
-
if (opts.customProperties !== void 0)
|
|
31384
|
-
args.custom_properties = opts.customProperties;
|
|
31385
|
-
if (opts.displayShippingDetails !== void 0)
|
|
31386
|
-
args.display_shipping_details = opts.displayShippingDetails;
|
|
31387
|
-
if (opts.phases !== void 0)
|
|
31388
|
-
args.phases = opts.phases;
|
|
31389
|
-
if (opts.contractTerms !== void 0)
|
|
31390
|
-
args.contract_terms = opts.contractTerms;
|
|
31391
|
-
if (opts.minimumInvoiceFee !== void 0)
|
|
31392
|
-
args.minimum_invoice_fee = Number(opts.minimumInvoiceFee);
|
|
31393
|
-
if (opts.estimatedArr !== void 0)
|
|
31394
|
-
args.estimated_arr = Number(opts.estimatedArr);
|
|
31395
|
-
if (opts.contractValue !== void 0)
|
|
31396
|
-
args.contract_value = Number(opts.contractValue);
|
|
31397
|
-
await ctx.execute({
|
|
31398
|
-
method: "PUT",
|
|
31399
|
-
path: "/v2/subscriptions/{id}",
|
|
31400
|
-
args,
|
|
31401
|
-
queryParamKeys: []
|
|
31402
|
-
});
|
|
31403
|
-
});
|
|
31404
|
-
resource.command("transition").description(`Transition a subscription to its next configured phase at a specified date.`).requiredOption("--id <value>", `id parameter`).option("--transition-date <value>", `Date of application of the transition. Use it if different than immediately to calculate pro-rata and display past or future dates on invoices. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).addHelpText("after", `
|
|
31405
|
-
Examples:
|
|
31406
|
-
hyperline subscriptions transition --id <id>
|
|
31407
|
-
hyperline subscriptions transition --id <id> --transition-date <transition_date>
|
|
31408
|
-
hyperline subscriptions transition --id <id> --output json`).action(async (opts) => {
|
|
31409
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31410
|
-
if (!ctx) {
|
|
31411
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31412
|
-
process.exit(1);
|
|
31413
|
-
}
|
|
31414
|
-
const args = {};
|
|
31415
|
-
if (opts.id !== void 0)
|
|
31416
|
-
args.id = opts.id;
|
|
31417
|
-
if (opts.transitionDate !== void 0)
|
|
31418
|
-
args.transition_date = opts.transitionDate;
|
|
31419
|
-
await ctx.execute({
|
|
31420
|
-
method: "POST",
|
|
31421
|
-
path: "/v2/subscriptions/{id}/next-phase",
|
|
31422
|
-
args,
|
|
31423
|
-
queryParamKeys: []
|
|
31424
|
-
});
|
|
31425
|
-
});
|
|
31426
|
-
resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.`).requiredOption("--source-subscription-id <value>", `The ID of the subscription to transition from`).option("--name <value>", `An optional name for the transition`).option("--calculation-method <value>", `The calculation method to use for the transition. 'do_not_charge' will not generate any transition invoice. 'pro_rata' will generate a prorated invoice for the remaining period.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `Whether the transition should be applied 'immediately' or 'scheduled' for a future date.`).option("--transition-date <value>", `The date at which the transition should occur. Only applicable if the application schedule is 'scheduled'. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).requiredOption("--target-subscription <value>", `The configuration of the subscription to transition to`).addHelpText("after", `
|
|
31427
|
-
Examples:
|
|
31428
|
-
hyperline subscriptions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
31429
|
-
hyperline subscriptions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription> --name <name> --calculation-method <calculation_method>
|
|
31430
|
-
hyperline subscriptions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription> --output json`).action(async (opts) => {
|
|
31562
|
+
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
31563
|
+
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription> --name <name> --calculation-method <calculation_method>
|
|
31564
|
+
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription> --output json`).action(async (opts) => {
|
|
31431
31565
|
const ctx = resource.parent?.opts()._ctx;
|
|
31432
31566
|
if (!ctx) {
|
|
31433
31567
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31457,7 +31591,7 @@ Examples:
|
|
|
31457
31591
|
});
|
|
31458
31592
|
resource.command("get-subscription-transition").description(`Retrieve details of a subscription transition by ID including source/target subscriptions and schedule.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31459
31593
|
Examples:
|
|
31460
|
-
hyperline subscriptions get-subscription-transition --id <id>`).action(async (opts) => {
|
|
31594
|
+
hyperline subscriptions-transitions get-subscription-transition --id <id>`).action(async (opts) => {
|
|
31461
31595
|
const ctx = resource.parent?.opts()._ctx;
|
|
31462
31596
|
if (!ctx) {
|
|
31463
31597
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31475,8 +31609,8 @@ Examples:
|
|
|
31475
31609
|
});
|
|
31476
31610
|
resource.command("cancel-subscription-transition").description(`Cancel a scheduled subscription transition before it is applied.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31477
31611
|
Examples:
|
|
31478
|
-
hyperline subscriptions cancel-subscription-transition --id <id>
|
|
31479
|
-
hyperline subscriptions cancel-subscription-transition --id <id> --output json`).action(async (opts) => {
|
|
31612
|
+
hyperline subscriptions-transitions cancel-subscription-transition --id <id>
|
|
31613
|
+
hyperline subscriptions-transitions cancel-subscription-transition --id <id> --output json`).action(async (opts) => {
|
|
31480
31614
|
const ctx = resource.parent?.opts()._ctx;
|
|
31481
31615
|
if (!ctx) {
|
|
31482
31616
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31492,71 +31626,6 @@ Examples:
|
|
|
31492
31626
|
queryParamKeys: []
|
|
31493
31627
|
});
|
|
31494
31628
|
});
|
|
31495
|
-
resource.command("get-subscription-valuation").description(`Compute valuation metrics for a subscription: contract value (total/invoiced/remaining), recurring contract value, and ARR (fixed + variable). Optionally pass granularity (year/quarter/month) for period breakdown.`).requiredOption("--id <value>", `id parameter`).option("--granularity <value>", `Period granularity for the breakdown. When provided, contract value and recurring contract value include a \`by_period\` array.`).addHelpText("after", `
|
|
31496
|
-
Examples:
|
|
31497
|
-
hyperline subscriptions get-subscription-valuation --id <id>
|
|
31498
|
-
hyperline subscriptions get-subscription-valuation --id <id> --granularity <granularity>`).action(async (opts) => {
|
|
31499
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31500
|
-
if (!ctx) {
|
|
31501
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31502
|
-
process.exit(1);
|
|
31503
|
-
}
|
|
31504
|
-
const args = {};
|
|
31505
|
-
if (opts.id !== void 0)
|
|
31506
|
-
args.id = opts.id;
|
|
31507
|
-
if (opts.granularity !== void 0)
|
|
31508
|
-
args.granularity = opts.granularity;
|
|
31509
|
-
await ctx.execute({
|
|
31510
|
-
method: "GET",
|
|
31511
|
-
path: "/v1/subscriptions/{id}/valuation",
|
|
31512
|
-
args,
|
|
31513
|
-
queryParamKeys: ["granularity"]
|
|
31514
|
-
});
|
|
31515
|
-
});
|
|
31516
|
-
}
|
|
31517
|
-
|
|
31518
|
-
// build/commands/generated/subscriptions-templates.js
|
|
31519
|
-
function registerSubscriptions_TemplatesCommands(parent) {
|
|
31520
|
-
const resource = parent.command("subscriptions-templates").description("Manage subscriptions > templates");
|
|
31521
|
-
resource.command("list-subscription-templates").description(`List subscription templates with pagination. Templates define reusable subscription configurations with pre-configured products, phases, and billing settings.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
31522
|
-
Examples:
|
|
31523
|
-
hyperline subscriptions-templates list-subscription-templates
|
|
31524
|
-
hyperline subscriptions-templates list-subscription-templates --take <take>`).action(async (opts) => {
|
|
31525
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31526
|
-
if (!ctx) {
|
|
31527
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31528
|
-
process.exit(1);
|
|
31529
|
-
}
|
|
31530
|
-
const args = {};
|
|
31531
|
-
if (opts.take !== void 0)
|
|
31532
|
-
args.take = Number(opts.take);
|
|
31533
|
-
if (opts.skip !== void 0)
|
|
31534
|
-
args.skip = Number(opts.skip);
|
|
31535
|
-
await ctx.execute({
|
|
31536
|
-
method: "GET",
|
|
31537
|
-
path: "/v1/subscriptions/templates",
|
|
31538
|
-
args,
|
|
31539
|
-
queryParamKeys: ["take", "skip"]
|
|
31540
|
-
});
|
|
31541
|
-
});
|
|
31542
|
-
resource.command("get-subscription-template").description(`Retrieve a subscription template by ID with its full configuration including products, phases, and pricing details.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31543
|
-
Examples:
|
|
31544
|
-
hyperline subscriptions-templates get-subscription-template --id <id>`).action(async (opts) => {
|
|
31545
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
31546
|
-
if (!ctx) {
|
|
31547
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
31548
|
-
process.exit(1);
|
|
31549
|
-
}
|
|
31550
|
-
const args = {};
|
|
31551
|
-
if (opts.id !== void 0)
|
|
31552
|
-
args.id = opts.id;
|
|
31553
|
-
await ctx.execute({
|
|
31554
|
-
method: "GET",
|
|
31555
|
-
path: "/v1/subscriptions/templates/{id}",
|
|
31556
|
-
args,
|
|
31557
|
-
queryParamKeys: []
|
|
31558
|
-
});
|
|
31559
|
-
});
|
|
31560
31629
|
}
|
|
31561
31630
|
|
|
31562
31631
|
// build/commands/generated/taxes.js
|
|
@@ -32111,6 +32180,8 @@ function registerAllCommands(program2) {
|
|
|
32111
32180
|
registerQuotesCommands(program2);
|
|
32112
32181
|
registerSubscriptionsCommands(program2);
|
|
32113
32182
|
registerSubscriptions_TemplatesCommands(program2);
|
|
32183
|
+
registerSubscriptions_TransitionsCommands(program2);
|
|
32184
|
+
registerSubscriptions_PhasesCommands(program2);
|
|
32114
32185
|
registerTaxesCommands(program2);
|
|
32115
32186
|
registerWalletsCommands(program2);
|
|
32116
32187
|
registerWebhooksCommands(program2);
|
|
@@ -32694,7 +32765,7 @@ function $constructor(name, initializer3, params) {
|
|
|
32694
32765
|
Object.defineProperty(_, "name", { value: name });
|
|
32695
32766
|
return _;
|
|
32696
32767
|
}
|
|
32697
|
-
var $brand = Symbol("zod_brand");
|
|
32768
|
+
var $brand = /* @__PURE__ */ Symbol("zod_brand");
|
|
32698
32769
|
var $ZodAsyncError = class extends Error {
|
|
32699
32770
|
constructor() {
|
|
32700
32771
|
super(`Encountered Promise during synchronous parse. Use .parseAsync() instead.`);
|
|
@@ -32841,7 +32912,7 @@ function floatSafeRemainder(val, step) {
|
|
|
32841
32912
|
const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", ""));
|
|
32842
32913
|
return valInt % stepInt / 10 ** decCount;
|
|
32843
32914
|
}
|
|
32844
|
-
var EVALUATING = Symbol("evaluating");
|
|
32915
|
+
var EVALUATING = /* @__PURE__ */ Symbol("evaluating");
|
|
32845
32916
|
function defineLazy(object2, key, getter) {
|
|
32846
32917
|
let value = void 0;
|
|
32847
32918
|
Object.defineProperty(object2, key, {
|
|
@@ -41914,8 +41985,8 @@ function yo_default() {
|
|
|
41914
41985
|
|
|
41915
41986
|
// ../../node_modules/zod/v4/core/registries.js
|
|
41916
41987
|
var _a;
|
|
41917
|
-
var $output = Symbol("ZodOutput");
|
|
41918
|
-
var $input = Symbol("ZodInput");
|
|
41988
|
+
var $output = /* @__PURE__ */ Symbol("ZodOutput");
|
|
41989
|
+
var $input = /* @__PURE__ */ Symbol("ZodInput");
|
|
41919
41990
|
var $ZodRegistry = class {
|
|
41920
41991
|
constructor() {
|
|
41921
41992
|
this._map = /* @__PURE__ */ new WeakMap();
|
|
@@ -42952,7 +43023,7 @@ function _stringbool(Classes, _params) {
|
|
|
42952
43023
|
type: "pipe",
|
|
42953
43024
|
in: stringSchema,
|
|
42954
43025
|
out: booleanSchema,
|
|
42955
|
-
transform: (input, payload) => {
|
|
43026
|
+
transform: ((input, payload) => {
|
|
42956
43027
|
let data = input;
|
|
42957
43028
|
if (params.case !== "sensitive")
|
|
42958
43029
|
data = data.toLowerCase();
|
|
@@ -42971,14 +43042,14 @@ function _stringbool(Classes, _params) {
|
|
|
42971
43042
|
});
|
|
42972
43043
|
return {};
|
|
42973
43044
|
}
|
|
42974
|
-
},
|
|
42975
|
-
reverseTransform: (input, _payload) => {
|
|
43045
|
+
}),
|
|
43046
|
+
reverseTransform: ((input, _payload) => {
|
|
42976
43047
|
if (input === true) {
|
|
42977
43048
|
return truthyArray[0] || "true";
|
|
42978
43049
|
} else {
|
|
42979
43050
|
return falsyArray[0] || "false";
|
|
42980
43051
|
}
|
|
42981
|
-
},
|
|
43052
|
+
}),
|
|
42982
43053
|
error: params.error
|
|
42983
43054
|
});
|
|
42984
43055
|
return codec2;
|
|
@@ -44306,10 +44377,10 @@ var ZodType = /* @__PURE__ */ $constructor("ZodType", (inst, def) => {
|
|
|
44306
44377
|
inst.with = inst.check;
|
|
44307
44378
|
inst.clone = (def2, params) => clone(inst, def2, params);
|
|
44308
44379
|
inst.brand = () => inst;
|
|
44309
|
-
inst.register = (reg, meta3) => {
|
|
44380
|
+
inst.register = ((reg, meta3) => {
|
|
44310
44381
|
reg.add(inst, meta3);
|
|
44311
44382
|
return inst;
|
|
44312
|
-
};
|
|
44383
|
+
});
|
|
44313
44384
|
inst.parse = (data, params) => parse2(inst, data, params, { callee: inst.parse });
|
|
44314
44385
|
inst.safeParse = (data, params) => safeParse2(inst, data, params);
|
|
44315
44386
|
inst.parseAsync = async (data, params) => parseAsync2(inst, data, params, { callee: inst.parseAsync });
|
|
@@ -46997,7 +47068,7 @@ function cosine(Ctor, x) {
|
|
|
46997
47068
|
Ctor.precision -= k;
|
|
46998
47069
|
return x;
|
|
46999
47070
|
}
|
|
47000
|
-
var divide = /* @__PURE__ */ function() {
|
|
47071
|
+
var divide = /* @__PURE__ */ (function() {
|
|
47001
47072
|
function multiplyInteger(x, k, base) {
|
|
47002
47073
|
var temp, carry = 0, i = x.length;
|
|
47003
47074
|
for (x = x.slice(); i--; ) {
|
|
@@ -47155,7 +47226,7 @@ var divide = /* @__PURE__ */ function() {
|
|
|
47155
47226
|
}
|
|
47156
47227
|
return q;
|
|
47157
47228
|
};
|
|
47158
|
-
}();
|
|
47229
|
+
})();
|
|
47159
47230
|
function finalise(x, sd, rm, isTruncated) {
|
|
47160
47231
|
var digits, i, j, k, rd, roundUp, w, xd, xdi, Ctor = x.constructor;
|
|
47161
47232
|
out: if (sd != null) {
|
|
@@ -48112,7 +48183,7 @@ function tanh(x) {
|
|
|
48112
48183
|
function trunc(x) {
|
|
48113
48184
|
return finalise(x = new this(x), x.e + 1, 1);
|
|
48114
48185
|
}
|
|
48115
|
-
P[Symbol.for("nodejs.util.inspect.custom")] = P.toString;
|
|
48186
|
+
P[/* @__PURE__ */ Symbol.for("nodejs.util.inspect.custom")] = P.toString;
|
|
48116
48187
|
P[Symbol.toStringTag] = "Decimal";
|
|
48117
48188
|
var Decimal = P.constructor = clone2(DEFAULTS);
|
|
48118
48189
|
LN10 = new Decimal(LN10);
|
|
@@ -51114,7 +51185,7 @@ var toLogRequest = (config4) => {
|
|
|
51114
51185
|
url: config4.url ?? "",
|
|
51115
51186
|
path: config4.url ?? "",
|
|
51116
51187
|
hostname: config4.baseURL ?? "",
|
|
51117
|
-
originalUrl: `${config4.baseURL}${config4.url}`,
|
|
51188
|
+
originalUrl: `${config4.baseURL ?? ""}${config4.url}`,
|
|
51118
51189
|
body: config4.data,
|
|
51119
51190
|
headers: {}
|
|
51120
51191
|
};
|
|
@@ -51159,8 +51230,8 @@ var PathParamError = class extends Error {
|
|
|
51159
51230
|
missingKeys;
|
|
51160
51231
|
constructor(missingKeys) {
|
|
51161
51232
|
super(`Missing required path parameter${missingKeys.length > 1 ? "s" : ""}: ${missingKeys.join(", ")}`);
|
|
51162
|
-
this.missingKeys = missingKeys;
|
|
51163
51233
|
this.name = "PathParamError";
|
|
51234
|
+
this.missingKeys = missingKeys;
|
|
51164
51235
|
}
|
|
51165
51236
|
};
|
|
51166
51237
|
function removeUsedKeys(args, usedKeys) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hyperline/cli",
|
|
3
|
-
"version": "0.1.0-build.1.
|
|
3
|
+
"version": "0.1.0-build.1.6f3cd3a",
|
|
4
4
|
"description": "Agent-first CLI for Hyperline API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -42,13 +42,13 @@
|
|
|
42
42
|
"winston": "3.10.0"
|
|
43
43
|
},
|
|
44
44
|
"devDependencies": {
|
|
45
|
-
"@biomejs/biome": "2.
|
|
45
|
+
"@biomejs/biome": "2.4.12",
|
|
46
46
|
"@hyperline/ts-config": "workspace:*",
|
|
47
47
|
"@hyperline/vitest-config": "workspace:*",
|
|
48
48
|
"@types/node": "24.10.1",
|
|
49
|
-
"esbuild": "0.
|
|
50
|
-
"typescript": "6.0.
|
|
51
|
-
"vitest": "4.
|
|
49
|
+
"esbuild": "0.28.0",
|
|
50
|
+
"typescript": "6.0.3",
|
|
51
|
+
"vitest": "4.1.5"
|
|
52
52
|
},
|
|
53
53
|
"publishConfig": {
|
|
54
54
|
"access": "public",
|