@hyperline/cli 0.1.0-build.1.2ca4ae5 → 0.1.0-build.1.30cad46
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 +358 -314
- package/package.json +4 -4
|
@@ -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" },
|
|
@@ -28401,6 +28401,27 @@ Examples:
|
|
|
28401
28401
|
queryParamKeys: []
|
|
28402
28402
|
});
|
|
28403
28403
|
});
|
|
28404
|
+
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", `
|
|
28405
|
+
Examples:
|
|
28406
|
+
hyperline exports list
|
|
28407
|
+
hyperline exports list --take <take>`).action(async (opts) => {
|
|
28408
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
28409
|
+
if (!ctx) {
|
|
28410
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
28411
|
+
process.exit(1);
|
|
28412
|
+
}
|
|
28413
|
+
const args = {};
|
|
28414
|
+
if (opts.take !== void 0)
|
|
28415
|
+
args.take = Number(opts.take);
|
|
28416
|
+
if (opts.skip !== void 0)
|
|
28417
|
+
args.skip = Number(opts.skip);
|
|
28418
|
+
await ctx.execute({
|
|
28419
|
+
method: "GET",
|
|
28420
|
+
path: "/v1/exports",
|
|
28421
|
+
args,
|
|
28422
|
+
queryParamKeys: ["take", "skip"]
|
|
28423
|
+
});
|
|
28424
|
+
});
|
|
28404
28425
|
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
28426
|
Examples:
|
|
28406
28427
|
hyperline exports get --export-id <exportId>`).action(async (opts) => {
|
|
@@ -28419,9 +28440,10 @@ Examples:
|
|
|
28419
28440
|
queryParamKeys: []
|
|
28420
28441
|
});
|
|
28421
28442
|
});
|
|
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", `
|
|
28443
|
+
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
28444
|
Examples:
|
|
28424
|
-
hyperline exports download --export-id <exportId
|
|
28445
|
+
hyperline exports download --export-id <exportId>
|
|
28446
|
+
hyperline exports download --export-id <exportId> --as-redirect <as_redirect>`).action(async (opts) => {
|
|
28425
28447
|
const ctx = resource.parent?.opts()._ctx;
|
|
28426
28448
|
if (!ctx) {
|
|
28427
28449
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -28430,11 +28452,13 @@ Examples:
|
|
|
28430
28452
|
const args = {};
|
|
28431
28453
|
if (opts.exportId !== void 0)
|
|
28432
28454
|
args.exportId = opts.exportId;
|
|
28455
|
+
if (opts.asRedirect !== void 0)
|
|
28456
|
+
args.as_redirect = opts.asRedirect;
|
|
28433
28457
|
await ctx.execute({
|
|
28434
28458
|
method: "GET",
|
|
28435
28459
|
path: "/v1/exports/{exportId}/download",
|
|
28436
28460
|
args,
|
|
28437
|
-
queryParamKeys: []
|
|
28461
|
+
queryParamKeys: ["as_redirect"]
|
|
28438
28462
|
});
|
|
28439
28463
|
});
|
|
28440
28464
|
}
|
|
@@ -30121,7 +30145,7 @@ Quote status.
|
|
|
30121
30145
|
- \`draft\`: The quote is a draft.
|
|
30122
30146
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
30123
30147
|
- \`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.
|
|
30148
|
+
`).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
30149
|
|
|
30126
30150
|
- \`all\`: Display all pricing tiers.
|
|
30127
30151
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
@@ -30157,6 +30181,8 @@ Examples:
|
|
|
30157
30181
|
args.require_tax_id = opts.requireTaxId;
|
|
30158
30182
|
if (opts.displayQuoteValue !== void 0)
|
|
30159
30183
|
args.display_quote_value = opts.displayQuoteValue;
|
|
30184
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
30185
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
30160
30186
|
if (opts.displayTaxes !== void 0)
|
|
30161
30187
|
args.display_taxes = opts.displayTaxes;
|
|
30162
30188
|
if (opts.displayPriceTiers !== void 0)
|
|
@@ -30570,10 +30596,10 @@ Examples:
|
|
|
30570
30596
|
queryParamKeys: []
|
|
30571
30597
|
});
|
|
30572
30598
|
});
|
|
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", `
|
|
30599
|
+
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
30600
|
Examples:
|
|
30575
30601
|
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>
|
|
30602
|
+
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
30603
|
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
30604
|
const ctx = resource.parent?.opts()._ctx;
|
|
30579
30605
|
if (!ctx) {
|
|
@@ -30589,6 +30615,8 @@ Examples:
|
|
|
30589
30615
|
args.apply_at = opts.applyAt;
|
|
30590
30616
|
if (opts.paymentSchedule !== void 0)
|
|
30591
30617
|
args.payment_schedule = opts.paymentSchedule;
|
|
30618
|
+
if (opts.chargeAt !== void 0)
|
|
30619
|
+
args.charge_at = opts.chargeAt;
|
|
30592
30620
|
if (opts.calculationMethod !== void 0)
|
|
30593
30621
|
args.calculation_method = opts.calculationMethod;
|
|
30594
30622
|
if (opts.type !== void 0)
|
|
@@ -30602,10 +30630,10 @@ Examples:
|
|
|
30602
30630
|
queryParamKeys: []
|
|
30603
30631
|
});
|
|
30604
30632
|
});
|
|
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", `
|
|
30633
|
+
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
30634
|
Examples:
|
|
30607
30635
|
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>
|
|
30636
|
+
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
30637
|
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
30638
|
const ctx = resource.parent?.opts()._ctx;
|
|
30611
30639
|
if (!ctx) {
|
|
@@ -30621,6 +30649,8 @@ Examples:
|
|
|
30621
30649
|
args.apply_at = opts.applyAt;
|
|
30622
30650
|
if (opts.paymentSchedule !== void 0)
|
|
30623
30651
|
args.payment_schedule = opts.paymentSchedule;
|
|
30652
|
+
if (opts.chargeAt !== void 0)
|
|
30653
|
+
args.charge_at = opts.chargeAt;
|
|
30624
30654
|
if (opts.calculationMethod !== void 0)
|
|
30625
30655
|
args.calculation_method = opts.calculationMethod;
|
|
30626
30656
|
if (opts.updates !== void 0)
|
|
@@ -30758,10 +30788,10 @@ Examples:
|
|
|
30758
30788
|
queryParamKeys: []
|
|
30759
30789
|
});
|
|
30760
30790
|
});
|
|
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", `
|
|
30791
|
+
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
30792
|
Examples:
|
|
30763
30793
|
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>
|
|
30794
|
+
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
30795
|
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
30796
|
const ctx = resource.parent?.opts()._ctx;
|
|
30767
30797
|
if (!ctx) {
|
|
@@ -30777,6 +30807,8 @@ Examples:
|
|
|
30777
30807
|
args.apply_at = opts.applyAt;
|
|
30778
30808
|
if (opts.paymentSchedule !== void 0)
|
|
30779
30809
|
args.payment_schedule = opts.paymentSchedule;
|
|
30810
|
+
if (opts.chargeAt !== void 0)
|
|
30811
|
+
args.charge_at = opts.chargeAt;
|
|
30780
30812
|
if (opts.calculationMethod !== void 0)
|
|
30781
30813
|
args.calculation_method = opts.calculationMethod;
|
|
30782
30814
|
if (opts.updates !== void 0)
|
|
@@ -31098,10 +31130,254 @@ Examples:
|
|
|
31098
31130
|
]
|
|
31099
31131
|
});
|
|
31100
31132
|
});
|
|
31133
|
+
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", `
|
|
31134
|
+
Examples:
|
|
31135
|
+
hyperline subscriptions get --id <id>
|
|
31136
|
+
hyperline subscriptions get --id <id> --include-live-billing <include_live_billing>`).action(async (opts) => {
|
|
31137
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31138
|
+
if (!ctx) {
|
|
31139
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31140
|
+
process.exit(1);
|
|
31141
|
+
}
|
|
31142
|
+
const args = {};
|
|
31143
|
+
if (opts.id !== void 0)
|
|
31144
|
+
args.id = opts.id;
|
|
31145
|
+
if (opts.includeLiveBilling !== void 0)
|
|
31146
|
+
args.include_live_billing = opts.includeLiveBilling;
|
|
31147
|
+
await ctx.execute({
|
|
31148
|
+
method: "GET",
|
|
31149
|
+
path: "/v2/subscriptions/{id}",
|
|
31150
|
+
args,
|
|
31151
|
+
queryParamKeys: ["include_live_billing"]
|
|
31152
|
+
});
|
|
31153
|
+
});
|
|
31154
|
+
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", `
|
|
31155
|
+
Examples:
|
|
31156
|
+
hyperline subscriptions refresh-subscription-seat-products --id <id>
|
|
31157
|
+
hyperline subscriptions refresh-subscription-seat-products --id <id> --output json`).action(async (opts) => {
|
|
31158
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31159
|
+
if (!ctx) {
|
|
31160
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31161
|
+
process.exit(1);
|
|
31162
|
+
}
|
|
31163
|
+
const args = {};
|
|
31164
|
+
if (opts.id !== void 0)
|
|
31165
|
+
args.id = opts.id;
|
|
31166
|
+
await ctx.execute({
|
|
31167
|
+
method: "POST",
|
|
31168
|
+
path: "/v2/subscriptions/{id}/refresh-seat-products",
|
|
31169
|
+
args,
|
|
31170
|
+
queryParamKeys: []
|
|
31171
|
+
});
|
|
31172
|
+
});
|
|
31173
|
+
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>", `
|
|
31174
|
+
Defines when invoices are generated relative to the billing period.
|
|
31175
|
+
|
|
31176
|
+
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
31177
|
+
- \`period_end\`: Invoices are generated at the end of the billing period.
|
|
31178
|
+
`).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", `
|
|
31179
|
+
Examples:
|
|
31180
|
+
hyperline subscriptions update --id <id>
|
|
31181
|
+
hyperline subscriptions update --id <id> --name <name> --purchase-order <purchase_order>
|
|
31182
|
+
hyperline subscriptions update --id <id> --output json`).action(async (opts) => {
|
|
31183
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31184
|
+
if (!ctx) {
|
|
31185
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31186
|
+
process.exit(1);
|
|
31187
|
+
}
|
|
31188
|
+
const args = {};
|
|
31189
|
+
if (opts.id !== void 0)
|
|
31190
|
+
args.id = opts.id;
|
|
31191
|
+
if (opts.name !== void 0)
|
|
31192
|
+
args.name = opts.name;
|
|
31193
|
+
if (opts.purchaseOrder !== void 0)
|
|
31194
|
+
args.purchase_order = opts.purchaseOrder;
|
|
31195
|
+
if (opts.crmOpportunityId !== void 0)
|
|
31196
|
+
args.crm_opportunity_id = opts.crmOpportunityId;
|
|
31197
|
+
if (opts.taxOnly !== void 0)
|
|
31198
|
+
args.tax_only = opts.taxOnly;
|
|
31199
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
31200
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
31201
|
+
if (opts.generateDocument !== void 0)
|
|
31202
|
+
args.generate_document = opts.generateDocument;
|
|
31203
|
+
if (opts.documentName !== void 0)
|
|
31204
|
+
args.document_name = opts.documentName;
|
|
31205
|
+
if (opts.addTaxToDocument !== void 0)
|
|
31206
|
+
args.add_tax_to_document = opts.addTaxToDocument;
|
|
31207
|
+
if (opts.doNotChargeSubscription !== void 0)
|
|
31208
|
+
args.do_not_charge_subscription = opts.doNotChargeSubscription;
|
|
31209
|
+
if (opts.invoiceCustomNote !== void 0)
|
|
31210
|
+
args.invoice_custom_note = opts.invoiceCustomNote;
|
|
31211
|
+
if (opts.invoiceSchedule !== void 0)
|
|
31212
|
+
args.invoice_schedule = opts.invoiceSchedule;
|
|
31213
|
+
if (opts.startsAt !== void 0)
|
|
31214
|
+
args.starts_at = opts.startsAt;
|
|
31215
|
+
if (opts.initialBillingAt !== void 0)
|
|
31216
|
+
args.initial_billing_at = opts.initialBillingAt;
|
|
31217
|
+
if (opts.cancelAt !== void 0)
|
|
31218
|
+
args.cancel_at = opts.cancelAt;
|
|
31219
|
+
if (opts.properties !== void 0)
|
|
31220
|
+
args.properties = opts.properties;
|
|
31221
|
+
if (opts.customProperties !== void 0)
|
|
31222
|
+
args.custom_properties = opts.customProperties;
|
|
31223
|
+
if (opts.displayShippingDetails !== void 0)
|
|
31224
|
+
args.display_shipping_details = opts.displayShippingDetails;
|
|
31225
|
+
if (opts.phases !== void 0)
|
|
31226
|
+
args.phases = opts.phases;
|
|
31227
|
+
if (opts.contractTerms !== void 0)
|
|
31228
|
+
args.contract_terms = opts.contractTerms;
|
|
31229
|
+
if (opts.minimumInvoiceFee !== void 0)
|
|
31230
|
+
args.minimum_invoice_fee = Number(opts.minimumInvoiceFee);
|
|
31231
|
+
if (opts.estimatedArr !== void 0)
|
|
31232
|
+
args.estimated_arr = Number(opts.estimatedArr);
|
|
31233
|
+
if (opts.contractValue !== void 0)
|
|
31234
|
+
args.contract_value = Number(opts.contractValue);
|
|
31235
|
+
await ctx.execute({
|
|
31236
|
+
method: "PUT",
|
|
31237
|
+
path: "/v2/subscriptions/{id}",
|
|
31238
|
+
args,
|
|
31239
|
+
queryParamKeys: []
|
|
31240
|
+
});
|
|
31241
|
+
});
|
|
31242
|
+
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", `
|
|
31243
|
+
Examples:
|
|
31244
|
+
hyperline subscriptions get-subscription-valuation --id <id>
|
|
31245
|
+
hyperline subscriptions get-subscription-valuation --id <id> --granularity <granularity>`).action(async (opts) => {
|
|
31246
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31247
|
+
if (!ctx) {
|
|
31248
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31249
|
+
process.exit(1);
|
|
31250
|
+
}
|
|
31251
|
+
const args = {};
|
|
31252
|
+
if (opts.id !== void 0)
|
|
31253
|
+
args.id = opts.id;
|
|
31254
|
+
if (opts.granularity !== void 0)
|
|
31255
|
+
args.granularity = opts.granularity;
|
|
31256
|
+
await ctx.execute({
|
|
31257
|
+
method: "GET",
|
|
31258
|
+
path: "/v1/subscriptions/{id}/valuation",
|
|
31259
|
+
args,
|
|
31260
|
+
queryParamKeys: ["granularity"]
|
|
31261
|
+
});
|
|
31262
|
+
});
|
|
31263
|
+
}
|
|
31264
|
+
|
|
31265
|
+
// build/commands/generated/subscriptions-phases.js
|
|
31266
|
+
function registerSubscriptions_PhasesCommands(parent) {
|
|
31267
|
+
const resource = parent.command("subscriptions-phases").description("Manage subscriptions > phases");
|
|
31268
|
+
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", `
|
|
31269
|
+
Examples:
|
|
31270
|
+
hyperline subscriptions-phases list-subscription-phases --id <id>`).action(async (opts) => {
|
|
31271
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31272
|
+
if (!ctx) {
|
|
31273
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31274
|
+
process.exit(1);
|
|
31275
|
+
}
|
|
31276
|
+
const args = {};
|
|
31277
|
+
if (opts.id !== void 0)
|
|
31278
|
+
args.id = opts.id;
|
|
31279
|
+
await ctx.execute({
|
|
31280
|
+
method: "GET",
|
|
31281
|
+
path: "/v2/subscriptions/{id}/phases",
|
|
31282
|
+
args,
|
|
31283
|
+
queryParamKeys: []
|
|
31284
|
+
});
|
|
31285
|
+
});
|
|
31286
|
+
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", `
|
|
31287
|
+
Examples:
|
|
31288
|
+
hyperline subscriptions-phases get-subscription-phase --id <id> --phase-id <phaseId>`).action(async (opts) => {
|
|
31289
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31290
|
+
if (!ctx) {
|
|
31291
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31292
|
+
process.exit(1);
|
|
31293
|
+
}
|
|
31294
|
+
const args = {};
|
|
31295
|
+
if (opts.id !== void 0)
|
|
31296
|
+
args.id = opts.id;
|
|
31297
|
+
if (opts.phaseId !== void 0)
|
|
31298
|
+
args.phaseId = opts.phaseId;
|
|
31299
|
+
await ctx.execute({
|
|
31300
|
+
method: "GET",
|
|
31301
|
+
path: "/v2/subscriptions/{id}/phases/{phaseId}",
|
|
31302
|
+
args,
|
|
31303
|
+
queryParamKeys: []
|
|
31304
|
+
});
|
|
31305
|
+
});
|
|
31306
|
+
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", `
|
|
31307
|
+
Examples:
|
|
31308
|
+
hyperline subscriptions-phases transition-subscription --id <id>
|
|
31309
|
+
hyperline subscriptions-phases transition-subscription --id <id> --transition-date <transition_date>
|
|
31310
|
+
hyperline subscriptions-phases transition-subscription --id <id> --output json`).action(async (opts) => {
|
|
31311
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31312
|
+
if (!ctx) {
|
|
31313
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31314
|
+
process.exit(1);
|
|
31315
|
+
}
|
|
31316
|
+
const args = {};
|
|
31317
|
+
if (opts.id !== void 0)
|
|
31318
|
+
args.id = opts.id;
|
|
31319
|
+
if (opts.transitionDate !== void 0)
|
|
31320
|
+
args.transition_date = opts.transitionDate;
|
|
31321
|
+
await ctx.execute({
|
|
31322
|
+
method: "POST",
|
|
31323
|
+
path: "/v2/subscriptions/{id}/next-phase",
|
|
31324
|
+
args,
|
|
31325
|
+
queryParamKeys: []
|
|
31326
|
+
});
|
|
31327
|
+
});
|
|
31328
|
+
}
|
|
31329
|
+
|
|
31330
|
+
// build/commands/generated/subscriptions-templates.js
|
|
31331
|
+
function registerSubscriptions_TemplatesCommands(parent) {
|
|
31332
|
+
const resource = parent.command("subscriptions-templates").description("Manage subscriptions > templates");
|
|
31333
|
+
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", `
|
|
31334
|
+
Examples:
|
|
31335
|
+
hyperline subscriptions-templates list-subscription-templates
|
|
31336
|
+
hyperline subscriptions-templates list-subscription-templates --take <take>`).action(async (opts) => {
|
|
31337
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31338
|
+
if (!ctx) {
|
|
31339
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31340
|
+
process.exit(1);
|
|
31341
|
+
}
|
|
31342
|
+
const args = {};
|
|
31343
|
+
if (opts.take !== void 0)
|
|
31344
|
+
args.take = Number(opts.take);
|
|
31345
|
+
if (opts.skip !== void 0)
|
|
31346
|
+
args.skip = Number(opts.skip);
|
|
31347
|
+
await ctx.execute({
|
|
31348
|
+
method: "GET",
|
|
31349
|
+
path: "/v1/subscriptions/templates",
|
|
31350
|
+
args,
|
|
31351
|
+
queryParamKeys: ["take", "skip"]
|
|
31352
|
+
});
|
|
31353
|
+
});
|
|
31354
|
+
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", `
|
|
31355
|
+
Examples:
|
|
31356
|
+
hyperline subscriptions-templates get-subscription-template --id <id>`).action(async (opts) => {
|
|
31357
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
31358
|
+
if (!ctx) {
|
|
31359
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
31360
|
+
process.exit(1);
|
|
31361
|
+
}
|
|
31362
|
+
const args = {};
|
|
31363
|
+
if (opts.id !== void 0)
|
|
31364
|
+
args.id = opts.id;
|
|
31365
|
+
await ctx.execute({
|
|
31366
|
+
method: "GET",
|
|
31367
|
+
path: "/v1/subscriptions/templates/{id}",
|
|
31368
|
+
args,
|
|
31369
|
+
queryParamKeys: []
|
|
31370
|
+
});
|
|
31371
|
+
});
|
|
31372
|
+
}
|
|
31373
|
+
|
|
31374
|
+
// build/commands/generated/subscriptions-transitions.js
|
|
31375
|
+
function registerSubscriptions_TransitionsCommands(parent) {
|
|
31376
|
+
const resource = parent.command("subscriptions-transitions").description("Manage subscriptions > transitions");
|
|
31101
31377
|
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
31378
|
Examples:
|
|
31103
|
-
hyperline subscriptions list-subscription-transitions
|
|
31104
|
-
hyperline subscriptions list-subscription-transitions --take <take> --status <status>`).action(async (opts) => {
|
|
31379
|
+
hyperline subscriptions-transitions list-subscription-transitions
|
|
31380
|
+
hyperline subscriptions-transitions list-subscription-transitions --take <take> --status <status>`).action(async (opts) => {
|
|
31105
31381
|
const ctx = resource.parent?.opts()._ctx;
|
|
31106
31382
|
if (!ctx) {
|
|
31107
31383
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31254,180 +31530,11 @@ Examples:
|
|
|
31254
31530
|
]
|
|
31255
31531
|
});
|
|
31256
31532
|
});
|
|
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", `
|
|
31317
|
-
Examples:
|
|
31318
|
-
hyperline subscriptions refresh-subscription-seat-products --id <id>
|
|
31319
|
-
hyperline subscriptions refresh-subscription-seat-products --id <id> --output json`).action(async (opts) => {
|
|
31320
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
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", `
|
|
31533
|
+
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", `
|
|
31405
31534
|
Examples:
|
|
31406
|
-
hyperline subscriptions transition --id <
|
|
31407
|
-
hyperline subscriptions transition --id <
|
|
31408
|
-
hyperline subscriptions transition --id <
|
|
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) => {
|
|
31535
|
+
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
31536
|
+
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>
|
|
31537
|
+
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
31538
|
const ctx = resource.parent?.opts()._ctx;
|
|
31432
31539
|
if (!ctx) {
|
|
31433
31540
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31457,7 +31564,7 @@ Examples:
|
|
|
31457
31564
|
});
|
|
31458
31565
|
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
31566
|
Examples:
|
|
31460
|
-
hyperline subscriptions get-subscription-transition --id <id>`).action(async (opts) => {
|
|
31567
|
+
hyperline subscriptions-transitions get-subscription-transition --id <id>`).action(async (opts) => {
|
|
31461
31568
|
const ctx = resource.parent?.opts()._ctx;
|
|
31462
31569
|
if (!ctx) {
|
|
31463
31570
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31475,8 +31582,8 @@ Examples:
|
|
|
31475
31582
|
});
|
|
31476
31583
|
resource.command("cancel-subscription-transition").description(`Cancel a scheduled subscription transition before it is applied.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
31477
31584
|
Examples:
|
|
31478
|
-
hyperline subscriptions cancel-subscription-transition --id <id>
|
|
31479
|
-
hyperline subscriptions cancel-subscription-transition --id <id> --output json`).action(async (opts) => {
|
|
31585
|
+
hyperline subscriptions-transitions cancel-subscription-transition --id <id>
|
|
31586
|
+
hyperline subscriptions-transitions cancel-subscription-transition --id <id> --output json`).action(async (opts) => {
|
|
31480
31587
|
const ctx = resource.parent?.opts()._ctx;
|
|
31481
31588
|
if (!ctx) {
|
|
31482
31589
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -31492,71 +31599,6 @@ Examples:
|
|
|
31492
31599
|
queryParamKeys: []
|
|
31493
31600
|
});
|
|
31494
31601
|
});
|
|
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
31602
|
}
|
|
31561
31603
|
|
|
31562
31604
|
// build/commands/generated/taxes.js
|
|
@@ -32111,6 +32153,8 @@ function registerAllCommands(program2) {
|
|
|
32111
32153
|
registerQuotesCommands(program2);
|
|
32112
32154
|
registerSubscriptionsCommands(program2);
|
|
32113
32155
|
registerSubscriptions_TemplatesCommands(program2);
|
|
32156
|
+
registerSubscriptions_TransitionsCommands(program2);
|
|
32157
|
+
registerSubscriptions_PhasesCommands(program2);
|
|
32114
32158
|
registerTaxesCommands(program2);
|
|
32115
32159
|
registerWalletsCommands(program2);
|
|
32116
32160
|
registerWebhooksCommands(program2);
|
|
@@ -32694,7 +32738,7 @@ function $constructor(name, initializer3, params) {
|
|
|
32694
32738
|
Object.defineProperty(_, "name", { value: name });
|
|
32695
32739
|
return _;
|
|
32696
32740
|
}
|
|
32697
|
-
var $brand = Symbol("zod_brand");
|
|
32741
|
+
var $brand = /* @__PURE__ */ Symbol("zod_brand");
|
|
32698
32742
|
var $ZodAsyncError = class extends Error {
|
|
32699
32743
|
constructor() {
|
|
32700
32744
|
super(`Encountered Promise during synchronous parse. Use .parseAsync() instead.`);
|
|
@@ -32841,7 +32885,7 @@ function floatSafeRemainder(val, step) {
|
|
|
32841
32885
|
const stepInt = Number.parseInt(step.toFixed(decCount).replace(".", ""));
|
|
32842
32886
|
return valInt % stepInt / 10 ** decCount;
|
|
32843
32887
|
}
|
|
32844
|
-
var EVALUATING = Symbol("evaluating");
|
|
32888
|
+
var EVALUATING = /* @__PURE__ */ Symbol("evaluating");
|
|
32845
32889
|
function defineLazy(object2, key, getter) {
|
|
32846
32890
|
let value = void 0;
|
|
32847
32891
|
Object.defineProperty(object2, key, {
|
|
@@ -41914,8 +41958,8 @@ function yo_default() {
|
|
|
41914
41958
|
|
|
41915
41959
|
// ../../node_modules/zod/v4/core/registries.js
|
|
41916
41960
|
var _a;
|
|
41917
|
-
var $output = Symbol("ZodOutput");
|
|
41918
|
-
var $input = Symbol("ZodInput");
|
|
41961
|
+
var $output = /* @__PURE__ */ Symbol("ZodOutput");
|
|
41962
|
+
var $input = /* @__PURE__ */ Symbol("ZodInput");
|
|
41919
41963
|
var $ZodRegistry = class {
|
|
41920
41964
|
constructor() {
|
|
41921
41965
|
this._map = /* @__PURE__ */ new WeakMap();
|
|
@@ -42952,7 +42996,7 @@ function _stringbool(Classes, _params) {
|
|
|
42952
42996
|
type: "pipe",
|
|
42953
42997
|
in: stringSchema,
|
|
42954
42998
|
out: booleanSchema,
|
|
42955
|
-
transform: (input, payload) => {
|
|
42999
|
+
transform: ((input, payload) => {
|
|
42956
43000
|
let data = input;
|
|
42957
43001
|
if (params.case !== "sensitive")
|
|
42958
43002
|
data = data.toLowerCase();
|
|
@@ -42971,14 +43015,14 @@ function _stringbool(Classes, _params) {
|
|
|
42971
43015
|
});
|
|
42972
43016
|
return {};
|
|
42973
43017
|
}
|
|
42974
|
-
},
|
|
42975
|
-
reverseTransform: (input, _payload) => {
|
|
43018
|
+
}),
|
|
43019
|
+
reverseTransform: ((input, _payload) => {
|
|
42976
43020
|
if (input === true) {
|
|
42977
43021
|
return truthyArray[0] || "true";
|
|
42978
43022
|
} else {
|
|
42979
43023
|
return falsyArray[0] || "false";
|
|
42980
43024
|
}
|
|
42981
|
-
},
|
|
43025
|
+
}),
|
|
42982
43026
|
error: params.error
|
|
42983
43027
|
});
|
|
42984
43028
|
return codec2;
|
|
@@ -44306,10 +44350,10 @@ var ZodType = /* @__PURE__ */ $constructor("ZodType", (inst, def) => {
|
|
|
44306
44350
|
inst.with = inst.check;
|
|
44307
44351
|
inst.clone = (def2, params) => clone(inst, def2, params);
|
|
44308
44352
|
inst.brand = () => inst;
|
|
44309
|
-
inst.register = (reg, meta3) => {
|
|
44353
|
+
inst.register = ((reg, meta3) => {
|
|
44310
44354
|
reg.add(inst, meta3);
|
|
44311
44355
|
return inst;
|
|
44312
|
-
};
|
|
44356
|
+
});
|
|
44313
44357
|
inst.parse = (data, params) => parse2(inst, data, params, { callee: inst.parse });
|
|
44314
44358
|
inst.safeParse = (data, params) => safeParse2(inst, data, params);
|
|
44315
44359
|
inst.parseAsync = async (data, params) => parseAsync2(inst, data, params, { callee: inst.parseAsync });
|
|
@@ -46997,7 +47041,7 @@ function cosine(Ctor, x) {
|
|
|
46997
47041
|
Ctor.precision -= k;
|
|
46998
47042
|
return x;
|
|
46999
47043
|
}
|
|
47000
|
-
var divide = /* @__PURE__ */ function() {
|
|
47044
|
+
var divide = /* @__PURE__ */ (function() {
|
|
47001
47045
|
function multiplyInteger(x, k, base) {
|
|
47002
47046
|
var temp, carry = 0, i = x.length;
|
|
47003
47047
|
for (x = x.slice(); i--; ) {
|
|
@@ -47155,7 +47199,7 @@ var divide = /* @__PURE__ */ function() {
|
|
|
47155
47199
|
}
|
|
47156
47200
|
return q;
|
|
47157
47201
|
};
|
|
47158
|
-
}();
|
|
47202
|
+
})();
|
|
47159
47203
|
function finalise(x, sd, rm, isTruncated) {
|
|
47160
47204
|
var digits, i, j, k, rd, roundUp, w, xd, xdi, Ctor = x.constructor;
|
|
47161
47205
|
out: if (sd != null) {
|
|
@@ -48112,7 +48156,7 @@ function tanh(x) {
|
|
|
48112
48156
|
function trunc(x) {
|
|
48113
48157
|
return finalise(x = new this(x), x.e + 1, 1);
|
|
48114
48158
|
}
|
|
48115
|
-
P[Symbol.for("nodejs.util.inspect.custom")] = P.toString;
|
|
48159
|
+
P[/* @__PURE__ */ Symbol.for("nodejs.util.inspect.custom")] = P.toString;
|
|
48116
48160
|
P[Symbol.toStringTag] = "Decimal";
|
|
48117
48161
|
var Decimal = P.constructor = clone2(DEFAULTS);
|
|
48118
48162
|
LN10 = new Decimal(LN10);
|
|
@@ -51114,7 +51158,7 @@ var toLogRequest = (config4) => {
|
|
|
51114
51158
|
url: config4.url ?? "",
|
|
51115
51159
|
path: config4.url ?? "",
|
|
51116
51160
|
hostname: config4.baseURL ?? "",
|
|
51117
|
-
originalUrl: `${config4.baseURL}${config4.url}`,
|
|
51161
|
+
originalUrl: `${config4.baseURL ?? ""}${config4.url}`,
|
|
51118
51162
|
body: config4.data,
|
|
51119
51163
|
headers: {}
|
|
51120
51164
|
};
|
|
@@ -51159,8 +51203,8 @@ var PathParamError = class extends Error {
|
|
|
51159
51203
|
missingKeys;
|
|
51160
51204
|
constructor(missingKeys) {
|
|
51161
51205
|
super(`Missing required path parameter${missingKeys.length > 1 ? "s" : ""}: ${missingKeys.join(", ")}`);
|
|
51162
|
-
this.missingKeys = missingKeys;
|
|
51163
51206
|
this.name = "PathParamError";
|
|
51207
|
+
this.missingKeys = missingKeys;
|
|
51164
51208
|
}
|
|
51165
51209
|
};
|
|
51166
51210
|
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.30cad46",
|
|
4
4
|
"description": "Agent-first CLI for Hyperline API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -46,9 +46,9 @@
|
|
|
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",
|