@hyperline/cli 0.1.0-build.1.d661ec4 → 0.1.0-build.1.d791b2b
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 +91 -1
- package/package.json +1 -1
|
@@ -39116,6 +39116,38 @@ Examples:
|
|
|
39116
39116
|
queryParamKeys: []
|
|
39117
39117
|
});
|
|
39118
39118
|
});
|
|
39119
|
+
resource.command("get-customer-arr-history").description(`List every subscription-level ARR evolution for a customer, including previous and current fixed, variable, and total annual values in each subscription currency. Results are latest-first and paginated with limit/cursor.`).requiredOption("--id <value>", `id parameter`).option("--limit <number>", `Maximum number of items to return (1-100).`).option("--cursor <value>", `Opaque cursor returned in the previous response's \`next_cursor\`. Omit to fetch the first page.`).option("--occurred-at.gte <value>", `Return evolutions that occurred at or after this UTC date and time.`).option("--occurred-at.lte <value>", `Return evolutions that occurred at or before this UTC date and time.`).addHelpText("after", `
|
|
39120
|
+
Examples:
|
|
39121
|
+
hyperline customers get-customer-arr-history --id <id>
|
|
39122
|
+
hyperline customers get-customer-arr-history --id <id> --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
39123
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
39124
|
+
if (!ctx) {
|
|
39125
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
39126
|
+
process.exit(1);
|
|
39127
|
+
}
|
|
39128
|
+
const args = {};
|
|
39129
|
+
if (opts.id !== void 0)
|
|
39130
|
+
args.id = opts.id;
|
|
39131
|
+
if (opts.cursor !== void 0)
|
|
39132
|
+
args.cursor = opts.cursor;
|
|
39133
|
+
if (opts["occurredAt.gte"] !== void 0)
|
|
39134
|
+
args.occurred_at__gte = opts["occurredAt.gte"];
|
|
39135
|
+
if (opts["occurredAt.lte"] !== void 0)
|
|
39136
|
+
args.occurred_at__lte = opts["occurredAt.lte"];
|
|
39137
|
+
if (opts.limit !== void 0)
|
|
39138
|
+
args.limit = Number(opts.limit);
|
|
39139
|
+
await ctx.execute({
|
|
39140
|
+
method: "GET",
|
|
39141
|
+
path: "/v1/customers/{id}/arr-history",
|
|
39142
|
+
args,
|
|
39143
|
+
queryParamKeys: [
|
|
39144
|
+
"limit",
|
|
39145
|
+
"cursor",
|
|
39146
|
+
"occurred_at__gte",
|
|
39147
|
+
"occurred_at__lte"
|
|
39148
|
+
]
|
|
39149
|
+
});
|
|
39150
|
+
});
|
|
39119
39151
|
resource.command("get-customer-valuation").description(`Compute aggregated valuation metrics for a customer across all active subscriptions, grouped by currency. Returns contract value, recurring contract value, and ARR for each subscription and aggregated totals. 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", `
|
|
39120
39152
|
Examples:
|
|
39121
39153
|
hyperline customers get-customer-valuation --id <id>
|
|
@@ -40469,7 +40501,7 @@ Examples:
|
|
|
40469
40501
|
queryParamKeys: []
|
|
40470
40502
|
});
|
|
40471
40503
|
});
|
|
40472
|
-
resource.command("update").description(`Update an invoice. Draft/grace_period allow modifying line items, dates, and metadata before finalization. Finalized invoices are restricted to metadata (paid: custom_note; uncollectible: properties/custom_note/custom_properties).`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Type of the invoice.
|
|
40504
|
+
resource.command("update").description(`Update an invoice. Draft/grace_period allow modifying line items, dates, and metadata before finalization. Finalized invoices are restricted to metadata (paid: custom_note/purchase_order; uncollectible: properties/custom_note/custom_properties).`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Type of the invoice.
|
|
40473
40505
|
|
|
40474
40506
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
40475
40507
|
- \`credit_note\`: Legal credit note cancelling an invoice and refunding your customer.
|
|
@@ -41425,6 +41457,32 @@ Examples:
|
|
|
41425
41457
|
queryParamKeys: []
|
|
41426
41458
|
});
|
|
41427
41459
|
});
|
|
41460
|
+
resource.command("delete").description(`Permanently delete an archived product by ID. Products attached to subscriptions, plans, or templates cannot be deleted.`).requiredOption("--id <value>", `id parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
41461
|
+
Examples:
|
|
41462
|
+
hyperline products delete --id <id>
|
|
41463
|
+
hyperline products delete --id <id> --output json`).action(async (opts) => {
|
|
41464
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41465
|
+
if (!ctx) {
|
|
41466
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41467
|
+
process.exit(1);
|
|
41468
|
+
}
|
|
41469
|
+
const args = {};
|
|
41470
|
+
if (opts.id !== void 0)
|
|
41471
|
+
args.id = opts.id;
|
|
41472
|
+
if (!opts.yes) {
|
|
41473
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41474
|
+
if (!confirmed) {
|
|
41475
|
+
process.stdout.write("Aborted.\n");
|
|
41476
|
+
return;
|
|
41477
|
+
}
|
|
41478
|
+
}
|
|
41479
|
+
await ctx.execute({
|
|
41480
|
+
method: "DELETE",
|
|
41481
|
+
path: "/v1/products/{id}",
|
|
41482
|
+
args,
|
|
41483
|
+
queryParamKeys: []
|
|
41484
|
+
});
|
|
41485
|
+
});
|
|
41428
41486
|
resource.command("unarchive").description(`Restore a previously archived product, making it available for new subscriptions again.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
41429
41487
|
Examples:
|
|
41430
41488
|
hyperline products unarchive --id <id>
|
|
@@ -42765,6 +42823,38 @@ Examples:
|
|
|
42765
42823
|
queryParamKeys: []
|
|
42766
42824
|
});
|
|
42767
42825
|
});
|
|
42826
|
+
resource.command("get-subscription-arr-history").description(`List every ARR evolution for a subscription, including previous and current fixed, variable, and total annual values in the subscription currency. Results are latest-first and paginated with limit/cursor.`).requiredOption("--id <value>", `id parameter`).option("--limit <number>", `Maximum number of items to return (1-100).`).option("--cursor <value>", `Opaque cursor returned in the previous response's \`next_cursor\`. Omit to fetch the first page.`).option("--occurred-at.gte <value>", `Return evolutions that occurred at or after this UTC date and time.`).option("--occurred-at.lte <value>", `Return evolutions that occurred at or before this UTC date and time.`).addHelpText("after", `
|
|
42827
|
+
Examples:
|
|
42828
|
+
hyperline subscriptions get-subscription-arr-history --id <id>
|
|
42829
|
+
hyperline subscriptions get-subscription-arr-history --id <id> --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
42830
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
42831
|
+
if (!ctx) {
|
|
42832
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
42833
|
+
process.exit(1);
|
|
42834
|
+
}
|
|
42835
|
+
const args = {};
|
|
42836
|
+
if (opts.id !== void 0)
|
|
42837
|
+
args.id = opts.id;
|
|
42838
|
+
if (opts.cursor !== void 0)
|
|
42839
|
+
args.cursor = opts.cursor;
|
|
42840
|
+
if (opts["occurredAt.gte"] !== void 0)
|
|
42841
|
+
args.occurred_at__gte = opts["occurredAt.gte"];
|
|
42842
|
+
if (opts["occurredAt.lte"] !== void 0)
|
|
42843
|
+
args.occurred_at__lte = opts["occurredAt.lte"];
|
|
42844
|
+
if (opts.limit !== void 0)
|
|
42845
|
+
args.limit = Number(opts.limit);
|
|
42846
|
+
await ctx.execute({
|
|
42847
|
+
method: "GET",
|
|
42848
|
+
path: "/v1/subscriptions/{id}/arr-history",
|
|
42849
|
+
args,
|
|
42850
|
+
queryParamKeys: [
|
|
42851
|
+
"limit",
|
|
42852
|
+
"cursor",
|
|
42853
|
+
"occurred_at__gte",
|
|
42854
|
+
"occurred_at__lte"
|
|
42855
|
+
]
|
|
42856
|
+
});
|
|
42857
|
+
});
|
|
42768
42858
|
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", `
|
|
42769
42859
|
Examples:
|
|
42770
42860
|
hyperline subscriptions get-subscription-valuation --id <id>
|