@hyperline/cli 0.1.0-build.1.0fbd9ac → 0.1.0-build.1.11402a2
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 +110 -34
- package/package.json +1 -1
|
@@ -38429,16 +38429,24 @@ Examples:
|
|
|
38429
38429
|
// build/commands/generated/customers.js
|
|
38430
38430
|
function registerCustomersCommands(parent) {
|
|
38431
38431
|
const resource = parent.command("customers").description("Manage customers");
|
|
38432
|
-
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, created_at, updated_at. Paginated with
|
|
38432
|
+
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, 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("--name <value>", `name`).option("--name.not <value>", `name__not`).option("--name.is-null <value>", `name__isNull`).option("--name.is-not-null <value>", `name__isNotNull`).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.is-null <value>", `currency__isNull`).option("--currency.is-not-null <value>", `currency__isNotNull`).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("--country <value>", `country`).option("--country.not <value>", `country__not`).option("--country.is-null <value>", `country__isNull`).option("--country.is-not-null <value>", `country__isNotNull`).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("--external-id <value>", `external_id`).option("--external-id.not <value>", `external_id__not`).option("--external-id.is-null <value>", `external_id__isNull`).option("--external-id.is-not-null <value>", `external_id__isNotNull`).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("--billing-email <value>", `billing_email`).option("--billing-email.not <value>", `billing_email__not`).option("--billing-email.is-null <value>", `billing_email__isNull`).option("--billing-email.is-not-null <value>", `billing_email__isNotNull`).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("--search <value>", `search`).option("--tax-id <value>", `tax_id`).option("--tax-id.not <value>", `tax_id__not`).option("--tax-id.is-null <value>", `tax_id__isNull`).option("--tax-id.is-not-null <value>", `tax_id__isNotNull`).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("--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.is-null <value>", `invoicing_entity_id__isNull`).option("--invoicing-entity-id.is-not-null <value>", `invoicing_entity_id__isNotNull`).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>", `custom_properties`).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.is-null <value>", `created_at__isNull`).option("--created-at.is-not-null <value>", `created_at__isNotNull`).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.is-null <value>", `updated_at__isNull`).option("--updated-at.is-not-null <value>", `updated_at__isNotNull`).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", `
|
|
38433
38433
|
Examples:
|
|
38434
38434
|
hyperline customers list
|
|
38435
|
-
hyperline customers list --
|
|
38435
|
+
hyperline customers list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
38436
38436
|
const ctx = resource.parent?.opts()._ctx;
|
|
38437
38437
|
if (!ctx) {
|
|
38438
38438
|
process.stderr.write("Error: Not authenticated\n");
|
|
38439
38439
|
process.exit(1);
|
|
38440
38440
|
}
|
|
38441
38441
|
const args = {};
|
|
38442
|
+
if (opts.cursor !== void 0)
|
|
38443
|
+
args.cursor = opts.cursor;
|
|
38444
|
+
if (opts.includeTotal !== void 0)
|
|
38445
|
+
args.include_total = opts.includeTotal;
|
|
38446
|
+
if (opts.order !== void 0)
|
|
38447
|
+
args.order = opts.order;
|
|
38448
|
+
if (opts.sort !== void 0)
|
|
38449
|
+
args.sort = opts.sort;
|
|
38442
38450
|
if (opts.name !== void 0)
|
|
38443
38451
|
args.name = opts.name;
|
|
38444
38452
|
if (opts["name.not"] !== void 0)
|
|
@@ -38611,17 +38619,18 @@ Examples:
|
|
|
38611
38619
|
args.updated_at__gt = opts["updatedAt.gt"];
|
|
38612
38620
|
if (opts["updatedAt.gte"] !== void 0)
|
|
38613
38621
|
args.updated_at__gte = opts["updatedAt.gte"];
|
|
38614
|
-
if (opts.
|
|
38615
|
-
args.
|
|
38616
|
-
if (opts.skip !== void 0)
|
|
38617
|
-
args.skip = Number(opts.skip);
|
|
38622
|
+
if (opts.limit !== void 0)
|
|
38623
|
+
args.limit = Number(opts.limit);
|
|
38618
38624
|
await ctx.execute({
|
|
38619
38625
|
method: "GET",
|
|
38620
|
-
path: "/
|
|
38626
|
+
path: "/v2/customers",
|
|
38621
38627
|
args,
|
|
38622
38628
|
queryParamKeys: [
|
|
38623
|
-
"
|
|
38624
|
-
"
|
|
38629
|
+
"limit",
|
|
38630
|
+
"cursor",
|
|
38631
|
+
"include_total",
|
|
38632
|
+
"order",
|
|
38633
|
+
"sort",
|
|
38625
38634
|
"name",
|
|
38626
38635
|
"name__not",
|
|
38627
38636
|
"name__isNull",
|
|
@@ -38711,13 +38720,31 @@ Examples:
|
|
|
38711
38720
|
]
|
|
38712
38721
|
});
|
|
38713
38722
|
});
|
|
38723
|
+
resource.command("get").description(`Retrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, integrations, payment method, and bank account.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38724
|
+
Examples:
|
|
38725
|
+
hyperline customers get --id <id>`).action(async (opts) => {
|
|
38726
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
38727
|
+
if (!ctx) {
|
|
38728
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
38729
|
+
process.exit(1);
|
|
38730
|
+
}
|
|
38731
|
+
const args = {};
|
|
38732
|
+
if (opts.id !== void 0)
|
|
38733
|
+
args.id = opts.id;
|
|
38734
|
+
await ctx.execute({
|
|
38735
|
+
method: "GET",
|
|
38736
|
+
path: "/v2/customers/{id}",
|
|
38737
|
+
args,
|
|
38738
|
+
queryParamKeys: []
|
|
38739
|
+
});
|
|
38740
|
+
});
|
|
38714
38741
|
resource.command("create-customer").description(`Create a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.`).option("--name <value>", `Customer name.`).option("--type <value>", `
|
|
38715
38742
|
Customer type.
|
|
38716
38743
|
|
|
38717
38744
|
- \`corporate\`: The customer is a business entity.
|
|
38718
38745
|
- \`person\`: The customer is a natural person.
|
|
38719
38746
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38720
|
-
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment
|
|
38747
|
+
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38721
38748
|
How customer invoices are issued from the parent organisation.
|
|
38722
38749
|
|
|
38723
38750
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -38812,24 +38839,6 @@ Examples:
|
|
|
38812
38839
|
queryParamKeys: []
|
|
38813
38840
|
});
|
|
38814
38841
|
});
|
|
38815
|
-
resource.command("get").description(`Retrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, and provider mappings.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38816
|
-
Examples:
|
|
38817
|
-
hyperline customers get --id <id>`).action(async (opts) => {
|
|
38818
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
38819
|
-
if (!ctx) {
|
|
38820
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
38821
|
-
process.exit(1);
|
|
38822
|
-
}
|
|
38823
|
-
const args = {};
|
|
38824
|
-
if (opts.id !== void 0)
|
|
38825
|
-
args.id = opts.id;
|
|
38826
|
-
await ctx.execute({
|
|
38827
|
-
method: "GET",
|
|
38828
|
-
path: "/v1/customers/{id}",
|
|
38829
|
-
args,
|
|
38830
|
-
queryParamKeys: []
|
|
38831
|
-
});
|
|
38832
|
-
});
|
|
38833
38842
|
resource.command("get-customer-portal-url").description(`Get a portal URL for a customer. The portal allows the customer to view invoices, update payment methods, and manage their account.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38834
38843
|
Examples:
|
|
38835
38844
|
hyperline customers get-customer-portal-url --id <id>`).action(async (opts) => {
|
|
@@ -38854,7 +38863,7 @@ Customer type.
|
|
|
38854
38863
|
- \`corporate\`: The customer is a business entity.
|
|
38855
38864
|
- \`person\`: The customer is a natural person.
|
|
38856
38865
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38857
|
-
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--payment-method-id <value>", `ID of the default payment method of the customer. Only applies to card and direct debit.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment
|
|
38866
|
+
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--payment-method-id <value>", `ID of the default payment method of the customer. Only applies to card and direct debit.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38858
38867
|
How customer invoices are issued from the parent organisation.
|
|
38859
38868
|
|
|
38860
38869
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -40175,7 +40184,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
40175
40184
|
|
|
40176
40185
|
- \`current\`: Use the current default payment method of the customer.
|
|
40177
40186
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
40178
|
-
`).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("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).requiredOption("--line-items <value>", `line_items`).option("--transactions <value>", `transactions`).option("--coupons <value>", `coupons`).addHelpText("after", `
|
|
40187
|
+
`).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("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).requiredOption("--line-items <value>", `line_items`).option("--transactions <value>", `transactions`).option("--coupons <value>", `coupons`).addHelpText("after", `
|
|
40179
40188
|
Examples:
|
|
40180
40189
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
40181
40190
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -40228,6 +40237,8 @@ Examples:
|
|
|
40228
40237
|
args.settled_at = opts.settledAt;
|
|
40229
40238
|
if (opts.properties !== void 0)
|
|
40230
40239
|
args.properties = opts.properties;
|
|
40240
|
+
if (opts.customProperties !== void 0)
|
|
40241
|
+
args.custom_properties = opts.customProperties;
|
|
40231
40242
|
if (opts.lineItems !== void 0)
|
|
40232
40243
|
args.line_items = opts.lineItems;
|
|
40233
40244
|
if (opts.transactions !== void 0)
|
|
@@ -40409,7 +40420,7 @@ Examples:
|
|
|
40409
40420
|
|
|
40410
40421
|
- \`auto\`: Tax is automatically computed and applied.
|
|
40411
40422
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
40412
|
-
`).option("--line-items <value>", `line_items`).option("--coupons <value>", `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("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--customer <value>", `Override customer details on the invoice. Only allowed for draft or grace period invoices.`).addHelpText("after", `
|
|
40423
|
+
`).option("--line-items <value>", `line_items`).option("--coupons <value>", `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("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).option("--customer <value>", `Override customer details on the invoice. Only allowed for draft or grace period invoices.`).addHelpText("after", `
|
|
40413
40424
|
Examples:
|
|
40414
40425
|
hyperline invoices update --id <id>
|
|
40415
40426
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -40450,6 +40461,8 @@ Examples:
|
|
|
40450
40461
|
args.bank_account_id = opts.bankAccountId;
|
|
40451
40462
|
if (opts.properties !== void 0)
|
|
40452
40463
|
args.properties = opts.properties;
|
|
40464
|
+
if (opts.customProperties !== void 0)
|
|
40465
|
+
args.custom_properties = opts.customProperties;
|
|
40453
40466
|
if (opts.customer !== void 0)
|
|
40454
40467
|
args.customer = opts.customer;
|
|
40455
40468
|
await ctx.execute({
|
|
@@ -40642,7 +40655,7 @@ Examples:
|
|
|
40642
40655
|
queryParamKeys: []
|
|
40643
40656
|
});
|
|
40644
40657
|
});
|
|
40645
|
-
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>", `The state or province of the invoicing entity.`).option("--city <value>", `The city of the invoicing entity.`).requiredOption("--country <value>", `The country in which the invoicing entity is registered.`).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.`).addHelpText("after", `
|
|
40658
|
+
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>", `The state or province of the invoicing entity.`).option("--city <value>", `The city of the invoicing entity.`).requiredOption("--country <value>", `The country in which the invoicing entity is registered.`).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, credit note refunds default to the customer's wallet for invoices under this invoicing entity. The default applies only when \`refund_method\` is omitted on \`POST /v1/invoices/{id}/credit-notes\`; an explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).addHelpText("after", `
|
|
40646
40659
|
Examples:
|
|
40647
40660
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
40648
40661
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -40721,6 +40734,8 @@ Examples:
|
|
|
40721
40734
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40722
40735
|
if (opts.isDefault !== void 0)
|
|
40723
40736
|
args.is_default = true;
|
|
40737
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40738
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40724
40739
|
await ctx.execute({
|
|
40725
40740
|
method: "POST",
|
|
40726
40741
|
path: "/v1/invoicing-entities",
|
|
@@ -40728,7 +40743,7 @@ Examples:
|
|
|
40728
40743
|
queryParamKeys: []
|
|
40729
40744
|
});
|
|
40730
40745
|
});
|
|
40731
|
-
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>", `The state or province of the invoicing entity.`).option("--city <value>", `The city of the invoicing entity.`).option("--country <value>", `The country in which the invoicing entity is registered.`).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.`).addHelpText("after", `
|
|
40746
|
+
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>", `The state or province of the invoicing entity.`).option("--city <value>", `The city of the invoicing entity.`).option("--country <value>", `The country in which the invoicing entity is registered.`).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, credit note refunds default to the customer's wallet for invoices under this invoicing entity. The default applies only when \`refund_method\` is omitted on \`POST /v1/invoices/{id}/credit-notes\`; an explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).addHelpText("after", `
|
|
40732
40747
|
Examples:
|
|
40733
40748
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
40734
40749
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -40799,6 +40814,8 @@ Examples:
|
|
|
40799
40814
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40800
40815
|
if (opts.isDefault !== void 0)
|
|
40801
40816
|
args.is_default = true;
|
|
40817
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40818
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40802
40819
|
await ctx.execute({
|
|
40803
40820
|
method: "PUT",
|
|
40804
40821
|
path: "/v1/invoicing-entities/{id}",
|
|
@@ -41657,6 +41674,65 @@ Examples:
|
|
|
41657
41674
|
queryParamKeys: []
|
|
41658
41675
|
});
|
|
41659
41676
|
});
|
|
41677
|
+
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass subscription to create or replace the draft subscription configuration attached to the quote.`).requiredOption("--id <value>", `id parameter`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. Set to \`null\` to clear the manually set value.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <value>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
41678
|
+
|
|
41679
|
+
- \`all\`: Display all pricing tiers.
|
|
41680
|
+
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41681
|
+
- \`none\`: Hide all pricing tiers.
|
|
41682
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <value>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).addHelpText("after", `
|
|
41683
|
+
Examples:
|
|
41684
|
+
hyperline quotes update --id <id>
|
|
41685
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
41686
|
+
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
41687
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41688
|
+
if (!ctx) {
|
|
41689
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41690
|
+
process.exit(1);
|
|
41691
|
+
}
|
|
41692
|
+
const args = {};
|
|
41693
|
+
if (opts.id !== void 0)
|
|
41694
|
+
args.id = opts.id;
|
|
41695
|
+
if (opts.ownerEmail !== void 0)
|
|
41696
|
+
args.owner_email = opts.ownerEmail;
|
|
41697
|
+
if (opts.comments !== void 0)
|
|
41698
|
+
args.comments = opts.comments;
|
|
41699
|
+
if (opts.terms !== void 0)
|
|
41700
|
+
args.terms = opts.terms;
|
|
41701
|
+
if (opts.collectPaymentDetails !== void 0)
|
|
41702
|
+
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41703
|
+
if (opts.collectCustomPropertyIds !== void 0)
|
|
41704
|
+
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41705
|
+
if (opts.requireTaxId !== void 0)
|
|
41706
|
+
args.require_tax_id = opts.requireTaxId;
|
|
41707
|
+
if (opts.displayQuoteValue !== void 0)
|
|
41708
|
+
args.display_quote_value = opts.displayQuoteValue;
|
|
41709
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
41710
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
41711
|
+
if (opts.displayTaxes !== void 0)
|
|
41712
|
+
args.display_taxes = opts.displayTaxes;
|
|
41713
|
+
if (opts.displayPriceTiers !== void 0)
|
|
41714
|
+
args.display_price_tiers = opts.displayPriceTiers;
|
|
41715
|
+
if (opts.displayPhaseValue !== void 0)
|
|
41716
|
+
args.display_phase_value = opts.displayPhaseValue;
|
|
41717
|
+
if (opts.displayFirstInvoiceAmount !== void 0)
|
|
41718
|
+
args.display_first_invoice_amount = opts.displayFirstInvoiceAmount;
|
|
41719
|
+
if (opts.displayDocumentsInPreview !== void 0)
|
|
41720
|
+
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41721
|
+
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41722
|
+
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41723
|
+
if (opts.expiresAt !== void 0)
|
|
41724
|
+
args.expires_at = opts.expiresAt;
|
|
41725
|
+
if (opts.subscription !== void 0)
|
|
41726
|
+
args.subscription = opts.subscription;
|
|
41727
|
+
if (opts.amount !== void 0)
|
|
41728
|
+
args.amount = Number(opts.amount);
|
|
41729
|
+
await ctx.execute({
|
|
41730
|
+
method: "PATCH",
|
|
41731
|
+
path: "/v1/quotes/{id}",
|
|
41732
|
+
args,
|
|
41733
|
+
queryParamKeys: []
|
|
41734
|
+
});
|
|
41735
|
+
});
|
|
41660
41736
|
resource.command("download").description(`Download the PDF of a quote. Supports locale parameter for localization.`).requiredOption("--id <value>", `id parameter`).option("--locale <value>", `locale`).addHelpText("after", `
|
|
41661
41737
|
Examples:
|
|
41662
41738
|
hyperline quotes download --id <id>
|
|
@@ -42384,7 +42460,7 @@ Examples:
|
|
|
42384
42460
|
queryParamKeys: []
|
|
42385
42461
|
});
|
|
42386
42462
|
});
|
|
42387
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons.
|
|
42463
|
+
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons. Draft quote subscription configuration must be updated through PATCH /v1/quotes/{id}.`).requiredOption("--id <value>", `id parameter`).option("--name <value>", `Subscription custom name.`).option("--purchase-order <value>", `Reference to the purchase order.`).option("--minimum-invoice-fee <number>", `Minimum fee applied to each invoice outside of one time payments.`).option("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).option("--tax-only <value>", `Only tax will be charged on this subscription.`).option("--generate-draft-invoices <value>", `Generate draft invoices for the subscription. Each invoice will need to be reviewed and validated manually before being sent`).option("--generate-document <value>", `Generate non-legal documents instead of invoices.`).option("--document-name <value>", `If \`generate_document\` is turned on, allows you to give a name to your document.`).option("--add-tax-to-document <value>", `If \`generate_document\` is turned on, will add taxes to document.`).option("--do-not-charge-subscription <value>", `Subscription will be invoiced but not charged (invoices/documents will be settled directly).`).option("--invoice-custom-note <value>", `Default custom note added to invoices generated by the subscription.`).option("--invoice-schedule <value>", `
|
|
42388
42464
|
Defines when invoices are generated relative to the billing period.
|
|
42389
42465
|
|
|
42390
42466
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|