@hyperline/cli 0.1.0-build.1.c1d7f34 → 0.1.0-build.1.cd81113
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 +62 -3
- package/package.json +1 -1
|
@@ -38744,7 +38744,7 @@ Customer type.
|
|
|
38744
38744
|
- \`corporate\`: The customer is a business entity.
|
|
38745
38745
|
- \`person\`: The customer is a natural person.
|
|
38746
38746
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38747
|
-
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment
|
|
38747
|
+
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38748
38748
|
How customer invoices are issued from the parent organisation.
|
|
38749
38749
|
|
|
38750
38750
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -38863,7 +38863,7 @@ Customer type.
|
|
|
38863
38863
|
- \`corporate\`: The customer is a business entity.
|
|
38864
38864
|
- \`person\`: The customer is a natural person.
|
|
38865
38865
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38866
|
-
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--payment-method-id <value>", `ID of the default payment method of the customer. Only applies to card and direct debit.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment
|
|
38866
|
+
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--payment-method-id <value>", `ID of the default payment method of the customer. Only applies to card and direct debit.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38867
38867
|
How customer invoices are issued from the parent organisation.
|
|
38868
38868
|
|
|
38869
38869
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -41674,6 +41674,65 @@ Examples:
|
|
|
41674
41674
|
queryParamKeys: []
|
|
41675
41675
|
});
|
|
41676
41676
|
});
|
|
41677
|
+
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 attached to the quote.`).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.
|
|
41678
|
+
|
|
41679
|
+
- \`all\`: Display all pricing tiers.
|
|
41680
|
+
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41681
|
+
- \`none\`: Hide all pricing tiers.
|
|
41682
|
+
`).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", `
|
|
41683
|
+
Examples:
|
|
41684
|
+
hyperline quotes update --id <id>
|
|
41685
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
41686
|
+
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
41687
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41688
|
+
if (!ctx) {
|
|
41689
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41690
|
+
process.exit(1);
|
|
41691
|
+
}
|
|
41692
|
+
const args = {};
|
|
41693
|
+
if (opts.id !== void 0)
|
|
41694
|
+
args.id = opts.id;
|
|
41695
|
+
if (opts.ownerEmail !== void 0)
|
|
41696
|
+
args.owner_email = opts.ownerEmail;
|
|
41697
|
+
if (opts.comments !== void 0)
|
|
41698
|
+
args.comments = opts.comments;
|
|
41699
|
+
if (opts.terms !== void 0)
|
|
41700
|
+
args.terms = opts.terms;
|
|
41701
|
+
if (opts.collectPaymentDetails !== void 0)
|
|
41702
|
+
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41703
|
+
if (opts.collectCustomPropertyIds !== void 0)
|
|
41704
|
+
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41705
|
+
if (opts.requireTaxId !== void 0)
|
|
41706
|
+
args.require_tax_id = opts.requireTaxId;
|
|
41707
|
+
if (opts.displayQuoteValue !== void 0)
|
|
41708
|
+
args.display_quote_value = opts.displayQuoteValue;
|
|
41709
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
41710
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
41711
|
+
if (opts.displayTaxes !== void 0)
|
|
41712
|
+
args.display_taxes = opts.displayTaxes;
|
|
41713
|
+
if (opts.displayPriceTiers !== void 0)
|
|
41714
|
+
args.display_price_tiers = opts.displayPriceTiers;
|
|
41715
|
+
if (opts.displayPhaseValue !== void 0)
|
|
41716
|
+
args.display_phase_value = opts.displayPhaseValue;
|
|
41717
|
+
if (opts.displayFirstInvoiceAmount !== void 0)
|
|
41718
|
+
args.display_first_invoice_amount = opts.displayFirstInvoiceAmount;
|
|
41719
|
+
if (opts.displayDocumentsInPreview !== void 0)
|
|
41720
|
+
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41721
|
+
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41722
|
+
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41723
|
+
if (opts.expiresAt !== void 0)
|
|
41724
|
+
args.expires_at = opts.expiresAt;
|
|
41725
|
+
if (opts.subscription !== void 0)
|
|
41726
|
+
args.subscription = opts.subscription;
|
|
41727
|
+
if (opts.amount !== void 0)
|
|
41728
|
+
args.amount = Number(opts.amount);
|
|
41729
|
+
await ctx.execute({
|
|
41730
|
+
method: "PATCH",
|
|
41731
|
+
path: "/v1/quotes/{id}",
|
|
41732
|
+
args,
|
|
41733
|
+
queryParamKeys: []
|
|
41734
|
+
});
|
|
41735
|
+
});
|
|
41677
41736
|
resource.command("download").description(`Download the PDF of a quote. Supports locale parameter for localization.`).requiredOption("--id <value>", `id parameter`).option("--locale <value>", `locale`).addHelpText("after", `
|
|
41678
41737
|
Examples:
|
|
41679
41738
|
hyperline quotes download --id <id>
|
|
@@ -42401,7 +42460,7 @@ Examples:
|
|
|
42401
42460
|
queryParamKeys: []
|
|
42402
42461
|
});
|
|
42403
42462
|
});
|
|
42404
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons.
|
|
42463
|
+
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Draft quote subscription configuration must be updated through PATCH /v1/quotes/{id}.`).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>", `
|
|
42405
42464
|
Defines when invoices are generated relative to the billing period.
|
|
42406
42465
|
|
|
42407
42466
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|