@hyperline/cli 0.1.0-build.1.5ddb1b1 → 0.1.0-build.1.5e73d8d
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 +13 -5
- package/package.json +1 -1
|
@@ -41392,18 +41392,18 @@ Examples:
|
|
|
41392
41392
|
// build/commands/generated/quotes.js
|
|
41393
41393
|
function registerQuotesCommands(parent) {
|
|
41394
41394
|
const resource = parent.command("quotes").description("Manage quotes");
|
|
41395
|
-
resource.command("create").description(`Create a new quote for a customer
|
|
41395
|
+
resource.command("create").description(`Create a new quote for a customer. Use \`subscription\` (or \`template_id\`) for subscription quotes; use \`invoice\` for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.`).option("--status <value>", `
|
|
41396
41396
|
Quote status.
|
|
41397
41397
|
|
|
41398
41398
|
- \`draft\`: The quote is a draft.
|
|
41399
41399
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
41400
41400
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
41401
|
-
`).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.
|
|
41401
|
+
`).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. For subscription quotes, defaults to the computed subscription value if not specified. For one-off quotes, this field is ignored \u2014 the amount is always derived from the linked invoice's \`amount_excluding_tax\`.`).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.
|
|
41402
41402
|
|
|
41403
41403
|
- \`all\`: Display all pricing tiers.
|
|
41404
41404
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41405
41405
|
- \`none\`: Hide all pricing tiers.
|
|
41406
|
-
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--template-id <value>", `ID of the quote template. If not specified, a subscription configuration must be defined.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--subscription <value>", `Subscription configuration constituting the quote.`).addHelpText("after", `
|
|
41406
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--generate-draft-invoices <value>", `When \`true\`, the invoice issued after signature stays in \`draft\` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to \`false\`.`).option("--template-id <value>", `ID of the quote template. If not specified, a subscription configuration or an \`invoice\` payload must be defined.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--subscription <value>", `Subscription configuration constituting the quote.`).option("--invoice <value>", `Invoice configuration constituting the one-off quote. When provided, a draft invoice is created and linked to the quote. Cannot be combined with \`subscription\` or \`template_id\`.`).addHelpText("after", `
|
|
41407
41407
|
Examples:
|
|
41408
41408
|
hyperline quotes create --customer-id <customer_id>
|
|
41409
41409
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -41448,12 +41448,16 @@ Examples:
|
|
|
41448
41448
|
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41449
41449
|
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41450
41450
|
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41451
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41452
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41451
41453
|
if (opts.templateId !== void 0)
|
|
41452
41454
|
args.template_id = opts.templateId;
|
|
41453
41455
|
if (opts.expiresAt !== void 0)
|
|
41454
41456
|
args.expires_at = opts.expiresAt;
|
|
41455
41457
|
if (opts.subscription !== void 0)
|
|
41456
41458
|
args.subscription = opts.subscription;
|
|
41459
|
+
if (opts.invoice !== void 0)
|
|
41460
|
+
args.invoice = opts.invoice;
|
|
41457
41461
|
if (opts.amount !== void 0)
|
|
41458
41462
|
args.amount = Number(opts.amount);
|
|
41459
41463
|
await ctx.execute({
|
|
@@ -41682,12 +41686,12 @@ Examples:
|
|
|
41682
41686
|
queryParamKeys: []
|
|
41683
41687
|
});
|
|
41684
41688
|
});
|
|
41685
|
-
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass subscription to create or replace the draft subscription configuration
|
|
41689
|
+
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass \`subscription\` to create or replace the draft subscription configuration, or pass \`invoice\` on a one-off quote to replace the linked draft invoice.`).requiredOption("--id <value>", `id parameter`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. Set to \`null\` to clear the manually set value.`).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.
|
|
41686
41690
|
|
|
41687
41691
|
- \`all\`: Display all pricing tiers.
|
|
41688
41692
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41689
41693
|
- \`none\`: Hide all pricing tiers.
|
|
41690
|
-
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <value>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).addHelpText("after", `
|
|
41694
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--generate-draft-invoices <value>", `When \`true\`, the invoice issued after signature stays in \`draft\` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to \`false\`.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <value>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).option("--invoice <value>", `Invoice configuration constituting the one-off quote. When provided on a draft one-off quote, it deletes the previous draft invoice and creates a fresh one linked to the quote. \`invoice.invoicing_entity_id\` is ignored on update \u2014 the quote's existing invoicing entity is reused.`).addHelpText("after", `
|
|
41691
41695
|
Examples:
|
|
41692
41696
|
hyperline quotes update --id <id>
|
|
41693
41697
|
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
@@ -41728,10 +41732,14 @@ Examples:
|
|
|
41728
41732
|
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41729
41733
|
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41730
41734
|
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41735
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41736
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41731
41737
|
if (opts.expiresAt !== void 0)
|
|
41732
41738
|
args.expires_at = opts.expiresAt;
|
|
41733
41739
|
if (opts.subscription !== void 0)
|
|
41734
41740
|
args.subscription = opts.subscription;
|
|
41741
|
+
if (opts.invoice !== void 0)
|
|
41742
|
+
args.invoice = opts.invoice;
|
|
41735
41743
|
if (opts.amount !== void 0)
|
|
41736
41744
|
args.amount = Number(opts.amount);
|
|
41737
41745
|
await ctx.execute({
|