@hyperline/cli 0.1.0-build.1.43ba76d → 0.1.0-build.1.440706
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 +624 -136
- 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,52 @@ Examples:
|
|
|
40675
40673
|
});
|
|
40676
40674
|
}
|
|
40677
40675
|
|
|
40676
|
+
// build/commands/generated/approval-workflows.js
|
|
40677
|
+
function registerApproval_WorkflowsCommands(parent) {
|
|
40678
|
+
const resource = parent.command("approval-workflows").description("Manage approval workflows");
|
|
40679
|
+
resource.command("list").description(`List approval workflows with their steps and approvers. Those whose \`applicable_flows\` include \`workflow_step\` can be picked as the \`approvalWorkflowId\` of a workflow's Request approval step (\`hyperline.request_approval\`). Filter with \`is_active\`; paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--is-active <value>", `Only return workflows matching this active state.`).addHelpText("after", `
|
|
40680
|
+
Examples:
|
|
40681
|
+
hyperline approval-workflows list
|
|
40682
|
+
hyperline approval-workflows list --take <take> --is-active <is_active>`).action(async (opts) => {
|
|
40683
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40684
|
+
if (!ctx) {
|
|
40685
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40686
|
+
process.exit(1);
|
|
40687
|
+
}
|
|
40688
|
+
const args = {};
|
|
40689
|
+
if (opts.isActive !== void 0)
|
|
40690
|
+
args.is_active = opts.isActive;
|
|
40691
|
+
if (opts.take !== void 0)
|
|
40692
|
+
args.take = Number(opts.take);
|
|
40693
|
+
if (opts.skip !== void 0)
|
|
40694
|
+
args.skip = Number(opts.skip);
|
|
40695
|
+
await ctx.execute({
|
|
40696
|
+
method: "GET",
|
|
40697
|
+
path: "/v1/approvals/workflows",
|
|
40698
|
+
args,
|
|
40699
|
+
queryParamKeys: ["take", "skip", "is_active"]
|
|
40700
|
+
});
|
|
40701
|
+
});
|
|
40702
|
+
resource.command("get").description(`Retrieve a single approval workflow.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
40703
|
+
Examples:
|
|
40704
|
+
hyperline approval-workflows get --id <id>`).action(async (opts) => {
|
|
40705
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40706
|
+
if (!ctx) {
|
|
40707
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40708
|
+
process.exit(1);
|
|
40709
|
+
}
|
|
40710
|
+
const args = {};
|
|
40711
|
+
if (opts.id !== void 0)
|
|
40712
|
+
args.id = opts.id;
|
|
40713
|
+
await ctx.execute({
|
|
40714
|
+
method: "GET",
|
|
40715
|
+
path: "/v1/approvals/workflows/{id}",
|
|
40716
|
+
args,
|
|
40717
|
+
queryParamKeys: []
|
|
40718
|
+
});
|
|
40719
|
+
});
|
|
40720
|
+
}
|
|
40721
|
+
|
|
40678
40722
|
// build/commands/generated/bank-accounts.js
|
|
40679
40723
|
function registerBank_AccountsCommands(parent) {
|
|
40680
40724
|
const resource = parent.command("bank-accounts").description("Manage bank accounts");
|
|
@@ -40864,6 +40908,332 @@ Examples:
|
|
|
40864
40908
|
});
|
|
40865
40909
|
}
|
|
40866
40910
|
|
|
40911
|
+
// build/commands/generated/contracts-clauses.js
|
|
40912
|
+
function registerContracts_ClausesCommands(parent) {
|
|
40913
|
+
const resource = parent.command("contracts-clauses").description("Manage contracts > clauses");
|
|
40914
|
+
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", `
|
|
40915
|
+
Examples:
|
|
40916
|
+
hyperline contracts-clauses list-contract-clauses
|
|
40917
|
+
hyperline contracts-clauses list-contract-clauses --take <take>`).action(async (opts) => {
|
|
40918
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40919
|
+
if (!ctx) {
|
|
40920
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40921
|
+
process.exit(1);
|
|
40922
|
+
}
|
|
40923
|
+
const args = {};
|
|
40924
|
+
if (opts.take !== void 0)
|
|
40925
|
+
args.take = Number(opts.take);
|
|
40926
|
+
if (opts.skip !== void 0)
|
|
40927
|
+
args.skip = Number(opts.skip);
|
|
40928
|
+
await ctx.execute({
|
|
40929
|
+
method: "GET",
|
|
40930
|
+
path: "/v1/contracts/clauses",
|
|
40931
|
+
args,
|
|
40932
|
+
queryParamKeys: ["take", "skip"]
|
|
40933
|
+
});
|
|
40934
|
+
});
|
|
40935
|
+
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", `
|
|
40936
|
+
Examples:
|
|
40937
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text>
|
|
40938
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text> --translations <translations> --invoicing-entity-ids <invoicing_entity_ids>
|
|
40939
|
+
hyperline contracts-clauses create-contract-clause --name <name> --text <text> --output json`).action(async (opts) => {
|
|
40940
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40941
|
+
if (!ctx) {
|
|
40942
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40943
|
+
process.exit(1);
|
|
40944
|
+
}
|
|
40945
|
+
const args = {};
|
|
40946
|
+
if (opts.name !== void 0)
|
|
40947
|
+
args.name = opts.name;
|
|
40948
|
+
if (opts.text !== void 0)
|
|
40949
|
+
args.text = opts.text;
|
|
40950
|
+
if (opts.translations !== void 0)
|
|
40951
|
+
args.translations = JSON.parse(opts.translations);
|
|
40952
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
40953
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
40954
|
+
await ctx.execute({
|
|
40955
|
+
method: "POST",
|
|
40956
|
+
path: "/v1/contracts/clauses",
|
|
40957
|
+
args,
|
|
40958
|
+
queryParamKeys: []
|
|
40959
|
+
});
|
|
40960
|
+
});
|
|
40961
|
+
resource.command("get-contract-clause").description(`Retrieve a contract clause by ID.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
40962
|
+
Examples:
|
|
40963
|
+
hyperline contracts-clauses get-contract-clause --id <id>`).action(async (opts) => {
|
|
40964
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40965
|
+
if (!ctx) {
|
|
40966
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40967
|
+
process.exit(1);
|
|
40968
|
+
}
|
|
40969
|
+
const args = {};
|
|
40970
|
+
if (opts.id !== void 0)
|
|
40971
|
+
args.id = opts.id;
|
|
40972
|
+
await ctx.execute({
|
|
40973
|
+
method: "GET",
|
|
40974
|
+
path: "/v1/contracts/clauses/{id}",
|
|
40975
|
+
args,
|
|
40976
|
+
queryParamKeys: []
|
|
40977
|
+
});
|
|
40978
|
+
});
|
|
40979
|
+
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", `
|
|
40980
|
+
Examples:
|
|
40981
|
+
hyperline contracts-clauses update-contract-clause --id <id>
|
|
40982
|
+
hyperline contracts-clauses update-contract-clause --id <id> --name <name> --text <text>
|
|
40983
|
+
hyperline contracts-clauses update-contract-clause --id <id> --output json`).action(async (opts) => {
|
|
40984
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
40985
|
+
if (!ctx) {
|
|
40986
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
40987
|
+
process.exit(1);
|
|
40988
|
+
}
|
|
40989
|
+
const args = {};
|
|
40990
|
+
if (opts.id !== void 0)
|
|
40991
|
+
args.id = opts.id;
|
|
40992
|
+
if (opts.name !== void 0)
|
|
40993
|
+
args.name = opts.name;
|
|
40994
|
+
if (opts.text !== void 0)
|
|
40995
|
+
args.text = opts.text;
|
|
40996
|
+
if (opts.translations !== void 0)
|
|
40997
|
+
args.translations = JSON.parse(opts.translations);
|
|
40998
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
40999
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41000
|
+
await ctx.execute({
|
|
41001
|
+
method: "PUT",
|
|
41002
|
+
path: "/v1/contracts/clauses/{id}",
|
|
41003
|
+
args,
|
|
41004
|
+
queryParamKeys: []
|
|
41005
|
+
});
|
|
41006
|
+
});
|
|
41007
|
+
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", `
|
|
41008
|
+
Examples:
|
|
41009
|
+
hyperline contracts-clauses delete-contract-clause --id <id>
|
|
41010
|
+
hyperline contracts-clauses delete-contract-clause --id <id> --output json`).action(async (opts) => {
|
|
41011
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41012
|
+
if (!ctx) {
|
|
41013
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41014
|
+
process.exit(1);
|
|
41015
|
+
}
|
|
41016
|
+
const args = {};
|
|
41017
|
+
if (opts.id !== void 0)
|
|
41018
|
+
args.id = opts.id;
|
|
41019
|
+
if (!opts.yes) {
|
|
41020
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41021
|
+
if (!confirmed) {
|
|
41022
|
+
process.stdout.write("Aborted.\n");
|
|
41023
|
+
return;
|
|
41024
|
+
}
|
|
41025
|
+
}
|
|
41026
|
+
await ctx.execute({
|
|
41027
|
+
method: "DELETE",
|
|
41028
|
+
path: "/v1/contracts/clauses/{id}",
|
|
41029
|
+
args,
|
|
41030
|
+
queryParamKeys: []
|
|
41031
|
+
});
|
|
41032
|
+
});
|
|
41033
|
+
}
|
|
41034
|
+
|
|
41035
|
+
// build/commands/generated/contracts-documents.js
|
|
41036
|
+
function registerContracts_DocumentsCommands(parent) {
|
|
41037
|
+
const resource = parent.command("contracts-documents").description("Manage contracts > documents");
|
|
41038
|
+
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", `
|
|
41039
|
+
Examples:
|
|
41040
|
+
hyperline contracts-documents list-contract-documents
|
|
41041
|
+
hyperline contracts-documents list-contract-documents --take <take>`).action(async (opts) => {
|
|
41042
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41043
|
+
if (!ctx) {
|
|
41044
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41045
|
+
process.exit(1);
|
|
41046
|
+
}
|
|
41047
|
+
const args = {};
|
|
41048
|
+
if (opts.take !== void 0)
|
|
41049
|
+
args.take = Number(opts.take);
|
|
41050
|
+
if (opts.skip !== void 0)
|
|
41051
|
+
args.skip = Number(opts.skip);
|
|
41052
|
+
await ctx.execute({
|
|
41053
|
+
method: "GET",
|
|
41054
|
+
path: "/v1/contracts/documents",
|
|
41055
|
+
args,
|
|
41056
|
+
queryParamKeys: ["take", "skip"]
|
|
41057
|
+
});
|
|
41058
|
+
});
|
|
41059
|
+
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", `
|
|
41060
|
+
Examples:
|
|
41061
|
+
hyperline contracts-documents create-contract-document --name <name>
|
|
41062
|
+
hyperline contracts-documents create-contract-document --name <name> --invoicing-entity-ids <invoicing_entity_ids>
|
|
41063
|
+
hyperline contracts-documents create-contract-document --name <name> --output json`).action(async (opts) => {
|
|
41064
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41065
|
+
if (!ctx) {
|
|
41066
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41067
|
+
process.exit(1);
|
|
41068
|
+
}
|
|
41069
|
+
const args = {};
|
|
41070
|
+
if (opts.name !== void 0)
|
|
41071
|
+
args.name = opts.name;
|
|
41072
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41073
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41074
|
+
await ctx.execute({
|
|
41075
|
+
method: "POST",
|
|
41076
|
+
path: "/v1/contracts/documents",
|
|
41077
|
+
args,
|
|
41078
|
+
queryParamKeys: []
|
|
41079
|
+
});
|
|
41080
|
+
});
|
|
41081
|
+
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", `
|
|
41082
|
+
Examples:
|
|
41083
|
+
hyperline contracts-documents get-contract-document --id <id>`).action(async (opts) => {
|
|
41084
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41085
|
+
if (!ctx) {
|
|
41086
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41087
|
+
process.exit(1);
|
|
41088
|
+
}
|
|
41089
|
+
const args = {};
|
|
41090
|
+
if (opts.id !== void 0)
|
|
41091
|
+
args.id = opts.id;
|
|
41092
|
+
await ctx.execute({
|
|
41093
|
+
method: "GET",
|
|
41094
|
+
path: "/v1/contracts/documents/{id}",
|
|
41095
|
+
args,
|
|
41096
|
+
queryParamKeys: []
|
|
41097
|
+
});
|
|
41098
|
+
});
|
|
41099
|
+
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", `
|
|
41100
|
+
Examples:
|
|
41101
|
+
hyperline contracts-documents update-contract-document --id <id>
|
|
41102
|
+
hyperline contracts-documents update-contract-document --id <id> --name <name> --invoicing-entity-ids <invoicing_entity_ids>
|
|
41103
|
+
hyperline contracts-documents update-contract-document --id <id> --output json`).action(async (opts) => {
|
|
41104
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41105
|
+
if (!ctx) {
|
|
41106
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41107
|
+
process.exit(1);
|
|
41108
|
+
}
|
|
41109
|
+
const args = {};
|
|
41110
|
+
if (opts.id !== void 0)
|
|
41111
|
+
args.id = opts.id;
|
|
41112
|
+
if (opts.name !== void 0)
|
|
41113
|
+
args.name = opts.name;
|
|
41114
|
+
if (opts.invoicingEntityIds !== void 0)
|
|
41115
|
+
args.invoicing_entity_ids = JSON.parse(opts.invoicingEntityIds);
|
|
41116
|
+
await ctx.execute({
|
|
41117
|
+
method: "PUT",
|
|
41118
|
+
path: "/v1/contracts/documents/{id}",
|
|
41119
|
+
args,
|
|
41120
|
+
queryParamKeys: []
|
|
41121
|
+
});
|
|
41122
|
+
});
|
|
41123
|
+
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", `
|
|
41124
|
+
Examples:
|
|
41125
|
+
hyperline contracts-documents delete-contract-document --id <id>
|
|
41126
|
+
hyperline contracts-documents delete-contract-document --id <id> --output json`).action(async (opts) => {
|
|
41127
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41128
|
+
if (!ctx) {
|
|
41129
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41130
|
+
process.exit(1);
|
|
41131
|
+
}
|
|
41132
|
+
const args = {};
|
|
41133
|
+
if (opts.id !== void 0)
|
|
41134
|
+
args.id = opts.id;
|
|
41135
|
+
if (!opts.yes) {
|
|
41136
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41137
|
+
if (!confirmed) {
|
|
41138
|
+
process.stdout.write("Aborted.\n");
|
|
41139
|
+
return;
|
|
41140
|
+
}
|
|
41141
|
+
}
|
|
41142
|
+
await ctx.execute({
|
|
41143
|
+
method: "DELETE",
|
|
41144
|
+
path: "/v1/contracts/documents/{id}",
|
|
41145
|
+
args,
|
|
41146
|
+
queryParamKeys: []
|
|
41147
|
+
});
|
|
41148
|
+
});
|
|
41149
|
+
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", `
|
|
41150
|
+
Examples:
|
|
41151
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path>
|
|
41152
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path> --countries <countries>
|
|
41153
|
+
hyperline contracts-documents create-contract-document-content --id <id> --language <language> --files <path> --output json`).action(async (opts) => {
|
|
41154
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41155
|
+
if (!ctx) {
|
|
41156
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41157
|
+
process.exit(1);
|
|
41158
|
+
}
|
|
41159
|
+
const args = {};
|
|
41160
|
+
if (opts.id !== void 0)
|
|
41161
|
+
args.id = opts.id;
|
|
41162
|
+
if (opts.language !== void 0)
|
|
41163
|
+
args.language = opts.language;
|
|
41164
|
+
if (opts.countries !== void 0)
|
|
41165
|
+
args.countries = opts.countries;
|
|
41166
|
+
const files = {};
|
|
41167
|
+
if (opts.files !== void 0)
|
|
41168
|
+
files.files = [opts.files].flat();
|
|
41169
|
+
await ctx.execute({
|
|
41170
|
+
method: "POST",
|
|
41171
|
+
path: "/v1/contracts/documents/{id}/contents",
|
|
41172
|
+
args,
|
|
41173
|
+
queryParamKeys: [],
|
|
41174
|
+
files
|
|
41175
|
+
});
|
|
41176
|
+
});
|
|
41177
|
+
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", `
|
|
41178
|
+
Examples:
|
|
41179
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId>
|
|
41180
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId> --language <language> --countries <countries>
|
|
41181
|
+
hyperline contracts-documents update-contract-document-content --id <id> --content-id <contentId> --output json`).action(async (opts) => {
|
|
41182
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41183
|
+
if (!ctx) {
|
|
41184
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41185
|
+
process.exit(1);
|
|
41186
|
+
}
|
|
41187
|
+
const args = {};
|
|
41188
|
+
if (opts.id !== void 0)
|
|
41189
|
+
args.id = opts.id;
|
|
41190
|
+
if (opts.contentId !== void 0)
|
|
41191
|
+
args.contentId = opts.contentId;
|
|
41192
|
+
if (opts.language !== void 0)
|
|
41193
|
+
args.language = opts.language;
|
|
41194
|
+
if (opts.countries !== void 0)
|
|
41195
|
+
args.countries = opts.countries;
|
|
41196
|
+
const files = {};
|
|
41197
|
+
if (opts.files !== void 0)
|
|
41198
|
+
files.files = [opts.files].flat();
|
|
41199
|
+
await ctx.execute({
|
|
41200
|
+
method: "PUT",
|
|
41201
|
+
path: "/v1/contracts/documents/{id}/contents/{contentId}",
|
|
41202
|
+
args,
|
|
41203
|
+
queryParamKeys: [],
|
|
41204
|
+
files
|
|
41205
|
+
});
|
|
41206
|
+
});
|
|
41207
|
+
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", `
|
|
41208
|
+
Examples:
|
|
41209
|
+
hyperline contracts-documents delete-contract-document-content --id <id> --content-id <contentId>
|
|
41210
|
+
hyperline contracts-documents delete-contract-document-content --id <id> --content-id <contentId> --output json`).action(async (opts) => {
|
|
41211
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41212
|
+
if (!ctx) {
|
|
41213
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41214
|
+
process.exit(1);
|
|
41215
|
+
}
|
|
41216
|
+
const args = {};
|
|
41217
|
+
if (opts.id !== void 0)
|
|
41218
|
+
args.id = opts.id;
|
|
41219
|
+
if (opts.contentId !== void 0)
|
|
41220
|
+
args.contentId = opts.contentId;
|
|
41221
|
+
if (!opts.yes) {
|
|
41222
|
+
const confirmed = await confirmPrompt("Are you sure? Pass --yes to skip. [y/N] ");
|
|
41223
|
+
if (!confirmed) {
|
|
41224
|
+
process.stdout.write("Aborted.\n");
|
|
41225
|
+
return;
|
|
41226
|
+
}
|
|
41227
|
+
}
|
|
41228
|
+
await ctx.execute({
|
|
41229
|
+
method: "DELETE",
|
|
41230
|
+
path: "/v1/contracts/documents/{id}/contents/{contentId}",
|
|
41231
|
+
args,
|
|
41232
|
+
queryParamKeys: []
|
|
41233
|
+
});
|
|
41234
|
+
});
|
|
41235
|
+
}
|
|
41236
|
+
|
|
40867
41237
|
// build/commands/generated/coupons.js
|
|
40868
41238
|
function registerCouponsCommands(parent) {
|
|
40869
41239
|
const resource = parent.command("coupons").description("Manage coupons");
|
|
@@ -41315,7 +41685,7 @@ Examples:
|
|
|
41315
41685
|
// build/commands/generated/customers.js
|
|
41316
41686
|
function registerCustomersCommands(parent) {
|
|
41317
41687
|
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>", `
|
|
41688
|
+
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
41689
|
Verification status of the customer tax ID.
|
|
41320
41690
|
|
|
41321
41691
|
- \`valid\`: Tax ID has been verified and is valid.
|
|
@@ -41323,7 +41693,7 @@ Verification status of the customer tax ID.
|
|
|
41323
41693
|
- \`mismatch\`: Tax ID is valid but is for a different country than the customer's country.
|
|
41324
41694
|
- \`unverified\`: Tax ID has not been verified yet.
|
|
41325
41695
|
- \`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>", `
|
|
41696
|
+
`).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
41697
|
Examples:
|
|
41328
41698
|
hyperline customers list
|
|
41329
41699
|
hyperline customers list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
@@ -41621,13 +41991,13 @@ Customer type.
|
|
|
41621
41991
|
|
|
41622
41992
|
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
41623
41993
|
- \`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>", `
|
|
41994
|
+
`).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
41995
|
How customer invoices are issued from the parent organisation.
|
|
41626
41996
|
|
|
41627
41997
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
41628
41998
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
41629
41999
|
- \`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", `
|
|
42000
|
+
`).option("--properties <json>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <json>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--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
42001
|
Examples:
|
|
41632
42002
|
hyperline customers create-customer
|
|
41633
42003
|
hyperline customers create-customer --name <name> --type <type>
|
|
@@ -41672,6 +42042,8 @@ Examples:
|
|
|
41672
42042
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
41673
42043
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
41674
42044
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42045
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42046
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
41675
42047
|
if (opts.forceInvoiceDraft !== void 0)
|
|
41676
42048
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
41677
42049
|
if (opts.priceBookId !== void 0)
|
|
@@ -41758,13 +42130,13 @@ Customer type.
|
|
|
41758
42130
|
|
|
41759
42131
|
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
41760
42132
|
- \`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>", `
|
|
42133
|
+
`).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
42134
|
How customer invoices are issued from the parent organisation.
|
|
41763
42135
|
|
|
41764
42136
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
41765
42137
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
41766
42138
|
- \`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", `
|
|
42139
|
+
`).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
42140
|
Examples:
|
|
41769
42141
|
hyperline customers update --id <id>
|
|
41770
42142
|
hyperline customers update --id <id> --name <name> --type <type>
|
|
@@ -41813,6 +42185,8 @@ Examples:
|
|
|
41813
42185
|
args.organisation_invoicing = opts.organisationInvoicing;
|
|
41814
42186
|
if (opts.invoiceRemindersEnabled !== void 0)
|
|
41815
42187
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
42188
|
+
if (opts.consolidatedInvoicingEnabled !== void 0)
|
|
42189
|
+
args.consolidated_invoicing_enabled = opts.consolidatedInvoicingEnabled;
|
|
41816
42190
|
if (opts.forceInvoiceDraft !== void 0)
|
|
41817
42191
|
args.force_invoice_draft = opts.forceInvoiceDraft;
|
|
41818
42192
|
if (opts.priceBookId !== void 0)
|
|
@@ -42044,7 +42418,13 @@ Examples:
|
|
|
42044
42418
|
queryParamKeys: []
|
|
42045
42419
|
});
|
|
42046
42420
|
});
|
|
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>", `
|
|
42421
|
+
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:
|
|
42422
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
42423
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
42424
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
42425
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
42426
|
+
|
|
42427
|
+
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
42428
|
Examples:
|
|
42049
42429
|
hyperline customers-address create-customer-address --customer-id <customerId> --type <type>
|
|
42050
42430
|
hyperline customers-address create-customer-address --customer-id <customerId> --type <type> --name <name> --line1 <line1>
|
|
@@ -42082,7 +42462,13 @@ Examples:
|
|
|
42082
42462
|
queryParamKeys: []
|
|
42083
42463
|
});
|
|
42084
42464
|
});
|
|
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>", `
|
|
42465
|
+
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:
|
|
42466
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
42467
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
42468
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
42469
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
42470
|
+
|
|
42471
|
+
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
42472
|
Examples:
|
|
42087
42473
|
hyperline customers-address update-customer-address --customer-id <customerId> --address-id <addressId>
|
|
42088
42474
|
hyperline customers-address update-customer-address --customer-id <customerId> --address-id <addressId> --name <name> --line1 <line1>
|
|
@@ -43332,10 +43718,10 @@ Examples:
|
|
|
43332
43718
|
]
|
|
43333
43719
|
});
|
|
43334
43720
|
});
|
|
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", `
|
|
43721
|
+
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
43722
|
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) => {
|
|
43723
|
+
hyperline files create --name <name> --customer-id <customer_id> --file <path>
|
|
43724
|
+
hyperline files create --name <name> --customer-id <customer_id> --file <path> --output json`).action(async (opts) => {
|
|
43339
43725
|
const ctx = resource.parent?.opts()._ctx;
|
|
43340
43726
|
if (!ctx) {
|
|
43341
43727
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -43346,11 +43732,15 @@ Examples:
|
|
|
43346
43732
|
args.name = opts.name;
|
|
43347
43733
|
if (opts.customerId !== void 0)
|
|
43348
43734
|
args.customer_id = opts.customerId;
|
|
43735
|
+
const files = {};
|
|
43736
|
+
if (opts.file !== void 0)
|
|
43737
|
+
files.file = [opts.file].flat();
|
|
43349
43738
|
await ctx.execute({
|
|
43350
43739
|
method: "POST",
|
|
43351
43740
|
path: "/v1/files",
|
|
43352
43741
|
args,
|
|
43353
|
-
queryParamKeys: []
|
|
43742
|
+
queryParamKeys: [],
|
|
43743
|
+
files
|
|
43354
43744
|
});
|
|
43355
43745
|
});
|
|
43356
43746
|
resource.command("delete").description(`Permanently delete a file by ID.`).requiredOption("--id <value>", `id parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
@@ -43707,7 +44097,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
43707
44097
|
|
|
43708
44098
|
- \`current\`: Use the current default payment method of the customer.
|
|
43709
44099
|
- \`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", `
|
|
44100
|
+
`).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.`).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
44101
|
Examples:
|
|
43712
44102
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
43713
44103
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -43760,6 +44150,8 @@ Examples:
|
|
|
43760
44150
|
args.settled_at = opts.settledAt;
|
|
43761
44151
|
if (opts.issuingMethod !== void 0)
|
|
43762
44152
|
args.issuing_method = opts.issuingMethod;
|
|
44153
|
+
if (opts.originalInvoiceId !== void 0)
|
|
44154
|
+
args.original_invoice_id = opts.originalInvoiceId;
|
|
43763
44155
|
if (opts.properties !== void 0)
|
|
43764
44156
|
args.properties = JSON.parse(opts.properties);
|
|
43765
44157
|
if (opts.customProperties !== void 0)
|
|
@@ -43768,6 +44160,8 @@ Examples:
|
|
|
43768
44160
|
args.additional_display_fields = JSON.parse(opts.additionalDisplayFields);
|
|
43769
44161
|
if (opts.lineItems !== void 0)
|
|
43770
44162
|
args.line_items = JSON.parse(opts.lineItems);
|
|
44163
|
+
if (opts.allocations !== void 0)
|
|
44164
|
+
args.allocations = JSON.parse(opts.allocations);
|
|
43771
44165
|
if (opts.transactions !== void 0)
|
|
43772
44166
|
args.transactions = JSON.parse(opts.transactions);
|
|
43773
44167
|
if (opts.coupons !== void 0)
|
|
@@ -43903,6 +44297,36 @@ Examples:
|
|
|
43903
44297
|
queryParamKeys: []
|
|
43904
44298
|
});
|
|
43905
44299
|
});
|
|
44300
|
+
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\`.
|
|
44301
|
+
|
|
44302
|
+
- \`invoice_ready\`: The to-pay invoice email (for \`to_pay\`, \`partially_paid\`, \`late\` invoices).
|
|
44303
|
+
- \`invoice_settled\`: The paid-invoice email (for \`paid\` invoices).
|
|
44304
|
+
- \`invoice_errored\`: The failed-payment email (for \`error\` invoices with a payment method).
|
|
44305
|
+
- \`credit_note_ready\`: The issued-credit-note email (for \`to_pay\`, \`partially_paid\` refunds).
|
|
44306
|
+
- \`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", `
|
|
44307
|
+
Examples:
|
|
44308
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids>
|
|
44309
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids> --batch-id <batch_id>
|
|
44310
|
+
hyperline invoices send-invoice-emails --email-type <email_type> --ids <ids> --output json`).action(async (opts) => {
|
|
44311
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
44312
|
+
if (!ctx) {
|
|
44313
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
44314
|
+
process.exit(1);
|
|
44315
|
+
}
|
|
44316
|
+
const args = {};
|
|
44317
|
+
if (opts.batchId !== void 0)
|
|
44318
|
+
args.batch_id = opts.batchId;
|
|
44319
|
+
if (opts.emailType !== void 0)
|
|
44320
|
+
args.email_type = opts.emailType;
|
|
44321
|
+
if (opts.ids !== void 0)
|
|
44322
|
+
args.ids = JSON.parse(opts.ids);
|
|
44323
|
+
await ctx.execute({
|
|
44324
|
+
method: "POST",
|
|
44325
|
+
path: "/v1/invoices/send-email",
|
|
44326
|
+
args,
|
|
44327
|
+
queryParamKeys: []
|
|
44328
|
+
});
|
|
44329
|
+
});
|
|
43906
44330
|
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
44331
|
Examples:
|
|
43908
44332
|
hyperline invoices mark-invoice-as-uncollectible --id <id>
|
|
@@ -43940,7 +44364,28 @@ Examples:
|
|
|
43940
44364
|
queryParamKeys: []
|
|
43941
44365
|
});
|
|
43942
44366
|
});
|
|
43943
|
-
resource.command("update").description(`
|
|
44367
|
+
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", `
|
|
44368
|
+
Examples:
|
|
44369
|
+
hyperline invoices update-credit-note-allocations --id <id> --allocations <allocations>
|
|
44370
|
+
hyperline invoices update-credit-note-allocations --id <id> --allocations <allocations> --output json`).action(async (opts) => {
|
|
44371
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
44372
|
+
if (!ctx) {
|
|
44373
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
44374
|
+
process.exit(1);
|
|
44375
|
+
}
|
|
44376
|
+
const args = {};
|
|
44377
|
+
if (opts.id !== void 0)
|
|
44378
|
+
args.id = opts.id;
|
|
44379
|
+
if (opts.allocations !== void 0)
|
|
44380
|
+
args.allocations = JSON.parse(opts.allocations);
|
|
44381
|
+
await ctx.execute({
|
|
44382
|
+
method: "PUT",
|
|
44383
|
+
path: "/v1/invoices/{id}/allocations",
|
|
44384
|
+
args,
|
|
44385
|
+
queryParamKeys: []
|
|
44386
|
+
});
|
|
44387
|
+
});
|
|
44388
|
+
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
44389
|
|
|
43945
44390
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
43946
44391
|
- \`credit_note\`: Legal credit note cancelling an invoice and refunding your customer.
|
|
@@ -43949,7 +44394,7 @@ Examples:
|
|
|
43949
44394
|
|
|
43950
44395
|
- \`auto\`: Tax is automatically computed and applied.
|
|
43951
44396
|
- \`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>", `
|
|
44397
|
+
`).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
44398
|
Examples:
|
|
43954
44399
|
hyperline invoices update --id <id>
|
|
43955
44400
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -43990,6 +44435,8 @@ Examples:
|
|
|
43990
44435
|
args.bank_account_id = opts.bankAccountId;
|
|
43991
44436
|
if (opts.subscriptionId !== void 0)
|
|
43992
44437
|
args.subscription_id = opts.subscriptionId;
|
|
44438
|
+
if (opts.originalInvoiceId !== void 0)
|
|
44439
|
+
args.original_invoice_id = opts.originalInvoiceId;
|
|
43993
44440
|
if (opts.lineItems !== void 0)
|
|
43994
44441
|
args.line_items = JSON.parse(opts.lineItems);
|
|
43995
44442
|
if (opts.coupons !== void 0)
|
|
@@ -44035,10 +44482,10 @@ Examples:
|
|
|
44035
44482
|
queryParamKeys: []
|
|
44036
44483
|
});
|
|
44037
44484
|
});
|
|
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", `
|
|
44485
|
+
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
44486
|
Examples:
|
|
44040
|
-
hyperline invoices upload-pdf-to --id <id>
|
|
44041
|
-
hyperline invoices upload-pdf-to --id <id> --output json`).action(async (opts) => {
|
|
44487
|
+
hyperline invoices upload-pdf-to --id <id> --file <path>
|
|
44488
|
+
hyperline invoices upload-pdf-to --id <id> --file <path> --output json`).action(async (opts) => {
|
|
44042
44489
|
const ctx = resource.parent?.opts()._ctx;
|
|
44043
44490
|
if (!ctx) {
|
|
44044
44491
|
process.stderr.write("Error: Not authenticated\n");
|
|
@@ -44047,11 +44494,15 @@ Examples:
|
|
|
44047
44494
|
const args = {};
|
|
44048
44495
|
if (opts.id !== void 0)
|
|
44049
44496
|
args.id = opts.id;
|
|
44497
|
+
const files = {};
|
|
44498
|
+
if (opts.file !== void 0)
|
|
44499
|
+
files.file = [opts.file].flat();
|
|
44050
44500
|
await ctx.execute({
|
|
44051
44501
|
method: "POST",
|
|
44052
44502
|
path: "/v1/invoices/{id}/upload",
|
|
44053
44503
|
args,
|
|
44054
|
-
queryParamKeys: []
|
|
44504
|
+
queryParamKeys: [],
|
|
44505
|
+
files
|
|
44055
44506
|
});
|
|
44056
44507
|
});
|
|
44057
44508
|
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 +44641,13 @@ Examples:
|
|
|
44190
44641
|
queryParamKeys: []
|
|
44191
44642
|
});
|
|
44192
44643
|
});
|
|
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>", `
|
|
44644
|
+
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:
|
|
44645
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
44646
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
44647
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
44648
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
44649
|
+
|
|
44650
|
+
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
44651
|
Examples:
|
|
44195
44652
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
44196
44653
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -44282,7 +44739,13 @@ Examples:
|
|
|
44282
44739
|
queryParamKeys: []
|
|
44283
44740
|
});
|
|
44284
44741
|
});
|
|
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>", `
|
|
44742
|
+
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:
|
|
44743
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
44744
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
44745
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
44746
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
44747
|
+
|
|
44748
|
+
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
44749
|
Examples:
|
|
44287
44750
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
44288
44751
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -44529,7 +44992,7 @@ function registerPaymentsCommands(parent) {
|
|
|
44529
44992
|
Payment type.
|
|
44530
44993
|
|
|
44531
44994
|
- \`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>", `
|
|
44995
|
+
`).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
44996
|
Charging method.
|
|
44534
44997
|
|
|
44535
44998
|
- \`immediately\`: Customer's payment method will be charged directly to pay the invoice.
|
|
@@ -44561,6 +45024,8 @@ Examples:
|
|
|
44561
45024
|
args.payment_method_id = opts.paymentMethodId;
|
|
44562
45025
|
if (opts.products !== void 0)
|
|
44563
45026
|
args.products = JSON.parse(opts.products);
|
|
45027
|
+
if (opts.coupons !== void 0)
|
|
45028
|
+
args.coupons = JSON.parse(opts.coupons);
|
|
44564
45029
|
if (opts.availablePaymentMethods !== void 0)
|
|
44565
45030
|
args.available_payment_methods = JSON.parse(opts.availablePaymentMethods);
|
|
44566
45031
|
if (opts.checkoutSession !== void 0)
|
|
@@ -44765,7 +45230,7 @@ Examples:
|
|
|
44765
45230
|
// build/commands/generated/products.js
|
|
44766
45231
|
function registerProductsCommands(parent) {
|
|
44767
45232
|
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
|
|
45233
|
+
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
45234
|
Examples:
|
|
44770
45235
|
hyperline products list
|
|
44771
45236
|
hyperline products list --take <take> --id <id>`).action(async (opts) => {
|
|
@@ -44833,6 +45298,8 @@ Examples:
|
|
|
44833
45298
|
args.type__endWith = opts["type.endWith"];
|
|
44834
45299
|
if (opts.priceBookId !== void 0)
|
|
44835
45300
|
args.price_book_id = opts.priceBookId;
|
|
45301
|
+
if (opts.customProperties !== void 0)
|
|
45302
|
+
args.custom_properties = opts.customProperties;
|
|
44836
45303
|
if (opts.take !== void 0)
|
|
44837
45304
|
args.take = Number(opts.take);
|
|
44838
45305
|
if (opts.skip !== void 0)
|
|
@@ -44872,7 +45339,8 @@ Examples:
|
|
|
44872
45339
|
"type__contains",
|
|
44873
45340
|
"type__startsWith",
|
|
44874
45341
|
"type__endWith",
|
|
44875
|
-
"price_book_id"
|
|
45342
|
+
"price_book_id",
|
|
45343
|
+
"custom_properties"
|
|
44876
45344
|
]
|
|
44877
45345
|
});
|
|
44878
45346
|
});
|
|
@@ -45156,7 +45624,7 @@ Quote status.
|
|
|
45156
45624
|
- \`all\`: Display all pricing tiers.
|
|
45157
45625
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
45158
45626
|
- \`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", `
|
|
45627
|
+
`).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
45628
|
Examples:
|
|
45161
45629
|
hyperline quotes create --customer-id <customer_id>
|
|
45162
45630
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -45221,11 +45689,15 @@ Examples:
|
|
|
45221
45689
|
args.subscription = JSON.parse(opts.subscription);
|
|
45222
45690
|
if (opts.invoice !== void 0)
|
|
45223
45691
|
args.invoice = JSON.parse(opts.invoice);
|
|
45692
|
+
const files = {};
|
|
45693
|
+
if (opts.attachments !== void 0)
|
|
45694
|
+
files.attachments = [opts.attachments].flat();
|
|
45224
45695
|
await ctx.execute({
|
|
45225
45696
|
method: "POST",
|
|
45226
45697
|
path: "/v1/quotes",
|
|
45227
45698
|
args,
|
|
45228
|
-
queryParamKeys: []
|
|
45699
|
+
queryParamKeys: [],
|
|
45700
|
+
files
|
|
45229
45701
|
});
|
|
45230
45702
|
});
|
|
45231
45703
|
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 +45879,7 @@ Examples:
|
|
|
45407
45879
|
- \`all\`: Display all pricing tiers.
|
|
45408
45880
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
45409
45881
|
- \`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", `
|
|
45882
|
+
`).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
45883
|
Examples:
|
|
45412
45884
|
hyperline quotes update --id <id>
|
|
45413
45885
|
hyperline quotes update --id <id> --owner-email <owner_email> --catalog-version-id <catalog_version_id>
|
|
@@ -45468,11 +45940,15 @@ Examples:
|
|
|
45468
45940
|
args.subscription = JSON.parse(opts.subscription);
|
|
45469
45941
|
if (opts.invoice !== void 0)
|
|
45470
45942
|
args.invoice = JSON.parse(opts.invoice);
|
|
45943
|
+
const files = {};
|
|
45944
|
+
if (opts.attachments !== void 0)
|
|
45945
|
+
files.attachments = [opts.attachments].flat();
|
|
45471
45946
|
await ctx.execute({
|
|
45472
45947
|
method: "PATCH",
|
|
45473
45948
|
path: "/v1/quotes/{id}",
|
|
45474
45949
|
args,
|
|
45475
|
-
queryParamKeys: []
|
|
45950
|
+
queryParamKeys: [],
|
|
45951
|
+
files
|
|
45476
45952
|
});
|
|
45477
45953
|
});
|
|
45478
45954
|
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 +46101,10 @@ Examples:
|
|
|
45625
46101
|
queryParamKeys: []
|
|
45626
46102
|
});
|
|
45627
46103
|
});
|
|
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", `
|
|
46104
|
+
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
46105
|
Examples:
|
|
45630
46106
|
hyperline quotes sign --id <id>
|
|
46107
|
+
hyperline quotes sign --id <id> --signed-quote <path>
|
|
45631
46108
|
hyperline quotes sign --id <id> --output json`).action(async (opts) => {
|
|
45632
46109
|
const ctx = resource.parent?.opts()._ctx;
|
|
45633
46110
|
if (!ctx) {
|
|
@@ -45637,11 +46114,15 @@ Examples:
|
|
|
45637
46114
|
const args = {};
|
|
45638
46115
|
if (opts.id !== void 0)
|
|
45639
46116
|
args.id = opts.id;
|
|
46117
|
+
const files = {};
|
|
46118
|
+
if (opts.signedQuote !== void 0)
|
|
46119
|
+
files.signed_quote = [opts.signedQuote].flat();
|
|
45640
46120
|
await ctx.execute({
|
|
45641
46121
|
method: "POST",
|
|
45642
46122
|
path: "/v1/quotes/{id}/sign",
|
|
45643
46123
|
args,
|
|
45644
|
-
queryParamKeys: []
|
|
46124
|
+
queryParamKeys: [],
|
|
46125
|
+
files
|
|
45645
46126
|
});
|
|
45646
46127
|
});
|
|
45647
46128
|
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 +46234,7 @@ Examples:
|
|
|
45753
46234
|
// build/commands/generated/quotes-templates.js
|
|
45754
46235
|
function registerQuotes_TemplatesCommands(parent) {
|
|
45755
46236
|
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("--
|
|
46237
|
+
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
46238
|
Examples:
|
|
45758
46239
|
hyperline quotes-templates list-quote-templates
|
|
45759
46240
|
hyperline quotes-templates list-quote-templates --take <take> --id <id>`).action(async (opts) => {
|
|
@@ -45789,20 +46270,6 @@ Examples:
|
|
|
45789
46270
|
args.name__endWith = opts["name.endWith"];
|
|
45790
46271
|
if (opts.subscriptionTemplateId !== void 0)
|
|
45791
46272
|
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
46273
|
if (opts.search !== void 0)
|
|
45807
46274
|
args.search = opts.search;
|
|
45808
46275
|
if (opts.take !== void 0)
|
|
@@ -45829,13 +46296,6 @@ Examples:
|
|
|
45829
46296
|
"name__startsWith",
|
|
45830
46297
|
"name__endWith",
|
|
45831
46298
|
"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
46299
|
"search"
|
|
45840
46300
|
]
|
|
45841
46301
|
});
|
|
@@ -46237,7 +46697,7 @@ Examples:
|
|
|
46237
46697
|
queryParamKeys: []
|
|
46238
46698
|
});
|
|
46239
46699
|
});
|
|
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>", `
|
|
46700
|
+
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
46701
|
Subscription status filter.
|
|
46242
46702
|
|
|
46243
46703
|
- \`active\`, \`pending\`, \`paused\`, \`errored\`, \`cancelled\`, \`draft\`, \`voided\`, \`archived\`: match that status.
|
|
@@ -46246,7 +46706,7 @@ Subscription status filter.
|
|
|
46246
46706
|
- \`any\`: every status, no exclusion.
|
|
46247
46707
|
|
|
46248
46708
|
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>", `
|
|
46709
|
+
`).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
46710
|
Examples:
|
|
46251
46711
|
hyperline subscriptions list
|
|
46252
46712
|
hyperline subscriptions list --take <take> --activation-strategy <activation_strategy>`).action(async (opts) => {
|
|
@@ -46893,7 +47353,7 @@ Examples:
|
|
|
46893
47353
|
]
|
|
46894
47354
|
});
|
|
46895
47355
|
});
|
|
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
|
|
47356
|
+
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
47357
|
Examples:
|
|
46898
47358
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
46899
47359
|
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>
|
|
@@ -47646,9 +48106,12 @@ function registerAllCommands(program2) {
|
|
|
47646
48106
|
registerAi_BillingCommands(program2);
|
|
47647
48107
|
registerAi_CostsCommands(program2);
|
|
47648
48108
|
registerAnalyticsCommands(program2);
|
|
48109
|
+
registerApproval_WorkflowsCommands(program2);
|
|
47649
48110
|
registerBank_AccountsCommands(program2);
|
|
47650
48111
|
registerCatalogCommands(program2);
|
|
47651
48112
|
registerCompaniesCommands(program2);
|
|
48113
|
+
registerContracts_ClausesCommands(program2);
|
|
48114
|
+
registerContracts_DocumentsCommands(program2);
|
|
47652
48115
|
registerCouponsCommands(program2);
|
|
47653
48116
|
registerCoupons_Promotion_CodesCommands(program2);
|
|
47654
48117
|
registerCustomers_CreditsCommands(program2);
|
|
@@ -63745,6 +64208,7 @@ var de = {
|
|
|
63745
64208
|
"quotes.blockers.quote_configuration_not_subscription_update": "W\xE4hlen Sie eine Konfiguration f\xFCr eine Abonnement\xE4nderung",
|
|
63746
64209
|
"quotes.blockers.quote_configuration_not_new_subscription": "W\xE4hlen Sie eine Konfiguration f\xFCr ein neues Abonnement",
|
|
63747
64210
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Ein Abonnement kann in einem Angebot nur einmal ge\xE4ndert werden",
|
|
64211
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Jedes Produkt muss aus dem Konto des Abrechnungsanbieters des ge\xE4nderten Abonnements stammen",
|
|
63748
64212
|
"quotes.blockers.quote_draft_invoice_missing": "Das Angebot muss eine Rechnung im Entwurf haben, um abgeschlossen zu werden",
|
|
63749
64213
|
"quotes.blockers.quote_draft_subscription_missing": "Das Angebot muss ein Abonnement im Entwurf haben, um abgeschlossen zu werden",
|
|
63750
64214
|
"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 +64277,7 @@ var en = {
|
|
|
63813
64277
|
"quotes.blockers.quote_configuration_not_subscription_update": "Select a subscription update configuration",
|
|
63814
64278
|
"quotes.blockers.quote_configuration_not_new_subscription": "Select a new subscription configuration",
|
|
63815
64279
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "A subscription can only be updated once in a quote",
|
|
64280
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Every product must come from the billing provider account of the subscription being updated",
|
|
63816
64281
|
"quotes.blockers.quote_draft_invoice_missing": "Quote must have a draft invoice to be finalized",
|
|
63817
64282
|
"quotes.blockers.quote_draft_subscription_missing": "Quote must have a draft subscription to be finalized",
|
|
63818
64283
|
"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 +64346,7 @@ var es = {
|
|
|
63881
64346
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecciona una configuraci\xF3n de actualizaci\xF3n de suscripci\xF3n",
|
|
63882
64347
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecciona una configuraci\xF3n de nueva suscripci\xF3n",
|
|
63883
64348
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Una suscripci\xF3n solo puede actualizarse una vez en un presupuesto",
|
|
64349
|
+
"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
64350
|
"quotes.blockers.quote_draft_invoice_missing": "El presupuesto debe tener una factura en borrador para finalizarse",
|
|
63885
64351
|
"quotes.blockers.quote_draft_subscription_missing": "El presupuesto debe tener una suscripci\xF3n en borrador para finalizarse",
|
|
63886
64352
|
"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 +64415,7 @@ var fr = {
|
|
|
63949
64415
|
"quotes.blockers.quote_configuration_not_subscription_update": "S\xE9lectionnez une configuration de mise \xE0 jour d'abonnement",
|
|
63950
64416
|
"quotes.blockers.quote_configuration_not_new_subscription": "S\xE9lectionnez une configuration de nouvel abonnement",
|
|
63951
64417
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abonnement ne peut \xEAtre mis \xE0 jour qu'une seule fois dans un devis",
|
|
64418
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Chaque produit doit provenir du compte du fournisseur de facturation de l'abonnement mis \xE0 jour",
|
|
63952
64419
|
"quotes.blockers.quote_draft_invoice_missing": "Le devis doit avoir une facture en brouillon pour \xEAtre finalis\xE9",
|
|
63953
64420
|
"quotes.blockers.quote_draft_subscription_missing": "Le devis doit avoir un abonnement en brouillon pour \xEAtre finalis\xE9",
|
|
63954
64421
|
"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 +64484,7 @@ var it = {
|
|
|
64017
64484
|
"quotes.blockers.quote_configuration_not_subscription_update": "Seleziona una configurazione di aggiornamento dell'abbonamento",
|
|
64018
64485
|
"quotes.blockers.quote_configuration_not_new_subscription": "Seleziona una configurazione di nuovo abbonamento",
|
|
64019
64486
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Un abbonamento pu\xF2 essere aggiornato una sola volta in un preventivo",
|
|
64487
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ogni prodotto deve provenire dall'account del provider di fatturazione dell'abbonamento aggiornato",
|
|
64020
64488
|
"quotes.blockers.quote_draft_invoice_missing": "Il preventivo deve avere una fattura in bozza per essere finalizzato",
|
|
64021
64489
|
"quotes.blockers.quote_draft_subscription_missing": "Il preventivo deve avere un abbonamento in bozza per essere finalizzato",
|
|
64022
64490
|
"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 +64553,7 @@ var lt = {
|
|
|
64085
64553
|
"quotes.blockers.quote_configuration_not_subscription_update": "Pasirinkite prenumeratos atnaujinimo konfig\u016Bracij\u0105",
|
|
64086
64554
|
"quotes.blockers.quote_configuration_not_new_subscription": "Pasirinkite naujos prenumeratos konfig\u016Bracij\u0105",
|
|
64087
64555
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Prenumerat\u0105 pasi\u016Blyme galima atnaujinti tik vien\u0105 kart\u0105",
|
|
64556
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Kiekvienas produktas turi b\u016Bti i\u0161 atnaujinamos prenumeratos atsiskaitymo teik\u0117jo paskyros",
|
|
64088
64557
|
"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
64558
|
"quotes.blockers.quote_draft_subscription_missing": "Pasi\u016Blymas turi tur\u0117ti prenumeratos juodra\u0161t\u012F, kad b\u016Bt\u0173 u\u017Ebaigtas",
|
|
64090
64559
|
"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 +64622,7 @@ var nl = {
|
|
|
64153
64622
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecteer een configuratie voor een abonnementswijziging",
|
|
64154
64623
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecteer een configuratie voor een nieuw abonnement",
|
|
64155
64624
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Een abonnement kan maar \xE9\xE9n keer per offerte worden gewijzigd",
|
|
64625
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Elk product moet afkomstig zijn van het account van de factureringsprovider van het gewijzigde abonnement",
|
|
64156
64626
|
"quotes.blockers.quote_draft_invoice_missing": "De offerte moet een conceptfactuur hebben om te worden afgerond",
|
|
64157
64627
|
"quotes.blockers.quote_draft_subscription_missing": "De offerte moet een conceptabonnement hebben om te worden afgerond",
|
|
64158
64628
|
"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 +64691,7 @@ var pl = {
|
|
|
64221
64691
|
"quotes.blockers.quote_configuration_not_subscription_update": "Wybierz konfiguracj\u0119 aktualizacji subskrypcji",
|
|
64222
64692
|
"quotes.blockers.quote_configuration_not_new_subscription": "Wybierz konfiguracj\u0119 nowej subskrypcji",
|
|
64223
64693
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Subskrypcj\u0119 mo\u017Cna zaktualizowa\u0107 w ofercie tylko raz",
|
|
64694
|
+
"quotes.blockers.quote_configuration_billing_provider_mismatch": "Ka\u017Cdy produkt musi pochodzi\u0107 z konta dostawcy rozlicze\u0144 aktualizowanej subskrypcji",
|
|
64224
64695
|
"quotes.blockers.quote_draft_invoice_missing": "Oferta musi mie\u0107 faktur\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64225
64696
|
"quotes.blockers.quote_draft_subscription_missing": "Oferta musi mie\u0107 subskrypcj\u0119 w wersji roboczej, aby zosta\u0142a sfinalizowana",
|
|
64226
64697
|
"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 +64760,7 @@ var pt = {
|
|
|
64289
64760
|
"quotes.blockers.quote_configuration_not_subscription_update": "Selecione uma configura\xE7\xE3o de atualiza\xE7\xE3o de subscri\xE7\xE3o",
|
|
64290
64761
|
"quotes.blockers.quote_configuration_not_new_subscription": "Selecione uma configura\xE7\xE3o de nova subscri\xE7\xE3o",
|
|
64291
64762
|
"quotes.blockers.quote_configuration_duplicate_subscription_update": "Uma subscri\xE7\xE3o s\xF3 pode ser atualizada uma vez num or\xE7amento",
|
|
64763
|
+
"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
64764
|
"quotes.blockers.quote_draft_invoice_missing": "O or\xE7amento deve ter uma fatura em rascunho para ser finalizado",
|
|
64293
64765
|
"quotes.blockers.quote_draft_subscription_missing": "O or\xE7amento deve ter uma subscri\xE7\xE3o em rascunho para ser finalizado",
|
|
64294
64766
|
"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 +64948,8 @@ var REDACTED_KEY_NAMES = /* @__PURE__ */ new Set([
|
|
|
64476
64948
|
"privatekey",
|
|
64477
64949
|
"publictoken",
|
|
64478
64950
|
"refreshtoken",
|
|
64951
|
+
// A workflow secret's value (core/workflows secrets).
|
|
64952
|
+
"secretvalue",
|
|
64479
64953
|
"sessiontoken",
|
|
64480
64954
|
"token",
|
|
64481
64955
|
"tokenid",
|
|
@@ -67244,69 +67718,6 @@ var Decimal = P.constructor = clone2(DEFAULTS);
|
|
|
67244
67718
|
LN10 = new Decimal(LN10);
|
|
67245
67719
|
PI = new Decimal(PI);
|
|
67246
67720
|
|
|
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
67721
|
// ../hyperline-lib/build/utils/dates.js
|
|
67311
67722
|
var import_shared2 = __toESM(require_shared(), 1);
|
|
67312
67723
|
var PERIOD_BOUND_DRIFT_TOLERANCE_MS = 2 * 60 * 1e3;
|
|
@@ -67331,7 +67742,8 @@ var dateRealignmentModeSchema = external_exports.enum([
|
|
|
67331
67742
|
"utc_midnight_import",
|
|
67332
67743
|
"dst_hour_drift",
|
|
67333
67744
|
"month_start_drift",
|
|
67334
|
-
"manual_phase_end_midnight"
|
|
67745
|
+
"manual_phase_end_midnight",
|
|
67746
|
+
"customer_timezone_change"
|
|
67335
67747
|
]).default("utc_midnight_import");
|
|
67336
67748
|
var DST_HOUR_SHIFT_BY_LOCAL_MILLISECOND_OF_DAY = /* @__PURE__ */ new Map([
|
|
67337
67749
|
[23 * MILLISECONDS_PER_HOUR, MILLISECONDS_PER_HOUR],
|
|
@@ -67381,8 +67793,14 @@ var authorizedOperators = [
|
|
|
67381
67793
|
var NullFilterValueSchema = BooleanSchema.or(external_exports.literal("")).optional();
|
|
67382
67794
|
|
|
67383
67795
|
// ../hyperline-lib/build/http/dto/state.js
|
|
67384
|
-
var StateSchema = external_exports.
|
|
67385
|
-
description:
|
|
67796
|
+
var StateSchema = external_exports.string().openapi({
|
|
67797
|
+
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:
|
|
67798
|
+
- United States: state, see [ISO 3166-2:US](https://en.wikipedia.org/wiki/ISO_3166-2:US)
|
|
67799
|
+
- Canada: province or territory, see [ISO 3166-2:CA](https://en.wikipedia.org/wiki/ISO_3166-2:CA)
|
|
67800
|
+
- Italy: province, see [ISO 3166-2:IT](https://en.wikipedia.org/wiki/ISO_3166-2:IT)
|
|
67801
|
+
- Brazil: state, see [ISO 3166-2:BR](https://en.wikipedia.org/wiki/ISO_3166-2:BR)
|
|
67802
|
+
|
|
67803
|
+
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
67804
|
example: "CA"
|
|
67387
67805
|
});
|
|
67388
67806
|
|
|
@@ -67496,9 +67914,10 @@ var toLogRequest = (config4) => {
|
|
|
67496
67914
|
};
|
|
67497
67915
|
|
|
67498
67916
|
// ../hyperline-lib/build/httpClient/publicUrlFetch.js
|
|
67917
|
+
import { lookup as lookupCallback } from "node:dns";
|
|
67499
67918
|
import { lookup } from "node:dns/promises";
|
|
67500
67919
|
import { isIP } from "node:net";
|
|
67501
|
-
import { Agent } from "undici";
|
|
67920
|
+
import { Agent, fetch as fetch2 } from "undici";
|
|
67502
67921
|
var PINNED_DISPATCHER_TTL_MS = 5 * 60 * 1e3;
|
|
67503
67922
|
var DEFAULT_MAX_RESPONSE_BYTES = 2 * 1024 * 1024;
|
|
67504
67923
|
|
|
@@ -67518,10 +67937,15 @@ import { createHash as createHash4 } from "node:crypto";
|
|
|
67518
67937
|
var TTL_MS = 5 * 6e4;
|
|
67519
67938
|
|
|
67520
67939
|
// ../hyperline-mcp/build/requestBuilder.js
|
|
67521
|
-
function buildRequestConfig(path2, args, method, queryParamKeys = []) {
|
|
67940
|
+
function buildRequestConfig({ path: path2, args, method, queryParamKeys = [], arrayBody = false }) {
|
|
67522
67941
|
const { url: url2, usedKeys } = replacePathParams(path2, args);
|
|
67523
67942
|
const remaining = removeUsedKeys(args, usedKeys);
|
|
67524
|
-
const { params, data } = separateParamsAndBody(
|
|
67943
|
+
const { params, data } = separateParamsAndBody({
|
|
67944
|
+
args: remaining,
|
|
67945
|
+
method,
|
|
67946
|
+
queryParamKeys,
|
|
67947
|
+
arrayBody
|
|
67948
|
+
});
|
|
67525
67949
|
return { url: url2, params, data };
|
|
67526
67950
|
}
|
|
67527
67951
|
function replacePathParams(path2, args) {
|
|
@@ -67552,7 +67976,7 @@ var PathParamError = class extends Error {
|
|
|
67552
67976
|
function removeUsedKeys(args, usedKeys) {
|
|
67553
67977
|
return Object.fromEntries(Object.entries(args).filter(([key]) => !usedKeys.has(key)));
|
|
67554
67978
|
}
|
|
67555
|
-
function separateParamsAndBody(args, method, queryParamKeys) {
|
|
67979
|
+
function separateParamsAndBody({ args, method, queryParamKeys, arrayBody }) {
|
|
67556
67980
|
const isBodyMethod = ["POST", "PUT", "PATCH"].includes(method);
|
|
67557
67981
|
if (!isBodyMethod) {
|
|
67558
67982
|
return { params: args };
|
|
@@ -67560,8 +67984,7 @@ function separateParamsAndBody(args, method, queryParamKeys) {
|
|
|
67560
67984
|
const queryKeySet = new Set(queryParamKeys);
|
|
67561
67985
|
const params = Object.fromEntries(Object.entries(args).filter(([key]) => queryKeySet.has(key)));
|
|
67562
67986
|
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)) {
|
|
67987
|
+
if (arrayBody && Array.isArray(data.items)) {
|
|
67565
67988
|
return { params, data: data.items };
|
|
67566
67989
|
}
|
|
67567
67990
|
return { params, data };
|
|
@@ -67579,6 +68002,62 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
|
|
|
67579
68002
|
// ../hyperline-mcp/build/server/server.js
|
|
67580
68003
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
67581
68004
|
|
|
68005
|
+
// build/multipart.js
|
|
68006
|
+
import { readFile as readFile2 } from "node:fs/promises";
|
|
68007
|
+
import { basename, extname } from "node:path";
|
|
68008
|
+
var MIMETYPES_BY_EXTENSION = {
|
|
68009
|
+
".csv": "text/csv",
|
|
68010
|
+
".doc": "application/msword",
|
|
68011
|
+
".docx": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
|
|
68012
|
+
".gif": "image/gif",
|
|
68013
|
+
".jpeg": "image/jpeg",
|
|
68014
|
+
".jpg": "image/jpeg",
|
|
68015
|
+
".json": "application/json",
|
|
68016
|
+
".pdf": "application/pdf",
|
|
68017
|
+
".png": "image/png",
|
|
68018
|
+
".svg": "image/svg+xml",
|
|
68019
|
+
".txt": "text/plain",
|
|
68020
|
+
".xls": "application/vnd.ms-excel",
|
|
68021
|
+
".xlsx": "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
|
|
68022
|
+
".xml": "application/xml"
|
|
68023
|
+
};
|
|
68024
|
+
function getMimetypeFromPath(filePath) {
|
|
68025
|
+
return MIMETYPES_BY_EXTENSION[extname(filePath).toLowerCase()] ?? "application/octet-stream";
|
|
68026
|
+
}
|
|
68027
|
+
function appendFormValue({ formData, key, value }) {
|
|
68028
|
+
if (value === void 0) {
|
|
68029
|
+
return;
|
|
68030
|
+
}
|
|
68031
|
+
if (value === null) {
|
|
68032
|
+
formData.append(key, "");
|
|
68033
|
+
return;
|
|
68034
|
+
}
|
|
68035
|
+
if (Array.isArray(value)) {
|
|
68036
|
+
for (const [index, item] of value.entries()) {
|
|
68037
|
+
appendFormValue({ formData, key: `${key}[${index}]`, value: item });
|
|
68038
|
+
}
|
|
68039
|
+
return;
|
|
68040
|
+
}
|
|
68041
|
+
if (typeof value === "object") {
|
|
68042
|
+
throw new Error(`--${key} cannot be sent alongside files: a multipart request only carries scalar fields.`);
|
|
68043
|
+
}
|
|
68044
|
+
formData.append(key, String(value));
|
|
68045
|
+
}
|
|
68046
|
+
async function buildMultipartBody({ data, files }) {
|
|
68047
|
+
const formData = new FormData();
|
|
68048
|
+
for (const [key, value] of Object.entries(data)) {
|
|
68049
|
+
appendFormValue({ formData, key, value });
|
|
68050
|
+
}
|
|
68051
|
+
const fileUploads = Object.entries(files).flatMap(([fieldName, filePaths]) => filePaths.map((filePath) => ({ fieldName, filePath })));
|
|
68052
|
+
const fileContents = await Promise.all(fileUploads.map(({ filePath }) => readFile2(filePath)));
|
|
68053
|
+
for (const [index, { fieldName, filePath }] of fileUploads.entries()) {
|
|
68054
|
+
formData.append(fieldName, new Blob([new Uint8Array(fileContents[index])], {
|
|
68055
|
+
type: getMimetypeFromPath(filePath)
|
|
68056
|
+
}), basename(filePath));
|
|
68057
|
+
}
|
|
68058
|
+
return formData;
|
|
68059
|
+
}
|
|
68060
|
+
|
|
67582
68061
|
// build/output.js
|
|
67583
68062
|
function formatOutput({ data, format: format2 }) {
|
|
67584
68063
|
if (format2 === "json") {
|
|
@@ -67638,16 +68117,25 @@ function createCLIContext({ apiKey, baseUrl, outputFormat, source, companyId })
|
|
|
67638
68117
|
return {
|
|
67639
68118
|
baseUrl,
|
|
67640
68119
|
outputFormat,
|
|
67641
|
-
async execute({ method, path: path2, args, queryParamKeys = [], body, baseUrlOverride }) {
|
|
67642
|
-
const { url: url2, params, data } = buildRequestConfig(
|
|
68120
|
+
async execute({ method, path: path2, args, queryParamKeys = [], body, files, baseUrlOverride }) {
|
|
68121
|
+
const { url: url2, params, data } = buildRequestConfig({
|
|
68122
|
+
path: path2,
|
|
68123
|
+
args,
|
|
68124
|
+
method,
|
|
68125
|
+
queryParamKeys
|
|
68126
|
+
});
|
|
67643
68127
|
const requestData = body ?? data;
|
|
67644
68128
|
const hasData = Array.isArray(requestData) ? requestData.length > 0 : requestData != null && Object.keys(requestData).length > 0;
|
|
68129
|
+
const hasFiles = Object.values(files ?? {}).some((filePaths) => filePaths.length > 0);
|
|
67645
68130
|
try {
|
|
67646
68131
|
const response = await httpClient.request({
|
|
67647
68132
|
method,
|
|
67648
68133
|
url: url2,
|
|
67649
68134
|
params,
|
|
67650
|
-
data:
|
|
68135
|
+
data: hasFiles ? await buildMultipartBody({
|
|
68136
|
+
data: requestData ?? {},
|
|
68137
|
+
files: files ?? {}
|
|
68138
|
+
}) : hasData ? requestData : void 0,
|
|
67651
68139
|
...baseUrlOverride ? { baseURL: baseUrlOverride } : {},
|
|
67652
68140
|
headers: {
|
|
67653
68141
|
"Hyperline-Source": source,
|