@hyperline/cli 0.1.0-build.1.7046368 → 0.1.0-build.1.732ca26
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 +364 -123
- package/dist/external-deps.json +1 -0
- package/package.json +2 -1
|
@@ -34894,10 +34894,10 @@ var require_shared = __commonJS({
|
|
|
34894
34894
|
ZodId: () => ZodId,
|
|
34895
34895
|
ZodTranslationsSchemaFn: () => ZodTranslationsSchemaFn
|
|
34896
34896
|
});
|
|
34897
|
-
var
|
|
34897
|
+
var import_zod19 = require_lib();
|
|
34898
34898
|
var countryIds2 = ["all", ...countries.map(({ id }) => id)];
|
|
34899
|
-
var ZodId =
|
|
34900
|
-
var ZodTranslationsSchemaFn = (schema) =>
|
|
34899
|
+
var ZodId = import_zod19.z.enum(countryIds2);
|
|
34900
|
+
var ZodTranslationsSchemaFn = (schema) => import_zod19.z.record(import_zod19.z.string(), schema.optional());
|
|
34901
34901
|
var UsStates = [
|
|
34902
34902
|
{ id: "AA", name: "Armed Forces Americas" },
|
|
34903
34903
|
{ id: "AE", name: "Armed Forces Europe" },
|
|
@@ -38020,7 +38020,7 @@ Examples:
|
|
|
38020
38020
|
queryParamKeys: ["take", "skip"]
|
|
38021
38021
|
});
|
|
38022
38022
|
});
|
|
38023
|
-
resource.command("create").description(`Create a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38023
|
+
resource.command("create").description(`Create a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).option("--repeat <value>", `Default repeat behaviour applied when the coupon is attached to a subscription. Valid values: \`once\`, \`forever\`, \`duration\`. Can be overridden at attach time.`).option("--duration <value>", `Default duration applied when \`repeat\` is \`duration\`. Required when \`repeat\` is \`duration\`, must be null otherwise.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38024
38024
|
Examples:
|
|
38025
38025
|
hyperline coupons create --name <name> --type <type>
|
|
38026
38026
|
hyperline coupons create --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38039,6 +38039,10 @@ Examples:
|
|
|
38039
38039
|
args.expiration_date = opts.expirationDate;
|
|
38040
38040
|
if (opts.productIds !== void 0)
|
|
38041
38041
|
args.product_ids = opts.productIds;
|
|
38042
|
+
if (opts.repeat !== void 0)
|
|
38043
|
+
args.repeat = opts.repeat;
|
|
38044
|
+
if (opts.duration !== void 0)
|
|
38045
|
+
args.duration = opts.duration;
|
|
38042
38046
|
if (opts.type !== void 0)
|
|
38043
38047
|
args.type = opts.type;
|
|
38044
38048
|
if (opts.currency !== void 0)
|
|
@@ -38074,7 +38078,7 @@ Examples:
|
|
|
38074
38078
|
queryParamKeys: []
|
|
38075
38079
|
});
|
|
38076
38080
|
});
|
|
38077
|
-
resource.command("update").description(`Update an existing coupon's name, discount rules, or restrictions.`).requiredOption("--id <value>", `id parameter`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38081
|
+
resource.command("update").description(`Update an existing coupon's name, discount rules, or restrictions.`).requiredOption("--id <value>", `id parameter`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).option("--repeat <value>", `Default repeat behaviour applied when the coupon is attached to a subscription. Valid values: \`once\`, \`forever\`, \`duration\`. Can be overridden at attach time.`).option("--duration <value>", `Default duration applied when \`repeat\` is \`duration\`. Required when \`repeat\` is \`duration\`, must be null otherwise.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38078
38082
|
Examples:
|
|
38079
38083
|
hyperline coupons update --id <id> --name <name> --type <type>
|
|
38080
38084
|
hyperline coupons update --id <id> --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38095,6 +38099,10 @@ Examples:
|
|
|
38095
38099
|
args.expiration_date = opts.expirationDate;
|
|
38096
38100
|
if (opts.productIds !== void 0)
|
|
38097
38101
|
args.product_ids = opts.productIds;
|
|
38102
|
+
if (opts.repeat !== void 0)
|
|
38103
|
+
args.repeat = opts.repeat;
|
|
38104
|
+
if (opts.duration !== void 0)
|
|
38105
|
+
args.duration = opts.duration;
|
|
38098
38106
|
if (opts.type !== void 0)
|
|
38099
38107
|
args.type = opts.type;
|
|
38100
38108
|
if (opts.currency !== void 0)
|
|
@@ -38429,16 +38437,24 @@ Examples:
|
|
|
38429
38437
|
// build/commands/generated/customers.js
|
|
38430
38438
|
function registerCustomersCommands(parent) {
|
|
38431
38439
|
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
|
|
38440
|
+
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
38441
|
Examples:
|
|
38434
38442
|
hyperline customers list
|
|
38435
|
-
hyperline customers list --
|
|
38443
|
+
hyperline customers list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
38436
38444
|
const ctx = resource.parent?.opts()._ctx;
|
|
38437
38445
|
if (!ctx) {
|
|
38438
38446
|
process.stderr.write("Error: Not authenticated\n");
|
|
38439
38447
|
process.exit(1);
|
|
38440
38448
|
}
|
|
38441
38449
|
const args = {};
|
|
38450
|
+
if (opts.cursor !== void 0)
|
|
38451
|
+
args.cursor = opts.cursor;
|
|
38452
|
+
if (opts.includeTotal !== void 0)
|
|
38453
|
+
args.include_total = opts.includeTotal;
|
|
38454
|
+
if (opts.order !== void 0)
|
|
38455
|
+
args.order = opts.order;
|
|
38456
|
+
if (opts.sort !== void 0)
|
|
38457
|
+
args.sort = opts.sort;
|
|
38442
38458
|
if (opts.name !== void 0)
|
|
38443
38459
|
args.name = opts.name;
|
|
38444
38460
|
if (opts["name.not"] !== void 0)
|
|
@@ -38611,17 +38627,18 @@ Examples:
|
|
|
38611
38627
|
args.updated_at__gt = opts["updatedAt.gt"];
|
|
38612
38628
|
if (opts["updatedAt.gte"] !== void 0)
|
|
38613
38629
|
args.updated_at__gte = opts["updatedAt.gte"];
|
|
38614
|
-
if (opts.
|
|
38615
|
-
args.
|
|
38616
|
-
if (opts.skip !== void 0)
|
|
38617
|
-
args.skip = Number(opts.skip);
|
|
38630
|
+
if (opts.limit !== void 0)
|
|
38631
|
+
args.limit = Number(opts.limit);
|
|
38618
38632
|
await ctx.execute({
|
|
38619
38633
|
method: "GET",
|
|
38620
|
-
path: "/
|
|
38634
|
+
path: "/v2/customers",
|
|
38621
38635
|
args,
|
|
38622
38636
|
queryParamKeys: [
|
|
38623
|
-
"
|
|
38624
|
-
"
|
|
38637
|
+
"limit",
|
|
38638
|
+
"cursor",
|
|
38639
|
+
"include_total",
|
|
38640
|
+
"order",
|
|
38641
|
+
"sort",
|
|
38625
38642
|
"name",
|
|
38626
38643
|
"name__not",
|
|
38627
38644
|
"name__isNull",
|
|
@@ -38711,19 +38728,41 @@ Examples:
|
|
|
38711
38728
|
]
|
|
38712
38729
|
});
|
|
38713
38730
|
});
|
|
38731
|
+
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", `
|
|
38732
|
+
Examples:
|
|
38733
|
+
hyperline customers get --id <id>`).action(async (opts) => {
|
|
38734
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
38735
|
+
if (!ctx) {
|
|
38736
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
38737
|
+
process.exit(1);
|
|
38738
|
+
}
|
|
38739
|
+
const args = {};
|
|
38740
|
+
if (opts.id !== void 0)
|
|
38741
|
+
args.id = opts.id;
|
|
38742
|
+
await ctx.execute({
|
|
38743
|
+
method: "GET",
|
|
38744
|
+
path: "/v2/customers/{id}",
|
|
38745
|
+
args,
|
|
38746
|
+
queryParamKeys: []
|
|
38747
|
+
});
|
|
38748
|
+
});
|
|
38714
38749
|
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
38750
|
Customer type.
|
|
38716
38751
|
|
|
38717
38752
|
- \`corporate\`: The customer is a business entity.
|
|
38718
38753
|
- \`person\`: The customer is a natural person.
|
|
38719
38754
|
- \`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("--
|
|
38755
|
+
`).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("--taxability <value>", `Customer taxability.
|
|
38756
|
+
|
|
38757
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38758
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38759
|
+
`).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
38760
|
How customer invoices are issued from the parent organisation.
|
|
38722
38761
|
|
|
38723
38762
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
38724
38763
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
38725
38764
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
38726
|
-
`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `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("--price-book-id <value>", `Default price book ID assigned to the customer.`).addHelpText("after", `
|
|
38765
|
+
`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `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("--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 <value>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
38727
38766
|
Examples:
|
|
38728
38767
|
hyperline customers create-customer
|
|
38729
38768
|
hyperline customers create-customer --name <name> --type <type>
|
|
@@ -38742,6 +38781,8 @@ Examples:
|
|
|
38742
38781
|
args.currency = opts.currency;
|
|
38743
38782
|
if (opts.taxIds !== void 0)
|
|
38744
38783
|
args.tax_ids = opts.taxIds;
|
|
38784
|
+
if (opts.taxability !== void 0)
|
|
38785
|
+
args.taxability = opts.taxability;
|
|
38745
38786
|
if (opts.registrationNumber !== void 0)
|
|
38746
38787
|
args.registration_number = opts.registrationNumber;
|
|
38747
38788
|
if (opts.externalId !== void 0)
|
|
@@ -38778,6 +38819,10 @@ Examples:
|
|
|
38778
38819
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
38779
38820
|
if (opts.priceBookId !== void 0)
|
|
38780
38821
|
args.price_book_id = opts.priceBookId;
|
|
38822
|
+
if (opts.ownerId !== void 0)
|
|
38823
|
+
args.owner_id = opts.ownerId;
|
|
38824
|
+
if (opts.followerIds !== void 0)
|
|
38825
|
+
args.follower_ids = opts.followerIds;
|
|
38781
38826
|
if (opts.taxRateCustom !== void 0)
|
|
38782
38827
|
args.tax_rate_custom = Number(opts.taxRateCustom);
|
|
38783
38828
|
if (opts.customPaymentDelay !== void 0)
|
|
@@ -38812,24 +38857,6 @@ Examples:
|
|
|
38812
38857
|
queryParamKeys: []
|
|
38813
38858
|
});
|
|
38814
38859
|
});
|
|
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
38860
|
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
38861
|
Examples:
|
|
38835
38862
|
hyperline customers get-customer-portal-url --id <id>`).action(async (opts) => {
|
|
@@ -38854,13 +38881,17 @@ Customer type.
|
|
|
38854
38881
|
- \`corporate\`: The customer is a business entity.
|
|
38855
38882
|
- \`person\`: The customer is a natural person.
|
|
38856
38883
|
- \`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("--
|
|
38884
|
+
`).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("--taxability <value>", `Customer taxability.
|
|
38885
|
+
|
|
38886
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38887
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38888
|
+
`).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
38889
|
How customer invoices are issued from the parent organisation.
|
|
38859
38890
|
|
|
38860
38891
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
38861
38892
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
38862
38893
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
38863
|
-
`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `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("--price-book-id <value>", `Default price book ID assigned to the customer.`).addHelpText("after", `
|
|
38894
|
+
`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `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("--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 <value>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
|
|
38864
38895
|
Examples:
|
|
38865
38896
|
hyperline customers update --id <id>
|
|
38866
38897
|
hyperline customers update --id <id> --name <name> --type <type>
|
|
@@ -38881,6 +38912,8 @@ Examples:
|
|
|
38881
38912
|
args.currency = opts.currency;
|
|
38882
38913
|
if (opts.taxIds !== void 0)
|
|
38883
38914
|
args.tax_ids = opts.taxIds;
|
|
38915
|
+
if (opts.taxability !== void 0)
|
|
38916
|
+
args.taxability = opts.taxability;
|
|
38884
38917
|
if (opts.registrationNumber !== void 0)
|
|
38885
38918
|
args.registration_number = opts.registrationNumber;
|
|
38886
38919
|
if (opts.externalId !== void 0)
|
|
@@ -38919,6 +38952,10 @@ Examples:
|
|
|
38919
38952
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
38920
38953
|
if (opts.priceBookId !== void 0)
|
|
38921
38954
|
args.price_book_id = opts.priceBookId;
|
|
38955
|
+
if (opts.ownerId !== void 0)
|
|
38956
|
+
args.owner_id = opts.ownerId;
|
|
38957
|
+
if (opts.followerIds !== void 0)
|
|
38958
|
+
args.follower_ids = opts.followerIds;
|
|
38922
38959
|
if (opts.taxRateCustom !== void 0)
|
|
38923
38960
|
args.tax_rate_custom = Number(opts.taxRateCustom);
|
|
38924
38961
|
if (opts.customPaymentDelay !== void 0)
|
|
@@ -39816,16 +39853,20 @@ Examples:
|
|
|
39816
39853
|
// build/commands/generated/invoices.js
|
|
39817
39854
|
function registerInvoicesCommands(parent) {
|
|
39818
39855
|
const resource = parent.command("invoices").description("Manage invoices");
|
|
39819
|
-
resource.command("list").description(`List invoices with filters for type, status, customer_id, customer_external_id, subscription_id, invoicing_entity_id, invoice_number, period dates, emission_date, due_date, and updated_at. Sortable by created_at or emitted_at. By default, open invoices are excluded. Paginated with
|
|
39856
|
+
resource.command("list").description(`List invoices with filters for type, status, customer_id, customer_external_id, subscription_id, invoicing_entity_id, invoice_number, period dates, emission_date, due_date, and updated_at. Sortable by created_at or emitted_at. By default, open invoices are excluded. 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("--type <value>", `type`).option("--type.in <value>", `type__in`).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.is-null <value>", `customer_id__isNull`).option("--customer-id.is-not-null <value>", `customer_id__isNotNull`).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-external-id <value>", `customer_external_id`).option("--subscription-id <value>", `subscription_id`).option("--subscription-id.not <value>", `subscription_id__not`).option("--subscription-id.is-null <value>", `subscription_id__isNull`).option("--subscription-id.is-not-null <value>", `subscription_id__isNotNull`).option("--subscription-id.equals <value>", `subscription_id__equals`).option("--subscription-id.contains <value>", `subscription_id__contains`).option("--subscription-id.starts-with <value>", `subscription_id__startsWith`).option("--subscription-id.end-with <value>", `subscription_id__endWith`).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("--invoice-number <value>", `invoice_number`).option("--invoice-number.not <value>", `invoice_number__not`).option("--invoice-number.is-null <value>", `invoice_number__isNull`).option("--invoice-number.is-not-null <value>", `invoice_number__isNotNull`).option("--invoice-number.equals <value>", `invoice_number__equals`).option("--invoice-number.contains <value>", `invoice_number__contains`).option("--invoice-number.starts-with <value>", `invoice_number__startsWith`).option("--invoice-number.end-with <value>", `invoice_number__endWith`).option("--original-invoice-id <value>", `original_invoice_id`).option("--original-invoice-id.not <value>", `original_invoice_id__not`).option("--original-invoice-id.is-null <value>", `original_invoice_id__isNull`).option("--original-invoice-id.is-not-null <value>", `original_invoice_id__isNotNull`).option("--original-invoice-id.equals <value>", `original_invoice_id__equals`).option("--original-invoice-id.contains <value>", `original_invoice_id__contains`).option("--original-invoice-id.starts-with <value>", `original_invoice_id__startsWith`).option("--original-invoice-id.end-with <value>", `original_invoice_id__endWith`).option("--original-invoice-number <value>", `original_invoice_number`).option("--original-invoice-number.not <value>", `original_invoice_number__not`).option("--original-invoice-number.is-null <value>", `original_invoice_number__isNull`).option("--original-invoice-number.is-not-null <value>", `original_invoice_number__isNotNull`).option("--original-invoice-number.equals <value>", `original_invoice_number__equals`).option("--original-invoice-number.contains <value>", `original_invoice_number__contains`).option("--original-invoice-number.starts-with <value>", `original_invoice_number__startsWith`).option("--original-invoice-number.end-with <value>", `original_invoice_number__endWith`).option("--line-item-id <value>", `line_item_id`).option("--period-start <value>", `period_start`).option("--period-start.not <value>", `period_start__not`).option("--period-start.is-null <value>", `period_start__isNull`).option("--period-start.is-not-null <value>", `period_start__isNotNull`).option("--period-start.equals <value>", `period_start__equals`).option("--period-start.lt <value>", `period_start__lt`).option("--period-start.lte <value>", `period_start__lte`).option("--period-start.gt <value>", `period_start__gt`).option("--period-start.gte <value>", `period_start__gte`).option("--period-end <value>", `period_end`).option("--period-end.not <value>", `period_end__not`).option("--period-end.is-null <value>", `period_end__isNull`).option("--period-end.is-not-null <value>", `period_end__isNotNull`).option("--period-end.equals <value>", `period_end__equals`).option("--period-end.lt <value>", `period_end__lt`).option("--period-end.lte <value>", `period_end__lte`).option("--period-end.gt <value>", `period_end__gt`).option("--period-end.gte <value>", `period_end__gte`).option("--issued-at <value>", `issued_at`).option("--issued-at.not <value>", `issued_at__not`).option("--issued-at.is-null <value>", `issued_at__isNull`).option("--issued-at.is-not-null <value>", `issued_at__isNotNull`).option("--issued-at.equals <value>", `issued_at__equals`).option("--issued-at.lt <value>", `issued_at__lt`).option("--issued-at.lte <value>", `issued_at__lte`).option("--issued-at.gt <value>", `issued_at__gt`).option("--issued-at.gte <value>", `issued_at__gte`).option("--due-at <value>", `due_at`).option("--due-at.not <value>", `due_at__not`).option("--due-at.is-null <value>", `due_at__isNull`).option("--due-at.is-not-null <value>", `due_at__isNotNull`).option("--due-at.equals <value>", `due_at__equals`).option("--due-at.lt <value>", `due_at__lt`).option("--due-at.lte <value>", `due_at__lte`).option("--due-at.gt <value>", `due_at__gt`).option("--due-at.gte <value>", `due_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", `
|
|
39820
39857
|
Examples:
|
|
39821
39858
|
hyperline invoices list
|
|
39822
|
-
hyperline invoices list --
|
|
39859
|
+
hyperline invoices list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
39823
39860
|
const ctx = resource.parent?.opts()._ctx;
|
|
39824
39861
|
if (!ctx) {
|
|
39825
39862
|
process.stderr.write("Error: Not authenticated\n");
|
|
39826
39863
|
process.exit(1);
|
|
39827
39864
|
}
|
|
39828
39865
|
const args = {};
|
|
39866
|
+
if (opts.cursor !== void 0)
|
|
39867
|
+
args.cursor = opts.cursor;
|
|
39868
|
+
if (opts.includeTotal !== void 0)
|
|
39869
|
+
args.include_total = opts.includeTotal;
|
|
39829
39870
|
if (opts.order !== void 0)
|
|
39830
39871
|
args.order = opts.order;
|
|
39831
39872
|
if (opts.sort !== void 0)
|
|
@@ -39974,42 +40015,42 @@ Examples:
|
|
|
39974
40015
|
args.period_end__gt = opts["periodEnd.gt"];
|
|
39975
40016
|
if (opts["periodEnd.gte"] !== void 0)
|
|
39976
40017
|
args.period_end__gte = opts["periodEnd.gte"];
|
|
39977
|
-
if (opts.
|
|
39978
|
-
args.
|
|
39979
|
-
if (opts["
|
|
39980
|
-
args.
|
|
39981
|
-
if (opts["
|
|
39982
|
-
args.
|
|
39983
|
-
if (opts["
|
|
39984
|
-
args.
|
|
39985
|
-
if (opts["
|
|
39986
|
-
args.
|
|
39987
|
-
if (opts["
|
|
39988
|
-
args.
|
|
39989
|
-
if (opts["
|
|
39990
|
-
args.
|
|
39991
|
-
if (opts["
|
|
39992
|
-
args.
|
|
39993
|
-
if (opts["
|
|
39994
|
-
args.
|
|
39995
|
-
if (opts.
|
|
39996
|
-
args.
|
|
39997
|
-
if (opts["
|
|
39998
|
-
args.
|
|
39999
|
-
if (opts["
|
|
40000
|
-
args.
|
|
40001
|
-
if (opts["
|
|
40002
|
-
args.
|
|
40003
|
-
if (opts["
|
|
40004
|
-
args.
|
|
40005
|
-
if (opts["
|
|
40006
|
-
args.
|
|
40007
|
-
if (opts["
|
|
40008
|
-
args.
|
|
40009
|
-
if (opts["
|
|
40010
|
-
args.
|
|
40011
|
-
if (opts["
|
|
40012
|
-
args.
|
|
40018
|
+
if (opts.issuedAt !== void 0)
|
|
40019
|
+
args.issued_at = opts.issuedAt;
|
|
40020
|
+
if (opts["issuedAt.not"] !== void 0)
|
|
40021
|
+
args.issued_at__not = opts["issuedAt.not"];
|
|
40022
|
+
if (opts["issuedAt.isNull"] !== void 0)
|
|
40023
|
+
args.issued_at__isNull = opts["issuedAt.isNull"];
|
|
40024
|
+
if (opts["issuedAt.isNotNull"] !== void 0)
|
|
40025
|
+
args.issued_at__isNotNull = opts["issuedAt.isNotNull"];
|
|
40026
|
+
if (opts["issuedAt.equals"] !== void 0)
|
|
40027
|
+
args.issued_at__equals = opts["issuedAt.equals"];
|
|
40028
|
+
if (opts["issuedAt.lt"] !== void 0)
|
|
40029
|
+
args.issued_at__lt = opts["issuedAt.lt"];
|
|
40030
|
+
if (opts["issuedAt.lte"] !== void 0)
|
|
40031
|
+
args.issued_at__lte = opts["issuedAt.lte"];
|
|
40032
|
+
if (opts["issuedAt.gt"] !== void 0)
|
|
40033
|
+
args.issued_at__gt = opts["issuedAt.gt"];
|
|
40034
|
+
if (opts["issuedAt.gte"] !== void 0)
|
|
40035
|
+
args.issued_at__gte = opts["issuedAt.gte"];
|
|
40036
|
+
if (opts.dueAt !== void 0)
|
|
40037
|
+
args.due_at = opts.dueAt;
|
|
40038
|
+
if (opts["dueAt.not"] !== void 0)
|
|
40039
|
+
args.due_at__not = opts["dueAt.not"];
|
|
40040
|
+
if (opts["dueAt.isNull"] !== void 0)
|
|
40041
|
+
args.due_at__isNull = opts["dueAt.isNull"];
|
|
40042
|
+
if (opts["dueAt.isNotNull"] !== void 0)
|
|
40043
|
+
args.due_at__isNotNull = opts["dueAt.isNotNull"];
|
|
40044
|
+
if (opts["dueAt.equals"] !== void 0)
|
|
40045
|
+
args.due_at__equals = opts["dueAt.equals"];
|
|
40046
|
+
if (opts["dueAt.lt"] !== void 0)
|
|
40047
|
+
args.due_at__lt = opts["dueAt.lt"];
|
|
40048
|
+
if (opts["dueAt.lte"] !== void 0)
|
|
40049
|
+
args.due_at__lte = opts["dueAt.lte"];
|
|
40050
|
+
if (opts["dueAt.gt"] !== void 0)
|
|
40051
|
+
args.due_at__gt = opts["dueAt.gt"];
|
|
40052
|
+
if (opts["dueAt.gte"] !== void 0)
|
|
40053
|
+
args.due_at__gte = opts["dueAt.gte"];
|
|
40013
40054
|
if (opts.updatedAt !== void 0)
|
|
40014
40055
|
args.updated_at = opts.updatedAt;
|
|
40015
40056
|
if (opts["updatedAt.not"] !== void 0)
|
|
@@ -40028,17 +40069,16 @@ Examples:
|
|
|
40028
40069
|
args.updated_at__gt = opts["updatedAt.gt"];
|
|
40029
40070
|
if (opts["updatedAt.gte"] !== void 0)
|
|
40030
40071
|
args.updated_at__gte = opts["updatedAt.gte"];
|
|
40031
|
-
if (opts.
|
|
40032
|
-
args.
|
|
40033
|
-
if (opts.skip !== void 0)
|
|
40034
|
-
args.skip = Number(opts.skip);
|
|
40072
|
+
if (opts.limit !== void 0)
|
|
40073
|
+
args.limit = Number(opts.limit);
|
|
40035
40074
|
await ctx.execute({
|
|
40036
40075
|
method: "GET",
|
|
40037
|
-
path: "/
|
|
40076
|
+
path: "/v2/invoices",
|
|
40038
40077
|
args,
|
|
40039
40078
|
queryParamKeys: [
|
|
40040
|
-
"
|
|
40041
|
-
"
|
|
40079
|
+
"limit",
|
|
40080
|
+
"cursor",
|
|
40081
|
+
"include_total",
|
|
40042
40082
|
"order",
|
|
40043
40083
|
"sort",
|
|
40044
40084
|
"type",
|
|
@@ -40113,24 +40153,24 @@ Examples:
|
|
|
40113
40153
|
"period_end__lte",
|
|
40114
40154
|
"period_end__gt",
|
|
40115
40155
|
"period_end__gte",
|
|
40116
|
-
"
|
|
40117
|
-
"
|
|
40118
|
-
"
|
|
40119
|
-
"
|
|
40120
|
-
"
|
|
40121
|
-
"
|
|
40122
|
-
"
|
|
40123
|
-
"
|
|
40124
|
-
"
|
|
40125
|
-
"
|
|
40126
|
-
"
|
|
40127
|
-
"
|
|
40128
|
-
"
|
|
40129
|
-
"
|
|
40130
|
-
"
|
|
40131
|
-
"
|
|
40132
|
-
"
|
|
40133
|
-
"
|
|
40156
|
+
"issued_at",
|
|
40157
|
+
"issued_at__not",
|
|
40158
|
+
"issued_at__isNull",
|
|
40159
|
+
"issued_at__isNotNull",
|
|
40160
|
+
"issued_at__equals",
|
|
40161
|
+
"issued_at__lt",
|
|
40162
|
+
"issued_at__lte",
|
|
40163
|
+
"issued_at__gt",
|
|
40164
|
+
"issued_at__gte",
|
|
40165
|
+
"due_at",
|
|
40166
|
+
"due_at__not",
|
|
40167
|
+
"due_at__isNull",
|
|
40168
|
+
"due_at__isNotNull",
|
|
40169
|
+
"due_at__equals",
|
|
40170
|
+
"due_at__lt",
|
|
40171
|
+
"due_at__lte",
|
|
40172
|
+
"due_at__gt",
|
|
40173
|
+
"due_at__gte",
|
|
40134
40174
|
"updated_at",
|
|
40135
40175
|
"updated_at__not",
|
|
40136
40176
|
"updated_at__isNull",
|
|
@@ -40172,7 +40212,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
40172
40212
|
|
|
40173
40213
|
- \`current\`: Use the current default payment method of the customer.
|
|
40174
40214
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
40175
|
-
`).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", `
|
|
40215
|
+
`).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", `
|
|
40176
40216
|
Examples:
|
|
40177
40217
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
40178
40218
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -40225,6 +40265,8 @@ Examples:
|
|
|
40225
40265
|
args.settled_at = opts.settledAt;
|
|
40226
40266
|
if (opts.properties !== void 0)
|
|
40227
40267
|
args.properties = opts.properties;
|
|
40268
|
+
if (opts.customProperties !== void 0)
|
|
40269
|
+
args.custom_properties = opts.customProperties;
|
|
40228
40270
|
if (opts.lineItems !== void 0)
|
|
40229
40271
|
args.line_items = opts.lineItems;
|
|
40230
40272
|
if (opts.transactions !== void 0)
|
|
@@ -40238,10 +40280,15 @@ Examples:
|
|
|
40238
40280
|
queryParamKeys: []
|
|
40239
40281
|
});
|
|
40240
40282
|
});
|
|
40241
|
-
resource.command("create-credit-note").description(`Create a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount.`).requiredOption("--id <value>", `id parameter`).option("--amount-including-tax <number>", `Amount of the credit note. If not specified, the amount will be computed from the original invoice.`).option("--status <value>", `Status of the credit note.
|
|
40283
|
+
resource.command("create-credit-note").description(`Create a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.`).requiredOption("--id <value>", `id parameter`).option("--amount-including-tax <number>", `Amount of the credit note. If not specified, the amount will be computed from the original invoice.`).option("--status <value>", `Status of the credit note.
|
|
40242
40284
|
|
|
40243
40285
|
- \`to_pay\`: Credit note is awaiting payment.
|
|
40244
40286
|
- \`draft\`: Credit note is in draft mode (not finalized yet).
|
|
40287
|
+
`).option("--trigger-refund", `Whether to trigger a refund for the credit note amount. Defaults to \`false\`. When \`true\`, the refund is issued using \`refund_method\`.`).option("--refund-method <value>", `How the refund should be settled. Only used when \`trigger_refund\` is \`true\`. Defaults to \`original_payment_method\`.
|
|
40288
|
+
|
|
40289
|
+
- \`wallet\`: Credit the customer's wallet with the refunded amount.
|
|
40290
|
+
- \`original_payment_method\`: Refund to the payment method used on the original invoice.
|
|
40291
|
+
- \`external\`: Mark the refund as settled externally (no automatic transfer).
|
|
40245
40292
|
`).addHelpText("after", `
|
|
40246
40293
|
Examples:
|
|
40247
40294
|
hyperline invoices create-credit-note --id <id>
|
|
@@ -40257,8 +40304,12 @@ Examples:
|
|
|
40257
40304
|
args.id = opts.id;
|
|
40258
40305
|
if (opts.status !== void 0)
|
|
40259
40306
|
args.status = opts.status;
|
|
40307
|
+
if (opts.refundMethod !== void 0)
|
|
40308
|
+
args.refund_method = opts.refundMethod;
|
|
40260
40309
|
if (opts.amountIncludingTax !== void 0)
|
|
40261
40310
|
args.amount_including_tax = Number(opts.amountIncludingTax);
|
|
40311
|
+
if (opts.triggerRefund !== void 0)
|
|
40312
|
+
args.trigger_refund = true;
|
|
40262
40313
|
await ctx.execute({
|
|
40263
40314
|
method: "POST",
|
|
40264
40315
|
path: "/v1/invoices/{id}/credit-notes",
|
|
@@ -40370,7 +40421,7 @@ Examples:
|
|
|
40370
40421
|
queryParamKeys: []
|
|
40371
40422
|
});
|
|
40372
40423
|
});
|
|
40373
|
-
resource.command("get").description(`Retrieve
|
|
40424
|
+
resource.command("get").description(`Retrieve the details of an invoice by ID including line items, transactions, customer info, and billing metadata.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
40374
40425
|
Examples:
|
|
40375
40426
|
hyperline invoices get --id <id>`).action(async (opts) => {
|
|
40376
40427
|
const ctx = resource.parent?.opts()._ctx;
|
|
@@ -40383,7 +40434,7 @@ Examples:
|
|
|
40383
40434
|
args.id = opts.id;
|
|
40384
40435
|
await ctx.execute({
|
|
40385
40436
|
method: "GET",
|
|
40386
|
-
path: "/
|
|
40437
|
+
path: "/v2/invoices/{id}",
|
|
40387
40438
|
args,
|
|
40388
40439
|
queryParamKeys: []
|
|
40389
40440
|
});
|
|
@@ -40397,7 +40448,7 @@ Examples:
|
|
|
40397
40448
|
|
|
40398
40449
|
- \`auto\`: Tax is automatically computed and applied.
|
|
40399
40450
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
40400
|
-
`).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", `
|
|
40451
|
+
`).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", `
|
|
40401
40452
|
Examples:
|
|
40402
40453
|
hyperline invoices update --id <id>
|
|
40403
40454
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -40438,6 +40489,8 @@ Examples:
|
|
|
40438
40489
|
args.bank_account_id = opts.bankAccountId;
|
|
40439
40490
|
if (opts.properties !== void 0)
|
|
40440
40491
|
args.properties = opts.properties;
|
|
40492
|
+
if (opts.customProperties !== void 0)
|
|
40493
|
+
args.custom_properties = opts.customProperties;
|
|
40441
40494
|
if (opts.customer !== void 0)
|
|
40442
40495
|
args.customer = opts.customer;
|
|
40443
40496
|
await ctx.execute({
|
|
@@ -40630,7 +40683,7 @@ Examples:
|
|
|
40630
40683
|
queryParamKeys: []
|
|
40631
40684
|
});
|
|
40632
40685
|
});
|
|
40633
|
-
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", `
|
|
40686
|
+
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", `
|
|
40634
40687
|
Examples:
|
|
40635
40688
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
40636
40689
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -40709,6 +40762,8 @@ Examples:
|
|
|
40709
40762
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40710
40763
|
if (opts.isDefault !== void 0)
|
|
40711
40764
|
args.is_default = true;
|
|
40765
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40766
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40712
40767
|
await ctx.execute({
|
|
40713
40768
|
method: "POST",
|
|
40714
40769
|
path: "/v1/invoicing-entities",
|
|
@@ -40716,7 +40771,7 @@ Examples:
|
|
|
40716
40771
|
queryParamKeys: []
|
|
40717
40772
|
});
|
|
40718
40773
|
});
|
|
40719
|
-
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", `
|
|
40774
|
+
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", `
|
|
40720
40775
|
Examples:
|
|
40721
40776
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
40722
40777
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -40787,6 +40842,8 @@ Examples:
|
|
|
40787
40842
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40788
40843
|
if (opts.isDefault !== void 0)
|
|
40789
40844
|
args.is_default = true;
|
|
40845
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40846
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40790
40847
|
await ctx.execute({
|
|
40791
40848
|
method: "PUT",
|
|
40792
40849
|
path: "/v1/invoicing-entities/{id}",
|
|
@@ -41355,18 +41412,18 @@ Examples:
|
|
|
41355
41412
|
// build/commands/generated/quotes.js
|
|
41356
41413
|
function registerQuotesCommands(parent) {
|
|
41357
41414
|
const resource = parent.command("quotes").description("Manage quotes");
|
|
41358
|
-
resource.command("create").description(`Create a new quote for a customer
|
|
41415
|
+
resource.command("create").description(`Create a new quote for a customer. Use \`subscription\` (or \`template_id\`) for subscription quotes; use \`invoice\` for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.`).option("--status <value>", `
|
|
41359
41416
|
Quote status.
|
|
41360
41417
|
|
|
41361
41418
|
- \`draft\`: The quote is a draft.
|
|
41362
41419
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
41363
41420
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
41364
|
-
`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the quote.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value.
|
|
41421
|
+
`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the quote.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. For subscription quotes, defaults to the computed subscription value if not specified. For one-off quotes, this field is ignored \u2014 the amount is always derived from the linked invoice's \`amount_excluding_tax\`.`).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.
|
|
41365
41422
|
|
|
41366
41423
|
- \`all\`: Display all pricing tiers.
|
|
41367
41424
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41368
41425
|
- \`none\`: Hide all pricing tiers.
|
|
41369
|
-
`).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("--template-id <value>", `ID of the quote template. If not specified, a subscription configuration 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 <value>", `Subscription configuration constituting the quote.`).addHelpText("after", `
|
|
41426
|
+
`).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("--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 <value>", `Subscription configuration constituting the quote.`).option("--invoice <value>", `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", `
|
|
41370
41427
|
Examples:
|
|
41371
41428
|
hyperline quotes create --customer-id <customer_id>
|
|
41372
41429
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -41411,12 +41468,16 @@ Examples:
|
|
|
41411
41468
|
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41412
41469
|
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41413
41470
|
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41471
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41472
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41414
41473
|
if (opts.templateId !== void 0)
|
|
41415
41474
|
args.template_id = opts.templateId;
|
|
41416
41475
|
if (opts.expiresAt !== void 0)
|
|
41417
41476
|
args.expires_at = opts.expiresAt;
|
|
41418
41477
|
if (opts.subscription !== void 0)
|
|
41419
41478
|
args.subscription = opts.subscription;
|
|
41479
|
+
if (opts.invoice !== void 0)
|
|
41480
|
+
args.invoice = opts.invoice;
|
|
41420
41481
|
if (opts.amount !== void 0)
|
|
41421
41482
|
args.amount = Number(opts.amount);
|
|
41422
41483
|
await ctx.execute({
|
|
@@ -41645,6 +41706,69 @@ Examples:
|
|
|
41645
41706
|
queryParamKeys: []
|
|
41646
41707
|
});
|
|
41647
41708
|
});
|
|
41709
|
+
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, or pass \`invoice\` on a one-off quote to replace the linked draft invoice.`).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.
|
|
41710
|
+
|
|
41711
|
+
- \`all\`: Display all pricing tiers.
|
|
41712
|
+
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41713
|
+
- \`none\`: Hide all pricing tiers.
|
|
41714
|
+
`).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("--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("--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.`).option("--invoice <value>", `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", `
|
|
41715
|
+
Examples:
|
|
41716
|
+
hyperline quotes update --id <id>
|
|
41717
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
41718
|
+
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
41719
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41720
|
+
if (!ctx) {
|
|
41721
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41722
|
+
process.exit(1);
|
|
41723
|
+
}
|
|
41724
|
+
const args = {};
|
|
41725
|
+
if (opts.id !== void 0)
|
|
41726
|
+
args.id = opts.id;
|
|
41727
|
+
if (opts.ownerEmail !== void 0)
|
|
41728
|
+
args.owner_email = opts.ownerEmail;
|
|
41729
|
+
if (opts.comments !== void 0)
|
|
41730
|
+
args.comments = opts.comments;
|
|
41731
|
+
if (opts.terms !== void 0)
|
|
41732
|
+
args.terms = opts.terms;
|
|
41733
|
+
if (opts.collectPaymentDetails !== void 0)
|
|
41734
|
+
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41735
|
+
if (opts.collectCustomPropertyIds !== void 0)
|
|
41736
|
+
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41737
|
+
if (opts.requireTaxId !== void 0)
|
|
41738
|
+
args.require_tax_id = opts.requireTaxId;
|
|
41739
|
+
if (opts.displayQuoteValue !== void 0)
|
|
41740
|
+
args.display_quote_value = opts.displayQuoteValue;
|
|
41741
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
41742
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
41743
|
+
if (opts.displayTaxes !== void 0)
|
|
41744
|
+
args.display_taxes = opts.displayTaxes;
|
|
41745
|
+
if (opts.displayPriceTiers !== void 0)
|
|
41746
|
+
args.display_price_tiers = opts.displayPriceTiers;
|
|
41747
|
+
if (opts.displayPhaseValue !== void 0)
|
|
41748
|
+
args.display_phase_value = opts.displayPhaseValue;
|
|
41749
|
+
if (opts.displayFirstInvoiceAmount !== void 0)
|
|
41750
|
+
args.display_first_invoice_amount = opts.displayFirstInvoiceAmount;
|
|
41751
|
+
if (opts.displayDocumentsInPreview !== void 0)
|
|
41752
|
+
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41753
|
+
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41754
|
+
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41755
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41756
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41757
|
+
if (opts.expiresAt !== void 0)
|
|
41758
|
+
args.expires_at = opts.expiresAt;
|
|
41759
|
+
if (opts.subscription !== void 0)
|
|
41760
|
+
args.subscription = opts.subscription;
|
|
41761
|
+
if (opts.invoice !== void 0)
|
|
41762
|
+
args.invoice = opts.invoice;
|
|
41763
|
+
if (opts.amount !== void 0)
|
|
41764
|
+
args.amount = Number(opts.amount);
|
|
41765
|
+
await ctx.execute({
|
|
41766
|
+
method: "PATCH",
|
|
41767
|
+
path: "/v1/quotes/{id}",
|
|
41768
|
+
args,
|
|
41769
|
+
queryParamKeys: []
|
|
41770
|
+
});
|
|
41771
|
+
});
|
|
41648
41772
|
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", `
|
|
41649
41773
|
Examples:
|
|
41650
41774
|
hyperline quotes download --id <id>
|
|
@@ -41685,6 +41809,25 @@ Examples:
|
|
|
41685
41809
|
queryParamKeys: []
|
|
41686
41810
|
});
|
|
41687
41811
|
});
|
|
41812
|
+
resource.command("finalize").description(`Finalize a draft quote. The quote is submitted for approval when approval is required, otherwise it becomes approved and ready to be sent for signature.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
41813
|
+
Examples:
|
|
41814
|
+
hyperline quotes finalize --id <id>
|
|
41815
|
+
hyperline quotes finalize --id <id> --output json`).action(async (opts) => {
|
|
41816
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41817
|
+
if (!ctx) {
|
|
41818
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41819
|
+
process.exit(1);
|
|
41820
|
+
}
|
|
41821
|
+
const args = {};
|
|
41822
|
+
if (opts.id !== void 0)
|
|
41823
|
+
args.id = opts.id;
|
|
41824
|
+
await ctx.execute({
|
|
41825
|
+
method: "POST",
|
|
41826
|
+
path: "/v1/quotes/{id}/finalize",
|
|
41827
|
+
args,
|
|
41828
|
+
queryParamKeys: []
|
|
41829
|
+
});
|
|
41830
|
+
});
|
|
41688
41831
|
resource.command("send").description(`Send a quote by email for customer signature. Requires the quote to be approved first.`).requiredOption("--id <value>", `id parameter`).requiredOption("--email <value>", `Email address to which the quote will be sent for signature.`).option("--message <value>", `Custom message used in the email content.`).addHelpText("after", `
|
|
41689
41832
|
Examples:
|
|
41690
41833
|
hyperline quotes send --id <id> --email <email>
|
|
@@ -41795,7 +41938,7 @@ Examples:
|
|
|
41795
41938
|
// build/commands/generated/subscriptions.js
|
|
41796
41939
|
function registerSubscriptionsCommands(parent) {
|
|
41797
41940
|
const resource = parent.command("subscriptions").description("Manage subscriptions");
|
|
41798
|
-
resource.command("create-subscription-update").description(`Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--type <value>", `type`).requiredOption("--payload <value>", `payload`).addHelpText("after", `
|
|
41941
|
+
resource.command("create-subscription-update").description(`Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--type <value>", `type`).requiredOption("--payload <value>", `payload`).addHelpText("after", `
|
|
41799
41942
|
Examples:
|
|
41800
41943
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload>
|
|
41801
41944
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload> --apply-at <apply_at> --charge-at <charge_at>
|
|
@@ -41818,6 +41961,8 @@ Examples:
|
|
|
41818
41961
|
args.charge_at = opts.chargeAt;
|
|
41819
41962
|
if (opts.calculationMethod !== void 0)
|
|
41820
41963
|
args.calculation_method = opts.calculationMethod;
|
|
41964
|
+
if (opts.refundMethod !== void 0)
|
|
41965
|
+
args.refund_method = opts.refundMethod;
|
|
41821
41966
|
if (opts.type !== void 0)
|
|
41822
41967
|
args.type = opts.type;
|
|
41823
41968
|
if (opts.payload !== void 0)
|
|
@@ -41829,7 +41974,7 @@ Examples:
|
|
|
41829
41974
|
queryParamKeys: []
|
|
41830
41975
|
});
|
|
41831
41976
|
});
|
|
41832
|
-
resource.command("create-subscription-updates").description(`Apply multiple updates at once to an existing subscription in a single atomic operation.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
41977
|
+
resource.command("create-subscription-updates").description(`Apply multiple updates at once to an existing subscription in a single atomic operation.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
41833
41978
|
Examples:
|
|
41834
41979
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
41835
41980
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at> --charge-at <charge_at>
|
|
@@ -41852,6 +41997,8 @@ Examples:
|
|
|
41852
41997
|
args.charge_at = opts.chargeAt;
|
|
41853
41998
|
if (opts.calculationMethod !== void 0)
|
|
41854
41999
|
args.calculation_method = opts.calculationMethod;
|
|
42000
|
+
if (opts.refundMethod !== void 0)
|
|
42001
|
+
args.refund_method = opts.refundMethod;
|
|
41855
42002
|
if (opts.updates !== void 0)
|
|
41856
42003
|
args.updates = opts.updates;
|
|
41857
42004
|
await ctx.execute({
|
|
@@ -41861,7 +42008,7 @@ Examples:
|
|
|
41861
42008
|
queryParamKeys: []
|
|
41862
42009
|
});
|
|
41863
42010
|
});
|
|
41864
|
-
resource.command("cancel").description(`Cancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason.`).requiredOption("--id <value>", `id parameter`).option("--cancel-at <value>", `Subscription cancel date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--reason <value>", `Reason for the cancellation.`).option("--pro-rata", `Indicates if the cancel should refund the customer using a pro rata strategy.`).addHelpText("after", `
|
|
42011
|
+
resource.command("cancel").description(`Cancel a subscription. Supports immediate or end-of-period cancellation. Optionally specify a cancellation reason.`).requiredOption("--id <value>", `id parameter`).option("--cancel-at <value>", `Subscription cancel date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--reason <value>", `Reason for the cancellation.`).option("--pro-rata", `Indicates if the cancel should refund the customer using a pro rata strategy.`).option("--refund-method <value>", `Override the refund destination for the resulting credit note. When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).addHelpText("after", `
|
|
41865
42012
|
Examples:
|
|
41866
42013
|
hyperline subscriptions cancel --id <id>
|
|
41867
42014
|
hyperline subscriptions cancel --id <id> --cancel-at <cancel_at> --reason <reason>
|
|
@@ -41878,6 +42025,8 @@ Examples:
|
|
|
41878
42025
|
args.cancel_at = opts.cancelAt;
|
|
41879
42026
|
if (opts.reason !== void 0)
|
|
41880
42027
|
args.reason = opts.reason;
|
|
42028
|
+
if (opts.refundMethod !== void 0)
|
|
42029
|
+
args.refund_method = opts.refundMethod;
|
|
41881
42030
|
if (opts.proRata !== void 0)
|
|
41882
42031
|
args.pro_rata = true;
|
|
41883
42032
|
await ctx.execute({
|
|
@@ -41987,7 +42136,7 @@ Examples:
|
|
|
41987
42136
|
queryParamKeys: []
|
|
41988
42137
|
});
|
|
41989
42138
|
});
|
|
41990
|
-
resource.command("simulate-subscription-updates").description(`Preview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
42139
|
+
resource.command("simulate-subscription-updates").description(`Preview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
41991
42140
|
Examples:
|
|
41992
42141
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
41993
42142
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates> --apply-at <apply_at> --charge-at <charge_at>
|
|
@@ -42010,6 +42159,8 @@ Examples:
|
|
|
42010
42159
|
args.charge_at = opts.chargeAt;
|
|
42011
42160
|
if (opts.calculationMethod !== void 0)
|
|
42012
42161
|
args.calculation_method = opts.calculationMethod;
|
|
42162
|
+
if (opts.refundMethod !== void 0)
|
|
42163
|
+
args.refund_method = opts.refundMethod;
|
|
42013
42164
|
if (opts.updates !== void 0)
|
|
42014
42165
|
args.updates = opts.updates;
|
|
42015
42166
|
await ctx.execute({
|
|
@@ -42035,7 +42186,7 @@ Strategy used to cancel the subscription. If not specified \`do_nothing\` is use
|
|
|
42035
42186
|
- \`refund_custom\`: Will refund to the customer a custom amount.
|
|
42036
42187
|
- \`end_of_period\`: Will cancel the subscription at the end date of the current billing period.
|
|
42037
42188
|
- \`do_nothing\`: Will only cease the subscription without any additional actions.
|
|
42038
|
-
`).option("--cancellation-amount <number>", `Custom amount used when cancelling the subscription. Only applies to the \`charge_custom\` or the \`refund_custom\` cancellation strategy.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).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>", `
|
|
42189
|
+
`).option("--cancellation-amount <number>", `Custom amount used when cancelling the subscription. Only applies to the \`charge_custom\` or the \`refund_custom\` cancellation strategy.`).option("--cancellation-refund-method <value>", `Override the refund destination for credit notes generated by \`refund_prorata\` / \`refund_custom\` cancellation strategies. When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).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>", `
|
|
42039
42190
|
Defines when invoices are generated relative to the billing period.
|
|
42040
42191
|
|
|
42041
42192
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42090,6 +42241,8 @@ Examples:
|
|
|
42090
42241
|
args.cancel_at = opts.cancelAt;
|
|
42091
42242
|
if (opts.cancellationStrategy !== void 0)
|
|
42092
42243
|
args.cancellation_strategy = opts.cancellationStrategy;
|
|
42244
|
+
if (opts.cancellationRefundMethod !== void 0)
|
|
42245
|
+
args.cancellation_refund_method = opts.cancellationRefundMethod;
|
|
42093
42246
|
if (opts.properties !== void 0)
|
|
42094
42247
|
args.properties = opts.properties;
|
|
42095
42248
|
if (opts.customProperties !== void 0)
|
|
@@ -42372,7 +42525,7 @@ Examples:
|
|
|
42372
42525
|
queryParamKeys: []
|
|
42373
42526
|
});
|
|
42374
42527
|
});
|
|
42375
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons.
|
|
42528
|
+
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>", `
|
|
42376
42529
|
Defines when invoices are generated relative to the billing period.
|
|
42377
42530
|
|
|
42378
42531
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42732,7 +42885,7 @@ Examples:
|
|
|
42732
42885
|
]
|
|
42733
42886
|
});
|
|
42734
42887
|
});
|
|
42735
|
-
resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be 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.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `
|
|
42888
|
+
resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be 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. 'refund_and_reinvoice' (only available with application_schedule 'last_renewal') issues a credit note for what was invoiced for the current period 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' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align 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 <value>", `The configuration of the subscription to transition to`).addHelpText("after", `
|
|
42736
42889
|
Examples:
|
|
42737
42890
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
42738
42891
|
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>
|
|
@@ -42946,6 +43099,30 @@ Examples:
|
|
|
42946
43099
|
});
|
|
42947
43100
|
}
|
|
42948
43101
|
|
|
43102
|
+
// build/commands/generated/transactions.js
|
|
43103
|
+
function registerTransactionsCommands(parent) {
|
|
43104
|
+
const resource = parent.command("transactions").description("Manage transactions");
|
|
43105
|
+
resource.command("refund").description(`Refund a settled banking transaction for its full amount. The related invoice will switch back to to pay status. Use the create credit note endpoint if you want to cancel (and optionally refund) the initial invoice.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
43106
|
+
Examples:
|
|
43107
|
+
hyperline transactions refund --id <id>
|
|
43108
|
+
hyperline transactions refund --id <id> --output json`).action(async (opts) => {
|
|
43109
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
43110
|
+
if (!ctx) {
|
|
43111
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
43112
|
+
process.exit(1);
|
|
43113
|
+
}
|
|
43114
|
+
const args = {};
|
|
43115
|
+
if (opts.id !== void 0)
|
|
43116
|
+
args.id = opts.id;
|
|
43117
|
+
await ctx.execute({
|
|
43118
|
+
method: "POST",
|
|
43119
|
+
path: "/v1/transactions/{id}/refund",
|
|
43120
|
+
args,
|
|
43121
|
+
queryParamKeys: []
|
|
43122
|
+
});
|
|
43123
|
+
});
|
|
43124
|
+
}
|
|
43125
|
+
|
|
42949
43126
|
// build/commands/generated/wallets.js
|
|
42950
43127
|
function registerWalletsCommands(parent) {
|
|
42951
43128
|
const resource = parent.command("wallets").description("Manage wallets");
|
|
@@ -43106,10 +43283,10 @@ Examples:
|
|
|
43106
43283
|
queryParamKeys: []
|
|
43107
43284
|
});
|
|
43108
43285
|
});
|
|
43109
|
-
resource.command("load").description(`Add credits
|
|
43286
|
+
resource.command("load").description(`Add paid credits by charging the customer's payment method, or add free credits by issuing a credit note.`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Wallet load type. Use \`paid\` to collect payment from the customer's payment method, or \`free\` to grant credits without collecting payment.`).option("--amount <number>", `Amount to be loaded onto the wallet as free credits. A corresponding credit note will be generated and no payment is collected. Expressed in currency's smallest unit.`).option("--comment <value>", `Internal comment stored on the wallet transaction for context.`).option("--document-status <value>", `Indicates the status of the generated credit note for free top-ups.`).option("--bank-account-id <value>", `Bank account ID to use when recording a paid wallet load by bank transfer.`).option("--reference <value>", `Reference stored on the generated payment document for a paid wallet load.`).addHelpText("after", `
|
|
43110
43287
|
Examples:
|
|
43111
43288
|
hyperline wallets load --id <id>
|
|
43112
|
-
hyperline wallets load --id <id> --
|
|
43289
|
+
hyperline wallets load --id <id> --type <type> --amount <amount>
|
|
43113
43290
|
hyperline wallets load --id <id> --output json`).action(async (opts) => {
|
|
43114
43291
|
const ctx = resource.parent?.opts()._ctx;
|
|
43115
43292
|
if (!ctx) {
|
|
@@ -43119,12 +43296,18 @@ Examples:
|
|
|
43119
43296
|
const args = {};
|
|
43120
43297
|
if (opts.id !== void 0)
|
|
43121
43298
|
args.id = opts.id;
|
|
43299
|
+
if (opts.type !== void 0)
|
|
43300
|
+
args.type = opts.type;
|
|
43301
|
+
if (opts.comment !== void 0)
|
|
43302
|
+
args.comment = opts.comment;
|
|
43122
43303
|
if (opts.documentStatus !== void 0)
|
|
43123
43304
|
args.document_status = opts.documentStatus;
|
|
43305
|
+
if (opts.bankAccountId !== void 0)
|
|
43306
|
+
args.bank_account_id = opts.bankAccountId;
|
|
43307
|
+
if (opts.reference !== void 0)
|
|
43308
|
+
args.reference = opts.reference;
|
|
43124
43309
|
if (opts.amount !== void 0)
|
|
43125
43310
|
args.amount = Number(opts.amount);
|
|
43126
|
-
if (opts.amountFree !== void 0)
|
|
43127
|
-
args.amount_free = Number(opts.amountFree);
|
|
43128
43311
|
await ctx.execute({
|
|
43129
43312
|
method: "POST",
|
|
43130
43313
|
path: "/v1/wallets/{id}/load",
|
|
@@ -43358,6 +43541,7 @@ function registerAllCommands(program2) {
|
|
|
43358
43541
|
registerSubscriptions_TransitionsCommands(program2);
|
|
43359
43542
|
registerSubscriptions_PhasesCommands(program2);
|
|
43360
43543
|
registerTaxesCommands(program2);
|
|
43544
|
+
registerTransactionsCommands(program2);
|
|
43361
43545
|
registerWalletsCommands(program2);
|
|
43362
43546
|
registerWebhooksCommands(program2);
|
|
43363
43547
|
}
|
|
@@ -57148,6 +57332,7 @@ var BooleanSchema = external_exports.boolean().or(external_exports.enum(["true",
|
|
|
57148
57332
|
});
|
|
57149
57333
|
var StringSchemaForMultipartForm = external_exports.string().transform((value) => value === "" ? null : value);
|
|
57150
57334
|
var StringArraySchemaForMultipartForm = external_exports.string().array().or(external_exports.string().length(0)).transform((value) => typeof value === "string" ? [] : value);
|
|
57335
|
+
var CommaSeparatedArraySchema = external_exports.string().optional().transform((raw) => raw ? raw.split(",").filter(Boolean) : void 0);
|
|
57151
57336
|
var urlRegex = /^(?:(?:https?):\/\/)?(?:www\.)?(?:[\w-]+\.)+[a-z]{2,7}(?:\/\S*)?$/i;
|
|
57152
57337
|
var ZodFlexibleUrl = external_exports.string({ message: "Invalid URL" }).regex(urlRegex).transform((url2) => {
|
|
57153
57338
|
if (!url2)
|
|
@@ -61460,6 +61645,7 @@ function getConfig(schema, testValues) {
|
|
|
61460
61645
|
var config3 = getConfig({
|
|
61461
61646
|
// config
|
|
61462
61647
|
APP_VERSION: types.string().optional(),
|
|
61648
|
+
DD_SERVICE: types.string().optional(),
|
|
61463
61649
|
LOGGER_CONSOLE_ENABLED: types.boolean().optional(),
|
|
61464
61650
|
LOGGER_STDOUT_ENABLED: types.boolean().optional(),
|
|
61465
61651
|
NODE_ENV: types.enum(["local", "test", "staging", "sandbox", "production"]),
|
|
@@ -61469,6 +61655,7 @@ var config3 = getConfig({
|
|
|
61469
61655
|
// secrets
|
|
61470
61656
|
}, {
|
|
61471
61657
|
APP_VERSION: void 0,
|
|
61658
|
+
DD_SERVICE: void 0,
|
|
61472
61659
|
LOGGER_CONSOLE_ENABLED: false,
|
|
61473
61660
|
LOGGER_STDOUT_ENABLED: false,
|
|
61474
61661
|
EVENT_LOOP_MONITORING_ENABLED: false,
|
|
@@ -61484,6 +61671,7 @@ import * as winston from "winston";
|
|
|
61484
61671
|
|
|
61485
61672
|
// ../hyperline-monitoring/build/logger/formatting/format.js
|
|
61486
61673
|
import prune from "json-prune";
|
|
61674
|
+
var REDACTED_HEADER_KEY_PATTERN = /authorization|authenticate|cookie|secret|token|credential|signature|jwt|api[_-]?key|access[_-]?token|refresh[_-]?token|private[_-]?key/i;
|
|
61487
61675
|
function jsonFormat(info) {
|
|
61488
61676
|
const prunedInfo = JSON.parse(prune(info));
|
|
61489
61677
|
for (const [key, value] of Object.entries(prunedInfo)) {
|
|
@@ -61566,17 +61754,26 @@ function formatAxiosError(error48) {
|
|
|
61566
61754
|
url: request?.url,
|
|
61567
61755
|
baseURL: request?.baseURL,
|
|
61568
61756
|
params: request?.params,
|
|
61569
|
-
headers: request?.headers,
|
|
61757
|
+
headers: redactHeaders({ headers: request?.headers }),
|
|
61570
61758
|
"axios-retry": request?.["axios-retry"]
|
|
61571
61759
|
},
|
|
61572
61760
|
response: {
|
|
61573
61761
|
status: response?.status,
|
|
61574
61762
|
statusText: response?.statusText,
|
|
61575
|
-
headers: response?.headers,
|
|
61763
|
+
headers: redactHeaders({ headers: response?.headers }),
|
|
61576
61764
|
data: response?.data
|
|
61577
61765
|
}
|
|
61578
61766
|
};
|
|
61579
61767
|
}
|
|
61768
|
+
function redactHeaders({ headers }) {
|
|
61769
|
+
if (!isRecord(headers)) {
|
|
61770
|
+
return headers;
|
|
61771
|
+
}
|
|
61772
|
+
return Object.fromEntries(Object.entries(headers).map(([headerKey, headerValue]) => [
|
|
61773
|
+
headerKey,
|
|
61774
|
+
REDACTED_HEADER_KEY_PATTERN.test(headerKey) ? "<redacted>" : headerValue
|
|
61775
|
+
]));
|
|
61776
|
+
}
|
|
61580
61777
|
function isRecord(value) {
|
|
61581
61778
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
61582
61779
|
}
|
|
@@ -61747,13 +61944,16 @@ var loggerFactory = buildLoggerFactory({
|
|
|
61747
61944
|
},
|
|
61748
61945
|
context: {
|
|
61749
61946
|
env: config3.NODE_ENV,
|
|
61750
|
-
service: "api",
|
|
61947
|
+
service: config3.DD_SERVICE ?? "api",
|
|
61751
61948
|
version: config3.APP_VERSION
|
|
61752
61949
|
}
|
|
61753
61950
|
});
|
|
61754
61951
|
var createLogger2 = loggerFactory.createLogger;
|
|
61755
61952
|
var logger = loggerFactory.createLogger({ serviceName: "default" });
|
|
61756
61953
|
|
|
61954
|
+
// ../hyperline-monitoring/build/tracing/tracing.js
|
|
61955
|
+
import tracer from "dd-trace";
|
|
61956
|
+
|
|
61757
61957
|
// ../hyperline-lib/build/utils/config/usStates.js
|
|
61758
61958
|
var usStates = [
|
|
61759
61959
|
"AA",
|
|
@@ -61895,6 +62095,20 @@ var PublicPaginationParams = {
|
|
|
61895
62095
|
skip: zod_default.coerce.number().nonnegative().optional().default(0)
|
|
61896
62096
|
};
|
|
61897
62097
|
var PublicPaginationSchema = zod_default.object(PublicPaginationParams);
|
|
62098
|
+
var PublicCursorPaginationParams = {
|
|
62099
|
+
limit: zod_default.coerce.number().positive().max(100).optional().default(50).openapi({
|
|
62100
|
+
description: "Maximum number of items to return (1-100).",
|
|
62101
|
+
example: 50
|
|
62102
|
+
}),
|
|
62103
|
+
cursor: zod_default.string().optional().openapi({
|
|
62104
|
+
description: "Opaque cursor returned in the previous response's `next_cursor`. Omit to fetch the first page."
|
|
62105
|
+
}),
|
|
62106
|
+
include_total: BooleanSchema.optional().default(false).openapi({
|
|
62107
|
+
description: "Set to `true` to include `total` in the response.",
|
|
62108
|
+
example: false
|
|
62109
|
+
})
|
|
62110
|
+
};
|
|
62111
|
+
var PublicCursorPaginationSchema = zod_default.object(PublicCursorPaginationParams);
|
|
61898
62112
|
|
|
61899
62113
|
// ../hyperline-lib/build/http/dto/state.js
|
|
61900
62114
|
var StateSchema = external_exports.enum(usStates).openapi({
|
|
@@ -61924,6 +62138,7 @@ var languages = [
|
|
|
61924
62138
|
var de = {
|
|
61925
62139
|
"accounting.invoicePosted.entryDescription": "Buchungseintrag f\xFCr Rechnung {{invoiceId}}",
|
|
61926
62140
|
"accounting.transactionSettled.entryDescription": "Zahlungsabwicklung f\xFCr Rechnung {{invoiceId}}",
|
|
62141
|
+
"accounting.transactionRefunded.entryDescription": "R\xFCckerstattung f\xFCr Rechnung {{invoiceId}}",
|
|
61927
62142
|
"accounting.creditNotePosted.entryDescription": "Gutschrift {{creditNoteId}} f\xFCr Rechnung {{invoiceId}}",
|
|
61928
62143
|
"accounting.revrec.creditLineDescription": "Umsatz realisieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
61929
62144
|
"accounting.revrec.debitLineDescription": "Abgrenzungsposten reduzieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
@@ -61940,7 +62155,9 @@ var de = {
|
|
|
61940
62155
|
"invoices.outstandingProduct.descriptionPeriod": "Unbezahlter Betrag der Rechnung{{invoiceNumber}} vom {{periodStart}} bis {{periodEnd}}",
|
|
61941
62156
|
"invoices.outstandingProduct.name": "Offener Saldo",
|
|
61942
62157
|
"invoices.prorata.paymentForItem": "Anteilig berechneter Betrag f\xFCr",
|
|
62158
|
+
"invoices.prorata.paymentForItemFullPeriod": "Zahlung f\xFCr",
|
|
61943
62159
|
"invoices.prorata.refundForItem": "Anteilig erstatteter Betrag f\xFCr",
|
|
62160
|
+
"invoices.prorata.refundForItemFullPeriod": "Erstattung f\xFCr",
|
|
61944
62161
|
"subscriptions.closingChargeName": "Abschlussgeb\xFChr f\xFCr das Abonnement",
|
|
61945
62162
|
"subscriptions.correction": "Vorperiodische Anpassung",
|
|
61946
62163
|
"subscriptions.updates.addCoupon": "Gutschein hinzuf\xFCgen {{couponName}}",
|
|
@@ -61969,7 +62186,9 @@ var en = {
|
|
|
61969
62186
|
"invoices.outstandingProduct.descriptionPeriod": "Unpaid amount from the invoice{{invoiceNumber}} from {{periodStart}} to {{periodEnd}}",
|
|
61970
62187
|
"invoices.outstandingProduct.name": "Outstanding balance",
|
|
61971
62188
|
"invoices.prorata.paymentForItem": "Prorated payment for",
|
|
62189
|
+
"invoices.prorata.paymentForItemFullPeriod": "Payment for",
|
|
61972
62190
|
"invoices.prorata.refundForItem": "Prorated refund for",
|
|
62191
|
+
"invoices.prorata.refundForItemFullPeriod": "Refund for",
|
|
61973
62192
|
"subscriptions.closingChargeName": "Closing fee for subscription",
|
|
61974
62193
|
"subscriptions.correction": "Adjustment previous period",
|
|
61975
62194
|
"subscriptions.updates.addCoupon": "Add coupon {{couponName}}",
|
|
@@ -61989,6 +62208,7 @@ var en = {
|
|
|
61989
62208
|
"subscriptions.updates.updateCount.description.full.not_committed.not_invoiced": "Amount of {{amount}} not invoiced for the full period",
|
|
61990
62209
|
"accounting.invoicePosted.entryDescription": "Posting entry for Invoice {{invoiceId}} issued",
|
|
61991
62210
|
"accounting.transactionSettled.entryDescription": "Payment settlement for Invoice {{invoiceId}}",
|
|
62211
|
+
"accounting.transactionRefunded.entryDescription": "Refund for Invoice {{invoiceId}}",
|
|
61992
62212
|
"accounting.creditNotePosted.entryDescription": "Credit note {{creditNoteId}} for Invoice {{invoiceId}}",
|
|
61993
62213
|
"accounting.revrec.entryDescription": "Revenue recognition for schedule {{scheduleId}}, period {{periodStart}} - {{periodEnd}}",
|
|
61994
62214
|
"accounting.revrec.debitLineDescription": "Decrease deferred revenue \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
@@ -62004,6 +62224,7 @@ var en = {
|
|
|
62004
62224
|
var es = {
|
|
62005
62225
|
"accounting.invoicePosted.entryDescription": "Asiento contable para la factura {{invoiceId}}",
|
|
62006
62226
|
"accounting.transactionSettled.entryDescription": "Liquidaci\xF3n de pago para la factura {{invoiceId}}",
|
|
62227
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso de la factura {{invoiceId}}",
|
|
62007
62228
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para la factura {{invoiceId}}",
|
|
62008
62229
|
"accounting.revrec.creditLineDescription": "Reconocer ingresos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62009
62230
|
"accounting.revrec.debitLineDescription": "Disminuci\xF3n de ingresos diferidos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
@@ -62020,7 +62241,9 @@ var es = {
|
|
|
62020
62241
|
"invoices.outstandingProduct.descriptionPeriod": "Monto pendiente de la factura{{invoiceNumber}} del {{periodStart}} al {{periodEnd}}",
|
|
62021
62242
|
"invoices.outstandingProduct.name": "Saldo pendiente",
|
|
62022
62243
|
"invoices.prorata.paymentForItem": "Pago prorrateado por",
|
|
62244
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pago por",
|
|
62023
62245
|
"invoices.prorata.refundForItem": "Reembolso prorrateado por",
|
|
62246
|
+
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
62024
62247
|
"subscriptions.closingChargeName": "Cargo por cierre de suscripci\xF3n",
|
|
62025
62248
|
"subscriptions.correction": "Ajuste del periodo anterior",
|
|
62026
62249
|
"subscriptions.updates.addCoupon": "A\xF1adir cup\xF3n {{couponName}}",
|
|
@@ -62048,6 +62271,7 @@ var fr = {
|
|
|
62048
62271
|
"accounting.revrec.discountDebitLineDescription": "Diminution des remises diff\xE9r\xE9es \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62049
62272
|
"accounting.invoicePosted.entryDescription": "\xC9criture de comptabilisation pour la facture {{invoiceId}}",
|
|
62050
62273
|
"accounting.transactionSettled.entryDescription": "R\xE8glement de la facture {{invoiceId}}",
|
|
62274
|
+
"accounting.transactionRefunded.entryDescription": "Remboursement de la facture {{invoiceId}}",
|
|
62051
62275
|
"accounting.creditNotePosted.entryDescription": "Avoir {{creditNoteId}} pour la facture {{invoiceId}}",
|
|
62052
62276
|
"accounting.revrec.entryDescription": "Reconnaissance du chiffre d'affaires pour l'\xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodStart}} - {{periodEnd}}",
|
|
62053
62277
|
"creditNotes.refundChargeName": "Remboursement pour facture",
|
|
@@ -62060,7 +62284,9 @@ var fr = {
|
|
|
62060
62284
|
"invoices.outstandingProduct.descriptionPeriod": "Montant impay\xE9 de la facture{{invoiceNumber}} du {{periodStart}} au {{periodEnd}}",
|
|
62061
62285
|
"invoices.outstandingProduct.name": "Solde impay\xE9",
|
|
62062
62286
|
"invoices.prorata.paymentForItem": "Paiement au prorata pour",
|
|
62287
|
+
"invoices.prorata.paymentForItemFullPeriod": "Paiement pour",
|
|
62063
62288
|
"invoices.prorata.refundForItem": "Remboursement au prorata pour",
|
|
62289
|
+
"invoices.prorata.refundForItemFullPeriod": "Remboursement pour",
|
|
62064
62290
|
"subscriptions.closingChargeName": "Frais de cl\xF4ture pour abonnement",
|
|
62065
62291
|
"subscriptions.correction": "Ajustement p\xE9riode pr\xE9c\xE9dente",
|
|
62066
62292
|
"subscriptions.updates.addCoupon": "Ajout du coupon {{couponName}}",
|
|
@@ -62084,6 +62310,7 @@ var fr = {
|
|
|
62084
62310
|
var it = {
|
|
62085
62311
|
"accounting.invoicePosted.entryDescription": "Registrazione contabile per la fattura {{invoiceId}}",
|
|
62086
62312
|
"accounting.transactionSettled.entryDescription": "Regolamento pagamento per la fattura {{invoiceId}}",
|
|
62313
|
+
"accounting.transactionRefunded.entryDescription": "Rimborso per la fattura {{invoiceId}}",
|
|
62087
62314
|
"accounting.creditNotePosted.entryDescription": "Nota di credito {{creditNoteId}} per la fattura {{invoiceId}}",
|
|
62088
62315
|
"accounting.revrec.creditLineDescription": "Riconoscere i ricavi \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62089
62316
|
"accounting.revrec.debitLineDescription": "Diminuzione dei ricavi differiti \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
@@ -62100,7 +62327,9 @@ var it = {
|
|
|
62100
62327
|
"invoices.outstandingProduct.descriptionPeriod": "Importo insoluto della fattura{{invoiceNumber}} dal {{periodStart}} al {{periodEnd}}",
|
|
62101
62328
|
"invoices.outstandingProduct.name": "Saldo insoluto",
|
|
62102
62329
|
"invoices.prorata.paymentForItem": "Pagamento proporzionale per",
|
|
62330
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pagamento per",
|
|
62103
62331
|
"invoices.prorata.refundForItem": "Rimborso proporzionale per",
|
|
62332
|
+
"invoices.prorata.refundForItemFullPeriod": "Rimborso per",
|
|
62104
62333
|
"subscriptions.closingChargeName": "Costo di chiusura per abbonamento",
|
|
62105
62334
|
"subscriptions.correction": "Correzione periodo precedente",
|
|
62106
62335
|
"subscriptions.updates.addCoupon": "Aggiungi coupon {{couponName}}",
|
|
@@ -62124,6 +62353,7 @@ var it = {
|
|
|
62124
62353
|
var nl = {
|
|
62125
62354
|
"accounting.invoicePosted.entryDescription": "Boekingsregel voor factuur {{invoiceId}}",
|
|
62126
62355
|
"accounting.transactionSettled.entryDescription": "Betalingsafwikkeling voor factuur {{invoiceId}}",
|
|
62356
|
+
"accounting.transactionRefunded.entryDescription": "Terugbetaling voor factuur {{invoiceId}}",
|
|
62127
62357
|
"accounting.creditNotePosted.entryDescription": "Creditnota {{creditNoteId}} voor factuur {{invoiceId}}",
|
|
62128
62358
|
"accounting.revrec.creditLineDescription": "Omzet erkennen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62129
62359
|
"accounting.revrec.debitLineDescription": "Uitgestelde omzet verlagen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
@@ -62140,7 +62370,9 @@ var nl = {
|
|
|
62140
62370
|
"invoices.outstandingProduct.descriptionPeriod": "Onbetaald bedrag van de factuur{{invoiceNumber}} van {{periodStart}} tot {{periodEnd}}",
|
|
62141
62371
|
"invoices.outstandingProduct.name": "Openstaand saldo",
|
|
62142
62372
|
"invoices.prorata.paymentForItem": "Gedeeltelijke betaling voor",
|
|
62373
|
+
"invoices.prorata.paymentForItemFullPeriod": "Betaling voor",
|
|
62143
62374
|
"invoices.prorata.refundForItem": "Gedeeltelijke terugbetaling voor",
|
|
62375
|
+
"invoices.prorata.refundForItemFullPeriod": "Terugbetaling voor",
|
|
62144
62376
|
"subscriptions.closingChargeName": "Afsluitkosten voor abonnement",
|
|
62145
62377
|
"subscriptions.correction": "Aanpassing vorige periode",
|
|
62146
62378
|
"subscriptions.updates.addCoupon": "Coupon toevoegen {{couponName}}",
|
|
@@ -62164,6 +62396,7 @@ var nl = {
|
|
|
62164
62396
|
var pl = {
|
|
62165
62397
|
"accounting.invoicePosted.entryDescription": "Zapis ksi\u0119gowy dla faktury {{invoiceId}}",
|
|
62166
62398
|
"accounting.transactionSettled.entryDescription": "Rozliczenie p\u0142atno\u015Bci dla faktury {{invoiceId}}",
|
|
62399
|
+
"accounting.transactionRefunded.entryDescription": "Zwrot za faktur\u0119 {{invoiceId}}",
|
|
62167
62400
|
"accounting.creditNotePosted.entryDescription": "Nota kredytowa {{creditNoteId}} dla faktury {{invoiceId}}",
|
|
62168
62401
|
"accounting.revrec.creditLineDescription": "Rozpoznanie przychodu \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62169
62402
|
"accounting.revrec.debitLineDescription": "Zmniejszenie przychod\xF3w przysz\u0142ych okres\xF3w \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
@@ -62180,7 +62413,9 @@ var pl = {
|
|
|
62180
62413
|
"invoices.outstandingProduct.descriptionPeriod": "Nieop\u0142acona kwota z faktury{{invoiceNumber}} od {{periodStart}} do {{periodEnd}}",
|
|
62181
62414
|
"invoices.outstandingProduct.name": "Niezap\u0142acone saldo",
|
|
62182
62415
|
"invoices.prorata.paymentForItem": "P\u0142atno\u015B\u0107 proporcjonalna za",
|
|
62416
|
+
"invoices.prorata.paymentForItemFullPeriod": "P\u0142atno\u015B\u0107 za",
|
|
62183
62417
|
"invoices.prorata.refundForItem": "Zwrot proporcjonalny za",
|
|
62418
|
+
"invoices.prorata.refundForItemFullPeriod": "Zwrot za",
|
|
62184
62419
|
"subscriptions.closingChargeName": "Op\u0142ata za zamkni\u0119cie subskrypcji",
|
|
62185
62420
|
"subscriptions.correction": "Korekta poprzedniego okresu",
|
|
62186
62421
|
"subscriptions.updates.addCoupon": "Dodaj kupon {{couponName}}",
|
|
@@ -62204,6 +62439,7 @@ var pl = {
|
|
|
62204
62439
|
var pt = {
|
|
62205
62440
|
"accounting.invoicePosted.entryDescription": "Lan\xE7amento cont\xE1bil para a fatura {{invoiceId}}",
|
|
62206
62441
|
"accounting.transactionSettled.entryDescription": "Liquida\xE7\xE3o de pagamento para a fatura {{invoiceId}}",
|
|
62442
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso da fatura {{invoiceId}}",
|
|
62207
62443
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para a fatura {{invoiceId}}",
|
|
62208
62444
|
"accounting.revrec.creditLineDescription": "Reconhecer receita \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62209
62445
|
"accounting.revrec.debitLineDescription": "Diminui\xE7\xE3o da receita diferida \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
@@ -62220,7 +62456,9 @@ var pt = {
|
|
|
62220
62456
|
"invoices.outstandingProduct.descriptionPeriod": "Valor em aberto da fatura{{invoiceNumber}} de {{periodStart}} a {{periodEnd}}",
|
|
62221
62457
|
"invoices.outstandingProduct.name": "Saldo em aberto",
|
|
62222
62458
|
"invoices.prorata.paymentForItem": "Pagamento proporcional por",
|
|
62459
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pagamento por",
|
|
62223
62460
|
"invoices.prorata.refundForItem": "Reembolso proporcional por",
|
|
62461
|
+
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
62224
62462
|
"subscriptions.closingChargeName": "Taxa de encerramento da assinatura",
|
|
62225
62463
|
"subscriptions.correction": "Ajuste do per\xEDodo anterior",
|
|
62226
62464
|
"subscriptions.updates.addCoupon": "Adicionar cupom {{couponName}}",
|
|
@@ -62438,6 +62676,9 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
|
|
|
62438
62676
|
|
|
62439
62677
|
// ../hyperline-mcp/build/server/server.js
|
|
62440
62678
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
62679
|
+
var defaultToolOutputSchema = {
|
|
62680
|
+
result: external_exports.unknown()
|
|
62681
|
+
};
|
|
62441
62682
|
|
|
62442
62683
|
// ../hyperline-mcp/build/session/sessionKey.js
|
|
62443
62684
|
import { createHmac } from "node:crypto";
|