@hyperline/cli 0.1.0-build.1.a3924c4 → 0.1.0-build.1.a3b9bed
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 +754 -139
- package/dist/external-deps.json +2 -2
- package/package.json +4 -4
|
@@ -38409,7 +38409,7 @@ Examples:
|
|
|
38409
38409
|
queryParamKeys: ["invoicing_entity_id"]
|
|
38410
38410
|
});
|
|
38411
38411
|
});
|
|
38412
|
-
resource.command("create-ledger").description(`Create an accounting ledger for an invoicing entity.`).requiredOption("--invoicing-entity-id <value>", `Identifier of the invoicing entity that owns the ledger.`).requiredOption("--name <value>", `Display name of the ledger.`).requiredOption("--code <value>", `Optional accounting code of the ledger.`).requiredOption("--description <value>", `Optional description of the ledger.`).requiredOption("--type <value>", `Type of ledger.`).requiredOption("--currency <value>", `ISO 4217 currency used by the ledger.`).option("--fiscal-year-end-month <number>", `Last month of the ledger's fiscal year, from 1 (January) to 12 (December). Reports split profit between past fiscal years and the current one from it. Defaults to 12.`).requiredOption("--entry-number-pattern <value>", `Entry numbering pattern containing \`{number}\`.`).requiredOption("--is-primary", `Whether this is the primary ledger for the invoicing entity.`).requiredOption("--is-inactive", `Whether the ledger is inactive.`).addHelpText("after", `
|
|
38412
|
+
resource.command("create-ledger").description(`Create an accounting ledger for an invoicing entity.`).requiredOption("--invoicing-entity-id <value>", `Identifier of the invoicing entity that owns the ledger.`).requiredOption("--name <value>", `Display name of the ledger.`).requiredOption("--code <value>", `Optional accounting code of the ledger.`).requiredOption("--description <value>", `Optional description of the ledger.`).requiredOption("--type <value>", `Type of ledger.`).requiredOption("--currency <value>", `ISO 4217 currency used by the ledger.`).option("--fiscal-year-end-month <number>", `Last month of the ledger's fiscal year, from 1 (January) to 12 (December). Reports split profit between past fiscal years and the current one from it. Defaults to 12. It cannot be changed after creation.`).requiredOption("--entry-number-pattern <value>", `Entry numbering pattern containing \`{number}\`.`).requiredOption("--is-primary", `Whether this is the primary ledger for the invoicing entity.`).requiredOption("--is-inactive", `Whether the ledger is inactive.`).addHelpText("after", `
|
|
38413
38413
|
Examples:
|
|
38414
38414
|
hyperline accounting-ledgers create-ledger --invoicing-entity-id <invoicing_entity_id> --name <name> --code <code> --description <description> --type <type> --currency <currency> --entry-number-pattern <entry_number_pattern> --is-primary --is-inactive
|
|
38415
38415
|
hyperline accounting-ledgers create-ledger --invoicing-entity-id <invoicing_entity_id> --name <name> --code <code> --description <description> --type <type> --currency <currency> --entry-number-pattern <entry_number_pattern> --is-primary --is-inactive --fiscal-year-end-month <fiscal_year_end_month>
|
|
@@ -38447,7 +38447,7 @@ Examples:
|
|
|
38447
38447
|
queryParamKeys: []
|
|
38448
38448
|
});
|
|
38449
38449
|
});
|
|
38450
|
-
resource.command("update-ledger").description(`Update an existing accounting ledger.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Display name of the ledger.`).option("--code <value>", `Optional accounting code of the ledger.`).option("--description <value>", `Optional description of the ledger.`).option("--type <value>", `Type of ledger.`).option("--currency <value>", `ISO 4217 currency used by the ledger.`).option("--
|
|
38450
|
+
resource.command("update-ledger").description(`Update an existing accounting ledger.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Display name of the ledger.`).option("--code <value>", `Optional accounting code of the ledger.`).option("--description <value>", `Optional description of the ledger.`).option("--type <value>", `Type of ledger.`).option("--currency <value>", `ISO 4217 currency used by the ledger.`).option("--entry-number-pattern <value>", `Entry numbering pattern containing \`{number}\`.`).option("--next-entry-number <number>", `Next sequence number assigned to an entry.`).addHelpText("after", `
|
|
38451
38451
|
Examples:
|
|
38452
38452
|
hyperline accounting-ledgers update-ledger --id <id>
|
|
38453
38453
|
hyperline accounting-ledgers update-ledger --id <id> --name <name> --code <code>
|
|
@@ -38472,8 +38472,6 @@ Examples:
|
|
|
38472
38472
|
args.currency = opts.currency;
|
|
38473
38473
|
if (opts.entryNumberPattern !== void 0)
|
|
38474
38474
|
args.entry_number_pattern = opts.entryNumberPattern;
|
|
38475
|
-
if (opts.fiscalYearEndMonth !== void 0)
|
|
38476
|
-
args.fiscal_year_end_month = Number(opts.fiscalYearEndMonth);
|
|
38477
38475
|
if (opts.nextEntryNumber !== void 0)
|
|
38478
38476
|
args.next_entry_number = Number(opts.nextEntryNumber);
|
|
38479
38477
|
await ctx.execute({
|
|
@@ -39089,7 +39087,7 @@ Examples:
|
|
|
39089
39087
|
queryParamKeys: []
|
|
39090
39088
|
});
|
|
39091
39089
|
});
|
|
39092
|
-
resource.command("create").description(`Create a new accounting rule for account code routing or journal posting, with the filters, accounts and required fields the rule editor applies to its category.`).option("--ledger-id <value>", `Identifier of the ledger this rule belongs to.`).option("--name <value>", `Optional user-defined name for the rule.`).requiredOption("--category <value>", `Rule category (e.g. accounting_software, invoice_posted).`).requiredOption("--priority <number>", `Override order. Higher priority wins when multiple rules match.`).option("--product-ids <json>", `Product IDs to match. Empty means match all.`).option("--product-types <json>", `Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.`).option("--customer-ids <json>", `Customer IDs for customer-specific overrides.`).option("--currencies <json>", `Currency codes to match (e.g. EUR, USD).`).option("--countries <json>", `Country codes for jurisdiction-based overrides.`).option("--tax-schemes <json>", `Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.`).option("--tax-territories <json>", `Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.`).option("--tax-rate-classes <json>", `Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.`).option("--coupon-ids <json>", `Coupon IDs to match. Empty means match all.`).option("--client-provider-ids <json>", `Client provider IDs to match. Empty means match all.`).option("--payment-method-types <json>", `Payment method types to match. Empty means match all.`).option("--bank-account-ids <json>", `Bank account IDs to match. Empty means match all.`).option("--invoice-types <json>", `Invoice kinds to match: \`invoice\` or \`document\`. Refunds and other standard invoices match as \`invoice\`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.`).option("--interval-period <value>", `Billing interval period filter (months, years, etc.)
|
|
39090
|
+
resource.command("create").description(`Create a new accounting rule for account code routing or journal posting, with the filters, accounts and required fields the rule editor applies to its category.`).option("--ledger-id <value>", `Identifier of the ledger this rule belongs to.`).option("--name <value>", `Optional user-defined name for the rule.`).requiredOption("--category <value>", `Rule category (e.g. accounting_software, invoice_posted).`).requiredOption("--priority <number>", `Override order. Higher priority wins when multiple rules match.`).option("--product-ids <json>", `Product IDs to match. Empty means match all.`).option("--product-types <json>", `Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.`).option("--customer-ids <json>", `Customer IDs for customer-specific overrides.`).option("--currencies <json>", `Currency codes to match (e.g. EUR, USD).`).option("--countries <json>", `Country codes for jurisdiction-based overrides.`).option("--tax-schemes <json>", `Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.`).option("--tax-territories <json>", `Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.`).option("--tax-rate-classes <json>", `Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.`).option("--coupon-ids <json>", `Coupon IDs to match. Empty means match all.`).option("--client-provider-ids <json>", `Client provider IDs to match. Empty means match all.`).option("--payment-method-types <json>", `Payment method types to match. Empty means match all.`).option("--bank-account-ids <json>", `Bank account IDs to match. Empty means match all.`).option("--invoice-types <json>", `Invoice kinds to match: \`invoice\` or \`document\`. Refunds and other standard invoices match as \`invoice\`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.`).option("--interval-period <value>", `Billing interval period filter (months, years, etc.). \`recurring\` matches every interval except \`once\` and requires a null \`interval_count\`. \`null\` matches every interval, including \`once\`.`).option("--interval-count <number>", `Billing interval count filter.`).option("--custom-property-filters <json>", `Invoice custom property filters. A rule matches only when every entry matches (AND across entries), and an entry matches when the invoice value is one of its \`values\` (any-of). Matching is strict: an invoice without a value for the property never matches. Each entry adds 10 to the \`suggested_priority\` returned by the rule defaults endpoint. Allowed on invoice_posted, invoice_settled, revenue_recognition, credit_note_created and accounting_software (invoice side) rules. An invoice_settled rule with filters cannot set \`payments_clearing_ledger_account_id\`, as PSP payouts are booked without the invoice. Empty means match all.`).option("--revenue-ledger-account-id <value>", `Revenue ledger account ID used for invoice line revenue routing. Must be a \`revenue\` account. On accounting_software rules, a \`revenue\` or \`contra_revenue\` account with entity_type invoice, an \`asset\` or \`contra_asset\` account with entity_type payment.`).option("--deferred-revenue-ledger-account-id <value>", `Deferred revenue ledger account ID used before revenue is recognized. Must be a \`liability\` account.`).option("--deferred-discount-ledger-account-id <value>", `Deferred discount ledger account ID used before discounts are recognized. Must be an \`asset\` or \`contra_liability\` account.`).option("--contra-revenue-ledger-account-id <value>", `Contra revenue ledger account ID used for amounts that reduce revenue. Must be a \`contra_revenue\` account.`).option("--discount-ledger-account-id <value>", `Discount ledger account ID used for recognized discounts. Must be a \`contra_revenue\` account.`).option("--ar-ledger-account-id <value>", `Accounts receivable ledger account ID used for invoice posting. Must be an \`asset\` account.`).option("--cash-ledger-account-id <value>", `Cash ledger account ID used for payment settlement. Must be an \`asset\` account.`).option("--payments-clearing-ledger-account-id <value>", `Payments clearing ledger account ID used while payments settle. Must be an \`asset\` account.`).option("--output-tax-ledger-account-id <value>", `Output tax ledger account ID used for tax liability. Must be a \`liability\` account.`).option("--uncollectible-debit-ledger-account-id <value>", `Ledger account ID debited when an invoice becomes uncollectible. Must be an \`asset\` account, for doubtful-receivable reclassification, or an \`expense\` account, for direct write-off.`).option("--allowance-for-doubtful-accounts-id <value>", `Allowance for doubtful accounts ledger account ID, set on credit_note_created rules. Must be a \`contra_asset\` account.`).option("--provider-fees-expense-ledger-account-id <value>", `Expense ledger account ID debited for payment provider fees when a payment settles. Must be an \`expense\` account.`).option("--payment-processing-fees-expense-ledger-account-id <value>", `Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over \`provider_fees_expense_ledger_account_id\` when set by the same or a higher priority rule. Must be an \`expense\` account.`).option("--payment-processing-fees-revenue-ledger-account-id <value>", `Payment processing fees revenue ledger account ID, set on invoice_settled rules. Must be a \`revenue\` account.`).option("--customer-credits-ledger-account-id <value>", `Customer credits ledger account ID used for credit balances. Must be a \`liability\` account.`).option("--rev-rec-method <value>", `Revenue recognition method.`).option("--rev-rec-granularity <value>", `Recognition period granularity. Used when \`rev_rec_method\` is \`over_time\`.`).option("--rev-rec-point-in-time-basis <value>", `Date revenue is recognized on. Used when \`rev_rec_method\` is \`point_in_time\`.`).option("--discount-recognition-method <value>", `Method used to recognize discounts.`).option("--journal-id <value>", `Journal ID used to route entries in the accounting provider.`).option("--entity-type <value>", `Entity type the rule applies to.`).addHelpText("after", `
|
|
39093
39091
|
Examples:
|
|
39094
39092
|
hyperline accounting-rules create --category <category> --priority <priority>
|
|
39095
39093
|
hyperline accounting-rules create --category <category> --priority <priority> --ledger-id <ledger_id> --name <name>
|
|
@@ -39189,7 +39187,7 @@ Examples:
|
|
|
39189
39187
|
queryParamKeys: []
|
|
39190
39188
|
});
|
|
39191
39189
|
});
|
|
39192
|
-
resource.command("update").description(`Update an existing accounting rule, with the filters, accounts and required fields the rule editor applies to its category.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Optional user-defined name for the rule.`).option("--category <value>", `Rule category. Cannot be changed after creation, must match the current category when sent.`).option("--priority <number>", `Override order. Higher priority wins when multiple rules match.`).option("--product-ids <json>", `Product IDs to match. Empty means match all.`).option("--product-types <json>", `Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.`).option("--customer-ids <json>", `Customer IDs for customer-specific overrides.`).option("--currencies <json>", `Currency codes to match (e.g. EUR, USD).`).option("--countries <json>", `Country codes for jurisdiction-based overrides.`).option("--tax-schemes <json>", `Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.`).option("--tax-territories <json>", `Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.`).option("--tax-rate-classes <json>", `Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.`).option("--coupon-ids <json>", `Coupon IDs to match. Empty means match all.`).option("--client-provider-ids <json>", `Client provider IDs to match. Empty means match all.`).option("--payment-method-types <json>", `Payment method types to match. Empty means match all.`).option("--bank-account-ids <json>", `Bank account IDs to match. Empty means match all.`).option("--invoice-types <json>", `Invoice kinds to match: \`invoice\` or \`document\`. Refunds and other standard invoices match as \`invoice\`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.`).option("--interval-period <value>", `Billing interval period filter (months, years, etc.)
|
|
39190
|
+
resource.command("update").description(`Update an existing accounting rule, with the filters, accounts and required fields the rule editor applies to its category.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Optional user-defined name for the rule.`).option("--category <value>", `Rule category. Cannot be changed after creation, must match the current category when sent.`).option("--priority <number>", `Override order. Higher priority wins when multiple rules match.`).option("--product-ids <json>", `Product IDs to match. Empty means match all.`).option("--product-types <json>", `Product types to match. Allowed values: flat_fee, dynamic, seat, credit. Empty means match all.`).option("--customer-ids <json>", `Customer IDs for customer-specific overrides.`).option("--currencies <json>", `Currency codes to match (e.g. EUR, USD).`).option("--countries <json>", `Country codes for jurisdiction-based overrides.`).option("--tax-schemes <json>", `Tax schemes to match. A context without a tax scheme never matches a rule that sets this filter. Empty means match all.`).option("--tax-territories <json>", `Tax territory country codes to match. A context without a tax territory never matches a rule that sets this filter. Empty means match all.`).option("--tax-rate-classes <json>", `Tax rate classes to match. A context without a tax rate class never matches a rule that sets this filter. Empty means match all.`).option("--coupon-ids <json>", `Coupon IDs to match. Empty means match all.`).option("--client-provider-ids <json>", `Client provider IDs to match. Empty means match all.`).option("--payment-method-types <json>", `Payment method types to match. Empty means match all.`).option("--bank-account-ids <json>", `Bank account IDs to match. Empty means match all.`).option("--invoice-types <json>", `Invoice kinds to match: \`invoice\` or \`document\`. Refunds and other standard invoices match as \`invoice\`. A context without an invoice, such as a PSP payout, never matches a rule that sets this filter. Empty means match all.`).option("--interval-period <value>", `Billing interval period filter (months, years, etc.). \`recurring\` matches every interval except \`once\` and requires a null \`interval_count\`. \`null\` matches every interval, including \`once\`.`).option("--interval-count <number>", `Billing interval count filter.`).option("--custom-property-filters <json>", `Invoice custom property filters. A rule matches only when every entry matches (AND across entries), and an entry matches when the invoice value is one of its \`values\` (any-of). Matching is strict: an invoice without a value for the property never matches. Each entry adds 10 to the \`suggested_priority\` returned by the rule defaults endpoint. Allowed on invoice_posted, invoice_settled, revenue_recognition, credit_note_created and accounting_software (invoice side) rules. An invoice_settled rule with filters cannot set \`payments_clearing_ledger_account_id\`, as PSP payouts are booked without the invoice. Empty means match all.`).option("--revenue-ledger-account-id <value>", `Revenue ledger account ID used for invoice line revenue routing. Must be a \`revenue\` account. On accounting_software rules, a \`revenue\` or \`contra_revenue\` account with entity_type invoice, an \`asset\` or \`contra_asset\` account with entity_type payment.`).option("--deferred-revenue-ledger-account-id <value>", `Deferred revenue ledger account ID used before revenue is recognized. Must be a \`liability\` account.`).option("--deferred-discount-ledger-account-id <value>", `Deferred discount ledger account ID used before discounts are recognized. Must be an \`asset\` or \`contra_liability\` account.`).option("--contra-revenue-ledger-account-id <value>", `Contra revenue ledger account ID used for amounts that reduce revenue. Must be a \`contra_revenue\` account.`).option("--discount-ledger-account-id <value>", `Discount ledger account ID used for recognized discounts. Must be a \`contra_revenue\` account.`).option("--ar-ledger-account-id <value>", `Accounts receivable ledger account ID used for invoice posting. Must be an \`asset\` account.`).option("--cash-ledger-account-id <value>", `Cash ledger account ID used for payment settlement. Must be an \`asset\` account.`).option("--payments-clearing-ledger-account-id <value>", `Payments clearing ledger account ID used while payments settle. Must be an \`asset\` account.`).option("--output-tax-ledger-account-id <value>", `Output tax ledger account ID used for tax liability. Must be a \`liability\` account.`).option("--uncollectible-debit-ledger-account-id <value>", `Ledger account ID debited when an invoice becomes uncollectible. Must be an \`asset\` account, for doubtful-receivable reclassification, or an \`expense\` account, for direct write-off.`).option("--allowance-for-doubtful-accounts-id <value>", `Allowance for doubtful accounts ledger account ID, set on credit_note_created rules. Must be a \`contra_asset\` account.`).option("--provider-fees-expense-ledger-account-id <value>", `Expense ledger account ID debited for payment provider fees when a payment settles. Must be an \`expense\` account.`).option("--payment-processing-fees-expense-ledger-account-id <value>", `Expense ledger account ID debited for payment processing fees when a payment settles. Takes precedence over \`provider_fees_expense_ledger_account_id\` when set by the same or a higher priority rule. Must be an \`expense\` account.`).option("--payment-processing-fees-revenue-ledger-account-id <value>", `Payment processing fees revenue ledger account ID, set on invoice_settled rules. Must be a \`revenue\` account.`).option("--customer-credits-ledger-account-id <value>", `Customer credits ledger account ID used for credit balances. Must be a \`liability\` account.`).option("--rev-rec-method <value>", `Revenue recognition method.`).option("--rev-rec-granularity <value>", `Recognition period granularity. Used when \`rev_rec_method\` is \`over_time\`.`).option("--rev-rec-point-in-time-basis <value>", `Date revenue is recognized on. Used when \`rev_rec_method\` is \`point_in_time\`.`).option("--discount-recognition-method <value>", `Method used to recognize discounts.`).option("--journal-id <value>", `Journal ID used to route entries in the accounting provider.`).option("--entity-type <value>", `Entity type the rule applies to.`).addHelpText("after", `
|
|
39193
39191
|
Examples:
|
|
39194
39192
|
hyperline accounting-rules update --id <id>
|
|
39195
39193
|
hyperline accounting-rules update --id <id> --name <name> --category <category>
|
|
@@ -40675,6 +40673,131 @@ Examples:
|
|
|
40675
40673
|
});
|
|
40676
40674
|
}
|
|
40677
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
|
+
|
|
40755
|
+
// build/commands/generated/approval-workflows.js
|
|
40756
|
+
function registerApproval_WorkflowsCommands(parent) {
|
|
40757
|
+
const resource = parent.command("approval-workflows").description("Manage approval > workflows");
|
|
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", `
|
|
40759
|
+
Examples:
|
|
40760
|
+
hyperline approval-workflows list
|
|
40761
|
+
hyperline approval-workflows list --take <take> --is-active <is_active>`).action(async (opts) => {
|
|
40762
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40763
|
+
if (!ctx) {
|
|
40764
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40765
|
+
process.exit(1);
|
|
40766
|
+
}
|
|
40767
|
+
const args = {};
|
|
40768
|
+
if (opts.isActive !== void 0)
|
|
40769
|
+
args.is_active = opts.isActive;
|
|
40770
|
+
if (opts.take !== void 0)
|
|
40771
|
+
args.take = Number(opts.take);
|
|
40772
|
+
if (opts.skip !== void 0)
|
|
40773
|
+
args.skip = Number(opts.skip);
|
|
40774
|
+
await ctx.execute({
|
|
40775
|
+
method: "GET",
|
|
40776
|
+
path: "/v1/approvals/workflows",
|
|
40777
|
+
args,
|
|
40778
|
+
queryParamKeys: ["take", "skip", "is_active"]
|
|
40779
|
+
});
|
|
40780
|
+
});
|
|
40781
|
+
resource.command("get").description(`Retrieve a single approval workflow.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
40782
|
+
Examples:
|
|
40783
|
+
hyperline approval-workflows get --id <id>`).action(async (opts) => {
|
|
40784
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40785
|
+
if (!ctx) {
|
|
40786
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40787
|
+
process.exit(1);
|
|
40788
|
+
}
|
|
40789
|
+
const args = {};
|
|
40790
|
+
if (opts.id !== void 0)
|
|
40791
|
+
args.id = opts.id;
|
|
40792
|
+
await ctx.execute({
|
|
40793
|
+
method: "GET",
|
|
40794
|
+
path: "/v1/approvals/workflows/{id}",
|
|
40795
|
+
args,
|
|
40796
|
+
queryParamKeys: []
|
|
40797
|
+
});
|
|
40798
|
+
});
|
|
40799
|
+
}
|
|
40800
|
+
|
|
40678
40801
|
// build/commands/generated/bank-accounts.js
|
|
40679
40802
|
function registerBank_AccountsCommands(parent) {
|
|
40680
40803
|
const resource = parent.command("bank-accounts").description("Manage bank accounts");
|
|
@@ -40864,6 +40987,332 @@ Examples:
|
|
|
40864
40987
|
});
|
|
40865
40988
|
}
|
|
40866
40989
|
|
|
40990
|
+
// build/commands/generated/contracts-clauses.js
|
|
40991
|
+
function registerContracts_ClausesCommands(parent) {
|
|
40992
|
+
const resource = parent.command("contracts-clauses").description("Manage contracts > clauses");
|
|
40993
|
+
resource.command("list-contract-clauses").description(`List the contract clauses of the contract library, with their texts and translations. Use the returned IDs in \`contract_clause_ids\` when creating a quote. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
40994
|
+
Examples:
|
|
40995
|
+
hyperline contracts-clauses list-contract-clauses
|
|
40996
|
+
hyperline contracts-clauses list-contract-clauses --take <take>`).action(async (opts) => {
|
|
40997
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40998
|
+
if (!ctx) {
|
|
40999
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41000
|
+
process.exit(1);
|
|
41001
|
+
}
|
|
41002
|
+
const args = {};
|
|
41003
|
+
if (opts.take !== void 0)
|
|
41004
|
+
args.take = Number(opts.take);
|
|
41005
|
+
if (opts.skip !== void 0)
|
|
41006
|
+
args.skip = Number(opts.skip);
|
|
41007
|
+
await ctx.execute({
|
|
41008
|
+
method: "GET",
|
|
41009
|
+
path: "/v1/contracts/clauses",
|
|
41010
|
+
args,
|
|
41011
|
+
queryParamKeys: ["take", "skip"]
|
|
41012
|
+
});
|
|
41013
|
+
});
|
|
41014
|
+
resource.command("create-contract-clause").description(`Create a contract clause in the contract library, with a default text and optional translations keyed by language code.`).requiredOption("--name <value>", `Name of the contract clause, displayed in the contract library.`).requiredOption("--text <value>", `Default text of the clause, used when no translation exists for the customer language. Plain text, line breaks are preserved.`).option("--translations <json>", `Translations of the clause, keyed by language code. The translation matching the customer language is used instead of \`text\`.`).option("--invoicing-entity-ids <json>", `IDs of the invoicing entities for which the clause is available when building a quote.`).addHelpText("after", `
|
|
41015
|
+
Examples:
|
|
41016
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text>
|
|
41017
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text> --translations <translations> --invoicing-entity-ids <invoicing_entity_ids>
|
|
41018
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text> --output json`).action(async (opts) => {
|
|
41019
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41020
|
+
if (!ctx) {
|
|
41021
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41022
|
+
process.exit(1);
|
|
41023
|
+
}
|
|
41024
|
+
const args = {};
|
|
41025
|
+
if (opts.name !== void 0)
|
|
41026
|
+
args.name = opts.name;
|
|
41027
|
+
if (opts.text !== void 0)
|
|
41028
|
+
args.text = opts.text;
|
|
41029
|
+
if (opts.translations !== void 0)
|
|
41030
|
+
args.translations = JSON.parse(opts.translations);
|
|
41031
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41032
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41033
|
+
await ctx.execute({
|
|
41034
|
+
method: "POST",
|
|
41035
|
+
path: "/v1/contracts/clauses",
|
|
41036
|
+
args,
|
|
41037
|
+
queryParamKeys: []
|
|
41038
|
+
});
|
|
41039
|
+
});
|
|
41040
|
+
resource.command("get-contract-clause").description(`Retrieve a contract clause by ID.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
41041
|
+
Examples:
|
|
41042
|
+
hyperline contracts-clauses get-contract-clause --id <id>`).action(async (opts) => {
|
|
41043
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41044
|
+
if (!ctx) {
|
|
41045
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41046
|
+
process.exit(1);
|
|
41047
|
+
}
|
|
41048
|
+
const args = {};
|
|
41049
|
+
if (opts.id !== void 0)
|
|
41050
|
+
args.id = opts.id;
|
|
41051
|
+
await ctx.execute({
|
|
41052
|
+
method: "GET",
|
|
41053
|
+
path: "/v1/contracts/clauses/{id}",
|
|
41054
|
+
args,
|
|
41055
|
+
queryParamKeys: []
|
|
41056
|
+
});
|
|
41057
|
+
});
|
|
41058
|
+
resource.command("update-contract-clause").description(`Update the name, text, translations or invoicing entities of a contract clause. Sending \`translations\` replaces all existing translations.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Name of the contract clause, displayed in the contract library.`).option("--text <value>", `Default text of the clause, used when no translation exists for the customer language. Plain text, line breaks are preserved.`).option("--translations <json>", `Translations of the clause, keyed by language code. Replaces all existing translations: omitted languages are removed.`).option("--invoicing-entity-ids <json>", `IDs of the invoicing entities for which the clause is available when building a quote.`).addHelpText("after", `
|
|
41059
|
+
Examples:
|
|
41060
|
+
hyperline contracts-clauses update-contract-clause --id <id>
|
|
41061
|
+
hyperline contracts-clauses update-contract-clause --id <id> --name <name> --text <text>
|
|
41062
|
+
hyperline contracts-clauses update-contract-clause --id <id> --output json`).action(async (opts) => {
|
|
41063
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41064
|
+
if (!ctx) {
|
|
41065
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41066
|
+
process.exit(1);
|
|
41067
|
+
}
|
|
41068
|
+
const args = {};
|
|
41069
|
+
if (opts.id !== void 0)
|
|
41070
|
+
args.id = opts.id;
|
|
41071
|
+
if (opts.name !== void 0)
|
|
41072
|
+
args.name = opts.name;
|
|
41073
|
+
if (opts.text !== void 0)
|
|
41074
|
+
args.text = opts.text;
|
|
41075
|
+
if (opts.translations !== void 0)
|
|
41076
|
+
args.translations = JSON.parse(opts.translations);
|
|
41077
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41078
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41079
|
+
await ctx.execute({
|
|
41080
|
+
method: "PUT",
|
|
41081
|
+
path: "/v1/contracts/clauses/{id}",
|
|
41082
|
+
args,
|
|
41083
|
+
queryParamKeys: []
|
|
41084
|
+
});
|
|
41085
|
+
});
|
|
41086
|
+
resource.command("delete-contract-clause").description(`Delete a contract clause from the contract library. Existing quotes keep their copy of the clause.`).requiredOption("--id <value>", `id parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
41087
|
+
Examples:
|
|
41088
|
+
hyperline contracts-clauses delete-contract-clause --id <id>
|
|
41089
|
+
hyperline contracts-clauses delete-contract-clause --id <id> --output json`).action(async (opts) => {
|
|
41090
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41091
|
+
if (!ctx) {
|
|
41092
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41093
|
+
process.exit(1);
|
|
41094
|
+
}
|
|
41095
|
+
const args = {};
|
|
41096
|
+
if (opts.id !== void 0)
|
|
41097
|
+
args.id = opts.id;
|
|
41098
|
+
if (!opts.yes) {
|
|
41099
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41100
|
+
if (!confirmed) {
|
|
41101
|
+
process.stdout.write("Aborted.\n");
|
|
41102
|
+
return;
|
|
41103
|
+
}
|
|
41104
|
+
}
|
|
41105
|
+
await ctx.execute({
|
|
41106
|
+
method: "DELETE",
|
|
41107
|
+
path: "/v1/contracts/clauses/{id}",
|
|
41108
|
+
args,
|
|
41109
|
+
queryParamKeys: []
|
|
41110
|
+
});
|
|
41111
|
+
});
|
|
41112
|
+
}
|
|
41113
|
+
|
|
41114
|
+
// build/commands/generated/contracts-documents.js
|
|
41115
|
+
function registerContracts_DocumentsCommands(parent) {
|
|
41116
|
+
const resource = parent.command("contracts-documents").description("Manage contracts > documents");
|
|
41117
|
+
resource.command("list-contract-documents").description(`List the contract documents of the contract library (terms of service, DPA, SLA...), with their contents per language and countries and the files of each content. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
41118
|
+
Examples:
|
|
41119
|
+
hyperline contracts-documents list-contract-documents
|
|
41120
|
+
hyperline contracts-documents list-contract-documents --take <take>`).action(async (opts) => {
|
|
41121
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41122
|
+
if (!ctx) {
|
|
41123
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41124
|
+
process.exit(1);
|
|
41125
|
+
}
|
|
41126
|
+
const args = {};
|
|
41127
|
+
if (opts.take !== void 0)
|
|
41128
|
+
args.take = Number(opts.take);
|
|
41129
|
+
if (opts.skip !== void 0)
|
|
41130
|
+
args.skip = Number(opts.skip);
|
|
41131
|
+
await ctx.execute({
|
|
41132
|
+
method: "GET",
|
|
41133
|
+
path: "/v1/contracts/documents",
|
|
41134
|
+
args,
|
|
41135
|
+
queryParamKeys: ["take", "skip"]
|
|
41136
|
+
});
|
|
41137
|
+
});
|
|
41138
|
+
resource.command("create-contract-document").description(`Create a contract document in the contract library. Its files are added afterwards per language with \`create_contract_document_content\`.`).requiredOption("--name <value>", `Name of the contract document, displayed in the contract library.`).option("--invoicing-entity-ids <json>", `IDs of the invoicing entities for which the contract document is available when building a quote.`).addHelpText("after", `
|
|
41139
|
+
Examples:
|
|
41140
|
+
hyperline contracts-documents create-contract-document --name <name>
|
|
41141
|
+
hyperline contracts-documents create-contract-document --name <name> --invoicing-entity-ids <invoicing_entity_ids>
|
|
41142
|
+
hyperline contracts-documents create-contract-document --name <name> --output json`).action(async (opts) => {
|
|
41143
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41144
|
+
if (!ctx) {
|
|
41145
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41146
|
+
process.exit(1);
|
|
41147
|
+
}
|
|
41148
|
+
const args = {};
|
|
41149
|
+
if (opts.name !== void 0)
|
|
41150
|
+
args.name = opts.name;
|
|
41151
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41152
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41153
|
+
await ctx.execute({
|
|
41154
|
+
method: "POST",
|
|
41155
|
+
path: "/v1/contracts/documents",
|
|
41156
|
+
args,
|
|
41157
|
+
queryParamKeys: []
|
|
41158
|
+
});
|
|
41159
|
+
});
|
|
41160
|
+
resource.command("get-contract-document").description(`Retrieve a contract document by ID, with its contents and their files.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
41161
|
+
Examples:
|
|
41162
|
+
hyperline contracts-documents get-contract-document --id <id>`).action(async (opts) => {
|
|
41163
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41164
|
+
if (!ctx) {
|
|
41165
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41166
|
+
process.exit(1);
|
|
41167
|
+
}
|
|
41168
|
+
const args = {};
|
|
41169
|
+
if (opts.id !== void 0)
|
|
41170
|
+
args.id = opts.id;
|
|
41171
|
+
await ctx.execute({
|
|
41172
|
+
method: "GET",
|
|
41173
|
+
path: "/v1/contracts/documents/{id}",
|
|
41174
|
+
args,
|
|
41175
|
+
queryParamKeys: []
|
|
41176
|
+
});
|
|
41177
|
+
});
|
|
41178
|
+
resource.command("update-contract-document").description(`Update the name or invoicing entities of a contract document. Its files are updated per content with \`update_contract_document_content\`.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Name of the contract document, displayed in the contract library.`).option("--invoicing-entity-ids <json>", `IDs of the invoicing entities for which the contract document is available when building a quote.`).addHelpText("after", `
|
|
41179
|
+
Examples:
|
|
41180
|
+
hyperline contracts-documents update-contract-document --id <id>
|
|
41181
|
+
hyperline contracts-documents update-contract-document --id <id> --name <name> --invoicing-entity-ids <invoicing_entity_ids>
|
|
41182
|
+
hyperline contracts-documents update-contract-document --id <id> --output json`).action(async (opts) => {
|
|
41183
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41184
|
+
if (!ctx) {
|
|
41185
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41186
|
+
process.exit(1);
|
|
41187
|
+
}
|
|
41188
|
+
const args = {};
|
|
41189
|
+
if (opts.id !== void 0)
|
|
41190
|
+
args.id = opts.id;
|
|
41191
|
+
if (opts.name !== void 0)
|
|
41192
|
+
args.name = opts.name;
|
|
41193
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41194
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41195
|
+
await ctx.execute({
|
|
41196
|
+
method: "PUT",
|
|
41197
|
+
path: "/v1/contracts/documents/{id}",
|
|
41198
|
+
args,
|
|
41199
|
+
queryParamKeys: []
|
|
41200
|
+
});
|
|
41201
|
+
});
|
|
41202
|
+
resource.command("delete-contract-document").description(`Delete a contract document from the contract library. Existing quotes keep their copy of the files.`).requiredOption("--id <value>", `id parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
41203
|
+
Examples:
|
|
41204
|
+
hyperline contracts-documents delete-contract-document --id <id>
|
|
41205
|
+
hyperline contracts-documents delete-contract-document --id <id> --output json`).action(async (opts) => {
|
|
41206
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41207
|
+
if (!ctx) {
|
|
41208
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41209
|
+
process.exit(1);
|
|
41210
|
+
}
|
|
41211
|
+
const args = {};
|
|
41212
|
+
if (opts.id !== void 0)
|
|
41213
|
+
args.id = opts.id;
|
|
41214
|
+
if (!opts.yes) {
|
|
41215
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41216
|
+
if (!confirmed) {
|
|
41217
|
+
process.stdout.write("Aborted.\n");
|
|
41218
|
+
return;
|
|
41219
|
+
}
|
|
41220
|
+
}
|
|
41221
|
+
await ctx.execute({
|
|
41222
|
+
method: "DELETE",
|
|
41223
|
+
path: "/v1/contracts/documents/{id}",
|
|
41224
|
+
args,
|
|
41225
|
+
queryParamKeys: []
|
|
41226
|
+
});
|
|
41227
|
+
});
|
|
41228
|
+
resource.command("create-contract-document-content").description(`Add a content to a contract document: its files for one language (\`default\` as fallback) and optional countries, sent as a comma-separated list. At least one PDF or Word file is required.`).requiredOption("--id <value>", `id parameter`).requiredOption("--language <value>", `Language of the content. \`default\` is used when no content exists for the customer language.`).option("--countries <value>", `Countries the content applies to, as ISO 3166-1 alpha-2 codes. Empty means all countries. In a multipart request, send a comma-separated list.`).requiredOption("--files <paths...>", `Paths of the local files to upload (space-separated, sends a multipart request)`).addHelpText("after", `
|
|
41229
|
+
Examples:
|
|
41230
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path>
|
|
41231
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path> --countries <countries>
|
|
41232
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path> --output json`).action(async (opts) => {
|
|
41233
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41234
|
+
if (!ctx) {
|
|
41235
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41236
|
+
process.exit(1);
|
|
41237
|
+
}
|
|
41238
|
+
const args = {};
|
|
41239
|
+
if (opts.id !== void 0)
|
|
41240
|
+
args.id = opts.id;
|
|
41241
|
+
if (opts.language !== void 0)
|
|
41242
|
+
args.language = opts.language;
|
|
41243
|
+
if (opts.countries !== void 0)
|
|
41244
|
+
args.countries = opts.countries;
|
|
41245
|
+
const files = {};
|
|
41246
|
+
if (opts.files !== void 0)
|
|
41247
|
+
files.files = [opts.files].flat();
|
|
41248
|
+
await ctx.execute({
|
|
41249
|
+
method: "POST",
|
|
41250
|
+
path: "/v1/contracts/documents/{id}/contents",
|
|
41251
|
+
args,
|
|
41252
|
+
queryParamKeys: [],
|
|
41253
|
+
files
|
|
41254
|
+
});
|
|
41255
|
+
});
|
|
41256
|
+
resource.command("update-contract-document-content").description(`Update a contract document content. Sent files replace all its existing files: use it to publish a new version of a document. Existing quotes keep their copy of the previous files.`).requiredOption("--id <value>", `id parameter`).requiredOption("--content-id <value>", `contentId parameter`).option("--language <value>", `Language of the content. \`default\` is used when no content exists for the customer language.`).option("--countries <value>", `Countries the content applies to, as ISO 3166-1 alpha-2 codes. Empty means all countries. In a multipart request, send a comma-separated list, or an empty value for all countries.`).option("--files <paths...>", `Paths of the local files to upload (space-separated, sends a multipart request)`).addHelpText("after", `
|
|
41257
|
+
Examples:
|
|
41258
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId>
|
|
41259
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId> --language <language> --countries <countries>
|
|
41260
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId> --output json`).action(async (opts) => {
|
|
41261
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41262
|
+
if (!ctx) {
|
|
41263
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41264
|
+
process.exit(1);
|
|
41265
|
+
}
|
|
41266
|
+
const args = {};
|
|
41267
|
+
if (opts.id !== void 0)
|
|
41268
|
+
args.id = opts.id;
|
|
41269
|
+
if (opts.contentId !== void 0)
|
|
41270
|
+
args.contentId = opts.contentId;
|
|
41271
|
+
if (opts.language !== void 0)
|
|
41272
|
+
args.language = opts.language;
|
|
41273
|
+
if (opts.countries !== void 0)
|
|
41274
|
+
args.countries = opts.countries;
|
|
41275
|
+
const files = {};
|
|
41276
|
+
if (opts.files !== void 0)
|
|
41277
|
+
files.files = [opts.files].flat();
|
|
41278
|
+
await ctx.execute({
|
|
41279
|
+
method: "PUT",
|
|
41280
|
+
path: "/v1/contracts/documents/{id}/contents/{contentId}",
|
|
41281
|
+
args,
|
|
41282
|
+
queryParamKeys: [],
|
|
41283
|
+
files
|
|
41284
|
+
});
|
|
41285
|
+
});
|
|
41286
|
+
resource.command("delete-contract-document-content").description(`Delete a content (one language and countries version) of a contract document.`).requiredOption("--id <value>", `id parameter`).requiredOption("--content-id <value>", `contentId parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
41287
|
+
Examples:
|
|
41288
|
+
hyperline contracts-documents delete-contract-document-content --id <id> --content-id <contentId>
|
|
41289
|
+
hyperline contracts-documents delete-contract-document-content --id <id> --content-id <contentId> --output json`).action(async (opts) => {
|
|
41290
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41291
|
+
if (!ctx) {
|
|
41292
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41293
|
+
process.exit(1);
|
|
41294
|
+
}
|
|
41295
|
+
const args = {};
|
|
41296
|
+
if (opts.id !== void 0)
|
|
41297
|
+
args.id = opts.id;
|
|
41298
|
+
if (opts.contentId !== void 0)
|
|
41299
|
+
args.contentId = opts.contentId;
|
|
41300
|
+
if (!opts.yes) {
|
|
41301
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41302
|
+
if (!confirmed) {
|
|
41303
|
+
process.stdout.write("Aborted.\n");
|
|
41304
|
+
return;
|
|
41305
|
+
}
|
|
41306
|
+
}
|
|
41307
|
+
await ctx.execute({
|
|
41308
|
+
method: "DELETE",
|
|
41309
|
+
path: "/v1/contracts/documents/{id}/contents/{contentId}",
|
|
41310
|
+
args,
|
|
41311
|
+
queryParamKeys: []
|
|
41312
|
+
});
|
|
41313
|
+
});
|
|
41314
|
+
}
|
|
41315
|
+
|
|
40867
41316
|
// build/commands/generated/coupons.js
|
|
40868
41317
|
function registerCouponsCommands(parent) {
|
|
40869
41318
|
const resource = parent.command("coupons").description("Manage coupons");
|
|
@@ -41315,7 +41764,7 @@ Examples:
|
|
|
41315
41764
|
// build/commands/generated/customers.js
|
|
41316
41765
|
function registerCustomersCommands(parent) {
|
|
41317
41766
|
const resource = parent.command("customers").description("Manage customers");
|
|
41318
|
-
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, tax_id_status, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.`).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("--include-total <value>", `Set to \`true\` to include \`total\` in the response.`).option("--order <value>", `Sort direction.`).option("--sort <value>", `Field used to sort the results.`).option("--tax-id-status <value>", `
|
|
41767
|
+
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, tax_id_status, subscription_status, invoicing_entity_id, segment_id, custom_properties (JSON object of slug to exact value, e.g. {"my_slug":"value"}; slugs matching no custom property are ignored), payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.`).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("--include-total <value>", `Set to \`true\` to include \`total\` in the response.`).option("--order <value>", `Sort direction.`).option("--sort <value>", `Field used to sort the results.`).option("--tax-id-status <value>", `
|
|
41319
41768
|
Verification status of the customer tax ID.
|
|
41320
41769
|
|
|
41321
41770
|
- \`valid\`: Tax ID has been verified and is valid.
|
|
@@ -41323,7 +41772,7 @@ Verification status of the customer tax ID.
|
|
|
41323
41772
|
- \`mismatch\`: Tax ID is valid but is for a different country than the customer's country.
|
|
41324
41773
|
- \`unverified\`: Tax ID has not been verified yet.
|
|
41325
41774
|
- \`unsupported\`: Tax ID verification for this type not supported yet.
|
|
41326
|
-
`).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("--type <value>", `type`).option("--type.in <value>", `type__in`).option("--status <value>", `status`).option("--status.in <value>", `status__in`).option("--currency <value>", `currency`).option("--currency.not <value>", `currency__not`).option("--currency.equals <value>", `currency__equals`).option("--currency.contains <value>", `currency__contains`).option("--currency.starts-with <value>", `currency__startsWith`).option("--currency.end-with <value>", `currency__endWith`).option("--currency.is-null <value>", `currency__isNull`).option("--currency.is-not-null <value>", `currency__isNotNull`).option("--country <value>", `country`).option("--country.not <value>", `country__not`).option("--country.equals <value>", `country__equals`).option("--country.contains <value>", `country__contains`).option("--country.starts-with <value>", `country__startsWith`).option("--country.end-with <value>", `country__endWith`).option("--country.is-null <value>", `country__isNull`).option("--country.is-not-null <value>", `country__isNotNull`).option("--external-id <value>", `external_id`).option("--external-id.not <value>", `external_id__not`).option("--external-id.equals <value>", `external_id__equals`).option("--external-id.contains <value>", `external_id__contains`).option("--external-id.starts-with <value>", `external_id__startsWith`).option("--external-id.end-with <value>", `external_id__endWith`).option("--external-id.is-null <value>", `external_id__isNull`).option("--external-id.is-not-null <value>", `external_id__isNotNull`).option("--billing-email <value>", `billing_email`).option("--billing-email.not <value>", `billing_email__not`).option("--billing-email.equals <value>", `billing_email__equals`).option("--billing-email.contains <value>", `billing_email__contains`).option("--billing-email.starts-with <value>", `billing_email__startsWith`).option("--billing-email.end-with <value>", `billing_email__endWith`).option("--billing-email.is-null <value>", `billing_email__isNull`).option("--billing-email.is-not-null <value>", `billing_email__isNotNull`).option("--search <value>", `search`).option("--tax-id <value>", `tax_id`).option("--tax-id.not <value>", `tax_id__not`).option("--tax-id.equals <value>", `tax_id__equals`).option("--tax-id.contains <value>", `tax_id__contains`).option("--tax-id.starts-with <value>", `tax_id__startsWith`).option("--tax-id.end-with <value>", `tax_id__endWith`).option("--tax-id.is-null <value>", `tax_id__isNull`).option("--tax-id.is-not-null <value>", `tax_id__isNotNull`).option("--subscription-status <value>", `subscription_status`).option("--subscription-status.in <value>", `subscription_status__in`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--invoicing-entity-id.not <value>", `invoicing_entity_id__not`).option("--invoicing-entity-id.equals <value>", `invoicing_entity_id__equals`).option("--invoicing-entity-id.contains <value>", `invoicing_entity_id__contains`).option("--invoicing-entity-id.starts-with <value>", `invoicing_entity_id__startsWith`).option("--invoicing-entity-id.end-with <value>", `invoicing_entity_id__endWith`).option("--segment-id <value>", `segment_id`).option("--custom-properties <value>", `
|
|
41775
|
+
`).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("--type <value>", `type`).option("--type.in <value>", `type__in`).option("--status <value>", `status`).option("--status.in <value>", `status__in`).option("--currency <value>", `currency`).option("--currency.not <value>", `currency__not`).option("--currency.equals <value>", `currency__equals`).option("--currency.contains <value>", `currency__contains`).option("--currency.starts-with <value>", `currency__startsWith`).option("--currency.end-with <value>", `currency__endWith`).option("--currency.is-null <value>", `currency__isNull`).option("--currency.is-not-null <value>", `currency__isNotNull`).option("--country <value>", `country`).option("--country.not <value>", `country__not`).option("--country.equals <value>", `country__equals`).option("--country.contains <value>", `country__contains`).option("--country.starts-with <value>", `country__startsWith`).option("--country.end-with <value>", `country__endWith`).option("--country.is-null <value>", `country__isNull`).option("--country.is-not-null <value>", `country__isNotNull`).option("--external-id <value>", `external_id`).option("--external-id.not <value>", `external_id__not`).option("--external-id.equals <value>", `external_id__equals`).option("--external-id.contains <value>", `external_id__contains`).option("--external-id.starts-with <value>", `external_id__startsWith`).option("--external-id.end-with <value>", `external_id__endWith`).option("--external-id.is-null <value>", `external_id__isNull`).option("--external-id.is-not-null <value>", `external_id__isNotNull`).option("--billing-email <value>", `billing_email`).option("--billing-email.not <value>", `billing_email__not`).option("--billing-email.equals <value>", `billing_email__equals`).option("--billing-email.contains <value>", `billing_email__contains`).option("--billing-email.starts-with <value>", `billing_email__startsWith`).option("--billing-email.end-with <value>", `billing_email__endWith`).option("--billing-email.is-null <value>", `billing_email__isNull`).option("--billing-email.is-not-null <value>", `billing_email__isNotNull`).option("--search <value>", `search`).option("--tax-id <value>", `tax_id`).option("--tax-id.not <value>", `tax_id__not`).option("--tax-id.equals <value>", `tax_id__equals`).option("--tax-id.contains <value>", `tax_id__contains`).option("--tax-id.starts-with <value>", `tax_id__startsWith`).option("--tax-id.end-with <value>", `tax_id__endWith`).option("--tax-id.is-null <value>", `tax_id__isNull`).option("--tax-id.is-not-null <value>", `tax_id__isNotNull`).option("--subscription-status <value>", `subscription_status`).option("--subscription-status.in <value>", `subscription_status__in`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--invoicing-entity-id.not <value>", `invoicing_entity_id__not`).option("--invoicing-entity-id.equals <value>", `invoicing_entity_id__equals`).option("--invoicing-entity-id.contains <value>", `invoicing_entity_id__contains`).option("--invoicing-entity-id.starts-with <value>", `invoicing_entity_id__startsWith`).option("--invoicing-entity-id.end-with <value>", `invoicing_entity_id__endWith`).option("--segment-id <value>", `segment_id`).option("--custom-properties <value>", `Filter by custom property values, as a JSON object mapping a custom property slug to the exact value to match. Suffix a slug with \`__contains\` for a case-sensitive substring match on text values. Several entries are combined with AND. Entries whose slug matches no custom property, or whose value is \`false\`, \`0\`, \`null\` or an empty string, are ignored.`).option("--payment-method-type <value>", `payment_method_type`).option("--payment-method-type.in <value>", `payment_method_type__in`).option("--integration-entity-id <value>", `integration_entity_id`).option("--created-at <value>", `created_at`).option("--created-at.not <value>", `created_at__not`).option("--created-at.equals <value>", `created_at__equals`).option("--created-at.lt <value>", `created_at__lt`).option("--created-at.lte <value>", `created_at__lte`).option("--created-at.gt <value>", `created_at__gt`).option("--created-at.gte <value>", `created_at__gte`).option("--updated-at <value>", `updated_at`).option("--updated-at.not <value>", `updated_at__not`).option("--updated-at.equals <value>", `updated_at__equals`).option("--updated-at.lt <value>", `updated_at__lt`).option("--updated-at.lte <value>", `updated_at__lte`).option("--updated-at.gt <value>", `updated_at__gt`).option("--updated-at.gte <value>", `updated_at__gte`).addHelpText("after", `
|
|
41327
41776
|
Examples:
|
|
41328
41777
|
hyperline customers list
|
|
41329
41778
|
hyperline customers list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
@@ -41621,13 +42070,13 @@ Customer type.
|
|
|
41621
42070
|
|
|
41622
42071
|
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
41623
42072
|
- \`exempt\`: The customer is exempt from tax.
|
|
41624
|
-
`).option("--registration-number <value>", `Customer registration number.`).option("--einvoicing-code <value>", `Customer electronic invoicing code, used to route their e-invoices to the relevant platform (e.g. Chorus Pro routing code or Peppol identifier).`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <json>", `Customer billing address.`).option("--shipping-address <json>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <json>", `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 <json>", `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 <json>", `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>", `
|
|
42073
|
+
`).option("--registration-number <value>", `Customer registration number.`).option("--einvoicing-code <value>", `Customer electronic invoicing code, used to route their e-invoices to the relevant platform (e.g. Chorus Pro routing code or Peppol identifier).`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline. When external ID uniqueness is enforced for your account, two active customers cannot share the same external ID.`).option("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <json>", `Customer billing address.`).option("--shipping-address <json>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <json>", `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 <json>", `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 <json>", `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>", `
|
|
41625
42074
|
How customer invoices are issued from the parent organisation.
|
|
41626
42075
|
|
|
41627
42076
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
41628
42077
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
41629
42078
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
41630
|
-
`).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", `
|
|
41631
42080
|
Examples:
|
|
41632
42081
|
hyperline customers create-customer
|
|
41633
42082
|
hyperline customers create-customer --name <name> --type <type>
|
|
@@ -41672,6 +42121,8 @@ Examples:
|
|
|
41672
42121
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
41673
42122
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
41674
42123
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42124
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42125
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
41675
42126
|
if (opts.forceInvoiceDraft !== void 0)
|
|
41676
42127
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
41677
42128
|
if (opts.priceBookId !== void 0)
|
|
@@ -41758,13 +42209,13 @@ Customer type.
|
|
|
41758
42209
|
|
|
41759
42210
|
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
41760
42211
|
- \`exempt\`: The customer is exempt from tax.
|
|
41761
|
-
`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--einvoicing-code <value>", `Customer electronic invoicing code, used to route their e-invoices to the relevant platform (e.g. Chorus Pro routing code or Peppol identifier).`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <json>", `Customer billing address.`).option("--shipping-address <json>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <json>", `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 <json>", `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 <json>", `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>", `
|
|
42212
|
+
`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--einvoicing-code <value>", `Customer electronic invoicing code, used to route their e-invoices to the relevant platform (e.g. Chorus Pro routing code or Peppol identifier).`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline. When external ID uniqueness is enforced for your account, two active customers cannot share the same external ID.`).option("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <json>", `Customer billing address.`).option("--shipping-address <json>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <json>", `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 <json>", `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 <json>", `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>", `
|
|
41762
42213
|
How customer invoices are issued from the parent organisation.
|
|
41763
42214
|
|
|
41764
42215
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
41765
42216
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
41766
42217
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
41767
|
-
`).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", `
|
|
41768
42219
|
Examples:
|
|
41769
42220
|
hyperline customers update --id <id>
|
|
41770
42221
|
hyperline customers update --id <id> --name <name> --type <type>
|
|
@@ -41813,6 +42264,8 @@ Examples:
|
|
|
41813
42264
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
41814
42265
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
41815
42266
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42267
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42268
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
41816
42269
|
if (opts.forceInvoiceDraft !== void 0)
|
|
41817
42270
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
41818
42271
|
if (opts.priceBookId !== void 0)
|
|
@@ -42044,7 +42497,13 @@ Examples:
|
|
|
42044
42497
|
queryParamKeys: []
|
|
42045
42498
|
});
|
|
42046
42499
|
});
|
|
42047
|
-
resource.command("create-customer-address").description(`Create a shipping address with type shipping; billing creation is rejected because a customer can have at most one billing address, managed through the customer endpoint.`).requiredOption("--customer-id <value>", `customerId parameter`).requiredOption("--type <value>", `Only shipping addresses can be created here. A customer has at most one active billing address, managed through the customer or by updating its address ID.`).option("--name <value>", `Address name.`).option("--line1 <value>", `Address first line.`).option("--line2 <value>", `Address second line (optional).`).option("--city <value>", `Address city.`).option("--zip <value>", `Address ZIP code.`).option("--state <value>", `
|
|
42500
|
+
resource.command("create-customer-address").description(`Create a shipping address with type shipping; billing creation is rejected because a customer can have at most one billing address, managed through the customer endpoint.`).requiredOption("--customer-id <value>", `customerId parameter`).requiredOption("--type <value>", `Only shipping addresses can be created here. A customer has at most one active billing address, managed through the customer or by updating its address ID.`).option("--name <value>", `Address name.`).option("--line1 <value>", `Address first line.`).option("--line2 <value>", `Address second line (optional).`).option("--city <value>", `Address city.`).option("--zip <value>", `Address ZIP code.`).option("--state <value>", `State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. \`CA\` for \`US-CA\`) for:
|
|
42501
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
42502
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
42503
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
42504
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
42505
|
+
|
|
42506
|
+
A code or a name is accepted (e.g. \`ON\` or \`Ontario\`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.`).option("--country <value>", `Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).`).option("--tax-id <value>", `Tax ID override for a shipping address. Null or blank inherits the customer's tax ID; omission on update preserves the override. Billing addresses cannot have an override.`).addHelpText("after", `
|
|
42048
42507
|
Examples:
|
|
42049
42508
|
hyperline customers-address create-customer-address --customer-id <customerId> --type <type>
|
|
42050
42509
|
hyperline customers-address create-customer-address --customer-id <customerId> --type <type> --name <name> --line1 <line1>
|
|
@@ -42082,7 +42541,13 @@ Examples:
|
|
|
42082
42541
|
queryParamKeys: []
|
|
42083
42542
|
});
|
|
42084
42543
|
});
|
|
42085
|
-
resource.command("update-customer-address").description(`Update a billing or shipping address by ID; billing changes also update the customer billing-address projection.`).requiredOption("--customer-id <value>", `customerId parameter`).requiredOption("--address-id <value>", `addressId parameter`).option("--name <value>", `Address name.`).option("--line1 <value>", `Address first line.`).option("--line2 <value>", `Address second line (optional).`).option("--city <value>", `Address city.`).option("--zip <value>", `Address ZIP code.`).option("--state <value>", `
|
|
42544
|
+
resource.command("update-customer-address").description(`Update a billing or shipping address by ID; billing changes also update the customer billing-address projection.`).requiredOption("--customer-id <value>", `customerId parameter`).requiredOption("--address-id <value>", `addressId parameter`).option("--name <value>", `Address name.`).option("--line1 <value>", `Address first line.`).option("--line2 <value>", `Address second line (optional).`).option("--city <value>", `Address city.`).option("--zip <value>", `Address ZIP code.`).option("--state <value>", `State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. \`CA\` for \`US-CA\`) for:
|
|
42545
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
42546
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
42547
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
42548
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
42549
|
+
|
|
42550
|
+
A code or a name is accepted (e.g. \`ON\` or \`Ontario\`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.`).option("--country <value>", `Two-letter country code in ISO format. See [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).`).option("--tax-id <value>", `Tax ID override for a shipping address. Null or blank inherits the customer's tax ID; omission on update preserves the override. Billing addresses cannot have an override.`).addHelpText("after", `
|
|
42086
42551
|
Examples:
|
|
42087
42552
|
hyperline customers-address update-customer-address --customer-id <customerId> --address-id <addressId>
|
|
42088
42553
|
hyperline customers-address update-customer-address --customer-id <customerId> --address-id <addressId> --name <name> --line1 <line1>
|
|
@@ -43332,10 +43797,10 @@ Examples:
|
|
|
43332
43797
|
]
|
|
43333
43798
|
});
|
|
43334
43799
|
});
|
|
43335
|
-
resource.command("create").description(`Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name and customer_id).`).requiredOption("--name <value>", `Name of the file to be uploaded.`).requiredOption("--customer-id <value>", `ID of the customer to link the file to.`).addHelpText("after", `
|
|
43800
|
+
resource.command("create").description(`Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name and customer_id).`).requiredOption("--name <value>", `Name of the file to be uploaded.`).requiredOption("--customer-id <value>", `ID of the customer to link the file to.`).requiredOption("--file <path>", `Path of the local file to upload (sends a multipart request)`).addHelpText("after", `
|
|
43336
43801
|
Examples:
|
|
43337
|
-
hyperline files create --name <name> --customer-id <customer_id>
|
|
43338
|
-
hyperline files create --name <name> --customer-id <customer_id> --output json`).action(async (opts) => {
|
|
43802
|
+
hyperline files create --name <name> --customer-id <customer_id> --file <path>
|
|
43803
|
+
hyperline files create --name <name> --customer-id <customer_id> --file <path> --output json`).action(async (opts) => {
|
|
43339
43804
|
const ctx = resource.parent?.opts()._ctx;
|
|
43340
43805
|
if (!ctx) {
|
|
43341
43806
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -43346,11 +43811,15 @@ Examples:
|
|
|
43346
43811
|
args.name = opts.name;
|
|
43347
43812
|
if (opts.customerId !== void 0)
|
|
43348
43813
|
args.customer_id = opts.customerId;
|
|
43814
|
+
const files = {};
|
|
43815
|
+
if (opts.file !== void 0)
|
|
43816
|
+
files.file = [opts.file].flat();
|
|
43349
43817
|
await ctx.execute({
|
|
43350
43818
|
method: "POST",
|
|
43351
43819
|
path: "/v1/files",
|
|
43352
43820
|
args,
|
|
43353
|
-
queryParamKeys: []
|
|
43821
|
+
queryParamKeys: [],
|
|
43822
|
+
files
|
|
43354
43823
|
});
|
|
43355
43824
|
});
|
|
43356
43825
|
resource.command("delete").description(`Permanently delete a file by ID.`).requiredOption("--id <value>", `id parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
@@ -43707,7 +44176,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
43707
44176
|
|
|
43708
44177
|
- \`current\`: Use the current default payment method of the customer.
|
|
43709
44178
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
43710
|
-
`).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", `
|
|
43711
44180
|
Examples:
|
|
43712
44181
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
43713
44182
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -43760,6 +44229,10 @@ Examples:
|
|
|
43760
44229
|
args.settled_at = opts.settledAt;
|
|
43761
44230
|
if (opts.issuingMethod !== void 0)
|
|
43762
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;
|
|
43763
44236
|
if (opts.properties !== void 0)
|
|
43764
44237
|
args.properties = JSON.parse(opts.properties);
|
|
43765
44238
|
if (opts.customProperties !== void 0)
|
|
@@ -43768,6 +44241,8 @@ Examples:
|
|
|
43768
44241
|
args.additional_display_fields = JSON.parse(opts.additionalDisplayFields);
|
|
43769
44242
|
if (opts.lineItems !== void 0)
|
|
43770
44243
|
args.line_items = JSON.parse(opts.lineItems);
|
|
44244
|
+
if (opts.allocations !== void 0)
|
|
44245
|
+
args.allocations = JSON.parse(opts.allocations);
|
|
43771
44246
|
if (opts.transactions !== void 0)
|
|
43772
44247
|
args.transactions = JSON.parse(opts.transactions);
|
|
43773
44248
|
if (opts.coupons !== void 0)
|
|
@@ -43903,6 +44378,36 @@ Examples:
|
|
|
43903
44378
|
queryParamKeys: []
|
|
43904
44379
|
});
|
|
43905
44380
|
});
|
|
44381
|
+
resource.command("send-invoice-emails").description(`Send a specific email (\`email_type\`, e.g. \`invoice_ready\` for the to-pay email) to the customer for a list of invoice IDs, asynchronously in batch. Returns a batch_id only; outcomes arrive via webhooks (invoice.batch.email_succeeded / invoice.batch.email_skipped / invoice.batch.email_failed). An invoice whose status doesn't match the email (e.g. a draft or an invoice still pending approval after validate_invoice) is skipped, so check each invoice's status with get_invoice first. Every call sends the emails again: never re-call it to retry or check status.`).option("--batch-id <value>", `Optional client-supplied identifier for the batch. Echoed back in the response and on the emitted webhook events. Generated if omitted.`).requiredOption("--email-type <value>", `The email to send. The invoice's status must resolve to this email, otherwise it is skipped with reason \`email_type_mismatch\`.
|
|
44382
|
+
|
|
44383
|
+
- \`invoice_ready\`: The to-pay invoice email (for \`to_pay\`, \`partially_paid\`, \`late\` invoices).
|
|
44384
|
+
- \`invoice_settled\`: The paid-invoice email (for \`paid\` invoices).
|
|
44385
|
+
- \`invoice_errored\`: The failed-payment email (for \`error\` invoices with a payment method).
|
|
44386
|
+
- \`credit_note_ready\`: The issued-credit-note email (for \`to_pay\`, \`partially_paid\` refunds).
|
|
44387
|
+
- \`credit_note_settled\`: The credit-note email (for paid refunds).`).requiredOption("--ids <json>", `IDs of the invoices to send the email for. Processed asynchronously; each outcome is reported via webhook events.`).addHelpText("after", `
|
|
44388
|
+
Examples:
|
|
44389
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids>
|
|
44390
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids> --batch-id <batch_id>
|
|
44391
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids> --output json`).action(async (opts) => {
|
|
44392
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
44393
|
+
if (!ctx) {
|
|
44394
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
44395
|
+
process.exit(1);
|
|
44396
|
+
}
|
|
44397
|
+
const args = {};
|
|
44398
|
+
if (opts.batchId !== void 0)
|
|
44399
|
+
args.batch_id = opts.batchId;
|
|
44400
|
+
if (opts.emailType !== void 0)
|
|
44401
|
+
args.email_type = opts.emailType;
|
|
44402
|
+
if (opts.ids !== void 0)
|
|
44403
|
+
args.ids = JSON.parse(opts.ids);
|
|
44404
|
+
await ctx.execute({
|
|
44405
|
+
method: "POST",
|
|
44406
|
+
path: "/v1/invoices/send-email",
|
|
44407
|
+
args,
|
|
44408
|
+
queryParamKeys: []
|
|
44409
|
+
});
|
|
44410
|
+
});
|
|
43906
44411
|
resource.command("mark-invoice-as-uncollectible").description(`Mark an invoice as uncollectible for accounting write-off purposes. The invoice remains in the system for record keeping.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
43907
44412
|
Examples:
|
|
43908
44413
|
hyperline invoices mark-invoice-as-uncollectible --id <id>
|
|
@@ -43940,7 +44445,28 @@ Examples:
|
|
|
43940
44445
|
queryParamKeys: []
|
|
43941
44446
|
});
|
|
43942
44447
|
});
|
|
43943
|
-
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.
|
|
43944
44470
|
|
|
43945
44471
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
43946
44472
|
- \`credit_note\`: Legal credit note cancelling an invoice and refunding your customer.
|
|
@@ -43949,7 +44475,7 @@ Examples:
|
|
|
43949
44475
|
|
|
43950
44476
|
- \`auto\`: Tax is automatically computed and applied.
|
|
43951
44477
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
43952
|
-
`).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>", `
|
|
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", `
|
|
43953
44479
|
Examples:
|
|
43954
44480
|
hyperline invoices update --id <id>
|
|
43955
44481
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -43990,6 +44516,8 @@ Examples:
|
|
|
43990
44516
|
args.bank_account_id = opts.bankAccountId;
|
|
43991
44517
|
if (opts.subscriptionId !== void 0)
|
|
43992
44518
|
args.subscription_id = opts.subscriptionId;
|
|
44519
|
+
if (opts.originalInvoiceId !== void 0)
|
|
44520
|
+
args.original_invoice_id = opts.originalInvoiceId;
|
|
43993
44521
|
if (opts.lineItems !== void 0)
|
|
43994
44522
|
args.line_items = JSON.parse(opts.lineItems);
|
|
43995
44523
|
if (opts.coupons !== void 0)
|
|
@@ -44035,10 +44563,10 @@ Examples:
|
|
|
44035
44563
|
queryParamKeys: []
|
|
44036
44564
|
});
|
|
44037
44565
|
});
|
|
44038
|
-
resource.command("upload-pdf-to").description(`Upload a custom PDF file (max 5MB) to attach to an existing invoice, replacing the auto-generated PDF.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
44566
|
+
resource.command("upload-pdf-to").description(`Upload a custom PDF file (max 5MB) to attach to an existing invoice, replacing the auto-generated PDF.`).requiredOption("--id <value>", `id parameter`).requiredOption("--file <path>", `Path of the local file to upload (sends a multipart request)`).addHelpText("after", `
|
|
44039
44567
|
Examples:
|
|
44040
|
-
hyperline invoices upload-pdf-to --id <id>
|
|
44041
|
-
hyperline invoices upload-pdf-to --id <id> --output json`).action(async (opts) => {
|
|
44568
|
+
hyperline invoices upload-pdf-to --id <id> --file <path>
|
|
44569
|
+
hyperline invoices upload-pdf-to --id <id> --file <path> --output json`).action(async (opts) => {
|
|
44042
44570
|
const ctx = resource.parent?.opts()._ctx;
|
|
44043
44571
|
if (!ctx) {
|
|
44044
44572
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -44047,11 +44575,15 @@ Examples:
|
|
|
44047
44575
|
const args = {};
|
|
44048
44576
|
if (opts.id !== void 0)
|
|
44049
44577
|
args.id = opts.id;
|
|
44578
|
+
const files = {};
|
|
44579
|
+
if (opts.file !== void 0)
|
|
44580
|
+
files.file = [opts.file].flat();
|
|
44050
44581
|
await ctx.execute({
|
|
44051
44582
|
method: "POST",
|
|
44052
44583
|
path: "/v1/invoices/{id}/upload",
|
|
44053
44584
|
args,
|
|
44054
|
-
queryParamKeys: []
|
|
44585
|
+
queryParamKeys: [],
|
|
44586
|
+
files
|
|
44055
44587
|
});
|
|
44056
44588
|
});
|
|
44057
44589
|
resource.command("download").description(`Download the PDF of an invoice as a downloadable file. The HTTP client must follow redirects. Supports lang/locale params for localization.`).requiredOption("--id <value>", `id parameter`).option("--lang <value>", `lang`).option("--locale <value>", `Locale as a supported language code and an uppercase ISO 3166-1 alpha-2 country code, separated by a hyphen.`).addHelpText("after", `
|
|
@@ -44190,7 +44722,13 @@ Examples:
|
|
|
44190
44722
|
queryParamKeys: []
|
|
44191
44723
|
});
|
|
44192
44724
|
});
|
|
44193
|
-
resource.command("create-invoicing-entity").description(`Create a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.`).option("--is-default", `Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.`).requiredOption("--name <value>", `The name of the invoicing entity.`).option("--trade-name <value>", `The trade name of the invoicing entity.`).option("--timezone <value>", `The timezone the invoicing entity operates in.`).option("--language <value>", `The default language of the invoicing entity.`).option("--registration-number <value>", `The registration number of the invoicing entity.`).option("--tax-id <value>", `The tax identification number of the invoicing entity.`).option("--billing-email <value>", `The billing email address for the invoicing entity.`).option("--address-line1 <value>", `The first line of the address for the invoicing entity.`).option("--address-line2 <value>", `The second line of the address for the invoicing entity.`).option("--zip-code <value>", `The postal code for the invoicing entity's address.`).option("--state <value>", `
|
|
44725
|
+
resource.command("create-invoicing-entity").description(`Create a new invoicing entity with company details, address, and tax configuration. Used as the sender on invoices.`).option("--is-default", `Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.`).requiredOption("--name <value>", `The name of the invoicing entity.`).option("--trade-name <value>", `The trade name of the invoicing entity.`).option("--timezone <value>", `The timezone the invoicing entity operates in.`).option("--language <value>", `The default language of the invoicing entity.`).option("--registration-number <value>", `The registration number of the invoicing entity.`).option("--tax-id <value>", `The tax identification number of the invoicing entity.`).option("--billing-email <value>", `The billing email address for the invoicing entity.`).option("--address-line1 <value>", `The first line of the address for the invoicing entity.`).option("--address-line2 <value>", `The second line of the address for the invoicing entity.`).option("--zip-code <value>", `The postal code for the invoicing entity's address.`).option("--state <value>", `State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. \`CA\` for \`US-CA\`) for:
|
|
44726
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
44727
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
44728
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
44729
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
44730
|
+
|
|
44731
|
+
A code or a name is accepted (e.g. \`ON\` or \`Ontario\`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.`).option("--city <value>", `The city of the invoicing entity.`).requiredOption("--country <value>", `The country in which the invoicing entity is registered. It cannot be changed after creation.`).requiredOption("--currency <value>", `The currency code that the invoicing entity operates in.`).requiredOption("--accounting-currency <value>", `The currency used for accounting purposes.`).option("--invoice-number-pattern <value>", `The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--credit-note-number-pattern <value>", `The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--document-number-pattern <value>", `The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--next-invoice-number <number>", `The next invoice number to be used.`).option("--next-credit-note-number <number>", `The next credit note number to be used.`).option("--next-document-number <number>", `The next document number to be used.`).option("--default-payment-delay <number>", `The default payment term in days.`).option("--invoice-grace-period-duration <number>", `The grace period duration in days.`).option("--invoice-payment-initiation-delay <number>", `The payment initiation delay in days for the invoices.`).option("--document-payment-initiation-delay <number>", `The payment initiation delay in days for the custom documents.`).option("--invoice-late-fees <value>", `The late fees applicable to the invoices.`).option("--invoice-footer <value>", `The footer text to be used in invoices.`).option("--document-footer <value>", `The footer text to be used in documents. If not specified, the invoice footer will be used.`).option("--quote-footer <value>", `The footer text to be used in quotes.`).option("--logo-url <value>", `URL of the logo to be used in invoices.`).option("--favicon-url <value>", `URL of the logo to be used as favicon.`).option("--brand-color <value>", `Brand color to be used in invoices (hexadecimal color code).`).option("--forced-customer-type <value>", `Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.`).option("--credit-note-wallet-refund-enabled", `When enabled and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity. Defaults to \`true\`.`).option("--fx-conversion-display-enabled", `Whether the exchange rate and converted amount in the accounting currency are displayed on the invoice PDF when the invoice currency differs from the accounting currency. The conversion data is still stored and returned by the API when disabled. Defaults to \`true\`.`).addHelpText("after", `
|
|
44194
44732
|
Examples:
|
|
44195
44733
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
44196
44734
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -44282,7 +44820,13 @@ Examples:
|
|
|
44282
44820
|
queryParamKeys: []
|
|
44283
44821
|
});
|
|
44284
44822
|
});
|
|
44285
|
-
resource.command("update-invoicing-entity").description(`Update an existing invoicing entity's details (address, tax ID, branding, etc.).`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `The name of the invoicing entity.`).option("--registration-number <value>", `The registration number of the invoicing entity.`).option("--tax-id <value>", `The tax identification number of the invoicing entity.`).option("--billing-email <value>", `The billing email address for the invoicing entity.`).option("--timezone <value>", `The timezone the invoicing entity operates in.`).option("--language <value>", `The default language of the invoicing entity.`).option("--is-default", `Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.`).option("--address-line1 <value>", `The first line of the address for the invoicing entity.`).option("--address-line2 <value>", `The second line of the address for the invoicing entity.`).option("--zip-code <value>", `The postal code for the invoicing entity's address.`).option("--state <value>", `
|
|
44823
|
+
resource.command("update-invoicing-entity").description(`Update an existing invoicing entity's details (address, tax ID, branding, etc.).`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `The name of the invoicing entity.`).option("--registration-number <value>", `The registration number of the invoicing entity.`).option("--tax-id <value>", `The tax identification number of the invoicing entity.`).option("--billing-email <value>", `The billing email address for the invoicing entity.`).option("--timezone <value>", `The timezone the invoicing entity operates in.`).option("--language <value>", `The default language of the invoicing entity.`).option("--is-default", `Flag to indicate if this is the default invoicing entity. If true, it will switch the other existing invoicing entities to non-default.`).option("--address-line1 <value>", `The first line of the address for the invoicing entity.`).option("--address-line2 <value>", `The second line of the address for the invoicing entity.`).option("--zip-code <value>", `The postal code for the invoicing entity's address.`).option("--state <value>", `State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. \`CA\` for \`US-CA\`) for:
|
|
44824
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
44825
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
44826
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
44827
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
44828
|
+
|
|
44829
|
+
A code or a name is accepted (e.g. \`ON\` or \`Ontario\`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.`).option("--city <value>", `The city of the invoicing entity.`).option("--country <value>", `The country in which the invoicing entity is registered. It cannot be changed after creation.`).option("--currency <value>", `The currency code that the invoicing entity operates in.`).option("--accounting-currency <value>", `The currency used for accounting purposes.`).option("--invoice-number-pattern <value>", `The pattern used for generating invoice numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--credit-note-number-pattern <value>", `The pattern used for generating credit note numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--document-number-pattern <value>", `The pattern used for generating document numbers. Available dynamic elements: number {number} (mandatory), year {YYYY}, month {MM} and day {DD}.`).option("--default-payment-delay <number>", `The default payment term in days.`).option("--invoice-grace-period-duration <number>", `The grace period duration in days.`).option("--invoice-payment-initiation-delay <number>", `The payment initiation delay in days for the invoices.`).option("--document-payment-initiation-delay <number>", `The payment initiation delay in days for the custom documents.`).option("--invoice-late-fees <value>", `The late fees applicable to the invoices.`).option("--invoice-footer <value>", `The footer text to be used in invoices.`).option("--document-footer <value>", `The footer text to be used in documents. If not specified, the invoice footer will be used.`).option("--logo-url <value>", `URL of the logo to be used in invoices.`).option("--favicon-url <value>", `URL of the logo to be used as favicon.`).option("--brand-color <value>", `Brand color to be used in invoices (hexadecimal color code).`).option("--forced-customer-type <value>", `Forces all customers created under this invoicing entity to have this type. Set to null to allow users to choose.`).option("--credit-note-wallet-refund-enabled", `When enabled and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity. Defaults to \`true\`.`).option("--fx-conversion-display-enabled", `Whether the exchange rate and converted amount in the accounting currency are displayed on the invoice PDF when the invoice currency differs from the accounting currency. The conversion data is still stored and returned by the API when disabled. Defaults to \`true\`.`).addHelpText("after", `
|
|
44286
44830
|
Examples:
|
|
44287
44831
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
44288
44832
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -44529,7 +45073,7 @@ function registerPaymentsCommands(parent) {
|
|
|
44529
45073
|
Payment type.
|
|
44530
45074
|
|
|
44531
45075
|
- \`one_time\`: One-time payment, generating one-off invoice.
|
|
44532
|
-
`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--products <json>", `Products composing the related invoice.`).option("--purchase-order <value>", `Purchase order added on the generated invoice.`).option("--custom-note <value>", `Custom note added on the generated invoice.`).requiredOption("--charging-method <value>", `
|
|
45076
|
+
`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--products <json>", `Products composing the related invoice.`).option("--purchase-order <value>", `Purchase order added on the generated invoice.`).option("--custom-note <value>", `Custom note added on the generated invoice.`).option("--coupons <json>", `Coupons applied to the generated invoice before the checkout is created, so the checkout email already shows the discounted amount. \`line_item_indexes\` refer to the position of the products in \`products\`. Only supported with the \`checkout\` charging method.`).requiredOption("--charging-method <value>", `
|
|
44533
45077
|
Charging method.
|
|
44534
45078
|
|
|
44535
45079
|
- \`immediately\`: Customer's payment method will be charged directly to pay the invoice.
|
|
@@ -44561,6 +45105,8 @@ Examples:
|
|
|
44561
45105
|
args.payment_method_id = opts.paymentMethodId;
|
|
44562
45106
|
if (opts.products !== void 0)
|
|
44563
45107
|
args.products = JSON.parse(opts.products);
|
|
45108
|
+
if (opts.coupons !== void 0)
|
|
45109
|
+
args.coupons = JSON.parse(opts.coupons);
|
|
44564
45110
|
if (opts.availablePaymentMethods !== void 0)
|
|
44565
45111
|
args.available_payment_methods = JSON.parse(opts.availablePaymentMethods);
|
|
44566
45112
|
if (opts.checkoutSession !== void 0)
|
|
@@ -44765,7 +45311,7 @@ Examples:
|
|
|
44765
45311
|
// build/commands/generated/products.js
|
|
44766
45312
|
function registerProductsCommands(parent) {
|
|
44767
45313
|
const resource = parent.command("products").description("Manage products");
|
|
44768
|
-
resource.command("list").description(`List products with optional filters for id, status, name, description, type, and
|
|
45314
|
+
resource.command("list").description(`List products with optional filters for id, status, name, description, type, price_book_id, and custom_properties (JSON object of slug to exact value, e.g. {"my_slug":"value"}; slugs matching no custom property are rejected). Products define what is being sold (flat fee, per-unit, usage-based, etc.). Paginated with take/skip. Includes bundle items and the first 50 price configurations per product. Use list_price_configurations filtered by product_id for the complete list.`).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("--status <value>", `status`).option("--status.in <value>", `status__in`).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("--description <value>", `description`).option("--description.not <value>", `description__not`).option("--description.equals <value>", `description__equals`).option("--description.contains <value>", `description__contains`).option("--description.starts-with <value>", `description__startsWith`).option("--description.end-with <value>", `description__endWith`).option("--description.is-null <value>", `description__isNull`).option("--description.is-not-null <value>", `description__isNotNull`).option("--type <value>", `type`).option("--type.not <value>", `type__not`).option("--type.equals <value>", `type__equals`).option("--type.contains <value>", `type__contains`).option("--type.starts-with <value>", `type__startsWith`).option("--type.end-with <value>", `type__endWith`).option("--price-book-id <value>", `price_book_id`).option("--custom-properties <value>", `Filter by custom property values, as a JSON object mapping a custom property slug to the exact value to match. Suffix a slug with \`__contains\` for a case-sensitive substring match on text values. Several entries are combined with AND. A slug that matches no custom property returns a \`400\` error.`).addHelpText("after", `
|
|
44769
45315
|
Examples:
|
|
44770
45316
|
hyperline products list
|
|
44771
45317
|
hyperline products list --take <take> --id <id>`).action(async (opts) => {
|
|
@@ -44833,6 +45379,8 @@ Examples:
|
|
|
44833
45379
|
args.type__endWith = opts["type.endWith"];
|
|
44834
45380
|
if (opts.priceBookId !== void 0)
|
|
44835
45381
|
args.price_book_id = opts.priceBookId;
|
|
45382
|
+
if (opts.customProperties !== void 0)
|
|
45383
|
+
args.custom_properties = opts.customProperties;
|
|
44836
45384
|
if (opts.take !== void 0)
|
|
44837
45385
|
args.take = Number(opts.take);
|
|
44838
45386
|
if (opts.skip !== void 0)
|
|
@@ -44872,7 +45420,8 @@ Examples:
|
|
|
44872
45420
|
"type__contains",
|
|
44873
45421
|
"type__startsWith",
|
|
44874
45422
|
"type__endWith",
|
|
44875
|
-
"price_book_id"
|
|
45423
|
+
"price_book_id",
|
|
45424
|
+
"custom_properties"
|
|
44876
45425
|
]
|
|
44877
45426
|
});
|
|
44878
45427
|
});
|
|
@@ -45156,7 +45705,7 @@ Quote status.
|
|
|
45156
45705
|
- \`all\`: Display all pricing tiers.
|
|
45157
45706
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
45158
45707
|
- \`none\`: Hide all pricing tiers.
|
|
45159
|
-
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-discounts-on-total <value>", `Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.`).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("--subscription-update-display <value>", `Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.`).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 <json>", `Subscription configuration constituting the quote.`).option("--invoice <json>", `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", `
|
|
45708
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-discounts-on-total <value>", `Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.`).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("--subscription-update-display <value>", `Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.`).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 <json>", `Subscription configuration constituting the quote.`).option("--invoice <json>", `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\`.`).option("--attachments <paths...>", `Paths of the local files to upload (space-separated, sends a multipart request)`).addHelpText("after", `
|
|
45160
45709
|
Examples:
|
|
45161
45710
|
hyperline quotes create --customer-id <customer_id>
|
|
45162
45711
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -45221,11 +45770,15 @@ Examples:
|
|
|
45221
45770
|
args.subscription = JSON.parse(opts.subscription);
|
|
45222
45771
|
if (opts.invoice !== void 0)
|
|
45223
45772
|
args.invoice = JSON.parse(opts.invoice);
|
|
45773
|
+
const files = {};
|
|
45774
|
+
if (opts.attachments !== void 0)
|
|
45775
|
+
files.attachments = [opts.attachments].flat();
|
|
45224
45776
|
await ctx.execute({
|
|
45225
45777
|
method: "POST",
|
|
45226
45778
|
path: "/v1/quotes",
|
|
45227
45779
|
args,
|
|
45228
|
-
queryParamKeys: []
|
|
45780
|
+
queryParamKeys: [],
|
|
45781
|
+
files
|
|
45229
45782
|
});
|
|
45230
45783
|
});
|
|
45231
45784
|
resource.command("list").description(`List quotes with optional filters for id, number, status, customer_id, template_id, crm_opportunity_id, type, and updated_at. Paginated with take/skip.`).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("--number <value>", `number`).option("--number.not <value>", `number__not`).option("--number.equals <value>", `number__equals`).option("--number.contains <value>", `number__contains`).option("--number.starts-with <value>", `number__startsWith`).option("--number.end-with <value>", `number__endWith`).option("--status <value>", `status`).option("--status.in <value>", `status__in`).option("--customer-id <value>", `customer_id`).option("--customer-id.not <value>", `customer_id__not`).option("--customer-id.equals <value>", `customer_id__equals`).option("--customer-id.contains <value>", `customer_id__contains`).option("--customer-id.starts-with <value>", `customer_id__startsWith`).option("--customer-id.end-with <value>", `customer_id__endWith`).option("--template-id <value>", `template_id`).option("--template-id.not <value>", `template_id__not`).option("--template-id.equals <value>", `template_id__equals`).option("--template-id.contains <value>", `template_id__contains`).option("--template-id.starts-with <value>", `template_id__startsWith`).option("--template-id.end-with <value>", `template_id__endWith`).option("--template-id.is-null <value>", `template_id__isNull`).option("--template-id.is-not-null <value>", `template_id__isNotNull`).option("--crm-opportunity-id <value>", `crm_opportunity_id`).option("--crm-opportunity-id.not <value>", `crm_opportunity_id__not`).option("--crm-opportunity-id.equals <value>", `crm_opportunity_id__equals`).option("--crm-opportunity-id.contains <value>", `crm_opportunity_id__contains`).option("--crm-opportunity-id.starts-with <value>", `crm_opportunity_id__startsWith`).option("--crm-opportunity-id.end-with <value>", `crm_opportunity_id__endWith`).option("--crm-opportunity-id.is-null <value>", `crm_opportunity_id__isNull`).option("--crm-opportunity-id.is-not-null <value>", `crm_opportunity_id__isNotNull`).option("--type <value>", `type`).option("--updated-at <value>", `updated_at`).option("--updated-at.not <value>", `updated_at__not`).option("--updated-at.equals <value>", `updated_at__equals`).option("--updated-at.lt <value>", `updated_at__lt`).option("--updated-at.lte <value>", `updated_at__lte`).option("--updated-at.gt <value>", `updated_at__gt`).option("--updated-at.gte <value>", `updated_at__gte`).addHelpText("after", `
|
|
@@ -45407,7 +45960,7 @@ Examples:
|
|
|
45407
45960
|
- \`all\`: Display all pricing tiers.
|
|
45408
45961
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
45409
45962
|
- \`none\`: Hide all pricing tiers.
|
|
45410
|
-
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-discounts-on-total <value>", `Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.`).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("--subscription-update-display <value>", `Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.`).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("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).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 <json>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).option("--invoice <json>", `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", `
|
|
45963
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-discounts-on-total <value>", `Display discounts on the totals, with product prices before discount. Totals then follow the contract value, so discounts with a limited duration are included.`).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("--subscription-update-display <value>", `Sections displayed on subscription update quotes: quote_update_details, subscription_details, or both. Takes precedence over display_subscription_on_update.`).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("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).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 <json>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).option("--invoice <json>", `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.`).option("--attachments <paths...>", `Paths of the local files to upload (space-separated, sends a multipart request)`).addHelpText("after", `
|
|
45411
45964
|
Examples:
|
|
45412
45965
|
hyperline quotes update --id <id>
|
|
45413
45966
|
hyperline quotes update --id <id> --owner-email <owner_email> --catalog-version-id <catalog_version_id>
|
|
@@ -45468,11 +46021,15 @@ Examples:
|
|
|
45468
46021
|
args.subscription = JSON.parse(opts.subscription);
|
|
45469
46022
|
if (opts.invoice !== void 0)
|
|
45470
46023
|
args.invoice = JSON.parse(opts.invoice);
|
|
46024
|
+
const files = {};
|
|
46025
|
+
if (opts.attachments !== void 0)
|
|
46026
|
+
files.attachments = [opts.attachments].flat();
|
|
45471
46027
|
await ctx.execute({
|
|
45472
46028
|
method: "PATCH",
|
|
45473
46029
|
path: "/v1/quotes/{id}",
|
|
45474
46030
|
args,
|
|
45475
|
-
queryParamKeys: []
|
|
46031
|
+
queryParamKeys: [],
|
|
46032
|
+
files
|
|
45476
46033
|
});
|
|
45477
46034
|
});
|
|
45478
46035
|
resource.command("duplicate").description(`Create a draft duplicate of an existing quote, including its linked invoice or subscription configuration.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
@@ -45625,9 +46182,10 @@ Examples:
|
|
|
45625
46182
|
queryParamKeys: []
|
|
45626
46183
|
});
|
|
45627
46184
|
});
|
|
45628
|
-
resource.command("sign").description(`Manually mark a quote as signed externally. Optionally upload a signed PDF. Bypasses the built-in Hyperline signature flow.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
46185
|
+
resource.command("sign").description(`Manually mark a quote as signed externally. Optionally upload a signed PDF. Bypasses the built-in Hyperline signature flow.`).requiredOption("--id <value>", `id parameter`).option("--signed-quote <path>", `Path of the local file to upload (sends a multipart request)`).addHelpText("after", `
|
|
45629
46186
|
Examples:
|
|
45630
46187
|
hyperline quotes sign --id <id>
|
|
46188
|
+
hyperline quotes sign --id <id> --signed-quote <path>
|
|
45631
46189
|
hyperline quotes sign --id <id> --output json`).action(async (opts) => {
|
|
45632
46190
|
const ctx = resource.parent?.opts()._ctx;
|
|
45633
46191
|
if (!ctx) {
|
|
@@ -45637,11 +46195,15 @@ Examples:
|
|
|
45637
46195
|
const args = {};
|
|
45638
46196
|
if (opts.id !== void 0)
|
|
45639
46197
|
args.id = opts.id;
|
|
46198
|
+
const files = {};
|
|
46199
|
+
if (opts.signedQuote !== void 0)
|
|
46200
|
+
files.signed_quote = [opts.signedQuote].flat();
|
|
45640
46201
|
await ctx.execute({
|
|
45641
46202
|
method: "POST",
|
|
45642
46203
|
path: "/v1/quotes/{id}/sign",
|
|
45643
46204
|
args,
|
|
45644
|
-
queryParamKeys: []
|
|
46205
|
+
queryParamKeys: [],
|
|
46206
|
+
files
|
|
45645
46207
|
});
|
|
45646
46208
|
});
|
|
45647
46209
|
resource.command("void").description(`Void an existing quote, canceling it and preventing further actions.`).requiredOption("--id <value>", `id parameter`).requiredOption("--reason <value>", `Quote voiding reason.`).addHelpText("after", `
|
|
@@ -45753,7 +46315,7 @@ Examples:
|
|
|
45753
46315
|
// build/commands/generated/quotes-templates.js
|
|
45754
46316
|
function registerQuotes_TemplatesCommands(parent) {
|
|
45755
46317
|
const resource = parent.command("quotes-templates").description("Manage quotes > templates");
|
|
45756
|
-
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", `
|
|
45757
46319
|
Examples:
|
|
45758
46320
|
hyperline quotes-templates list-quote-templates
|
|
45759
46321
|
hyperline quotes-templates list-quote-templates --take <take> --id <id>`).action(async (opts) => {
|
|
@@ -45789,20 +46351,6 @@ Examples:
|
|
|
45789
46351
|
args.name__endWith = opts["name.endWith"];
|
|
45790
46352
|
if (opts.subscriptionTemplateId !== void 0)
|
|
45791
46353
|
args.subscription_template_id = opts.subscriptionTemplateId;
|
|
45792
|
-
if (opts["subscriptionTemplateId.not"] !== void 0)
|
|
45793
|
-
args.subscription_template_id__not = opts["subscriptionTemplateId.not"];
|
|
45794
|
-
if (opts["subscriptionTemplateId.equals"] !== void 0)
|
|
45795
|
-
args.subscription_template_id__equals = opts["subscriptionTemplateId.equals"];
|
|
45796
|
-
if (opts["subscriptionTemplateId.contains"] !== void 0)
|
|
45797
|
-
args.subscription_template_id__contains = opts["subscriptionTemplateId.contains"];
|
|
45798
|
-
if (opts["subscriptionTemplateId.startsWith"] !== void 0)
|
|
45799
|
-
args.subscription_template_id__startsWith = opts["subscriptionTemplateId.startsWith"];
|
|
45800
|
-
if (opts["subscriptionTemplateId.endWith"] !== void 0)
|
|
45801
|
-
args.subscription_template_id__endWith = opts["subscriptionTemplateId.endWith"];
|
|
45802
|
-
if (opts["subscriptionTemplateId.isNull"] !== void 0)
|
|
45803
|
-
args.subscription_template_id__isNull = opts["subscriptionTemplateId.isNull"];
|
|
45804
|
-
if (opts["subscriptionTemplateId.isNotNull"] !== void 0)
|
|
45805
|
-
args.subscription_template_id__isNotNull = opts["subscriptionTemplateId.isNotNull"];
|
|
45806
46354
|
if (opts.search !== void 0)
|
|
45807
46355
|
args.search = opts.search;
|
|
45808
46356
|
if (opts.take !== void 0)
|
|
@@ -45829,13 +46377,6 @@ Examples:
|
|
|
45829
46377
|
"name__startsWith",
|
|
45830
46378
|
"name__endWith",
|
|
45831
46379
|
"subscription_template_id",
|
|
45832
|
-
"subscription_template_id__not",
|
|
45833
|
-
"subscription_template_id__equals",
|
|
45834
|
-
"subscription_template_id__contains",
|
|
45835
|
-
"subscription_template_id__startsWith",
|
|
45836
|
-
"subscription_template_id__endWith",
|
|
45837
|
-
"subscription_template_id__isNull",
|
|
45838
|
-
"subscription_template_id__isNotNull",
|
|
45839
46380
|
"search"
|
|
45840
46381
|
]
|
|
45841
46382
|
});
|
|
@@ -46237,7 +46778,7 @@ Examples:
|
|
|
46237
46778
|
queryParamKeys: []
|
|
46238
46779
|
});
|
|
46239
46780
|
});
|
|
46240
|
-
resource.command("list").description(`List subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, cancel_at, custom_properties, and the active contract: contract_start__gte/__lte, contract_end__gte/__lte, renew_automatically. For upcoming renewals, combine contract_end__gte/__lte with renew_automatically, plus cancel_at for scheduled cancellations. Draft, voided, cancelled and archived excluded by default (status=all applies the same exclusion); status=any returns every status. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--activation-strategy <value>", `activation_strategy`).option("--activation-strategy.in <value>", `activation_strategy__in`).option("--status <value>", `
|
|
46781
|
+
resource.command("list").description(`List subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, cancel_at, custom_properties (JSON object of slug to exact value, e.g. {"my_slug":"value"}; slugs matching no custom property are ignored), and the active contract: contract_start__gte/__lte, contract_end__gte/__lte, renew_automatically. For upcoming renewals, combine contract_end__gte/__lte with renew_automatically, plus cancel_at for scheduled cancellations. Draft, voided, cancelled and archived excluded by default (status=all applies the same exclusion); status=any returns every status. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--activation-strategy <value>", `activation_strategy`).option("--activation-strategy.in <value>", `activation_strategy__in`).option("--status <value>", `
|
|
46241
46782
|
Subscription status filter.
|
|
46242
46783
|
|
|
46243
46784
|
- \`active\`, \`pending\`, \`paused\`, \`errored\`, \`cancelled\`, \`draft\`, \`voided\`, \`archived\`: match that status.
|
|
@@ -46246,7 +46787,7 @@ Subscription status filter.
|
|
|
46246
46787
|
- \`any\`: every status, no exclusion.
|
|
46247
46788
|
|
|
46248
46789
|
Use \`status__in\` with comma-separated values to combine statuses. When the filter is omitted, \`draft\`, \`voided\`, \`cancelled\` and \`archived\` subscriptions are excluded.
|
|
46249
|
-
`).option("--status.in <value>", `Comma-separated list of subscription statuses to include. Same values as \`status\`.`).option("--currency <value>", `currency`).option("--currency.not <value>", `currency__not`).option("--currency.equals <value>", `currency__equals`).option("--currency.contains <value>", `currency__contains`).option("--currency.starts-with <value>", `currency__startsWith`).option("--currency.end-with <value>", `currency__endWith`).option("--plan-id <value>", `plan_id`).option("--plan-id.not <value>", `plan_id__not`).option("--plan-id.equals <value>", `plan_id__equals`).option("--plan-id.contains <value>", `plan_id__contains`).option("--plan-id.starts-with <value>", `plan_id__startsWith`).option("--plan-id.end-with <value>", `plan_id__endWith`).option("--plan-id.is-null <value>", `plan_id__isNull`).option("--plan-id.is-not-null <value>", `plan_id__isNotNull`).option("--original-quote-id <value>", `original_quote_id`).option("--original-quote-id.not <value>", `original_quote_id__not`).option("--original-quote-id.equals <value>", `original_quote_id__equals`).option("--original-quote-id.contains <value>", `original_quote_id__contains`).option("--original-quote-id.starts-with <value>", `original_quote_id__startsWith`).option("--original-quote-id.end-with <value>", `original_quote_id__endWith`).option("--original-quote-id.is-null <value>", `original_quote_id__isNull`).option("--original-quote-id.is-not-null <value>", `original_quote_id__isNotNull`).option("--customer-id <value>", `customer_id`).option("--customer-id.not <value>", `customer_id__not`).option("--customer-id.equals <value>", `customer_id__equals`).option("--customer-id.contains <value>", `customer_id__contains`).option("--customer-id.starts-with <value>", `customer_id__startsWith`).option("--customer-id.end-with <value>", `customer_id__endWith`).option("--customer-id.is-null <value>", `customer_id__isNull`).option("--customer-id.is-not-null <value>", `customer_id__isNotNull`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--purchase-order <value>", `purchase_order`).option("--purchase-order.not <value>", `purchase_order__not`).option("--purchase-order.equals <value>", `purchase_order__equals`).option("--purchase-order.contains <value>", `purchase_order__contains`).option("--purchase-order.starts-with <value>", `purchase_order__startsWith`).option("--purchase-order.end-with <value>", `purchase_order__endWith`).option("--purchase-order.is-null <value>", `purchase_order__isNull`).option("--purchase-order.is-not-null <value>", `purchase_order__isNotNull`).option("--custom-properties <value>", `
|
|
46790
|
+
`).option("--status.in <value>", `Comma-separated list of subscription statuses to include. Same values as \`status\`.`).option("--currency <value>", `currency`).option("--currency.not <value>", `currency__not`).option("--currency.equals <value>", `currency__equals`).option("--currency.contains <value>", `currency__contains`).option("--currency.starts-with <value>", `currency__startsWith`).option("--currency.end-with <value>", `currency__endWith`).option("--plan-id <value>", `plan_id`).option("--plan-id.not <value>", `plan_id__not`).option("--plan-id.equals <value>", `plan_id__equals`).option("--plan-id.contains <value>", `plan_id__contains`).option("--plan-id.starts-with <value>", `plan_id__startsWith`).option("--plan-id.end-with <value>", `plan_id__endWith`).option("--plan-id.is-null <value>", `plan_id__isNull`).option("--plan-id.is-not-null <value>", `plan_id__isNotNull`).option("--original-quote-id <value>", `original_quote_id`).option("--original-quote-id.not <value>", `original_quote_id__not`).option("--original-quote-id.equals <value>", `original_quote_id__equals`).option("--original-quote-id.contains <value>", `original_quote_id__contains`).option("--original-quote-id.starts-with <value>", `original_quote_id__startsWith`).option("--original-quote-id.end-with <value>", `original_quote_id__endWith`).option("--original-quote-id.is-null <value>", `original_quote_id__isNull`).option("--original-quote-id.is-not-null <value>", `original_quote_id__isNotNull`).option("--customer-id <value>", `customer_id`).option("--customer-id.not <value>", `customer_id__not`).option("--customer-id.equals <value>", `customer_id__equals`).option("--customer-id.contains <value>", `customer_id__contains`).option("--customer-id.starts-with <value>", `customer_id__startsWith`).option("--customer-id.end-with <value>", `customer_id__endWith`).option("--customer-id.is-null <value>", `customer_id__isNull`).option("--customer-id.is-not-null <value>", `customer_id__isNotNull`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--purchase-order <value>", `purchase_order`).option("--purchase-order.not <value>", `purchase_order__not`).option("--purchase-order.equals <value>", `purchase_order__equals`).option("--purchase-order.contains <value>", `purchase_order__contains`).option("--purchase-order.starts-with <value>", `purchase_order__startsWith`).option("--purchase-order.end-with <value>", `purchase_order__endWith`).option("--purchase-order.is-null <value>", `purchase_order__isNull`).option("--purchase-order.is-not-null <value>", `purchase_order__isNotNull`).option("--custom-properties <value>", `Filter by custom property values, as a JSON object mapping a custom property slug to the exact value to match. Suffix a slug with \`__contains\` for a case-sensitive substring match on text values. Several entries are combined with AND. Entries whose slug matches no custom property, or whose value is \`false\`, \`0\`, \`null\` or an empty string, are ignored.`).option("--invoice-drafts <value>", `invoice_drafts`).option("--integration-entity-id <value>", `integration_entity_id`).option("--updated-at <value>", `updated_at`).option("--updated-at.not <value>", `updated_at__not`).option("--updated-at.equals <value>", `updated_at__equals`).option("--updated-at.lt <value>", `updated_at__lt`).option("--updated-at.lte <value>", `updated_at__lte`).option("--updated-at.gt <value>", `updated_at__gt`).option("--updated-at.gte <value>", `updated_at__gte`).option("--cancel-at <value>", `cancel_at`).option("--cancel-at.not <value>", `cancel_at__not`).option("--cancel-at.equals <value>", `cancel_at__equals`).option("--cancel-at.lt <value>", `cancel_at__lt`).option("--cancel-at.lte <value>", `cancel_at__lte`).option("--cancel-at.gt <value>", `cancel_at__gt`).option("--cancel-at.gte <value>", `cancel_at__gte`).option("--cancel-at.is-null <value>", `cancel_at__isNull`).option("--cancel-at.is-not-null <value>", `cancel_at__isNotNull`).option("--contract-start.gte <value>", `Return only subscriptions whose active contract starts on or after this date.`).option("--contract-start.lte <value>", `Return only subscriptions whose active contract starts on or before this date.`).option("--contract-end.gte <value>", `Return only subscriptions whose active contract ends on or after this date.`).option("--contract-end.lte <value>", `Return only subscriptions whose active contract ends on or before this date.`).option("--renew-automatically <value>", `Return only subscriptions whose active contract renews automatically (\`true\`) or not (\`false\`).`).addHelpText("after", `
|
|
46250
46791
|
Examples:
|
|
46251
46792
|
hyperline subscriptions list
|
|
46252
46793
|
hyperline subscriptions list --take <take> --activation-strategy <activation_strategy>`).action(async (opts) => {
|
|
@@ -46893,7 +47434,7 @@ Examples:
|
|
|
46893
47434
|
]
|
|
46894
47435
|
});
|
|
46895
47436
|
});
|
|
46896
|
-
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", `
|
|
46897
47438
|
Examples:
|
|
46898
47439
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
46899
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>
|
|
@@ -47158,16 +47699,44 @@ Examples:
|
|
|
47158
47699
|
queryParamKeys: []
|
|
47159
47700
|
});
|
|
47160
47701
|
});
|
|
47161
|
-
resource.command("list").description(`List transactions across all invoices, including transactions without an invoice allocation. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).addHelpText("after", `
|
|
47702
|
+
resource.command("list").description(`List transactions across all invoices, including transactions without an invoice allocation. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--created-at <value>", `created_at`).option("--created-at.not <value>", `created_at__not`).option("--created-at.equals <value>", `created_at__equals`).option("--created-at.lt <value>", `created_at__lt`).option("--created-at.lte <value>", `created_at__lte`).option("--created-at.gt <value>", `created_at__gt`).option("--created-at.gte <value>", `created_at__gte`).option("--updated-at <value>", `updated_at`).option("--updated-at.not <value>", `updated_at__not`).option("--updated-at.equals <value>", `updated_at__equals`).option("--updated-at.lt <value>", `updated_at__lt`).option("--updated-at.lte <value>", `updated_at__lte`).option("--updated-at.gt <value>", `updated_at__gt`).option("--updated-at.gte <value>", `updated_at__gte`).addHelpText("after", `
|
|
47162
47703
|
Examples:
|
|
47163
47704
|
hyperline transactions list
|
|
47164
|
-
hyperline transactions list --take <take>`).action(async (opts) => {
|
|
47705
|
+
hyperline transactions list --take <take> --created-at <created_at>`).action(async (opts) => {
|
|
47165
47706
|
const ctx = resource.parent?.opts()._ctx;
|
|
47166
47707
|
if (!ctx) {
|
|
47167
47708
|
process.stderr.write("Error: Not authenticated\n");
|
|
47168
47709
|
process.exit(1);
|
|
47169
47710
|
}
|
|
47170
47711
|
const args = {};
|
|
47712
|
+
if (opts.createdAt !== void 0)
|
|
47713
|
+
args.created_at = opts.createdAt;
|
|
47714
|
+
if (opts["createdAt.not"] !== void 0)
|
|
47715
|
+
args.created_at__not = opts["createdAt.not"];
|
|
47716
|
+
if (opts["createdAt.equals"] !== void 0)
|
|
47717
|
+
args.created_at__equals = opts["createdAt.equals"];
|
|
47718
|
+
if (opts["createdAt.lt"] !== void 0)
|
|
47719
|
+
args.created_at__lt = opts["createdAt.lt"];
|
|
47720
|
+
if (opts["createdAt.lte"] !== void 0)
|
|
47721
|
+
args.created_at__lte = opts["createdAt.lte"];
|
|
47722
|
+
if (opts["createdAt.gt"] !== void 0)
|
|
47723
|
+
args.created_at__gt = opts["createdAt.gt"];
|
|
47724
|
+
if (opts["createdAt.gte"] !== void 0)
|
|
47725
|
+
args.created_at__gte = opts["createdAt.gte"];
|
|
47726
|
+
if (opts.updatedAt !== void 0)
|
|
47727
|
+
args.updated_at = opts.updatedAt;
|
|
47728
|
+
if (opts["updatedAt.not"] !== void 0)
|
|
47729
|
+
args.updated_at__not = opts["updatedAt.not"];
|
|
47730
|
+
if (opts["updatedAt.equals"] !== void 0)
|
|
47731
|
+
args.updated_at__equals = opts["updatedAt.equals"];
|
|
47732
|
+
if (opts["updatedAt.lt"] !== void 0)
|
|
47733
|
+
args.updated_at__lt = opts["updatedAt.lt"];
|
|
47734
|
+
if (opts["updatedAt.lte"] !== void 0)
|
|
47735
|
+
args.updated_at__lte = opts["updatedAt.lte"];
|
|
47736
|
+
if (opts["updatedAt.gt"] !== void 0)
|
|
47737
|
+
args.updated_at__gt = opts["updatedAt.gt"];
|
|
47738
|
+
if (opts["updatedAt.gte"] !== void 0)
|
|
47739
|
+
args.updated_at__gte = opts["updatedAt.gte"];
|
|
47171
47740
|
if (opts.take !== void 0)
|
|
47172
47741
|
args.take = Number(opts.take);
|
|
47173
47742
|
if (opts.skip !== void 0)
|
|
@@ -47176,7 +47745,24 @@ Examples:
|
|
|
47176
47745
|
method: "GET",
|
|
47177
47746
|
path: "/v1/transactions",
|
|
47178
47747
|
args,
|
|
47179
|
-
queryParamKeys: [
|
|
47748
|
+
queryParamKeys: [
|
|
47749
|
+
"take",
|
|
47750
|
+
"skip",
|
|
47751
|
+
"created_at",
|
|
47752
|
+
"created_at__not",
|
|
47753
|
+
"created_at__equals",
|
|
47754
|
+
"created_at__lt",
|
|
47755
|
+
"created_at__lte",
|
|
47756
|
+
"created_at__gt",
|
|
47757
|
+
"created_at__gte",
|
|
47758
|
+
"updated_at",
|
|
47759
|
+
"updated_at__not",
|
|
47760
|
+
"updated_at__equals",
|
|
47761
|
+
"updated_at__lt",
|
|
47762
|
+
"updated_at__lte",
|
|
47763
|
+
"updated_at__gt",
|
|
47764
|
+
"updated_at__gte"
|
|
47765
|
+
]
|
|
47180
47766
|
});
|
|
47181
47767
|
});
|
|
47182
47768
|
resource.command("get").description(`Retrieve a transaction by ID, including its current invoice allocations.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
@@ -47646,9 +48232,13 @@ function registerAllCommands(program2) {
|
|
|
47646
48232
|
registerAi_BillingCommands(program2);
|
|
47647
48233
|
registerAi_CostsCommands(program2);
|
|
47648
48234
|
registerAnalyticsCommands(program2);
|
|
48235
|
+
registerApproval_RequestsCommands(program2);
|
|
48236
|
+
registerApproval_WorkflowsCommands(program2);
|
|
47649
48237
|
registerBank_AccountsCommands(program2);
|
|
47650
48238
|
registerCatalogCommands(program2);
|
|
47651
48239
|
registerCompaniesCommands(program2);
|
|
48240
|
+
registerContracts_ClausesCommands(program2);
|
|
48241
|
+
registerContracts_DocumentsCommands(program2);
|
|
47652
48242
|
registerCouponsCommands(program2);
|
|
47653
48243
|
registerCoupons_Promotion_CodesCommands(program2);
|
|
47654
48244
|
registerCustomers_CreditsCommands(program2);
|
|
@@ -63745,6 +64335,7 @@ var de = {
|
|
|
63745
64335
|
"quotes.blockers.quote_configuration_not_subscription_update": "W\xE4hlen Sie eine Konfiguration f\xFCr eine Abonnement\xE4nderung",
|
|
63746
64336
|
"quotes.blockers.quote_configuration_not_new_subscription": "W\xE4hlen Sie eine Konfiguration f\xFCr ein neues Abonnement",
|
|
63747
64337
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Ein Abonnement kann in einem Angebot nur einmal ge\xE4ndert werden",
|
|
64338
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Jedes Produkt muss aus dem Konto des Abrechnungsanbieters des ge\xE4nderten Abonnements stammen",
|
|
63748
64339
|
"quotes.blockers.quote_draft_invoice_missing": "Das Angebot muss eine Rechnung im Entwurf haben, um abgeschlossen zu werden",
|
|
63749
64340
|
"quotes.blockers.quote_draft_subscription_missing": "Das Angebot muss ein Abonnement im Entwurf haben, um abgeschlossen zu werden",
|
|
63750
64341
|
"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"
|
|
@@ -63813,6 +64404,7 @@ var en = {
|
|
|
63813
64404
|
"quotes.blockers.quote_configuration_not_subscription_update": "Select a subscription update configuration",
|
|
63814
64405
|
"quotes.blockers.quote_configuration_not_new_subscription": "Select a new subscription configuration",
|
|
63815
64406
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "A subscription can only be updated once in a quote",
|
|
64407
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Every product must come from the billing provider account of the subscription being updated",
|
|
63816
64408
|
"quotes.blockers.quote_draft_invoice_missing": "Quote must have a draft invoice to be finalized",
|
|
63817
64409
|
"quotes.blockers.quote_draft_subscription_missing": "Quote must have a draft subscription to be finalized",
|
|
63818
64410
|
"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"
|
|
@@ -63881,6 +64473,7 @@ var es = {
|
|
|
63881
64473
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecciona una configuraci\xF3n de actualizaci\xF3n de suscripci\xF3n",
|
|
63882
64474
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecciona una configuraci\xF3n de nueva suscripci\xF3n",
|
|
63883
64475
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Una suscripci\xF3n solo puede actualizarse una vez en un presupuesto",
|
|
64476
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Cada producto debe provenir de la cuenta del proveedor de facturaci\xF3n de la suscripci\xF3n actualizada",
|
|
63884
64477
|
"quotes.blockers.quote_draft_invoice_missing": "El presupuesto debe tener una factura en borrador para finalizarse",
|
|
63885
64478
|
"quotes.blockers.quote_draft_subscription_missing": "El presupuesto debe tener una suscripci\xF3n en borrador para finalizarse",
|
|
63886
64479
|
"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"
|
|
@@ -63949,6 +64542,7 @@ var fr = {
|
|
|
63949
64542
|
"quotes.blockers.quote_configuration_not_subscription_update": "S\xE9lectionnez une configuration de mise \xE0 jour d'abonnement",
|
|
63950
64543
|
"quotes.blockers.quote_configuration_not_new_subscription": "S\xE9lectionnez une configuration de nouvel abonnement",
|
|
63951
64544
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abonnement ne peut \xEAtre mis \xE0 jour qu'une seule fois dans un devis",
|
|
64545
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Chaque produit doit provenir du compte du fournisseur de facturation de l'abonnement mis \xE0 jour",
|
|
63952
64546
|
"quotes.blockers.quote_draft_invoice_missing": "Le devis doit avoir une facture en brouillon pour \xEAtre finalis\xE9",
|
|
63953
64547
|
"quotes.blockers.quote_draft_subscription_missing": "Le devis doit avoir un abonnement en brouillon pour \xEAtre finalis\xE9",
|
|
63954
64548
|
"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"
|
|
@@ -64017,6 +64611,7 @@ var it = {
|
|
|
64017
64611
|
"quotes.blockers.quote_configuration_not_subscription_update": "Seleziona una configurazione di aggiornamento dell'abbonamento",
|
|
64018
64612
|
"quotes.blockers.quote_configuration_not_new_subscription": "Seleziona una configurazione di nuovo abbonamento",
|
|
64019
64613
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abbonamento pu\xF2 essere aggiornato una sola volta in un preventivo",
|
|
64614
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ogni prodotto deve provenire dall'account del provider di fatturazione dell'abbonamento aggiornato",
|
|
64020
64615
|
"quotes.blockers.quote_draft_invoice_missing": "Il preventivo deve avere una fattura in bozza per essere finalizzato",
|
|
64021
64616
|
"quotes.blockers.quote_draft_subscription_missing": "Il preventivo deve avere un abbonamento in bozza per essere finalizzato",
|
|
64022
64617
|
"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"
|
|
@@ -64085,6 +64680,7 @@ var lt = {
|
|
|
64085
64680
|
"quotes.blockers.quote_configuration_not_subscription_update": "Pasirinkite prenumeratos atnaujinimo konfig\u016Bracij\u0105",
|
|
64086
64681
|
"quotes.blockers.quote_configuration_not_new_subscription": "Pasirinkite naujos prenumeratos konfig\u016Bracij\u0105",
|
|
64087
64682
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Prenumerat\u0105 pasi\u016Blyme galima atnaujinti tik vien\u0105 kart\u0105",
|
|
64683
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Kiekvienas produktas turi b\u016Bti i\u0161 atnaujinamos prenumeratos atsiskaitymo teik\u0117jo paskyros",
|
|
64088
64684
|
"quotes.blockers.quote_draft_invoice_missing": "Pasi\u016Blymas turi tur\u0117ti s\u0105skaitos fakt\u016Bros juodra\u0161t\u012F, kad b\u016Bt\u0173 u\u017Ebaigtas",
|
|
64089
64685
|
"quotes.blockers.quote_draft_subscription_missing": "Pasi\u016Blymas turi tur\u0117ti prenumeratos juodra\u0161t\u012F, kad b\u016Bt\u0173 u\u017Ebaigtas",
|
|
64090
64686
|
"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"
|
|
@@ -64153,6 +64749,7 @@ var nl = {
|
|
|
64153
64749
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecteer een configuratie voor een abonnementswijziging",
|
|
64154
64750
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecteer een configuratie voor een nieuw abonnement",
|
|
64155
64751
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Een abonnement kan maar \xE9\xE9n keer per offerte worden gewijzigd",
|
|
64752
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Elk product moet afkomstig zijn van het account van de factureringsprovider van het gewijzigde abonnement",
|
|
64156
64753
|
"quotes.blockers.quote_draft_invoice_missing": "De offerte moet een conceptfactuur hebben om te worden afgerond",
|
|
64157
64754
|
"quotes.blockers.quote_draft_subscription_missing": "De offerte moet een conceptabonnement hebben om te worden afgerond",
|
|
64158
64755
|
"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"
|
|
@@ -64221,6 +64818,7 @@ var pl = {
|
|
|
64221
64818
|
"quotes.blockers.quote_configuration_not_subscription_update": "Wybierz konfiguracj\u0119 aktualizacji subskrypcji",
|
|
64222
64819
|
"quotes.blockers.quote_configuration_not_new_subscription": "Wybierz konfiguracj\u0119 nowej subskrypcji",
|
|
64223
64820
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Subskrypcj\u0119 mo\u017Cna zaktualizowa\u0107 w ofercie tylko raz",
|
|
64821
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ka\u017Cdy produkt musi pochodzi\u0107 z konta dostawcy rozlicze\u0144 aktualizowanej subskrypcji",
|
|
64224
64822
|
"quotes.blockers.quote_draft_invoice_missing": "Oferta musi mie\u0107 faktur\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64225
64823
|
"quotes.blockers.quote_draft_subscription_missing": "Oferta musi mie\u0107 subskrypcj\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64226
64824
|
"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"
|
|
@@ -64289,6 +64887,7 @@ var pt = {
|
|
|
64289
64887
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecione uma configura\xE7\xE3o de atualiza\xE7\xE3o de subscri\xE7\xE3o",
|
|
64290
64888
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecione uma configura\xE7\xE3o de nova subscri\xE7\xE3o",
|
|
64291
64889
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Uma subscri\xE7\xE3o s\xF3 pode ser atualizada uma vez num or\xE7amento",
|
|
64890
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Cada produto deve vir da conta do fornecedor de fatura\xE7\xE3o da subscri\xE7\xE3o atualizada",
|
|
64292
64891
|
"quotes.blockers.quote_draft_invoice_missing": "O or\xE7amento deve ter uma fatura em rascunho para ser finalizado",
|
|
64293
64892
|
"quotes.blockers.quote_draft_subscription_missing": "O or\xE7amento deve ter uma subscri\xE7\xE3o em rascunho para ser finalizado",
|
|
64294
64893
|
"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"
|
|
@@ -64476,6 +65075,8 @@ var REDACTED_KEY_NAMES = /* @__PURE__ */ new Set([
|
|
|
64476
65075
|
"privatekey",
|
|
64477
65076
|
"publictoken",
|
|
64478
65077
|
"refreshtoken",
|
|
65078
|
+
// A workflow secret's value (core/workflows secrets).
|
|
65079
|
+
"secretvalue",
|
|
64479
65080
|
"sessiontoken",
|
|
64480
65081
|
"token",
|
|
64481
65082
|
"tokenid",
|
|
@@ -67244,69 +67845,6 @@ var Decimal = P.constructor = clone2(DEFAULTS);
|
|
|
67244
67845
|
LN10 = new Decimal(LN10);
|
|
67245
67846
|
PI = new Decimal(PI);
|
|
67246
67847
|
|
|
67247
|
-
// ../hyperline-lib/build/utils/config/usStates.js
|
|
67248
|
-
var usStates = [
|
|
67249
|
-
"AA",
|
|
67250
|
-
"AE",
|
|
67251
|
-
"AK",
|
|
67252
|
-
"AL",
|
|
67253
|
-
"AP",
|
|
67254
|
-
"AR",
|
|
67255
|
-
"AS",
|
|
67256
|
-
"AZ",
|
|
67257
|
-
"CA",
|
|
67258
|
-
"CO",
|
|
67259
|
-
"CT",
|
|
67260
|
-
"DC",
|
|
67261
|
-
"DE",
|
|
67262
|
-
"FL",
|
|
67263
|
-
"GA",
|
|
67264
|
-
"GU",
|
|
67265
|
-
"HI",
|
|
67266
|
-
"IA",
|
|
67267
|
-
"ID",
|
|
67268
|
-
"IL",
|
|
67269
|
-
"IN",
|
|
67270
|
-
"KS",
|
|
67271
|
-
"KY",
|
|
67272
|
-
"LA",
|
|
67273
|
-
"MA",
|
|
67274
|
-
"MD",
|
|
67275
|
-
"ME",
|
|
67276
|
-
"MI",
|
|
67277
|
-
"MN",
|
|
67278
|
-
"MO",
|
|
67279
|
-
"MP",
|
|
67280
|
-
"MS",
|
|
67281
|
-
"MT",
|
|
67282
|
-
"NC",
|
|
67283
|
-
"ND",
|
|
67284
|
-
"NE",
|
|
67285
|
-
"NH",
|
|
67286
|
-
"NJ",
|
|
67287
|
-
"NM",
|
|
67288
|
-
"NV",
|
|
67289
|
-
"NY",
|
|
67290
|
-
"OH",
|
|
67291
|
-
"OK",
|
|
67292
|
-
"OR",
|
|
67293
|
-
"PA",
|
|
67294
|
-
"PR",
|
|
67295
|
-
"RI",
|
|
67296
|
-
"SC",
|
|
67297
|
-
"SD",
|
|
67298
|
-
"TN",
|
|
67299
|
-
"TX",
|
|
67300
|
-
"UT",
|
|
67301
|
-
"VA",
|
|
67302
|
-
"VI",
|
|
67303
|
-
"VT",
|
|
67304
|
-
"WA",
|
|
67305
|
-
"WI",
|
|
67306
|
-
"WV",
|
|
67307
|
-
"WY"
|
|
67308
|
-
];
|
|
67309
|
-
|
|
67310
67848
|
// ../hyperline-lib/build/utils/dates.js
|
|
67311
67849
|
var import_shared2 = __toESM(require_shared(), 1);
|
|
67312
67850
|
var PERIOD_BOUND_DRIFT_TOLERANCE_MS = 2 * 60 * 1e3;
|
|
@@ -67331,7 +67869,8 @@ var dateRealignmentModeSchema = external_exports.enum([
|
|
|
67331
67869
|
"utc_midnight_import",
|
|
67332
67870
|
"dst_hour_drift",
|
|
67333
67871
|
"month_start_drift",
|
|
67334
|
-
"manual_phase_end_midnight"
|
|
67872
|
+
"manual_phase_end_midnight",
|
|
67873
|
+
"customer_timezone_change"
|
|
67335
67874
|
]).default("utc_midnight_import");
|
|
67336
67875
|
var DST_HOUR_SHIFT_BY_LOCAL_MILLISECOND_OF_DAY = /* @__PURE__ */ new Map([
|
|
67337
67876
|
[23 * MILLISECONDS_PER_HOUR, MILLISECONDS_PER_HOUR],
|
|
@@ -67381,8 +67920,14 @@ var authorizedOperators = [
|
|
|
67381
67920
|
var NullFilterValueSchema = BooleanSchema.or(external_exports.literal("")).optional();
|
|
67382
67921
|
|
|
67383
67922
|
// ../hyperline-lib/build/http/dto/state.js
|
|
67384
|
-
var StateSchema = external_exports.
|
|
67385
|
-
description:
|
|
67923
|
+
var StateSchema = external_exports.string().openapi({
|
|
67924
|
+
description: `State or province of the address, stored as its code (the second part of the ISO 3166-2 code, e.g. \`CA\` for \`US-CA\`) for:
|
|
67925
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
67926
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
67927
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
67928
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
67929
|
+
|
|
67930
|
+
A code or a name is accepted (e.g. \`ON\` or \`Ontario\`); a value that matches neither for these countries is rejected. For any other country, the state is ignored.`,
|
|
67386
67931
|
example: "CA"
|
|
67387
67932
|
});
|
|
67388
67933
|
|
|
@@ -67496,9 +68041,10 @@ var toLogRequest = (config4) => {
|
|
|
67496
68041
|
};
|
|
67497
68042
|
|
|
67498
68043
|
// ../hyperline-lib/build/httpClient/publicUrlFetch.js
|
|
68044
|
+
import { lookup as lookupCallback } from "node:dns";
|
|
67499
68045
|
import { lookup } from "node:dns/promises";
|
|
67500
68046
|
import { isIP } from "node:net";
|
|
67501
|
-
import { Agent } from "undici";
|
|
68047
|
+
import { Agent, fetch as fetch2 } from "undici";
|
|
67502
68048
|
var PINNED_DISPATCHER_TTL_MS = 5 * 60 * 1e3;
|
|
67503
68049
|
var DEFAULT_MAX_RESPONSE_BYTES = 2 * 1024 * 1024;
|
|
67504
68050
|
|
|
@@ -67518,10 +68064,15 @@ import { createHash as createHash4 } from "node:crypto";
|
|
|
67518
68064
|
var TTL_MS = 5 * 6e4;
|
|
67519
68065
|
|
|
67520
68066
|
// ../hyperline-mcp/build/requestBuilder.js
|
|
67521
|
-
function buildRequestConfig(path2, args, method, queryParamKeys = []) {
|
|
68067
|
+
function buildRequestConfig({ path: path2, args, method, queryParamKeys = [], arrayBody = false }) {
|
|
67522
68068
|
const { url: url2, usedKeys } = replacePathParams(path2, args);
|
|
67523
68069
|
const remaining = removeUsedKeys(args, usedKeys);
|
|
67524
|
-
const { params, data } = separateParamsAndBody(
|
|
68070
|
+
const { params, data } = separateParamsAndBody({
|
|
68071
|
+
args: remaining,
|
|
68072
|
+
method,
|
|
68073
|
+
queryParamKeys,
|
|
68074
|
+
arrayBody
|
|
68075
|
+
});
|
|
67525
68076
|
return { url: url2, params, data };
|
|
67526
68077
|
}
|
|
67527
68078
|
function replacePathParams(path2, args) {
|
|
@@ -67552,7 +68103,7 @@ var PathParamError = class extends Error {
|
|
|
67552
68103
|
function removeUsedKeys(args, usedKeys) {
|
|
67553
68104
|
return Object.fromEntries(Object.entries(args).filter(([key]) => !usedKeys.has(key)));
|
|
67554
68105
|
}
|
|
67555
|
-
function separateParamsAndBody(args, method, queryParamKeys) {
|
|
68106
|
+
function separateParamsAndBody({ args, method, queryParamKeys, arrayBody }) {
|
|
67556
68107
|
const isBodyMethod = ["POST", "PUT", "PATCH"].includes(method);
|
|
67557
68108
|
if (!isBodyMethod) {
|
|
67558
68109
|
return { params: args };
|
|
@@ -67560,8 +68111,7 @@ function separateParamsAndBody(args, method, queryParamKeys) {
|
|
|
67560
68111
|
const queryKeySet = new Set(queryParamKeys);
|
|
67561
68112
|
const params = Object.fromEntries(Object.entries(args).filter(([key]) => queryKeySet.has(key)));
|
|
67562
68113
|
const data = Object.fromEntries(Object.entries(args).filter(([key]) => !queryKeySet.has(key)));
|
|
67563
|
-
|
|
67564
|
-
if (dataKeys.length === 1 && dataKeys[0] === "items" && Array.isArray(data.items)) {
|
|
68114
|
+
if (arrayBody && Array.isArray(data.items)) {
|
|
67565
68115
|
return { params, data: data.items };
|
|
67566
68116
|
}
|
|
67567
68117
|
return { params, data };
|
|
@@ -67579,6 +68129,62 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
|
|
|
67579
68129
|
// ../hyperline-mcp/build/server/server.js
|
|
67580
68130
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
67581
68131
|
|
|
68132
|
+
// build/multipart.js
|
|
68133
|
+
import { readFile as readFile2 } from "node:fs/promises";
|
|
68134
|
+
import { basename, extname } from "node:path";
|
|
68135
|
+
var MIMETYPES_BY_EXTENSION = {
|
|
68136
|
+
".csv": "text/csv",
|
|
68137
|
+
".doc": "application/msword",
|
|
68138
|
+
".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
|
|
68139
|
+
".gif": "image/gif",
|
|
68140
|
+
".jpeg": "image/jpeg",
|
|
68141
|
+
".jpg": "image/jpeg",
|
|
68142
|
+
".json": "application/json",
|
|
68143
|
+
".pdf": "application/pdf",
|
|
68144
|
+
".png": "image/png",
|
|
68145
|
+
".svg": "image/svg+xml",
|
|
68146
|
+
".txt": "text/plain",
|
|
68147
|
+
".xls": "application/vnd.ms-excel",
|
|
68148
|
+
".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
|
|
68149
|
+
".xml": "application/xml"
|
|
68150
|
+
};
|
|
68151
|
+
function getMimetypeFromPath(filePath) {
|
|
68152
|
+
return MIMETYPES_BY_EXTENSION[extname(filePath).toLowerCase()] ?? "application/octet-stream";
|
|
68153
|
+
}
|
|
68154
|
+
function appendFormValue({ formData, key, value }) {
|
|
68155
|
+
if (value === void 0) {
|
|
68156
|
+
return;
|
|
68157
|
+
}
|
|
68158
|
+
if (value === null) {
|
|
68159
|
+
formData.append(key, "");
|
|
68160
|
+
return;
|
|
68161
|
+
}
|
|
68162
|
+
if (Array.isArray(value)) {
|
|
68163
|
+
for (const [index, item] of value.entries()) {
|
|
68164
|
+
appendFormValue({ formData, key: `${key}[${index}]`, value: item });
|
|
68165
|
+
}
|
|
68166
|
+
return;
|
|
68167
|
+
}
|
|
68168
|
+
if (typeof value === "object") {
|
|
68169
|
+
throw new Error(`--${key} cannot be sent alongside files: a multipart request only carries scalar fields.`);
|
|
68170
|
+
}
|
|
68171
|
+
formData.append(key, String(value));
|
|
68172
|
+
}
|
|
68173
|
+
async function buildMultipartBody({ data, files }) {
|
|
68174
|
+
const formData = new FormData();
|
|
68175
|
+
for (const [key, value] of Object.entries(data)) {
|
|
68176
|
+
appendFormValue({ formData, key, value });
|
|
68177
|
+
}
|
|
68178
|
+
const fileUploads = Object.entries(files).flatMap(([fieldName, filePaths]) => filePaths.map((filePath) => ({ fieldName, filePath })));
|
|
68179
|
+
const fileContents = await Promise.all(fileUploads.map(({ filePath }) => readFile2(filePath)));
|
|
68180
|
+
for (const [index, { fieldName, filePath }] of fileUploads.entries()) {
|
|
68181
|
+
formData.append(fieldName, new Blob([new Uint8Array(fileContents[index])], {
|
|
68182
|
+
type: getMimetypeFromPath(filePath)
|
|
68183
|
+
}), basename(filePath));
|
|
68184
|
+
}
|
|
68185
|
+
return formData;
|
|
68186
|
+
}
|
|
68187
|
+
|
|
67582
68188
|
// build/output.js
|
|
67583
68189
|
function formatOutput({ data, format: format2 }) {
|
|
67584
68190
|
if (format2 === "json") {
|
|
@@ -67638,16 +68244,25 @@ function createCLIContext({ apiKey, baseUrl, outputFormat, source, companyId })
|
|
|
67638
68244
|
return {
|
|
67639
68245
|
baseUrl,
|
|
67640
68246
|
outputFormat,
|
|
67641
|
-
async execute({ method, path: path2, args, queryParamKeys = [], body, baseUrlOverride }) {
|
|
67642
|
-
const { url: url2, params, data } = buildRequestConfig(
|
|
68247
|
+
async execute({ method, path: path2, args, queryParamKeys = [], body, files, baseUrlOverride }) {
|
|
68248
|
+
const { url: url2, params, data } = buildRequestConfig({
|
|
68249
|
+
path: path2,
|
|
68250
|
+
args,
|
|
68251
|
+
method,
|
|
68252
|
+
queryParamKeys
|
|
68253
|
+
});
|
|
67643
68254
|
const requestData = body ?? data;
|
|
67644
68255
|
const hasData = Array.isArray(requestData) ? requestData.length > 0 : requestData != null && Object.keys(requestData).length > 0;
|
|
68256
|
+
const hasFiles = Object.values(files ?? {}).some((filePaths) => filePaths.length > 0);
|
|
67645
68257
|
try {
|
|
67646
68258
|
const response = await httpClient.request({
|
|
67647
68259
|
method,
|
|
67648
68260
|
url: url2,
|
|
67649
68261
|
params,
|
|
67650
|
-
data:
|
|
68262
|
+
data: hasFiles ? await buildMultipartBody({
|
|
68263
|
+
data: requestData ?? {},
|
|
68264
|
+
files: files ?? {}
|
|
68265
|
+
}) : hasData ? requestData : void 0,
|
|
67651
68266
|
...baseUrlOverride ? { baseURL: baseUrlOverride } : {},
|
|
67652
68267
|
headers: {
|
|
67653
68268
|
"Hyperline-Source": source,
|