@hyperline/cli 0.1.0-build.1.359209 → 0.1.0-build.1.3592c94
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 +130 -29
- package/package.json +1 -1
|
@@ -40673,9 +40673,88 @@ Examples:
|
|
|
40673
40673
|
});
|
|
40674
40674
|
}
|
|
40675
40675
|
|
|
40676
|
+
// build/commands/generated/approval-requests.js
|
|
40677
|
+
function registerApproval_RequestsCommands(parent) {
|
|
40678
|
+
const resource = parent.command("approval-requests").description("Manage approval > requests");
|
|
40679
|
+
resource.command("get").description(`Retrieve an approval request and its decisions.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
40680
|
+
Examples:
|
|
40681
|
+
hyperline approval-requests get --id <id>`).action(async (opts) => {
|
|
40682
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40683
|
+
if (!ctx) {
|
|
40684
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40685
|
+
process.exit(1);
|
|
40686
|
+
}
|
|
40687
|
+
const args = {};
|
|
40688
|
+
if (opts.id !== void 0)
|
|
40689
|
+
args.id = opts.id;
|
|
40690
|
+
await ctx.execute({
|
|
40691
|
+
method: "GET",
|
|
40692
|
+
path: "/v1/approvals/requests/{id}",
|
|
40693
|
+
args,
|
|
40694
|
+
queryParamKeys: []
|
|
40695
|
+
});
|
|
40696
|
+
});
|
|
40697
|
+
resource.command("approve").description(`Approve the current step of an approval request.`).requiredOption("--id <value>", `id parameter`).requiredOption("--step-id <value>", `Expected current workflow step ID. A stale step is rejected instead of deciding the next step.`).option("--approver-id <value>", `Identifier of the account member making the decision. Supply exactly one of approver_id or approver_email. With a user token, this must be the authenticated user.`).option("--comment <value>", `Decision comment. Required and nonblank when rejecting; optional when approving. Trimmed, with a maximum of 2000 characters.`).option("--approver-email <value>", `Email of the account member making the decision, matched case-insensitively. Supply exactly one of approver_id or approver_email. With a user token, this must be the authenticated user.`).addHelpText("after", `
|
|
40698
|
+
Examples:
|
|
40699
|
+
hyperline approval-requests approve --id <id> --step-id <step_id>
|
|
40700
|
+
hyperline approval-requests approve --id <id> --step-id <step_id> --approver-id <approver_id> --comment <comment>
|
|
40701
|
+
hyperline approval-requests approve --id <id> --step-id <step_id> --output json`).action(async (opts) => {
|
|
40702
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40703
|
+
if (!ctx) {
|
|
40704
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40705
|
+
process.exit(1);
|
|
40706
|
+
}
|
|
40707
|
+
const args = {};
|
|
40708
|
+
if (opts.id !== void 0)
|
|
40709
|
+
args.id = opts.id;
|
|
40710
|
+
if (opts.stepId !== void 0)
|
|
40711
|
+
args.step_id = opts.stepId;
|
|
40712
|
+
if (opts.approverId !== void 0)
|
|
40713
|
+
args.approver_id = opts.approverId;
|
|
40714
|
+
if (opts.comment !== void 0)
|
|
40715
|
+
args.comment = opts.comment;
|
|
40716
|
+
if (opts.approverEmail !== void 0)
|
|
40717
|
+
args.approver_email = opts.approverEmail;
|
|
40718
|
+
await ctx.execute({
|
|
40719
|
+
method: "POST",
|
|
40720
|
+
path: "/v1/approvals/requests/{id}/approve",
|
|
40721
|
+
args,
|
|
40722
|
+
queryParamKeys: []
|
|
40723
|
+
});
|
|
40724
|
+
});
|
|
40725
|
+
resource.command("reject").description(`Reject an approval request with a required comment.`).requiredOption("--id <value>", `id parameter`).requiredOption("--step-id <value>", `Expected current workflow step ID. A stale step is rejected instead of deciding the next step.`).option("--approver-id <value>", `Identifier of the account member making the decision. Supply exactly one of approver_id or approver_email. With a user token, this must be the authenticated user.`).requiredOption("--comment <value>", `Decision comment. Required and nonblank when rejecting; optional when approving. Trimmed, with a maximum of 2000 characters.`).option("--approver-email <value>", `Email of the account member making the decision, matched case-insensitively. Supply exactly one of approver_id or approver_email. With a user token, this must be the authenticated user.`).addHelpText("after", `
|
|
40726
|
+
Examples:
|
|
40727
|
+
hyperline approval-requests reject --id <id> --step-id <step_id> --comment <comment>
|
|
40728
|
+
hyperline approval-requests reject --id <id> --step-id <step_id> --comment <comment> --approver-id <approver_id> --approver-email <approver_email>
|
|
40729
|
+
hyperline approval-requests reject --id <id> --step-id <step_id> --comment <comment> --output json`).action(async (opts) => {
|
|
40730
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40731
|
+
if (!ctx) {
|
|
40732
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40733
|
+
process.exit(1);
|
|
40734
|
+
}
|
|
40735
|
+
const args = {};
|
|
40736
|
+
if (opts.id !== void 0)
|
|
40737
|
+
args.id = opts.id;
|
|
40738
|
+
if (opts.stepId !== void 0)
|
|
40739
|
+
args.step_id = opts.stepId;
|
|
40740
|
+
if (opts.approverId !== void 0)
|
|
40741
|
+
args.approver_id = opts.approverId;
|
|
40742
|
+
if (opts.comment !== void 0)
|
|
40743
|
+
args.comment = opts.comment;
|
|
40744
|
+
if (opts.approverEmail !== void 0)
|
|
40745
|
+
args.approver_email = opts.approverEmail;
|
|
40746
|
+
await ctx.execute({
|
|
40747
|
+
method: "POST",
|
|
40748
|
+
path: "/v1/approvals/requests/{id}/reject",
|
|
40749
|
+
args,
|
|
40750
|
+
queryParamKeys: []
|
|
40751
|
+
});
|
|
40752
|
+
});
|
|
40753
|
+
}
|
|
40754
|
+
|
|
40676
40755
|
// build/commands/generated/approval-workflows.js
|
|
40677
40756
|
function registerApproval_WorkflowsCommands(parent) {
|
|
40678
|
-
const resource = parent.command("approval-workflows").description("Manage approval workflows");
|
|
40757
|
+
const resource = parent.command("approval-workflows").description("Manage approval > workflows");
|
|
40679
40758
|
resource.command("list").description(`List approval workflows with their steps and approvers. Those whose \`applicable_flows\` include \`workflow_step\` can be picked as the \`approvalWorkflowId\` of a workflow's Request approval step (\`hyperline.request_approval\`). Filter with \`is_active\`; paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--is-active <value>", `Only return workflows matching this active state.`).addHelpText("after", `
|
|
40680
40759
|
Examples:
|
|
40681
40760
|
hyperline approval-workflows list
|
|
@@ -41997,7 +42076,7 @@ How customer invoices are issued from the parent organisation.
|
|
|
41997
42076
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
41998
42077
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
41999
42078
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
42000
|
-
`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--force-invoice-draft <value>", `Indicates if customer invoices should be created as draft invoices.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <json>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
42079
|
+
`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--consolidated-invoicing-enabled <value>", `Indicates if consolidated invoicing is enabled for the customer. When enabled, subscription invoices billed on the same day are grouped into a single invoice. Cannot be disabled while invoices are pending consolidation.`).option("--force-invoice-draft <value>", `Indicates if customer invoices should be created as draft invoices.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <json>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
42001
42080
|
Examples:
|
|
42002
42081
|
hyperline customers create-customer
|
|
42003
42082
|
hyperline customers create-customer --name <name> --type <type>
|
|
@@ -42042,6 +42121,8 @@ Examples:
|
|
|
42042
42121
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
42043
42122
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
42044
42123
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42124
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42125
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
42045
42126
|
if (opts.forceInvoiceDraft !== void 0)
|
|
42046
42127
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
42047
42128
|
if (opts.priceBookId !== void 0)
|
|
@@ -42134,7 +42215,7 @@ How customer invoices are issued from the parent organisation.
|
|
|
42134
42215
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
42135
42216
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
42136
42217
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
42137
|
-
`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--force-invoice-draft <value>", `Indicates if customer invoices should be created as draft invoices.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <json>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
42218
|
+
`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--consolidated-invoicing-enabled <value>", `Indicates if consolidated invoicing is enabled for the customer. When enabled, subscription invoices billed on the same day are grouped into a single invoice. Cannot be disabled while invoices are pending consolidation.`).option("--force-invoice-draft <value>", `Indicates if customer invoices should be created as draft invoices.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <json>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
42138
42219
|
Examples:
|
|
42139
42220
|
hyperline customers update --id <id>
|
|
42140
42221
|
hyperline customers update --id <id> --name <name> --type <type>
|
|
@@ -42183,6 +42264,8 @@ Examples:
|
|
|
42183
42264
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
42184
42265
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
42185
42266
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42267
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42268
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
42186
42269
|
if (opts.forceInvoiceDraft !== void 0)
|
|
42187
42270
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
42188
42271
|
if (opts.priceBookId !== void 0)
|
|
@@ -44093,7 +44176,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
44093
44176
|
|
|
44094
44177
|
- \`current\`: Use the current default payment method of the customer.
|
|
44095
44178
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
44096
|
-
`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--emitted-at <value>", `Issue date of the invoice.`).option("--due-at <value>", `Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.`).option("--settled-at <value>", `Date the invoice was fully paid.`).option("--issuing-method <value>", `Set to \`scheduled\` to finalize the draft invoice automatically on its issue date (\`emitted_at\`), resolved to the start of that day in the customer timezone. Requires \`status\` to be \`draft\` and an issue date after today. Default to \`manual\`.`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).option("--additional-display-fields <json>", `Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.`).requiredOption("--line-items <json>", `line_items`).option("--transactions <json>", `transactions`).option("--coupons <json>", `coupons`).addHelpText("after", `
|
|
44179
|
+
`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--emitted-at <value>", `Issue date of the invoice.`).option("--due-at <value>", `Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.`).option("--settled-at <value>", `Date the invoice was fully paid.`).option("--issuing-method <value>", `Set to \`scheduled\` to finalize the draft invoice automatically on its issue date (\`emitted_at\`), resolved to the start of that day in the customer timezone. Requires \`status\` to be \`draft\` and an issue date after today. Default to \`manual\`.`).option("--send-email", `Whether to send the paid invoice or credit note email when creating with \`status: paid\` (the default status). Defaults to true and respects existing email settings. Set to false to suppress this email without suppressing lifecycle events or webhooks. Does not affect invoices created as \`draft\` or \`to_pay\`, or later email requests.`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).option("--additional-display-fields <json>", `Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.`).option("--original-invoice-id <value>", `Reference invoice for a credit note, including an imported invoice. Must belong to the same customer, currency and invoicing entity. This reference does not apply credit; use \`allocations\` separately.`).requiredOption("--line-items <json>", `line_items`).option("--allocations <json>", `Invoice applications for a credit note, independent of \`original_invoice_id\`. Omit or send an empty array to apply no credit. Created atomically with the credit note. Amounts must fit the available credit and target balances. For \`paid\` credit notes, non-empty allocations and explicit transactions must settle the full amount; no refund transaction is inferred.`).option("--transactions <json>", `transactions`).option("--coupons <json>", `coupons`).addHelpText("after", `
|
|
44097
44180
|
Examples:
|
|
44098
44181
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
44099
44182
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -44146,6 +44229,10 @@ Examples:
|
|
|
44146
44229
|
args.settled_at = opts.settledAt;
|
|
44147
44230
|
if (opts.issuingMethod !== void 0)
|
|
44148
44231
|
args.issuing_method = opts.issuingMethod;
|
|
44232
|
+
if (opts.originalInvoiceId !== void 0)
|
|
44233
|
+
args.original_invoice_id = opts.originalInvoiceId;
|
|
44234
|
+
if (opts.sendEmail !== void 0)
|
|
44235
|
+
args.send_email = true;
|
|
44149
44236
|
if (opts.properties !== void 0)
|
|
44150
44237
|
args.properties = JSON.parse(opts.properties);
|
|
44151
44238
|
if (opts.customProperties !== void 0)
|
|
@@ -44154,6 +44241,8 @@ Examples:
|
|
|
44154
44241
|
args.additional_display_fields = JSON.parse(opts.additionalDisplayFields);
|
|
44155
44242
|
if (opts.lineItems !== void 0)
|
|
44156
44243
|
args.line_items = JSON.parse(opts.lineItems);
|
|
44244
|
+
if (opts.allocations !== void 0)
|
|
44245
|
+
args.allocations = JSON.parse(opts.allocations);
|
|
44157
44246
|
if (opts.transactions !== void 0)
|
|
44158
44247
|
args.transactions = JSON.parse(opts.transactions);
|
|
44159
44248
|
if (opts.coupons !== void 0)
|
|
@@ -44356,7 +44445,28 @@ Examples:
|
|
|
44356
44445
|
queryParamKeys: []
|
|
44357
44446
|
});
|
|
44358
44447
|
});
|
|
44359
|
-
resource.command("update").description(`
|
|
44448
|
+
resource.command("update-credit-note-allocations").description(`Replace a credit note's invoice allocations, including imported invoices, without changing its original invoice reference.`).requiredOption("--id <value>", `id parameter`).requiredOption("--allocations <json>", `Complete replacement of this credit note's invoice applications. An empty array removes all applications, preserving the original invoice reference. Targets must share the customer, currency and invoicing entity. Amounts exceeding available credit or invoice balances are rejected.`).addHelpText("after", `
|
|
44449
|
+
Examples:
|
|
44450
|
+
hyperline invoices update-credit-note-allocations --id <id> --allocations <allocations>
|
|
44451
|
+
hyperline invoices update-credit-note-allocations --id <id> --allocations <allocations> --output json`).action(async (opts) => {
|
|
44452
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
44453
|
+
if (!ctx) {
|
|
44454
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
44455
|
+
process.exit(1);
|
|
44456
|
+
}
|
|
44457
|
+
const args = {};
|
|
44458
|
+
if (opts.id !== void 0)
|
|
44459
|
+
args.id = opts.id;
|
|
44460
|
+
if (opts.allocations !== void 0)
|
|
44461
|
+
args.allocations = JSON.parse(opts.allocations);
|
|
44462
|
+
await ctx.execute({
|
|
44463
|
+
method: "PUT",
|
|
44464
|
+
path: "/v1/invoices/{id}/allocations",
|
|
44465
|
+
args,
|
|
44466
|
+
queryParamKeys: []
|
|
44467
|
+
});
|
|
44468
|
+
});
|
|
44469
|
+
resource.command("update").description(`Update an invoice. Send original_invoice_id alone to fill a missing reference on an imported credit note without changing allocations. Draft/grace_period allow modifying line items, dates, and metadata before finalization. Finalized invoices allow updating product and price links and revenue classification on existing line items by ID, with unchanged amounts/taxes and automatic accounting reposting, plus metadata (paid/partially_paid: custom_note/purchase_order/custom_properties/additional_display_fields/subscription_id; uncollectible: properties/custom_note/custom_properties/additional_display_fields/subscription_id).`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Type of the invoice.
|
|
44360
44470
|
|
|
44361
44471
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
44362
44472
|
- \`credit_note\`: Legal credit note cancelling an invoice and refunding your customer.
|
|
@@ -44365,7 +44475,7 @@ Examples:
|
|
|
44365
44475
|
|
|
44366
44476
|
- \`auto\`: Tax is automatically computed and applied.
|
|
44367
44477
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
44368
|
-
`).option("--issuing-method <value>", `Set to \`scheduled\` to finalize the draft invoice automatically on its issue date (\`emitted_at\`), in the invoice timezone. The issue date must be after today. Set to \`manual\` to unschedule the invoice.`).option("--emitted-at <value>", `Issue date of the draft invoice. For a scheduled invoice, the day on which it is automatically finalized.`).option("--line-items <json>", `Draft edits replace the line list. Finalized invoice line updates accept up to 100 lines per request and update only the specified existing line IDs and allow product and price links and revenue classification; amounts and taxes stay unchanged. Accounting postings are rebuilt atomically; updates affecting closed accounting periods are rejected.`).option("--coupons <json>", `coupons`).option("--payment-method-type <value>", `payment_method_type`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).option("--additional-display-fields <json>", `Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.`).option("--customer <json>", `Override customer details on the invoice. Only allowed for draft or grace period invoices.`).addHelpText("after", `
|
|
44478
|
+
`).option("--issuing-method <value>", `Set to \`scheduled\` to finalize the draft invoice automatically on its issue date (\`emitted_at\`), in the invoice timezone. The issue date must be after today. Set to \`manual\` to unschedule the invoice.`).option("--emitted-at <value>", `Issue date of the draft invoice. For a scheduled invoice, the day on which it is automatically finalized.`).option("--line-items <json>", `Draft edits replace the line list. Finalized invoice line updates accept up to 100 lines per request and update only the specified existing line IDs and allow product and price links and revenue classification; amounts and taxes stay unchanged. Accounting postings are rebuilt atomically; updates affecting closed accounting periods are rejected.`).option("--coupons <json>", `coupons`).option("--payment-method-type <value>", `payment_method_type`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--original-invoice-id <value>", `Fill a missing reference invoice on an imported credit note. Cannot replace or clear an existing reference. Does not change allocations. Send this field alone.`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).option("--additional-display-fields <json>", `Ordered additional fields displayed on the invoice PDF. Invoice and customer custom properties are referenced by slug.`).option("--customer <json>", `Override customer details on the invoice. Only allowed for draft or grace period invoices.`).addHelpText("after", `
|
|
44369
44479
|
Examples:
|
|
44370
44480
|
hyperline invoices update --id <id>
|
|
44371
44481
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -44406,6 +44516,8 @@ Examples:
|
|
|
44406
44516
|
args.bank_account_id = opts.bankAccountId;
|
|
44407
44517
|
if (opts.subscriptionId !== void 0)
|
|
44408
44518
|
args.subscription_id = opts.subscriptionId;
|
|
44519
|
+
if (opts.originalInvoiceId !== void 0)
|
|
44520
|
+
args.original_invoice_id = opts.originalInvoiceId;
|
|
44409
44521
|
if (opts.lineItems !== void 0)
|
|
44410
44522
|
args.line_items = JSON.parse(opts.lineItems);
|
|
44411
44523
|
if (opts.coupons !== void 0)
|
|
@@ -46203,7 +46315,7 @@ Examples:
|
|
|
46203
46315
|
// build/commands/generated/quotes-templates.js
|
|
46204
46316
|
function registerQuotes_TemplatesCommands(parent) {
|
|
46205
46317
|
const resource = parent.command("quotes-templates").description("Manage quotes > templates");
|
|
46206
|
-
resource.command("list-quote-templates").description(`List quote templates with pagination and optional filters for id, name, subscription_template_id, and search. Use template IDs to create quotes from reusable quote defaults.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--id <value>", `id`).option("--id.not <value>", `id__not`).option("--id.equals <value>", `id__equals`).option("--id.contains <value>", `id__contains`).option("--id.starts-with <value>", `id__startsWith`).option("--id.end-with <value>", `id__endWith`).option("--name <value>", `name`).option("--name.not <value>", `name__not`).option("--name.equals <value>", `name__equals`).option("--name.contains <value>", `name__contains`).option("--name.starts-with <value>", `name__startsWith`).option("--name.end-with <value>", `name__endWith`).option("--subscription-template-id <value>", `subscription_template_id`).option("--
|
|
46318
|
+
resource.command("list-quote-templates").description(`List quote templates with pagination and optional filters for id, name, subscription_template_id, and search. Use template IDs to create quotes from reusable quote defaults.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--id <value>", `id`).option("--id.not <value>", `id__not`).option("--id.equals <value>", `id__equals`).option("--id.contains <value>", `id__contains`).option("--id.starts-with <value>", `id__startsWith`).option("--id.end-with <value>", `id__endWith`).option("--name <value>", `name`).option("--name.not <value>", `name__not`).option("--name.equals <value>", `name__equals`).option("--name.contains <value>", `name__contains`).option("--name.starts-with <value>", `name__startsWith`).option("--name.end-with <value>", `name__endWith`).option("--subscription-template-id <value>", `subscription_template_id`).option("--search <value>", `search`).addHelpText("after", `
|
|
46207
46319
|
Examples:
|
|
46208
46320
|
hyperline quotes-templates list-quote-templates
|
|
46209
46321
|
hyperline quotes-templates list-quote-templates --take <take> --id <id>`).action(async (opts) => {
|
|
@@ -46239,20 +46351,6 @@ Examples:
|
|
|
46239
46351
|
args.name__endWith = opts["name.endWith"];
|
|
46240
46352
|
if (opts.subscriptionTemplateId !== void 0)
|
|
46241
46353
|
args.subscription_template_id = opts.subscriptionTemplateId;
|
|
46242
|
-
if (opts["subscriptionTemplateId.not"] !== void 0)
|
|
46243
|
-
args.subscription_template_id__not = opts["subscriptionTemplateId.not"];
|
|
46244
|
-
if (opts["subscriptionTemplateId.equals"] !== void 0)
|
|
46245
|
-
args.subscription_template_id__equals = opts["subscriptionTemplateId.equals"];
|
|
46246
|
-
if (opts["subscriptionTemplateId.contains"] !== void 0)
|
|
46247
|
-
args.subscription_template_id__contains = opts["subscriptionTemplateId.contains"];
|
|
46248
|
-
if (opts["subscriptionTemplateId.startsWith"] !== void 0)
|
|
46249
|
-
args.subscription_template_id__startsWith = opts["subscriptionTemplateId.startsWith"];
|
|
46250
|
-
if (opts["subscriptionTemplateId.endWith"] !== void 0)
|
|
46251
|
-
args.subscription_template_id__endWith = opts["subscriptionTemplateId.endWith"];
|
|
46252
|
-
if (opts["subscriptionTemplateId.isNull"] !== void 0)
|
|
46253
|
-
args.subscription_template_id__isNull = opts["subscriptionTemplateId.isNull"];
|
|
46254
|
-
if (opts["subscriptionTemplateId.isNotNull"] !== void 0)
|
|
46255
|
-
args.subscription_template_id__isNotNull = opts["subscriptionTemplateId.isNotNull"];
|
|
46256
46354
|
if (opts.search !== void 0)
|
|
46257
46355
|
args.search = opts.search;
|
|
46258
46356
|
if (opts.take !== void 0)
|
|
@@ -46279,13 +46377,6 @@ Examples:
|
|
|
46279
46377
|
"name__startsWith",
|
|
46280
46378
|
"name__endWith",
|
|
46281
46379
|
"subscription_template_id",
|
|
46282
|
-
"subscription_template_id__not",
|
|
46283
|
-
"subscription_template_id__equals",
|
|
46284
|
-
"subscription_template_id__contains",
|
|
46285
|
-
"subscription_template_id__startsWith",
|
|
46286
|
-
"subscription_template_id__endWith",
|
|
46287
|
-
"subscription_template_id__isNull",
|
|
46288
|
-
"subscription_template_id__isNotNull",
|
|
46289
46380
|
"search"
|
|
46290
46381
|
]
|
|
46291
46382
|
});
|
|
@@ -47343,7 +47434,7 @@ Examples:
|
|
|
47343
47434
|
]
|
|
47344
47435
|
});
|
|
47345
47436
|
});
|
|
47346
|
-
resource.command("create-subscription-transition").description(`Submit a transition from one subscription to another. The result may be pending approval, 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. 'pro_rata_separate_documents' issues a credit note for the current period (the amount invoiced when 'last_renewal', otherwise a prorated cancellation credit) and a separate invoice for the new configuration.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' (the default) keeps the current billing cycle dates; the request is rejected when the phases share no product billing periodicity, as the cycle cannot then be preserved \u2014 use 'align_to_new_billing_cycle' in that case. 'align_to_new_billing_cycle' aligns the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `When the transition should be applied: 'immediately', 'scheduled' for a specific date, or 'last_renewal' to apply it retroactively to the start of the current billing period (refunding what was already invoiced for that period and re-charging the new configuration). 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 <json>", `The configuration of the subscription to transition to
|
|
47437
|
+
resource.command("create-subscription-transition").description(`Submit a transition from one subscription to another. The result may be pending approval, 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. 'pro_rata_separate_documents' issues a credit note for the current period (the amount invoiced when 'last_renewal', otherwise a prorated cancellation credit) and a separate invoice for the new configuration.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' (the default) keeps the current billing cycle dates; the request is rejected when the phases share no product billing periodicity, as the cycle cannot then be preserved \u2014 use 'align_to_new_billing_cycle' in that case. 'align_to_new_billing_cycle' aligns the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `When the transition should be applied: 'immediately', 'scheduled' for a specific date, or 'last_renewal' to apply it retroactively to the start of the current billing period (refunding what was already invoiced for that period and re-charging the new configuration). 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 <json>", `The configuration of the subscription to transition to. It is billed in the source subscription's currency, even when the customer's currency has changed: a template configuration in another currency is refused.`).addHelpText("after", `
|
|
47347
47438
|
Examples:
|
|
47348
47439
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
47349
47440
|
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>
|
|
@@ -48096,6 +48187,7 @@ function registerAllCommands(program2) {
|
|
|
48096
48187
|
registerAi_BillingCommands(program2);
|
|
48097
48188
|
registerAi_CostsCommands(program2);
|
|
48098
48189
|
registerAnalyticsCommands(program2);
|
|
48190
|
+
registerApproval_RequestsCommands(program2);
|
|
48099
48191
|
registerApproval_WorkflowsCommands(program2);
|
|
48100
48192
|
registerBank_AccountsCommands(program2);
|
|
48101
48193
|
registerCatalogCommands(program2);
|
|
@@ -64198,6 +64290,7 @@ var de = {
|
|
|
64198
64290
|
"quotes.blockers.quote_configuration_not_subscription_update": "W\xE4hlen Sie eine Konfiguration f\xFCr eine Abonnement\xE4nderung",
|
|
64199
64291
|
"quotes.blockers.quote_configuration_not_new_subscription": "W\xE4hlen Sie eine Konfiguration f\xFCr ein neues Abonnement",
|
|
64200
64292
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Ein Abonnement kann in einem Angebot nur einmal ge\xE4ndert werden",
|
|
64293
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Jedes Produkt muss aus dem Konto des Abrechnungsanbieters des ge\xE4nderten Abonnements stammen",
|
|
64201
64294
|
"quotes.blockers.quote_draft_invoice_missing": "Das Angebot muss eine Rechnung im Entwurf haben, um abgeschlossen zu werden",
|
|
64202
64295
|
"quotes.blockers.quote_draft_subscription_missing": "Das Angebot muss ein Abonnement im Entwurf haben, um abgeschlossen zu werden",
|
|
64203
64296
|
"quotes.blockers.quote_expiry_after_transition_date": "Das Ablaufdatum des Angebots muss sp\xE4testens am Ende des aktuellen Abrechnungszeitraums liegen, oder am geplanten \xDCbergangsdatum, wenn dieses sp\xE4ter liegt"
|
|
@@ -64266,6 +64359,7 @@ var en = {
|
|
|
64266
64359
|
"quotes.blockers.quote_configuration_not_subscription_update": "Select a subscription update configuration",
|
|
64267
64360
|
"quotes.blockers.quote_configuration_not_new_subscription": "Select a new subscription configuration",
|
|
64268
64361
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "A subscription can only be updated once in a quote",
|
|
64362
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Every product must come from the billing provider account of the subscription being updated",
|
|
64269
64363
|
"quotes.blockers.quote_draft_invoice_missing": "Quote must have a draft invoice to be finalized",
|
|
64270
64364
|
"quotes.blockers.quote_draft_subscription_missing": "Quote must have a draft subscription to be finalized",
|
|
64271
64365
|
"quotes.blockers.quote_expiry_after_transition_date": "The quote expiration date must be on or before the end of the current billing period, or the scheduled transition date when it falls later"
|
|
@@ -64334,6 +64428,7 @@ var es = {
|
|
|
64334
64428
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecciona una configuraci\xF3n de actualizaci\xF3n de suscripci\xF3n",
|
|
64335
64429
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecciona una configuraci\xF3n de nueva suscripci\xF3n",
|
|
64336
64430
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Una suscripci\xF3n solo puede actualizarse una vez en un presupuesto",
|
|
64431
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Cada producto debe provenir de la cuenta del proveedor de facturaci\xF3n de la suscripci\xF3n actualizada",
|
|
64337
64432
|
"quotes.blockers.quote_draft_invoice_missing": "El presupuesto debe tener una factura en borrador para finalizarse",
|
|
64338
64433
|
"quotes.blockers.quote_draft_subscription_missing": "El presupuesto debe tener una suscripci\xF3n en borrador para finalizarse",
|
|
64339
64434
|
"quotes.blockers.quote_expiry_after_transition_date": "La fecha de vencimiento del presupuesto debe ser, como m\xE1ximo, el final del periodo de facturaci\xF3n actual, o la fecha de transici\xF3n programada si es posterior"
|
|
@@ -64402,6 +64497,7 @@ var fr = {
|
|
|
64402
64497
|
"quotes.blockers.quote_configuration_not_subscription_update": "S\xE9lectionnez une configuration de mise \xE0 jour d'abonnement",
|
|
64403
64498
|
"quotes.blockers.quote_configuration_not_new_subscription": "S\xE9lectionnez une configuration de nouvel abonnement",
|
|
64404
64499
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abonnement ne peut \xEAtre mis \xE0 jour qu'une seule fois dans un devis",
|
|
64500
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Chaque produit doit provenir du compte du fournisseur de facturation de l'abonnement mis \xE0 jour",
|
|
64405
64501
|
"quotes.blockers.quote_draft_invoice_missing": "Le devis doit avoir une facture en brouillon pour \xEAtre finalis\xE9",
|
|
64406
64502
|
"quotes.blockers.quote_draft_subscription_missing": "Le devis doit avoir un abonnement en brouillon pour \xEAtre finalis\xE9",
|
|
64407
64503
|
"quotes.blockers.quote_expiry_after_transition_date": "La date d'expiration du devis doit \xEAtre au plus tard la fin de la p\xE9riode de facturation en cours, ou la date de transition planifi\xE9e si elle est post\xE9rieure"
|
|
@@ -64470,6 +64566,7 @@ var it = {
|
|
|
64470
64566
|
"quotes.blockers.quote_configuration_not_subscription_update": "Seleziona una configurazione di aggiornamento dell'abbonamento",
|
|
64471
64567
|
"quotes.blockers.quote_configuration_not_new_subscription": "Seleziona una configurazione di nuovo abbonamento",
|
|
64472
64568
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abbonamento pu\xF2 essere aggiornato una sola volta in un preventivo",
|
|
64569
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ogni prodotto deve provenire dall'account del provider di fatturazione dell'abbonamento aggiornato",
|
|
64473
64570
|
"quotes.blockers.quote_draft_invoice_missing": "Il preventivo deve avere una fattura in bozza per essere finalizzato",
|
|
64474
64571
|
"quotes.blockers.quote_draft_subscription_missing": "Il preventivo deve avere un abbonamento in bozza per essere finalizzato",
|
|
64475
64572
|
"quotes.blockers.quote_expiry_after_transition_date": "La data di scadenza del preventivo deve essere entro la fine del periodo di fatturazione corrente, o la data di transizione pianificata se successiva"
|
|
@@ -64538,6 +64635,7 @@ var lt = {
|
|
|
64538
64635
|
"quotes.blockers.quote_configuration_not_subscription_update": "Pasirinkite prenumeratos atnaujinimo konfig\u016Bracij\u0105",
|
|
64539
64636
|
"quotes.blockers.quote_configuration_not_new_subscription": "Pasirinkite naujos prenumeratos konfig\u016Bracij\u0105",
|
|
64540
64637
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Prenumerat\u0105 pasi\u016Blyme galima atnaujinti tik vien\u0105 kart\u0105",
|
|
64638
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Kiekvienas produktas turi b\u016Bti i\u0161 atnaujinamos prenumeratos atsiskaitymo teik\u0117jo paskyros",
|
|
64541
64639
|
"quotes.blockers.quote_draft_invoice_missing": "Pasi\u016Blymas turi tur\u0117ti s\u0105skaitos fakt\u016Bros juodra\u0161t\u012F, kad b\u016Bt\u0173 u\u017Ebaigtas",
|
|
64542
64640
|
"quotes.blockers.quote_draft_subscription_missing": "Pasi\u016Blymas turi tur\u0117ti prenumeratos juodra\u0161t\u012F, kad b\u016Bt\u0173 u\u017Ebaigtas",
|
|
64543
64641
|
"quotes.blockers.quote_expiry_after_transition_date": "Pasi\u016Blymo galiojimo pabaigos data turi b\u016Bti ne v\u0117lesn\u0117 nei dabartinio atsiskaitymo laikotarpio pabaiga arba suplanuota per\u0117jimo data, jei ji v\u0117lesn\u0117"
|
|
@@ -64606,6 +64704,7 @@ var nl = {
|
|
|
64606
64704
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecteer een configuratie voor een abonnementswijziging",
|
|
64607
64705
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecteer een configuratie voor een nieuw abonnement",
|
|
64608
64706
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Een abonnement kan maar \xE9\xE9n keer per offerte worden gewijzigd",
|
|
64707
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Elk product moet afkomstig zijn van het account van de factureringsprovider van het gewijzigde abonnement",
|
|
64609
64708
|
"quotes.blockers.quote_draft_invoice_missing": "De offerte moet een conceptfactuur hebben om te worden afgerond",
|
|
64610
64709
|
"quotes.blockers.quote_draft_subscription_missing": "De offerte moet een conceptabonnement hebben om te worden afgerond",
|
|
64611
64710
|
"quotes.blockers.quote_expiry_after_transition_date": "De vervaldatum van de offerte moet uiterlijk het einde van de huidige factuurperiode zijn, of de geplande overgangsdatum als die later valt"
|
|
@@ -64674,6 +64773,7 @@ var pl = {
|
|
|
64674
64773
|
"quotes.blockers.quote_configuration_not_subscription_update": "Wybierz konfiguracj\u0119 aktualizacji subskrypcji",
|
|
64675
64774
|
"quotes.blockers.quote_configuration_not_new_subscription": "Wybierz konfiguracj\u0119 nowej subskrypcji",
|
|
64676
64775
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Subskrypcj\u0119 mo\u017Cna zaktualizowa\u0107 w ofercie tylko raz",
|
|
64776
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ka\u017Cdy produkt musi pochodzi\u0107 z konta dostawcy rozlicze\u0144 aktualizowanej subskrypcji",
|
|
64677
64777
|
"quotes.blockers.quote_draft_invoice_missing": "Oferta musi mie\u0107 faktur\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64678
64778
|
"quotes.blockers.quote_draft_subscription_missing": "Oferta musi mie\u0107 subskrypcj\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64679
64779
|
"quotes.blockers.quote_expiry_after_transition_date": "Data wyga\u015Bni\u0119cia oferty musi przypada\u0107 najp\xF3\u017Aniej na koniec bie\u017C\u0105cego okresu rozliczeniowego lub na zaplanowan\u0105 dat\u0119 przej\u015Bcia, je\u015Bli jest p\xF3\u017Aniejsza"
|
|
@@ -64742,6 +64842,7 @@ var pt = {
|
|
|
64742
64842
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecione uma configura\xE7\xE3o de atualiza\xE7\xE3o de subscri\xE7\xE3o",
|
|
64743
64843
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecione uma configura\xE7\xE3o de nova subscri\xE7\xE3o",
|
|
64744
64844
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Uma subscri\xE7\xE3o s\xF3 pode ser atualizada uma vez num or\xE7amento",
|
|
64845
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Cada produto deve vir da conta do fornecedor de fatura\xE7\xE3o da subscri\xE7\xE3o atualizada",
|
|
64745
64846
|
"quotes.blockers.quote_draft_invoice_missing": "O or\xE7amento deve ter uma fatura em rascunho para ser finalizado",
|
|
64746
64847
|
"quotes.blockers.quote_draft_subscription_missing": "O or\xE7amento deve ter uma subscri\xE7\xE3o em rascunho para ser finalizado",
|
|
64747
64848
|
"quotes.blockers.quote_expiry_after_transition_date": "A data de expira\xE7\xE3o do or\xE7amento deve ser, no m\xE1ximo, o fim do per\xEDodo de fatura\xE7\xE3o atual, ou a data de transi\xE7\xE3o agendada se for posterior"
|