@hyperline/cli 0.1.0-build.1.62e33b0 → 0.1.0-build.1.63ae408
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 +443 -39
- package/package.json +2 -2
|
@@ -34894,10 +34894,10 @@ var require_shared = __commonJS({
|
|
|
34894
34894
|
ZodId: () => ZodId,
|
|
34895
34895
|
ZodTranslationsSchemaFn: () => ZodTranslationsSchemaFn
|
|
34896
34896
|
});
|
|
34897
|
-
var
|
|
34897
|
+
var import_zod20 = require_lib();
|
|
34898
34898
|
var countryIds2 = ["all", ...countries.map(({ id }) => id)];
|
|
34899
|
-
var ZodId =
|
|
34900
|
-
var ZodTranslationsSchemaFn = (schema) =>
|
|
34899
|
+
var ZodId = import_zod20.z.enum(countryIds2);
|
|
34900
|
+
var ZodTranslationsSchemaFn = (schema) => import_zod20.z.record(import_zod20.z.string(), schema.optional());
|
|
34901
34901
|
var UsStates = [
|
|
34902
34902
|
{ id: "AA", name: "Armed Forces Americas" },
|
|
34903
34903
|
{ id: "AE", name: "Armed Forces Europe" },
|
|
@@ -37934,7 +37934,7 @@ Examples:
|
|
|
37934
37934
|
queryParamKeys: ["take", "skip"]
|
|
37935
37935
|
});
|
|
37936
37936
|
});
|
|
37937
|
-
resource.command("get").description(`Retrieve a specific bank account by its ID. Returns bank account details
|
|
37937
|
+
resource.command("get").description(`Retrieve a specific bank account by its ID. Returns masked bank account details, account type, balance, and currency.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
37938
37938
|
Examples:
|
|
37939
37939
|
hyperline bank-accounts get --id <id>`).action(async (opts) => {
|
|
37940
37940
|
const ctx = resource.parent?.opts()._ctx;
|
|
@@ -37952,6 +37952,31 @@ Examples:
|
|
|
37952
37952
|
queryParamKeys: []
|
|
37953
37953
|
});
|
|
37954
37954
|
});
|
|
37955
|
+
resource.command("list-bank-account-transactions").description(`List open banking transactions for a specific bank account. Paginated with limit/cursor.`).requiredOption("--id <value>", `id parameter`).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.`).addHelpText("after", `
|
|
37956
|
+
Examples:
|
|
37957
|
+
hyperline bank-accounts list-bank-account-transactions --id <id>
|
|
37958
|
+
hyperline bank-accounts list-bank-account-transactions --id <id> --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
37959
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
37960
|
+
if (!ctx) {
|
|
37961
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
37962
|
+
process.exit(1);
|
|
37963
|
+
}
|
|
37964
|
+
const args = {};
|
|
37965
|
+
if (opts.id !== void 0)
|
|
37966
|
+
args.id = opts.id;
|
|
37967
|
+
if (opts.cursor !== void 0)
|
|
37968
|
+
args.cursor = opts.cursor;
|
|
37969
|
+
if (opts.includeTotal !== void 0)
|
|
37970
|
+
args.include_total = opts.includeTotal;
|
|
37971
|
+
if (opts.limit !== void 0)
|
|
37972
|
+
args.limit = Number(opts.limit);
|
|
37973
|
+
await ctx.execute({
|
|
37974
|
+
method: "GET",
|
|
37975
|
+
path: "/v1/bank-accounts/{id}/transactions",
|
|
37976
|
+
args,
|
|
37977
|
+
queryParamKeys: ["limit", "cursor", "include_total"]
|
|
37978
|
+
});
|
|
37979
|
+
});
|
|
37955
37980
|
}
|
|
37956
37981
|
|
|
37957
37982
|
// build/commands/generated/companies.js
|
|
@@ -38020,7 +38045,7 @@ Examples:
|
|
|
38020
38045
|
queryParamKeys: ["take", "skip"]
|
|
38021
38046
|
});
|
|
38022
38047
|
});
|
|
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", `
|
|
38048
|
+
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
38049
|
Examples:
|
|
38025
38050
|
hyperline coupons create --name <name> --type <type>
|
|
38026
38051
|
hyperline coupons create --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38039,6 +38064,10 @@ Examples:
|
|
|
38039
38064
|
args.expiration_date = opts.expirationDate;
|
|
38040
38065
|
if (opts.productIds !== void 0)
|
|
38041
38066
|
args.product_ids = opts.productIds;
|
|
38067
|
+
if (opts.repeat !== void 0)
|
|
38068
|
+
args.repeat = opts.repeat;
|
|
38069
|
+
if (opts.duration !== void 0)
|
|
38070
|
+
args.duration = opts.duration;
|
|
38042
38071
|
if (opts.type !== void 0)
|
|
38043
38072
|
args.type = opts.type;
|
|
38044
38073
|
if (opts.currency !== void 0)
|
|
@@ -38074,7 +38103,7 @@ Examples:
|
|
|
38074
38103
|
queryParamKeys: []
|
|
38075
38104
|
});
|
|
38076
38105
|
});
|
|
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", `
|
|
38106
|
+
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
38107
|
Examples:
|
|
38079
38108
|
hyperline coupons update --id <id> --name <name> --type <type>
|
|
38080
38109
|
hyperline coupons update --id <id> --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38095,6 +38124,10 @@ Examples:
|
|
|
38095
38124
|
args.expiration_date = opts.expirationDate;
|
|
38096
38125
|
if (opts.productIds !== void 0)
|
|
38097
38126
|
args.product_ids = opts.productIds;
|
|
38127
|
+
if (opts.repeat !== void 0)
|
|
38128
|
+
args.repeat = opts.repeat;
|
|
38129
|
+
if (opts.duration !== void 0)
|
|
38130
|
+
args.duration = opts.duration;
|
|
38098
38131
|
if (opts.type !== void 0)
|
|
38099
38132
|
args.type = opts.type;
|
|
38100
38133
|
if (opts.currency !== void 0)
|
|
@@ -38744,13 +38777,17 @@ Customer type.
|
|
|
38744
38777
|
- \`corporate\`: The customer is a business entity.
|
|
38745
38778
|
- \`person\`: The customer is a natural person.
|
|
38746
38779
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38747
|
-
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--
|
|
38780
|
+
`).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.
|
|
38781
|
+
|
|
38782
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38783
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38784
|
+
`).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("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <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>", `
|
|
38748
38785
|
How customer invoices are issued from the parent organisation.
|
|
38749
38786
|
|
|
38750
38787
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
38751
38788
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
38752
38789
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
38753
|
-
`).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", `
|
|
38790
|
+
`).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", `
|
|
38754
38791
|
Examples:
|
|
38755
38792
|
hyperline customers create-customer
|
|
38756
38793
|
hyperline customers create-customer --name <name> --type <type>
|
|
@@ -38769,10 +38806,14 @@ Examples:
|
|
|
38769
38806
|
args.currency = opts.currency;
|
|
38770
38807
|
if (opts.taxIds !== void 0)
|
|
38771
38808
|
args.tax_ids = opts.taxIds;
|
|
38809
|
+
if (opts.taxability !== void 0)
|
|
38810
|
+
args.taxability = opts.taxability;
|
|
38772
38811
|
if (opts.registrationNumber !== void 0)
|
|
38773
38812
|
args.registration_number = opts.registrationNumber;
|
|
38774
38813
|
if (opts.externalId !== void 0)
|
|
38775
38814
|
args.external_id = opts.externalId;
|
|
38815
|
+
if (opts.domain !== void 0)
|
|
38816
|
+
args.domain = opts.domain;
|
|
38776
38817
|
if (opts.invoicingEntityId !== void 0)
|
|
38777
38818
|
args.invoicing_entity_id = opts.invoicingEntityId;
|
|
38778
38819
|
if (opts.billingAddress !== void 0)
|
|
@@ -38805,6 +38846,10 @@ Examples:
|
|
|
38805
38846
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
38806
38847
|
if (opts.priceBookId !== void 0)
|
|
38807
38848
|
args.price_book_id = opts.priceBookId;
|
|
38849
|
+
if (opts.ownerId !== void 0)
|
|
38850
|
+
args.owner_id = opts.ownerId;
|
|
38851
|
+
if (opts.followerIds !== void 0)
|
|
38852
|
+
args.follower_ids = opts.followerIds;
|
|
38808
38853
|
if (opts.taxRateCustom !== void 0)
|
|
38809
38854
|
args.tax_rate_custom = Number(opts.taxRateCustom);
|
|
38810
38855
|
if (opts.customPaymentDelay !== void 0)
|
|
@@ -38863,13 +38908,17 @@ Customer type.
|
|
|
38863
38908
|
- \`corporate\`: The customer is a business entity.
|
|
38864
38909
|
- \`person\`: The customer is a natural person.
|
|
38865
38910
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38866
|
-
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--
|
|
38911
|
+
`).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.
|
|
38912
|
+
|
|
38913
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38914
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38915
|
+
`).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("--domain <value>", `Customer domain. If not defined, it is inferred from the billing email.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <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>", `
|
|
38867
38916
|
How customer invoices are issued from the parent organisation.
|
|
38868
38917
|
|
|
38869
38918
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
38870
38919
|
- \`every_invoice\`: Customer invoices will be issued from the organisation individually.
|
|
38871
38920
|
- \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
|
|
38872
|
-
`).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", `
|
|
38921
|
+
`).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", `
|
|
38873
38922
|
Examples:
|
|
38874
38923
|
hyperline customers update --id <id>
|
|
38875
38924
|
hyperline customers update --id <id> --name <name> --type <type>
|
|
@@ -38890,10 +38939,14 @@ Examples:
|
|
|
38890
38939
|
args.currency = opts.currency;
|
|
38891
38940
|
if (opts.taxIds !== void 0)
|
|
38892
38941
|
args.tax_ids = opts.taxIds;
|
|
38942
|
+
if (opts.taxability !== void 0)
|
|
38943
|
+
args.taxability = opts.taxability;
|
|
38893
38944
|
if (opts.registrationNumber !== void 0)
|
|
38894
38945
|
args.registration_number = opts.registrationNumber;
|
|
38895
38946
|
if (opts.externalId !== void 0)
|
|
38896
38947
|
args.external_id = opts.externalId;
|
|
38948
|
+
if (opts.domain !== void 0)
|
|
38949
|
+
args.domain = opts.domain;
|
|
38897
38950
|
if (opts.invoicingEntityId !== void 0)
|
|
38898
38951
|
args.invoicing_entity_id = opts.invoicingEntityId;
|
|
38899
38952
|
if (opts.billingAddress !== void 0)
|
|
@@ -38928,6 +38981,10 @@ Examples:
|
|
|
38928
38981
|
args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
|
|
38929
38982
|
if (opts.priceBookId !== void 0)
|
|
38930
38983
|
args.price_book_id = opts.priceBookId;
|
|
38984
|
+
if (opts.ownerId !== void 0)
|
|
38985
|
+
args.owner_id = opts.ownerId;
|
|
38986
|
+
if (opts.followerIds !== void 0)
|
|
38987
|
+
args.follower_ids = opts.followerIds;
|
|
38931
38988
|
if (opts.taxRateCustom !== void 0)
|
|
38932
38989
|
args.tax_rate_custom = Number(opts.taxRateCustom);
|
|
38933
38990
|
if (opts.customPaymentDelay !== void 0)
|
|
@@ -39592,6 +39649,7 @@ Export name.
|
|
|
39592
39649
|
- \`draft_invoices\`: Export all draft invoices, with customer and product information.
|
|
39593
39650
|
- \`open_invoices\`: Export all open invoices, with customer and product information.
|
|
39594
39651
|
- \`live_subscriptions\`: List of all active subscriptions line by line.
|
|
39652
|
+
- \`credit_balances\`: Monthly credit balance roll-forward per customer and credit type (opening, top-ups, consumption, expiry, closing).
|
|
39595
39653
|
`).requiredOption("--file-type <value>", `
|
|
39596
39654
|
Export file type.
|
|
39597
39655
|
|
|
@@ -40169,7 +40227,7 @@ Examples:
|
|
|
40169
40227
|
- \`archived\`: A previous version of an invoice.
|
|
40170
40228
|
- \`charged_on_parent\`: Invoice is charged on the parent customer.
|
|
40171
40229
|
- \`pending_parent_concat\`: Invoice is pending invoices concatenation on the parent customer to be grouped.
|
|
40172
|
-
- \`uncollectible\`: Invoice is uncollectible (bad debt).
|
|
40230
|
+
- \`uncollectible\`: Invoice is uncollectible (bad debt). Only metadata (properties, custom_note, custom_properties) can be updated in this status.
|
|
40173
40231
|
`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the invoice.`).option("--number <value>", `Invoice number. If specified, the invoice will be considered as imported from an external source and the number will not be generated by Hyperline. You are responsible for avoiding duplicates and ensuring it does not impact the numbering sequence in Hyperline.`).option("--type <value>", `Type of the invoice.
|
|
40174
40232
|
|
|
40175
40233
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
@@ -40184,7 +40242,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
40184
40242
|
|
|
40185
40243
|
- \`current\`: Use the current default payment method of the customer.
|
|
40186
40244
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
40187
|
-
`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--emitted-at <value>", `Issue date of the invoice.`).option("--due-at <value>", `Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.`).option("--settled-at <value>", `Date the invoice was fully paid.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).requiredOption("--line-items <value>", `line_items`).option("--transactions <value>", `transactions`).option("--coupons <value>", `coupons`).addHelpText("after", `
|
|
40245
|
+
`).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", `
|
|
40188
40246
|
Examples:
|
|
40189
40247
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
40190
40248
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -40237,6 +40295,8 @@ Examples:
|
|
|
40237
40295
|
args.settled_at = opts.settledAt;
|
|
40238
40296
|
if (opts.properties !== void 0)
|
|
40239
40297
|
args.properties = opts.properties;
|
|
40298
|
+
if (opts.customProperties !== void 0)
|
|
40299
|
+
args.custom_properties = opts.customProperties;
|
|
40240
40300
|
if (opts.lineItems !== void 0)
|
|
40241
40301
|
args.line_items = opts.lineItems;
|
|
40242
40302
|
if (opts.transactions !== void 0)
|
|
@@ -40409,7 +40469,7 @@ Examples:
|
|
|
40409
40469
|
queryParamKeys: []
|
|
40410
40470
|
});
|
|
40411
40471
|
});
|
|
40412
|
-
resource.command("update").description(`Update
|
|
40472
|
+
resource.command("update").description(`Update an invoice. Draft/grace_period allow modifying line items, dates, and metadata before finalization. Finalized invoices are restricted to metadata (paid: custom_note; uncollectible: properties/custom_note/custom_properties).`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Type of the invoice.
|
|
40413
40473
|
|
|
40414
40474
|
- \`invoice\`: Legal invoice to be paid by your customer.
|
|
40415
40475
|
- \`credit_note\`: Legal credit note cancelling an invoice and refunding your customer.
|
|
@@ -40418,7 +40478,7 @@ Examples:
|
|
|
40418
40478
|
|
|
40419
40479
|
- \`auto\`: Tax is automatically computed and applied.
|
|
40420
40480
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
40421
|
-
`).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", `
|
|
40481
|
+
`).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", `
|
|
40422
40482
|
Examples:
|
|
40423
40483
|
hyperline invoices update --id <id>
|
|
40424
40484
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -40459,6 +40519,8 @@ Examples:
|
|
|
40459
40519
|
args.bank_account_id = opts.bankAccountId;
|
|
40460
40520
|
if (opts.properties !== void 0)
|
|
40461
40521
|
args.properties = opts.properties;
|
|
40522
|
+
if (opts.customProperties !== void 0)
|
|
40523
|
+
args.custom_properties = opts.customProperties;
|
|
40462
40524
|
if (opts.customer !== void 0)
|
|
40463
40525
|
args.customer = opts.customer;
|
|
40464
40526
|
await ctx.execute({
|
|
@@ -40579,7 +40641,7 @@ Examples:
|
|
|
40579
40641
|
queryParamKeys: []
|
|
40580
40642
|
});
|
|
40581
40643
|
});
|
|
40582
|
-
resource.command("delete-invoice-transaction").description(`Delete a scheduled transaction from an invoice
|
|
40644
|
+
resource.command("delete-invoice-transaction").description(`Delete a scheduled transaction or wallet debit from an invoice.`).requiredOption("--id <value>", `id parameter`).requiredOption("--transaction-id <value>", `transactionId parameter`).option("--yes", "Skip confirmation").addHelpText("after", `
|
|
40583
40645
|
Examples:
|
|
40584
40646
|
hyperline invoices-transactions delete-invoice-transaction --id <id> --transaction-id <transactionId>
|
|
40585
40647
|
hyperline invoices-transactions delete-invoice-transaction --id <id> --transaction-id <transactionId> --output json`).action(async (opts) => {
|
|
@@ -40651,7 +40713,7 @@ Examples:
|
|
|
40651
40713
|
queryParamKeys: []
|
|
40652
40714
|
});
|
|
40653
40715
|
});
|
|
40654
|
-
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", `
|
|
40716
|
+
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", `
|
|
40655
40717
|
Examples:
|
|
40656
40718
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
40657
40719
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -40730,6 +40792,8 @@ Examples:
|
|
|
40730
40792
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40731
40793
|
if (opts.isDefault !== void 0)
|
|
40732
40794
|
args.is_default = true;
|
|
40795
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40796
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40733
40797
|
await ctx.execute({
|
|
40734
40798
|
method: "POST",
|
|
40735
40799
|
path: "/v1/invoicing-entities",
|
|
@@ -40737,7 +40801,7 @@ Examples:
|
|
|
40737
40801
|
queryParamKeys: []
|
|
40738
40802
|
});
|
|
40739
40803
|
});
|
|
40740
|
-
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", `
|
|
40804
|
+
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", `
|
|
40741
40805
|
Examples:
|
|
40742
40806
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
40743
40807
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -40808,6 +40872,8 @@ Examples:
|
|
|
40808
40872
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40809
40873
|
if (opts.isDefault !== void 0)
|
|
40810
40874
|
args.is_default = true;
|
|
40875
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40876
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40811
40877
|
await ctx.execute({
|
|
40812
40878
|
method: "PUT",
|
|
40813
40879
|
path: "/v1/invoicing-entities/{id}",
|
|
@@ -41216,7 +41282,12 @@ Examples:
|
|
|
41216
41282
|
]
|
|
41217
41283
|
});
|
|
41218
41284
|
});
|
|
41219
|
-
resource.command("create").description(`Create a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.`).requiredOption("--name <value>", `Product name.`).option("--description <value>", `Product description.`).option("--description-display-interval-dates", `Indicates if the dates of the interval should be automatically added in the product description on the invoices.`).option("--public-description <value>", `Public description of the product.`).option("--translations <value>", `Product name and description translations.`).option("--is-available-on-demand", `is_available_on_demand`).option("--is-available-on-subscription", `is_available_on_subscription`).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("--accounting <value>", `Mapping invoicing entity ID/accounting settings.`).requiredOption("--type <value>", `Product type for fixed fee products.`).requiredOption("--price-configurations <value>", `Price configurations for the product.`).option("--aggregator <value>", `Aggregator configuration to automatically count seats from billable events. Only count aggregators are supported for seat products.`).option("--aggregator-id <value>", `ID of an existing aggregator to link to this product.`).option("--unit-name <value>", `Name of the unit (e.g., 'user', 'seat').`).option("--is-connected-seat-item", `When true, the seat count is automatically synced from an external source (e.g., CRM users).`).option("--credit-aggregators <value>", `Multiple aggregators with weights for multi-aggregator credit consumption. Cannot be used together with aggregator or aggregator_id.`).option("--low-credits-threshold <number>", `Threshold indicating a low level of credits.`).option("--
|
|
41285
|
+
resource.command("create").description(`Create a new product with name, type (flat_fee, per_unit, usage, seat, etc.), and pricing configuration.`).requiredOption("--name <value>", `Product name.`).option("--description <value>", `Product description.`).option("--description-display-interval-dates", `Indicates if the dates of the interval should be automatically added in the product description on the invoices.`).option("--public-description <value>", `Public description of the product.`).option("--translations <value>", `Product name and description translations.`).option("--is-available-on-demand", `is_available_on_demand`).option("--is-available-on-subscription", `is_available_on_subscription`).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("--accounting <value>", `Mapping invoicing entity ID/accounting settings.`).requiredOption("--type <value>", `Product type for fixed fee products.`).requiredOption("--price-configurations <value>", `Price configurations for the product.`).option("--aggregator <value>", `Aggregator configuration to automatically count seats from billable events. Only count aggregators are supported for seat products.`).option("--aggregator-id <value>", `ID of an existing aggregator to link to this product.`).option("--unit-name <value>", `Name of the unit (e.g., 'user', 'seat').`).option("--is-connected-seat-item", `When true, the seat count is automatically synced from an external source (e.g., CRM users).`).option("--credit-aggregators <value>", `Multiple aggregators with weights for multi-aggregator credit consumption. Cannot be used together with aggregator or aggregator_id.`).option("--low-credits-threshold <number>", `Threshold indicating a low level of credits.`).option("--credits-grant-mode <value>", `
|
|
41286
|
+
How the periodic credit allowance is granted for partial billing periods.
|
|
41287
|
+
|
|
41288
|
+
- \`prorated\` (default): the granted credits are prorated to the elapsed period.
|
|
41289
|
+
- \`full_allowance\`: the full allowance is always granted (the invoice remains prorated).
|
|
41290
|
+
`).option("--display-mode <value>", `How bundle items are displayed on invoices.`).option("--exclusive-items-enabled", `When true, only one item in the bundle can be active at a time.`).option("--bundle-items <value>", `Products included in this bundle. Percentages must sum to 100.`).addHelpText("after", `
|
|
41220
41291
|
Examples:
|
|
41221
41292
|
hyperline products create --name <name> --type <type> --price-configurations <price_configurations>
|
|
41222
41293
|
hyperline products create --name <name> --type <type> --price-configurations <price_configurations> --description <description> --description-display-interval-dates
|
|
@@ -41251,6 +41322,8 @@ Examples:
|
|
|
41251
41322
|
args.unit_name = opts.unitName;
|
|
41252
41323
|
if (opts.creditAggregators !== void 0)
|
|
41253
41324
|
args.credit_aggregators = opts.creditAggregators;
|
|
41325
|
+
if (opts.creditsGrantMode !== void 0)
|
|
41326
|
+
args.credits_grant_mode = opts.creditsGrantMode;
|
|
41254
41327
|
if (opts.displayMode !== void 0)
|
|
41255
41328
|
args.display_mode = opts.displayMode;
|
|
41256
41329
|
if (opts.bundleItems !== void 0)
|
|
@@ -41376,18 +41449,18 @@ Examples:
|
|
|
41376
41449
|
// build/commands/generated/quotes.js
|
|
41377
41450
|
function registerQuotesCommands(parent) {
|
|
41378
41451
|
const resource = parent.command("quotes").description("Manage quotes");
|
|
41379
|
-
resource.command("create").description(`Create a new quote for a customer
|
|
41452
|
+
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. When creating from a quote template, do not combine \`template_id\` with subscription overrides for dates, contract terms, products, phases, coupons, discounts, prices, or seats in this call: first create the quote from \`template_id\` so template terms and contract documents are copied, then call \`update_quote\` with the subscription payload.`).option("--status <value>", `
|
|
41380
41453
|
Quote status.
|
|
41381
41454
|
|
|
41382
41455
|
- \`draft\`: The quote is a draft.
|
|
41383
41456
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
41384
41457
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
41385
|
-
`).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.
|
|
41458
|
+
`).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("--contract-clause-ids <value>", `IDs of the contract clauses used in the quote terms.`).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.
|
|
41386
41459
|
|
|
41387
41460
|
- \`all\`: Display all pricing tiers.
|
|
41388
41461
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41389
41462
|
- \`none\`: Hide all pricing tiers.
|
|
41390
|
-
`).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", `
|
|
41463
|
+
`).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", `
|
|
41391
41464
|
Examples:
|
|
41392
41465
|
hyperline quotes create --customer-id <customer_id>
|
|
41393
41466
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -41414,6 +41487,8 @@ Examples:
|
|
|
41414
41487
|
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41415
41488
|
if (opts.collectCustomPropertyIds !== void 0)
|
|
41416
41489
|
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41490
|
+
if (opts.contractClauseIds !== void 0)
|
|
41491
|
+
args.contract_clause_ids = opts.contractClauseIds;
|
|
41417
41492
|
if (opts.requireTaxId !== void 0)
|
|
41418
41493
|
args.require_tax_id = opts.requireTaxId;
|
|
41419
41494
|
if (opts.displayQuoteValue !== void 0)
|
|
@@ -41432,12 +41507,16 @@ Examples:
|
|
|
41432
41507
|
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41433
41508
|
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41434
41509
|
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41510
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41511
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41435
41512
|
if (opts.templateId !== void 0)
|
|
41436
41513
|
args.template_id = opts.templateId;
|
|
41437
41514
|
if (opts.expiresAt !== void 0)
|
|
41438
41515
|
args.expires_at = opts.expiresAt;
|
|
41439
41516
|
if (opts.subscription !== void 0)
|
|
41440
41517
|
args.subscription = opts.subscription;
|
|
41518
|
+
if (opts.invoice !== void 0)
|
|
41519
|
+
args.invoice = opts.invoice;
|
|
41441
41520
|
if (opts.amount !== void 0)
|
|
41442
41521
|
args.amount = Number(opts.amount);
|
|
41443
41522
|
await ctx.execute({
|
|
@@ -41666,6 +41745,73 @@ Examples:
|
|
|
41666
41745
|
queryParamKeys: []
|
|
41667
41746
|
});
|
|
41668
41747
|
});
|
|
41748
|
+
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. For quotes created from \`template_id\`, use this tool for subscription overrides such as dates, contract terms, products, phases, coupons, discounts, prices, seats, and subscription custom properties. Omit \`terms\`, \`comments\`, and \`contract_clause_ids\` unless deliberately overriding template content.`).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("--contract-clause-ids <value>", `IDs of the contract clauses used in the quote terms.`).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.
|
|
41749
|
+
|
|
41750
|
+
- \`all\`: Display all pricing tiers.
|
|
41751
|
+
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41752
|
+
- \`none\`: Hide all pricing tiers.
|
|
41753
|
+
`).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("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <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", `
|
|
41754
|
+
Examples:
|
|
41755
|
+
hyperline quotes update --id <id>
|
|
41756
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
41757
|
+
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
41758
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41759
|
+
if (!ctx) {
|
|
41760
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41761
|
+
process.exit(1);
|
|
41762
|
+
}
|
|
41763
|
+
const args = {};
|
|
41764
|
+
if (opts.id !== void 0)
|
|
41765
|
+
args.id = opts.id;
|
|
41766
|
+
if (opts.ownerEmail !== void 0)
|
|
41767
|
+
args.owner_email = opts.ownerEmail;
|
|
41768
|
+
if (opts.comments !== void 0)
|
|
41769
|
+
args.comments = opts.comments;
|
|
41770
|
+
if (opts.terms !== void 0)
|
|
41771
|
+
args.terms = opts.terms;
|
|
41772
|
+
if (opts.collectPaymentDetails !== void 0)
|
|
41773
|
+
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41774
|
+
if (opts.collectCustomPropertyIds !== void 0)
|
|
41775
|
+
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41776
|
+
if (opts.contractClauseIds !== void 0)
|
|
41777
|
+
args.contract_clause_ids = opts.contractClauseIds;
|
|
41778
|
+
if (opts.requireTaxId !== void 0)
|
|
41779
|
+
args.require_tax_id = opts.requireTaxId;
|
|
41780
|
+
if (opts.displayQuoteValue !== void 0)
|
|
41781
|
+
args.display_quote_value = opts.displayQuoteValue;
|
|
41782
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
41783
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
41784
|
+
if (opts.displayTaxes !== void 0)
|
|
41785
|
+
args.display_taxes = opts.displayTaxes;
|
|
41786
|
+
if (opts.displayPriceTiers !== void 0)
|
|
41787
|
+
args.display_price_tiers = opts.displayPriceTiers;
|
|
41788
|
+
if (opts.displayPhaseValue !== void 0)
|
|
41789
|
+
args.display_phase_value = opts.displayPhaseValue;
|
|
41790
|
+
if (opts.displayFirstInvoiceAmount !== void 0)
|
|
41791
|
+
args.display_first_invoice_amount = opts.displayFirstInvoiceAmount;
|
|
41792
|
+
if (opts.displayDocumentsInPreview !== void 0)
|
|
41793
|
+
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41794
|
+
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41795
|
+
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41796
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41797
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41798
|
+
if (opts.crmOpportunityId !== void 0)
|
|
41799
|
+
args.crm_opportunity_id = opts.crmOpportunityId;
|
|
41800
|
+
if (opts.expiresAt !== void 0)
|
|
41801
|
+
args.expires_at = opts.expiresAt;
|
|
41802
|
+
if (opts.subscription !== void 0)
|
|
41803
|
+
args.subscription = opts.subscription;
|
|
41804
|
+
if (opts.invoice !== void 0)
|
|
41805
|
+
args.invoice = opts.invoice;
|
|
41806
|
+
if (opts.amount !== void 0)
|
|
41807
|
+
args.amount = Number(opts.amount);
|
|
41808
|
+
await ctx.execute({
|
|
41809
|
+
method: "PATCH",
|
|
41810
|
+
path: "/v1/quotes/{id}",
|
|
41811
|
+
args,
|
|
41812
|
+
queryParamKeys: []
|
|
41813
|
+
});
|
|
41814
|
+
});
|
|
41669
41815
|
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", `
|
|
41670
41816
|
Examples:
|
|
41671
41817
|
hyperline quotes download --id <id>
|
|
@@ -41706,6 +41852,25 @@ Examples:
|
|
|
41706
41852
|
queryParamKeys: []
|
|
41707
41853
|
});
|
|
41708
41854
|
});
|
|
41855
|
+
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", `
|
|
41856
|
+
Examples:
|
|
41857
|
+
hyperline quotes finalize --id <id>
|
|
41858
|
+
hyperline quotes finalize --id <id> --output json`).action(async (opts) => {
|
|
41859
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41860
|
+
if (!ctx) {
|
|
41861
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41862
|
+
process.exit(1);
|
|
41863
|
+
}
|
|
41864
|
+
const args = {};
|
|
41865
|
+
if (opts.id !== void 0)
|
|
41866
|
+
args.id = opts.id;
|
|
41867
|
+
await ctx.execute({
|
|
41868
|
+
method: "POST",
|
|
41869
|
+
path: "/v1/quotes/{id}/finalize",
|
|
41870
|
+
args,
|
|
41871
|
+
queryParamKeys: []
|
|
41872
|
+
});
|
|
41873
|
+
});
|
|
41709
41874
|
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", `
|
|
41710
41875
|
Examples:
|
|
41711
41876
|
hyperline quotes send --id <id> --email <email>
|
|
@@ -41813,10 +41978,132 @@ Examples:
|
|
|
41813
41978
|
});
|
|
41814
41979
|
}
|
|
41815
41980
|
|
|
41981
|
+
// build/commands/generated/quotes-templates.js
|
|
41982
|
+
function registerQuotes_TemplatesCommands(parent) {
|
|
41983
|
+
const resource = parent.command("quotes-templates").description("Manage quotes > templates");
|
|
41984
|
+
resource.command("list-quote-templates").description(`List quote templates with pagination and optional filters for id, name, subscription_template_id, and search. Use template IDs to create quotes from reusable quote defaults.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--id <value>", `id`).option("--id.not <value>", `id__not`).option("--id.is-null <value>", `id__isNull`).option("--id.is-not-null <value>", `id__isNotNull`).option("--id.equals <value>", `id__equals`).option("--id.contains <value>", `id__contains`).option("--id.starts-with <value>", `id__startsWith`).option("--id.end-with <value>", `id__endWith`).option("--name <value>", `name`).option("--name.not <value>", `name__not`).option("--name.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("--subscription-template-id <value>", `subscription_template_id`).option("--subscription-template-id.not <value>", `subscription_template_id__not`).option("--subscription-template-id.is-null <value>", `subscription_template_id__isNull`).option("--subscription-template-id.is-not-null <value>", `subscription_template_id__isNotNull`).option("--subscription-template-id.equals <value>", `subscription_template_id__equals`).option("--subscription-template-id.contains <value>", `subscription_template_id__contains`).option("--subscription-template-id.starts-with <value>", `subscription_template_id__startsWith`).option("--subscription-template-id.end-with <value>", `subscription_template_id__endWith`).option("--search <value>", `search`).addHelpText("after", `
|
|
41985
|
+
Examples:
|
|
41986
|
+
hyperline quotes-templates list-quote-templates
|
|
41987
|
+
hyperline quotes-templates list-quote-templates --take <take> --id <id>`).action(async (opts) => {
|
|
41988
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41989
|
+
if (!ctx) {
|
|
41990
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41991
|
+
process.exit(1);
|
|
41992
|
+
}
|
|
41993
|
+
const args = {};
|
|
41994
|
+
if (opts.id !== void 0)
|
|
41995
|
+
args.id = opts.id;
|
|
41996
|
+
if (opts["id.not"] !== void 0)
|
|
41997
|
+
args.id__not = opts["id.not"];
|
|
41998
|
+
if (opts["id.isNull"] !== void 0)
|
|
41999
|
+
args.id__isNull = opts["id.isNull"];
|
|
42000
|
+
if (opts["id.isNotNull"] !== void 0)
|
|
42001
|
+
args.id__isNotNull = opts["id.isNotNull"];
|
|
42002
|
+
if (opts["id.equals"] !== void 0)
|
|
42003
|
+
args.id__equals = opts["id.equals"];
|
|
42004
|
+
if (opts["id.contains"] !== void 0)
|
|
42005
|
+
args.id__contains = opts["id.contains"];
|
|
42006
|
+
if (opts["id.startsWith"] !== void 0)
|
|
42007
|
+
args.id__startsWith = opts["id.startsWith"];
|
|
42008
|
+
if (opts["id.endWith"] !== void 0)
|
|
42009
|
+
args.id__endWith = opts["id.endWith"];
|
|
42010
|
+
if (opts.name !== void 0)
|
|
42011
|
+
args.name = opts.name;
|
|
42012
|
+
if (opts["name.not"] !== void 0)
|
|
42013
|
+
args.name__not = opts["name.not"];
|
|
42014
|
+
if (opts["name.isNull"] !== void 0)
|
|
42015
|
+
args.name__isNull = opts["name.isNull"];
|
|
42016
|
+
if (opts["name.isNotNull"] !== void 0)
|
|
42017
|
+
args.name__isNotNull = opts["name.isNotNull"];
|
|
42018
|
+
if (opts["name.equals"] !== void 0)
|
|
42019
|
+
args.name__equals = opts["name.equals"];
|
|
42020
|
+
if (opts["name.contains"] !== void 0)
|
|
42021
|
+
args.name__contains = opts["name.contains"];
|
|
42022
|
+
if (opts["name.startsWith"] !== void 0)
|
|
42023
|
+
args.name__startsWith = opts["name.startsWith"];
|
|
42024
|
+
if (opts["name.endWith"] !== void 0)
|
|
42025
|
+
args.name__endWith = opts["name.endWith"];
|
|
42026
|
+
if (opts.subscriptionTemplateId !== void 0)
|
|
42027
|
+
args.subscription_template_id = opts.subscriptionTemplateId;
|
|
42028
|
+
if (opts["subscriptionTemplateId.not"] !== void 0)
|
|
42029
|
+
args.subscription_template_id__not = opts["subscriptionTemplateId.not"];
|
|
42030
|
+
if (opts["subscriptionTemplateId.isNull"] !== void 0)
|
|
42031
|
+
args.subscription_template_id__isNull = opts["subscriptionTemplateId.isNull"];
|
|
42032
|
+
if (opts["subscriptionTemplateId.isNotNull"] !== void 0)
|
|
42033
|
+
args.subscription_template_id__isNotNull = opts["subscriptionTemplateId.isNotNull"];
|
|
42034
|
+
if (opts["subscriptionTemplateId.equals"] !== void 0)
|
|
42035
|
+
args.subscription_template_id__equals = opts["subscriptionTemplateId.equals"];
|
|
42036
|
+
if (opts["subscriptionTemplateId.contains"] !== void 0)
|
|
42037
|
+
args.subscription_template_id__contains = opts["subscriptionTemplateId.contains"];
|
|
42038
|
+
if (opts["subscriptionTemplateId.startsWith"] !== void 0)
|
|
42039
|
+
args.subscription_template_id__startsWith = opts["subscriptionTemplateId.startsWith"];
|
|
42040
|
+
if (opts["subscriptionTemplateId.endWith"] !== void 0)
|
|
42041
|
+
args.subscription_template_id__endWith = opts["subscriptionTemplateId.endWith"];
|
|
42042
|
+
if (opts.search !== void 0)
|
|
42043
|
+
args.search = opts.search;
|
|
42044
|
+
if (opts.take !== void 0)
|
|
42045
|
+
args.take = Number(opts.take);
|
|
42046
|
+
if (opts.skip !== void 0)
|
|
42047
|
+
args.skip = Number(opts.skip);
|
|
42048
|
+
await ctx.execute({
|
|
42049
|
+
method: "GET",
|
|
42050
|
+
path: "/v1/quotes/templates",
|
|
42051
|
+
args,
|
|
42052
|
+
queryParamKeys: [
|
|
42053
|
+
"take",
|
|
42054
|
+
"skip",
|
|
42055
|
+
"id",
|
|
42056
|
+
"id__not",
|
|
42057
|
+
"id__isNull",
|
|
42058
|
+
"id__isNotNull",
|
|
42059
|
+
"id__equals",
|
|
42060
|
+
"id__contains",
|
|
42061
|
+
"id__startsWith",
|
|
42062
|
+
"id__endWith",
|
|
42063
|
+
"name",
|
|
42064
|
+
"name__not",
|
|
42065
|
+
"name__isNull",
|
|
42066
|
+
"name__isNotNull",
|
|
42067
|
+
"name__equals",
|
|
42068
|
+
"name__contains",
|
|
42069
|
+
"name__startsWith",
|
|
42070
|
+
"name__endWith",
|
|
42071
|
+
"subscription_template_id",
|
|
42072
|
+
"subscription_template_id__not",
|
|
42073
|
+
"subscription_template_id__isNull",
|
|
42074
|
+
"subscription_template_id__isNotNull",
|
|
42075
|
+
"subscription_template_id__equals",
|
|
42076
|
+
"subscription_template_id__contains",
|
|
42077
|
+
"subscription_template_id__startsWith",
|
|
42078
|
+
"subscription_template_id__endWith",
|
|
42079
|
+
"search"
|
|
42080
|
+
]
|
|
42081
|
+
});
|
|
42082
|
+
});
|
|
42083
|
+
resource.command("get-quote-template").description(`Retrieve a quote template by ID with quote defaults, display options, attachments, and linked contract template/clause IDs.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
42084
|
+
Examples:
|
|
42085
|
+
hyperline quotes-templates get-quote-template --id <id>`).action(async (opts) => {
|
|
42086
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
42087
|
+
if (!ctx) {
|
|
42088
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
42089
|
+
process.exit(1);
|
|
42090
|
+
}
|
|
42091
|
+
const args = {};
|
|
42092
|
+
if (opts.id !== void 0)
|
|
42093
|
+
args.id = opts.id;
|
|
42094
|
+
await ctx.execute({
|
|
42095
|
+
method: "GET",
|
|
42096
|
+
path: "/v1/quotes/templates/{id}",
|
|
42097
|
+
args,
|
|
42098
|
+
queryParamKeys: []
|
|
42099
|
+
});
|
|
42100
|
+
});
|
|
42101
|
+
}
|
|
42102
|
+
|
|
41816
42103
|
// build/commands/generated/subscriptions.js
|
|
41817
42104
|
function registerSubscriptionsCommands(parent) {
|
|
41818
42105
|
const resource = parent.command("subscriptions").description("Manage subscriptions");
|
|
41819
|
-
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", `
|
|
42106
|
+
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("--precision <value>", `Granularity used to prorate the update amount. Defaults to 'calendar_days' when omitted, prorating on whole calendar days; 'milliseconds' prorates on the exact elapsed time, charging the precise partial period.`).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", `
|
|
41820
42107
|
Examples:
|
|
41821
42108
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload>
|
|
41822
42109
|
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>
|
|
@@ -41839,6 +42126,10 @@ Examples:
|
|
|
41839
42126
|
args.charge_at = opts.chargeAt;
|
|
41840
42127
|
if (opts.calculationMethod !== void 0)
|
|
41841
42128
|
args.calculation_method = opts.calculationMethod;
|
|
42129
|
+
if (opts.precision !== void 0)
|
|
42130
|
+
args.precision = opts.precision;
|
|
42131
|
+
if (opts.refundMethod !== void 0)
|
|
42132
|
+
args.refund_method = opts.refundMethod;
|
|
41842
42133
|
if (opts.type !== void 0)
|
|
41843
42134
|
args.type = opts.type;
|
|
41844
42135
|
if (opts.payload !== void 0)
|
|
@@ -41850,7 +42141,7 @@ Examples:
|
|
|
41850
42141
|
queryParamKeys: []
|
|
41851
42142
|
});
|
|
41852
42143
|
});
|
|
41853
|
-
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", `
|
|
42144
|
+
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("--precision <value>", `Granularity used to prorate the update amount. Defaults to 'calendar_days' when omitted, prorating on whole calendar days; 'milliseconds' prorates on the exact elapsed time, charging the precise partial period.`).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", `
|
|
41854
42145
|
Examples:
|
|
41855
42146
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
41856
42147
|
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>
|
|
@@ -41873,6 +42164,10 @@ Examples:
|
|
|
41873
42164
|
args.charge_at = opts.chargeAt;
|
|
41874
42165
|
if (opts.calculationMethod !== void 0)
|
|
41875
42166
|
args.calculation_method = opts.calculationMethod;
|
|
42167
|
+
if (opts.precision !== void 0)
|
|
42168
|
+
args.precision = opts.precision;
|
|
42169
|
+
if (opts.refundMethod !== void 0)
|
|
42170
|
+
args.refund_method = opts.refundMethod;
|
|
41876
42171
|
if (opts.updates !== void 0)
|
|
41877
42172
|
args.updates = opts.updates;
|
|
41878
42173
|
await ctx.execute({
|
|
@@ -41882,7 +42177,7 @@ Examples:
|
|
|
41882
42177
|
queryParamKeys: []
|
|
41883
42178
|
});
|
|
41884
42179
|
});
|
|
41885
|
-
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", `
|
|
42180
|
+
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", `
|
|
41886
42181
|
Examples:
|
|
41887
42182
|
hyperline subscriptions cancel --id <id>
|
|
41888
42183
|
hyperline subscriptions cancel --id <id> --cancel-at <cancel_at> --reason <reason>
|
|
@@ -41899,6 +42194,8 @@ Examples:
|
|
|
41899
42194
|
args.cancel_at = opts.cancelAt;
|
|
41900
42195
|
if (opts.reason !== void 0)
|
|
41901
42196
|
args.reason = opts.reason;
|
|
42197
|
+
if (opts.refundMethod !== void 0)
|
|
42198
|
+
args.refund_method = opts.refundMethod;
|
|
41902
42199
|
if (opts.proRata !== void 0)
|
|
41903
42200
|
args.pro_rata = true;
|
|
41904
42201
|
await ctx.execute({
|
|
@@ -41927,7 +42224,7 @@ Examples:
|
|
|
41927
42224
|
queryParamKeys: []
|
|
41928
42225
|
});
|
|
41929
42226
|
});
|
|
41930
|
-
resource.command("pause").description(`Pause a subscription. Billing stops while paused. Optionally specify a reactivate_at date for automatic resumption.`).requiredOption("--id <value>", `id parameter`).option("--reactivate-at <value>", `Date when the subscription will be automatically reactivated. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).addHelpText("after", `
|
|
42227
|
+
resource.command("pause").description(`Pause a subscription. Billing stops while paused. Optionally specify a reactivate_at date for automatic resumption. If the subscription is already paused, updates (or clears) its reactivation date.`).requiredOption("--id <value>", `id parameter`).option("--reactivate-at <value>", `Date when the subscription will be automatically reactivated. Must be a future date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).addHelpText("after", `
|
|
41931
42228
|
Examples:
|
|
41932
42229
|
hyperline subscriptions pause --id <id>
|
|
41933
42230
|
hyperline subscriptions pause --id <id> --reactivate-at <reactivate_at>
|
|
@@ -42008,7 +42305,7 @@ Examples:
|
|
|
42008
42305
|
queryParamKeys: []
|
|
42009
42306
|
});
|
|
42010
42307
|
});
|
|
42011
|
-
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", `
|
|
42308
|
+
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("--precision <value>", `Granularity used to prorate the update amount. Defaults to 'calendar_days' when omitted, prorating on whole calendar days; 'milliseconds' prorates on the exact elapsed time, charging the precise partial period.`).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", `
|
|
42012
42309
|
Examples:
|
|
42013
42310
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
42014
42311
|
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>
|
|
@@ -42031,6 +42328,10 @@ Examples:
|
|
|
42031
42328
|
args.charge_at = opts.chargeAt;
|
|
42032
42329
|
if (opts.calculationMethod !== void 0)
|
|
42033
42330
|
args.calculation_method = opts.calculationMethod;
|
|
42331
|
+
if (opts.precision !== void 0)
|
|
42332
|
+
args.precision = opts.precision;
|
|
42333
|
+
if (opts.refundMethod !== void 0)
|
|
42334
|
+
args.refund_method = opts.refundMethod;
|
|
42034
42335
|
if (opts.updates !== void 0)
|
|
42035
42336
|
args.updates = opts.updates;
|
|
42036
42337
|
await ctx.execute({
|
|
@@ -42056,7 +42357,7 @@ Strategy used to cancel the subscription. If not specified \`do_nothing\` is use
|
|
|
42056
42357
|
- \`refund_custom\`: Will refund to the customer a custom amount.
|
|
42057
42358
|
- \`end_of_period\`: Will cancel the subscription at the end date of the current billing period.
|
|
42058
42359
|
- \`do_nothing\`: Will only cease the subscription without any additional actions.
|
|
42059
|
-
`).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>", `
|
|
42360
|
+
`).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>", `
|
|
42060
42361
|
Defines when invoices are generated relative to the billing period.
|
|
42061
42362
|
|
|
42062
42363
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42111,6 +42412,8 @@ Examples:
|
|
|
42111
42412
|
args.cancel_at = opts.cancelAt;
|
|
42112
42413
|
if (opts.cancellationStrategy !== void 0)
|
|
42113
42414
|
args.cancellation_strategy = opts.cancellationStrategy;
|
|
42415
|
+
if (opts.cancellationRefundMethod !== void 0)
|
|
42416
|
+
args.cancellation_refund_method = opts.cancellationRefundMethod;
|
|
42114
42417
|
if (opts.properties !== void 0)
|
|
42115
42418
|
args.properties = opts.properties;
|
|
42116
42419
|
if (opts.customProperties !== void 0)
|
|
@@ -42393,7 +42696,7 @@ Examples:
|
|
|
42393
42696
|
queryParamKeys: []
|
|
42394
42697
|
});
|
|
42395
42698
|
});
|
|
42396
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons.
|
|
42699
|
+
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>", `
|
|
42397
42700
|
Defines when invoices are generated relative to the billing period.
|
|
42398
42701
|
|
|
42399
42702
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42753,7 +43056,7 @@ Examples:
|
|
|
42753
43056
|
]
|
|
42754
43057
|
});
|
|
42755
43058
|
});
|
|
42756
|
-
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>", `
|
|
43059
|
+
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", `
|
|
42757
43060
|
Examples:
|
|
42758
43061
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
42759
43062
|
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>
|
|
@@ -42967,6 +43270,30 @@ Examples:
|
|
|
42967
43270
|
});
|
|
42968
43271
|
}
|
|
42969
43272
|
|
|
43273
|
+
// build/commands/generated/transactions.js
|
|
43274
|
+
function registerTransactionsCommands(parent) {
|
|
43275
|
+
const resource = parent.command("transactions").description("Manage transactions");
|
|
43276
|
+
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", `
|
|
43277
|
+
Examples:
|
|
43278
|
+
hyperline transactions refund --id <id>
|
|
43279
|
+
hyperline transactions refund --id <id> --output json`).action(async (opts) => {
|
|
43280
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
43281
|
+
if (!ctx) {
|
|
43282
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
43283
|
+
process.exit(1);
|
|
43284
|
+
}
|
|
43285
|
+
const args = {};
|
|
43286
|
+
if (opts.id !== void 0)
|
|
43287
|
+
args.id = opts.id;
|
|
43288
|
+
await ctx.execute({
|
|
43289
|
+
method: "POST",
|
|
43290
|
+
path: "/v1/transactions/{id}/refund",
|
|
43291
|
+
args,
|
|
43292
|
+
queryParamKeys: []
|
|
43293
|
+
});
|
|
43294
|
+
});
|
|
43295
|
+
}
|
|
43296
|
+
|
|
42970
43297
|
// build/commands/generated/wallets.js
|
|
42971
43298
|
function registerWalletsCommands(parent) {
|
|
42972
43299
|
const resource = parent.command("wallets").description("Manage wallets");
|
|
@@ -43127,10 +43454,10 @@ Examples:
|
|
|
43127
43454
|
queryParamKeys: []
|
|
43128
43455
|
});
|
|
43129
43456
|
});
|
|
43130
|
-
resource.command("load").description(`Add credits
|
|
43457
|
+
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", `
|
|
43131
43458
|
Examples:
|
|
43132
43459
|
hyperline wallets load --id <id>
|
|
43133
|
-
hyperline wallets load --id <id> --
|
|
43460
|
+
hyperline wallets load --id <id> --type <type> --amount <amount>
|
|
43134
43461
|
hyperline wallets load --id <id> --output json`).action(async (opts) => {
|
|
43135
43462
|
const ctx = resource.parent?.opts()._ctx;
|
|
43136
43463
|
if (!ctx) {
|
|
@@ -43140,12 +43467,18 @@ Examples:
|
|
|
43140
43467
|
const args = {};
|
|
43141
43468
|
if (opts.id !== void 0)
|
|
43142
43469
|
args.id = opts.id;
|
|
43470
|
+
if (opts.type !== void 0)
|
|
43471
|
+
args.type = opts.type;
|
|
43472
|
+
if (opts.comment !== void 0)
|
|
43473
|
+
args.comment = opts.comment;
|
|
43143
43474
|
if (opts.documentStatus !== void 0)
|
|
43144
43475
|
args.document_status = opts.documentStatus;
|
|
43476
|
+
if (opts.bankAccountId !== void 0)
|
|
43477
|
+
args.bank_account_id = opts.bankAccountId;
|
|
43478
|
+
if (opts.reference !== void 0)
|
|
43479
|
+
args.reference = opts.reference;
|
|
43145
43480
|
if (opts.amount !== void 0)
|
|
43146
43481
|
args.amount = Number(opts.amount);
|
|
43147
|
-
if (opts.amountFree !== void 0)
|
|
43148
|
-
args.amount_free = Number(opts.amountFree);
|
|
43149
43482
|
await ctx.execute({
|
|
43150
43483
|
method: "POST",
|
|
43151
43484
|
path: "/v1/wallets/{id}/load",
|
|
@@ -43374,11 +43707,13 @@ function registerAllCommands(program2) {
|
|
|
43374
43707
|
registerProductsCommands(program2);
|
|
43375
43708
|
registerPrice_ConfigurationsCommands(program2);
|
|
43376
43709
|
registerQuotesCommands(program2);
|
|
43710
|
+
registerQuotes_TemplatesCommands(program2);
|
|
43377
43711
|
registerSubscriptions_TemplatesCommands(program2);
|
|
43378
43712
|
registerSubscriptionsCommands(program2);
|
|
43379
43713
|
registerSubscriptions_TransitionsCommands(program2);
|
|
43380
43714
|
registerSubscriptions_PhasesCommands(program2);
|
|
43381
43715
|
registerTaxesCommands(program2);
|
|
43716
|
+
registerTransactionsCommands(program2);
|
|
43382
43717
|
registerWalletsCommands(program2);
|
|
43383
43718
|
registerWebhooksCommands(program2);
|
|
43384
43719
|
}
|
|
@@ -57169,6 +57504,7 @@ var BooleanSchema = external_exports.boolean().or(external_exports.enum(["true",
|
|
|
57169
57504
|
});
|
|
57170
57505
|
var StringSchemaForMultipartForm = external_exports.string().transform((value) => value === "" ? null : value);
|
|
57171
57506
|
var StringArraySchemaForMultipartForm = external_exports.string().array().or(external_exports.string().length(0)).transform((value) => typeof value === "string" ? [] : value);
|
|
57507
|
+
var CommaSeparatedArraySchema = external_exports.string().optional().transform((raw) => raw ? raw.split(",").filter(Boolean) : void 0);
|
|
57172
57508
|
var urlRegex = /^(?:(?:https?):\/\/)?(?:www\.)?(?:[\w-]+\.)+[a-z]{2,7}(?:\/\S*)?$/i;
|
|
57173
57509
|
var ZodFlexibleUrl = external_exports.string({ message: "Invalid URL" }).regex(urlRegex).transform((url2) => {
|
|
57174
57510
|
if (!url2)
|
|
@@ -61507,6 +61843,7 @@ import * as winston from "winston";
|
|
|
61507
61843
|
|
|
61508
61844
|
// ../hyperline-monitoring/build/logger/formatting/format.js
|
|
61509
61845
|
import prune from "json-prune";
|
|
61846
|
+
var REDACTED_HEADER_KEY_PATTERN = /authorization|authenticate|cookie|secret|token|credential|signature|jwt|api[_-]?key|access[_-]?token|refresh[_-]?token|private[_-]?key/i;
|
|
61510
61847
|
function jsonFormat(info) {
|
|
61511
61848
|
const prunedInfo = JSON.parse(prune(info));
|
|
61512
61849
|
for (const [key, value] of Object.entries(prunedInfo)) {
|
|
@@ -61589,17 +61926,26 @@ function formatAxiosError(error48) {
|
|
|
61589
61926
|
url: request?.url,
|
|
61590
61927
|
baseURL: request?.baseURL,
|
|
61591
61928
|
params: request?.params,
|
|
61592
|
-
headers: request?.headers,
|
|
61929
|
+
headers: redactHeaders({ headers: request?.headers }),
|
|
61593
61930
|
"axios-retry": request?.["axios-retry"]
|
|
61594
61931
|
},
|
|
61595
61932
|
response: {
|
|
61596
61933
|
status: response?.status,
|
|
61597
61934
|
statusText: response?.statusText,
|
|
61598
|
-
headers: response?.headers,
|
|
61935
|
+
headers: redactHeaders({ headers: response?.headers }),
|
|
61599
61936
|
data: response?.data
|
|
61600
61937
|
}
|
|
61601
61938
|
};
|
|
61602
61939
|
}
|
|
61940
|
+
function redactHeaders({ headers }) {
|
|
61941
|
+
if (!isRecord(headers)) {
|
|
61942
|
+
return headers;
|
|
61943
|
+
}
|
|
61944
|
+
return Object.fromEntries(Object.entries(headers).map(([headerKey, headerValue]) => [
|
|
61945
|
+
headerKey,
|
|
61946
|
+
REDACTED_HEADER_KEY_PATTERN.test(headerKey) ? "<redacted>" : headerValue
|
|
61947
|
+
]));
|
|
61948
|
+
}
|
|
61603
61949
|
function isRecord(value) {
|
|
61604
61950
|
return typeof value === "object" && value !== null && !Array.isArray(value);
|
|
61605
61951
|
}
|
|
@@ -61623,13 +61969,16 @@ function logHttpRequest(logger2, request, extra) {
|
|
|
61623
61969
|
});
|
|
61624
61970
|
}
|
|
61625
61971
|
function logHttpResponse(logger2, response, responseTime, extra) {
|
|
61626
|
-
const { request, statusCode, responseBody } = response;
|
|
61972
|
+
const { request, statusCode, responseBody, responseHeaders } = response;
|
|
61627
61973
|
const { message, metadata } = transform2(request);
|
|
61628
61974
|
const readableResponseTime = responseTime ? getReadableTime(responseTime) : void 0;
|
|
61629
61975
|
const responseMetadata = {
|
|
61630
61976
|
statusCode,
|
|
61631
61977
|
responseTime,
|
|
61632
|
-
responseBody
|
|
61978
|
+
responseBody,
|
|
61979
|
+
// Redacted so secrets (authorization/cookie/token/…) never reach the logs
|
|
61980
|
+
// while diagnostic headers (e.g. rate-limit headers on a 429) stay visible.
|
|
61981
|
+
responseHeaders: responseHeaders === void 0 ? void 0 : redactHeaders({ headers: responseHeaders })
|
|
61633
61982
|
};
|
|
61634
61983
|
logger2.info(`HTTP RES - ${message} ${statusCode} ${readableResponseTime || ""} ${extra?.postfix || ""}`, {
|
|
61635
61984
|
...metadata,
|
|
@@ -61910,6 +62259,12 @@ var DateTimeSchema = external_exports.iso.datetime({
|
|
|
61910
62259
|
example: "2024-12-20T16:04:11Z"
|
|
61911
62260
|
});
|
|
61912
62261
|
|
|
62262
|
+
// ../hyperline-lib/build/http/dto/domain.js
|
|
62263
|
+
var DomainSchema = external_exports.string().trim().toLowerCase().regex(/^(?!:\/\/)(?=.{1,253}$)(?!-)([a-z0-9-]{1,63}\.)+[a-z]{2,63}$/, "Invalid domain").openapi({
|
|
62264
|
+
description: "Domain name.",
|
|
62265
|
+
example: "acme.com"
|
|
62266
|
+
});
|
|
62267
|
+
|
|
61913
62268
|
// ../hyperline-lib/build/http/dto/error.js
|
|
61914
62269
|
var ErrorSchema = external_exports.object({
|
|
61915
62270
|
message: external_exports.string()
|
|
@@ -61964,10 +62319,13 @@ var languages = [
|
|
|
61964
62319
|
var de = {
|
|
61965
62320
|
"accounting.invoicePosted.entryDescription": "Buchungseintrag f\xFCr Rechnung {{invoiceId}}",
|
|
61966
62321
|
"accounting.transactionSettled.entryDescription": "Zahlungsabwicklung f\xFCr Rechnung {{invoiceId}}",
|
|
62322
|
+
"accounting.transactionRefunded.entryDescription": "R\xFCckerstattung f\xFCr Rechnung {{invoiceId}}",
|
|
61967
62323
|
"accounting.creditNotePosted.entryDescription": "Gutschrift {{creditNoteId}} f\xFCr Rechnung {{invoiceId}}",
|
|
62324
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Gutschrift {{creditNoteId}}",
|
|
61968
62325
|
"accounting.revrec.creditLineDescription": "Umsatz realisieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
61969
62326
|
"accounting.revrec.debitLineDescription": "Abgrenzungsposten reduzieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
61970
62327
|
"accounting.revrec.discountCreditLineDescription": "Erl\xF6sminderung (Rabatt) erfassen \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
62328
|
+
"accounting.revrec.closedPeriodFallbackNote": " (in die n\xE4chste offene Periode gebucht \u2013 Zielperiode geschlossen; urspr\xFCngliches Datum {{originalDate}})",
|
|
61971
62329
|
"accounting.revrec.discountDebitLineDescription": "Abgegrenzten Rabatt reduzieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
61972
62330
|
"accounting.revrec.entryDescription": "Umsatzrealisierung f\xFCr Zeitplan {{scheduleId}}, Zeitraum {{periodStart}} - {{periodEnd}}",
|
|
61973
62331
|
"creditNotes.refundChargeName": "R\xFCckerstattung f\xFCr die Rechnung",
|
|
@@ -61980,7 +62338,9 @@ var de = {
|
|
|
61980
62338
|
"invoices.outstandingProduct.descriptionPeriod": "Unbezahlter Betrag der Rechnung{{invoiceNumber}} vom {{periodStart}} bis {{periodEnd}}",
|
|
61981
62339
|
"invoices.outstandingProduct.name": "Offener Saldo",
|
|
61982
62340
|
"invoices.prorata.paymentForItem": "Anteilig berechneter Betrag f\xFCr",
|
|
62341
|
+
"invoices.prorata.paymentForItemFullPeriod": "Zahlung f\xFCr",
|
|
61983
62342
|
"invoices.prorata.refundForItem": "Anteilig erstatteter Betrag f\xFCr",
|
|
62343
|
+
"invoices.prorata.refundForItemFullPeriod": "Erstattung f\xFCr",
|
|
61984
62344
|
"subscriptions.closingChargeName": "Abschlussgeb\xFChr f\xFCr das Abonnement",
|
|
61985
62345
|
"subscriptions.correction": "Vorperiodische Anpassung",
|
|
61986
62346
|
"subscriptions.updates.addCoupon": "Gutschein hinzuf\xFCgen {{couponName}}",
|
|
@@ -62009,7 +62369,9 @@ var en = {
|
|
|
62009
62369
|
"invoices.outstandingProduct.descriptionPeriod": "Unpaid amount from the invoice{{invoiceNumber}} from {{periodStart}} to {{periodEnd}}",
|
|
62010
62370
|
"invoices.outstandingProduct.name": "Outstanding balance",
|
|
62011
62371
|
"invoices.prorata.paymentForItem": "Prorated payment for",
|
|
62372
|
+
"invoices.prorata.paymentForItemFullPeriod": "Payment for",
|
|
62012
62373
|
"invoices.prorata.refundForItem": "Prorated refund for",
|
|
62374
|
+
"invoices.prorata.refundForItemFullPeriod": "Refund for",
|
|
62013
62375
|
"subscriptions.closingChargeName": "Closing fee for subscription",
|
|
62014
62376
|
"subscriptions.correction": "Adjustment previous period",
|
|
62015
62377
|
"subscriptions.updates.addCoupon": "Add coupon {{couponName}}",
|
|
@@ -62029,12 +62391,15 @@ var en = {
|
|
|
62029
62391
|
"subscriptions.updates.updateCount.description.full.not_committed.not_invoiced": "Amount of {{amount}} not invoiced for the full period",
|
|
62030
62392
|
"accounting.invoicePosted.entryDescription": "Posting entry for Invoice {{invoiceId}} issued",
|
|
62031
62393
|
"accounting.transactionSettled.entryDescription": "Payment settlement for Invoice {{invoiceId}}",
|
|
62394
|
+
"accounting.transactionRefunded.entryDescription": "Refund for Invoice {{invoiceId}}",
|
|
62032
62395
|
"accounting.creditNotePosted.entryDescription": "Credit note {{creditNoteId}} for Invoice {{invoiceId}}",
|
|
62396
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Credit note {{creditNoteId}}",
|
|
62033
62397
|
"accounting.revrec.entryDescription": "Revenue recognition for schedule {{scheduleId}}, period {{periodStart}} - {{periodEnd}}",
|
|
62034
62398
|
"accounting.revrec.debitLineDescription": "Decrease deferred revenue \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
62035
62399
|
"accounting.revrec.creditLineDescription": "Recognize revenue \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
62036
62400
|
"accounting.revrec.discountDebitLineDescription": "Decrease deferred discount \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
62037
62401
|
"accounting.revrec.discountCreditLineDescription": "Recognize contra-revenue (discount) \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
62402
|
+
"accounting.revrec.closedPeriodFallbackNote": " (posted to next open period \u2014 target accounting period closed; original date {{originalDate}})",
|
|
62038
62403
|
"einvoicing.paymentProcessed": "Payment processed",
|
|
62039
62404
|
"einvoicing.paymentReceived": "Payment received",
|
|
62040
62405
|
"einvoicing.paymentFromWallet": "Payment from wallet"
|
|
@@ -62044,10 +62409,13 @@ var en = {
|
|
|
62044
62409
|
var es = {
|
|
62045
62410
|
"accounting.invoicePosted.entryDescription": "Asiento contable para la factura {{invoiceId}}",
|
|
62046
62411
|
"accounting.transactionSettled.entryDescription": "Liquidaci\xF3n de pago para la factura {{invoiceId}}",
|
|
62412
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso de la factura {{invoiceId}}",
|
|
62047
62413
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para la factura {{invoiceId}}",
|
|
62414
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}}",
|
|
62048
62415
|
"accounting.revrec.creditLineDescription": "Reconocer ingresos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62049
62416
|
"accounting.revrec.debitLineDescription": "Disminuci\xF3n de ingresos diferidos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62050
62417
|
"accounting.revrec.discountCreditLineDescription": "Reconocer contra-ingresos (descuento) \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62418
|
+
"accounting.revrec.closedPeriodFallbackNote": " (registrado en el pr\xF3ximo per\xEDodo abierto \u2014 per\xEDodo contable de destino cerrado; fecha original {{originalDate}})",
|
|
62051
62419
|
"accounting.revrec.discountDebitLineDescription": "Disminuci\xF3n de descuento diferido \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62052
62420
|
"accounting.revrec.entryDescription": "Reconocimiento de ingresos para el cronograma {{scheduleId}}, per\xEDodo {{periodStart}} - {{periodEnd}}",
|
|
62053
62421
|
"creditNotes.refundChargeName": "Reembolso por factura",
|
|
@@ -62060,7 +62428,9 @@ var es = {
|
|
|
62060
62428
|
"invoices.outstandingProduct.descriptionPeriod": "Monto pendiente de la factura{{invoiceNumber}} del {{periodStart}} al {{periodEnd}}",
|
|
62061
62429
|
"invoices.outstandingProduct.name": "Saldo pendiente",
|
|
62062
62430
|
"invoices.prorata.paymentForItem": "Pago prorrateado por",
|
|
62431
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pago por",
|
|
62063
62432
|
"invoices.prorata.refundForItem": "Reembolso prorrateado por",
|
|
62433
|
+
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
62064
62434
|
"subscriptions.closingChargeName": "Cargo por cierre de suscripci\xF3n",
|
|
62065
62435
|
"subscriptions.correction": "Ajuste del periodo anterior",
|
|
62066
62436
|
"subscriptions.updates.addCoupon": "A\xF1adir cup\xF3n {{couponName}}",
|
|
@@ -62085,10 +62455,13 @@ var fr = {
|
|
|
62085
62455
|
"accounting.revrec.creditLineDescription": "Reconnaissance du chiffre d'affaires \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62086
62456
|
"accounting.revrec.debitLineDescription": "Diminution des produits constat\xE9s d'avance \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62087
62457
|
"accounting.revrec.discountCreditLineDescription": "Reconnaissance du contre-revenu (remise) \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62458
|
+
"accounting.revrec.closedPeriodFallbackNote": " (comptabilis\xE9 sur la prochaine p\xE9riode ouverte \u2014 p\xE9riode comptable cible cl\xF4tur\xE9e ; date d'origine {{originalDate}})",
|
|
62088
62459
|
"accounting.revrec.discountDebitLineDescription": "Diminution des remises diff\xE9r\xE9es \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62089
62460
|
"accounting.invoicePosted.entryDescription": "\xC9criture de comptabilisation pour la facture {{invoiceId}}",
|
|
62090
62461
|
"accounting.transactionSettled.entryDescription": "R\xE8glement de la facture {{invoiceId}}",
|
|
62462
|
+
"accounting.transactionRefunded.entryDescription": "Remboursement de la facture {{invoiceId}}",
|
|
62091
62463
|
"accounting.creditNotePosted.entryDescription": "Avoir {{creditNoteId}} pour la facture {{invoiceId}}",
|
|
62464
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Avoir {{creditNoteId}}",
|
|
62092
62465
|
"accounting.revrec.entryDescription": "Reconnaissance du chiffre d'affaires pour l'\xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodStart}} - {{periodEnd}}",
|
|
62093
62466
|
"creditNotes.refundChargeName": "Remboursement pour facture",
|
|
62094
62467
|
"credits.bundleOf": "{{productName}} - Pack de {{creditCount}} cr\xE9dits",
|
|
@@ -62100,7 +62473,9 @@ var fr = {
|
|
|
62100
62473
|
"invoices.outstandingProduct.descriptionPeriod": "Montant impay\xE9 de la facture{{invoiceNumber}} du {{periodStart}} au {{periodEnd}}",
|
|
62101
62474
|
"invoices.outstandingProduct.name": "Solde impay\xE9",
|
|
62102
62475
|
"invoices.prorata.paymentForItem": "Paiement au prorata pour",
|
|
62476
|
+
"invoices.prorata.paymentForItemFullPeriod": "Paiement pour",
|
|
62103
62477
|
"invoices.prorata.refundForItem": "Remboursement au prorata pour",
|
|
62478
|
+
"invoices.prorata.refundForItemFullPeriod": "Remboursement pour",
|
|
62104
62479
|
"subscriptions.closingChargeName": "Frais de cl\xF4ture pour abonnement",
|
|
62105
62480
|
"subscriptions.correction": "Ajustement p\xE9riode pr\xE9c\xE9dente",
|
|
62106
62481
|
"subscriptions.updates.addCoupon": "Ajout du coupon {{couponName}}",
|
|
@@ -62124,10 +62499,13 @@ var fr = {
|
|
|
62124
62499
|
var it = {
|
|
62125
62500
|
"accounting.invoicePosted.entryDescription": "Registrazione contabile per la fattura {{invoiceId}}",
|
|
62126
62501
|
"accounting.transactionSettled.entryDescription": "Regolamento pagamento per la fattura {{invoiceId}}",
|
|
62502
|
+
"accounting.transactionRefunded.entryDescription": "Rimborso per la fattura {{invoiceId}}",
|
|
62127
62503
|
"accounting.creditNotePosted.entryDescription": "Nota di credito {{creditNoteId}} per la fattura {{invoiceId}}",
|
|
62504
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Nota di credito {{creditNoteId}}",
|
|
62128
62505
|
"accounting.revrec.creditLineDescription": "Riconoscere i ricavi \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62129
62506
|
"accounting.revrec.debitLineDescription": "Diminuzione dei ricavi differiti \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62130
62507
|
"accounting.revrec.discountCreditLineDescription": "Riconoscere il contra-ricavo (sconto) \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62508
|
+
"accounting.revrec.closedPeriodFallbackNote": " (registrato nel prossimo periodo aperto \u2014 periodo contabile di destinazione chiuso; data originale {{originalDate}})",
|
|
62131
62509
|
"accounting.revrec.discountDebitLineDescription": "Diminuzione dello sconto differito \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62132
62510
|
"accounting.revrec.entryDescription": "Riconoscimento dei ricavi per il programma {{scheduleId}}, periodo {{periodStart}} - {{periodEnd}}",
|
|
62133
62511
|
"creditNotes.refundChargeName": "Rimborso per fattura",
|
|
@@ -62140,7 +62518,9 @@ var it = {
|
|
|
62140
62518
|
"invoices.outstandingProduct.descriptionPeriod": "Importo insoluto della fattura{{invoiceNumber}} dal {{periodStart}} al {{periodEnd}}",
|
|
62141
62519
|
"invoices.outstandingProduct.name": "Saldo insoluto",
|
|
62142
62520
|
"invoices.prorata.paymentForItem": "Pagamento proporzionale per",
|
|
62521
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pagamento per",
|
|
62143
62522
|
"invoices.prorata.refundForItem": "Rimborso proporzionale per",
|
|
62523
|
+
"invoices.prorata.refundForItemFullPeriod": "Rimborso per",
|
|
62144
62524
|
"subscriptions.closingChargeName": "Costo di chiusura per abbonamento",
|
|
62145
62525
|
"subscriptions.correction": "Correzione periodo precedente",
|
|
62146
62526
|
"subscriptions.updates.addCoupon": "Aggiungi coupon {{couponName}}",
|
|
@@ -62164,10 +62544,13 @@ var it = {
|
|
|
62164
62544
|
var nl = {
|
|
62165
62545
|
"accounting.invoicePosted.entryDescription": "Boekingsregel voor factuur {{invoiceId}}",
|
|
62166
62546
|
"accounting.transactionSettled.entryDescription": "Betalingsafwikkeling voor factuur {{invoiceId}}",
|
|
62547
|
+
"accounting.transactionRefunded.entryDescription": "Terugbetaling voor factuur {{invoiceId}}",
|
|
62167
62548
|
"accounting.creditNotePosted.entryDescription": "Creditnota {{creditNoteId}} voor factuur {{invoiceId}}",
|
|
62549
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Creditnota {{creditNoteId}}",
|
|
62168
62550
|
"accounting.revrec.creditLineDescription": "Omzet erkennen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62169
62551
|
"accounting.revrec.debitLineDescription": "Uitgestelde omzet verlagen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62170
62552
|
"accounting.revrec.discountCreditLineDescription": "Omzetvermindering (korting) erkennen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62553
|
+
"accounting.revrec.closedPeriodFallbackNote": " (geboekt in de volgende open periode \u2014 doelboekingsperiode gesloten; oorspronkelijke datum {{originalDate}})",
|
|
62171
62554
|
"accounting.revrec.discountDebitLineDescription": "Uitgestelde korting verlagen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62172
62555
|
"accounting.revrec.entryDescription": "Omzeterkenning voor schema {{scheduleId}}, periode {{periodStart}} - {{periodEnd}}",
|
|
62173
62556
|
"creditNotes.refundChargeName": "Terugbetaling voor factuur",
|
|
@@ -62180,7 +62563,9 @@ var nl = {
|
|
|
62180
62563
|
"invoices.outstandingProduct.descriptionPeriod": "Onbetaald bedrag van de factuur{{invoiceNumber}} van {{periodStart}} tot {{periodEnd}}",
|
|
62181
62564
|
"invoices.outstandingProduct.name": "Openstaand saldo",
|
|
62182
62565
|
"invoices.prorata.paymentForItem": "Gedeeltelijke betaling voor",
|
|
62566
|
+
"invoices.prorata.paymentForItemFullPeriod": "Betaling voor",
|
|
62183
62567
|
"invoices.prorata.refundForItem": "Gedeeltelijke terugbetaling voor",
|
|
62568
|
+
"invoices.prorata.refundForItemFullPeriod": "Terugbetaling voor",
|
|
62184
62569
|
"subscriptions.closingChargeName": "Afsluitkosten voor abonnement",
|
|
62185
62570
|
"subscriptions.correction": "Aanpassing vorige periode",
|
|
62186
62571
|
"subscriptions.updates.addCoupon": "Coupon toevoegen {{couponName}}",
|
|
@@ -62204,10 +62589,13 @@ var nl = {
|
|
|
62204
62589
|
var pl = {
|
|
62205
62590
|
"accounting.invoicePosted.entryDescription": "Zapis ksi\u0119gowy dla faktury {{invoiceId}}",
|
|
62206
62591
|
"accounting.transactionSettled.entryDescription": "Rozliczenie p\u0142atno\u015Bci dla faktury {{invoiceId}}",
|
|
62592
|
+
"accounting.transactionRefunded.entryDescription": "Zwrot za faktur\u0119 {{invoiceId}}",
|
|
62207
62593
|
"accounting.creditNotePosted.entryDescription": "Nota kredytowa {{creditNoteId}} dla faktury {{invoiceId}}",
|
|
62594
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Nota kredytowa {{creditNoteId}}",
|
|
62208
62595
|
"accounting.revrec.creditLineDescription": "Rozpoznanie przychodu \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62209
62596
|
"accounting.revrec.debitLineDescription": "Zmniejszenie przychod\xF3w przysz\u0142ych okres\xF3w \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62210
62597
|
"accounting.revrec.discountCreditLineDescription": "Rozpoznanie kontra-przychodu (rabat) \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62598
|
+
"accounting.revrec.closedPeriodFallbackNote": " (zaksi\u0119gowano w nast\u0119pnym otwartym okresie \u2014 docelowy okres ksi\u0119gowy zamkni\u0119ty; pierwotna data {{originalDate}})",
|
|
62211
62599
|
"accounting.revrec.discountDebitLineDescription": "Zmniejszenie odroczonego rabatu \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62212
62600
|
"accounting.revrec.entryDescription": "Rozpoznanie przychodu dla harmonogramu {{scheduleId}}, okres {{periodStart}} - {{periodEnd}}",
|
|
62213
62601
|
"creditNotes.refundChargeName": "Zwrot za faktur\u0119",
|
|
@@ -62220,7 +62608,9 @@ var pl = {
|
|
|
62220
62608
|
"invoices.outstandingProduct.descriptionPeriod": "Nieop\u0142acona kwota z faktury{{invoiceNumber}} od {{periodStart}} do {{periodEnd}}",
|
|
62221
62609
|
"invoices.outstandingProduct.name": "Niezap\u0142acone saldo",
|
|
62222
62610
|
"invoices.prorata.paymentForItem": "P\u0142atno\u015B\u0107 proporcjonalna za",
|
|
62611
|
+
"invoices.prorata.paymentForItemFullPeriod": "P\u0142atno\u015B\u0107 za",
|
|
62223
62612
|
"invoices.prorata.refundForItem": "Zwrot proporcjonalny za",
|
|
62613
|
+
"invoices.prorata.refundForItemFullPeriod": "Zwrot za",
|
|
62224
62614
|
"subscriptions.closingChargeName": "Op\u0142ata za zamkni\u0119cie subskrypcji",
|
|
62225
62615
|
"subscriptions.correction": "Korekta poprzedniego okresu",
|
|
62226
62616
|
"subscriptions.updates.addCoupon": "Dodaj kupon {{couponName}}",
|
|
@@ -62244,10 +62634,13 @@ var pl = {
|
|
|
62244
62634
|
var pt = {
|
|
62245
62635
|
"accounting.invoicePosted.entryDescription": "Lan\xE7amento cont\xE1bil para a fatura {{invoiceId}}",
|
|
62246
62636
|
"accounting.transactionSettled.entryDescription": "Liquida\xE7\xE3o de pagamento para a fatura {{invoiceId}}",
|
|
62637
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso da fatura {{invoiceId}}",
|
|
62247
62638
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para a fatura {{invoiceId}}",
|
|
62639
|
+
"accounting.standaloneCreditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}}",
|
|
62248
62640
|
"accounting.revrec.creditLineDescription": "Reconhecer receita \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62249
62641
|
"accounting.revrec.debitLineDescription": "Diminui\xE7\xE3o da receita diferida \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62250
62642
|
"accounting.revrec.discountCreditLineDescription": "Reconhecer contra-receita (desconto) \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62643
|
+
"accounting.revrec.closedPeriodFallbackNote": " (lan\xE7ado no pr\xF3ximo per\xEDodo aberto \u2014 per\xEDodo cont\xE1bil de destino fechado; data original {{originalDate}})",
|
|
62251
62644
|
"accounting.revrec.discountDebitLineDescription": "Diminui\xE7\xE3o do desconto diferido \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62252
62645
|
"accounting.revrec.entryDescription": "Reconhecimento de receita para o cronograma {{scheduleId}}, per\xEDodo {{periodStart}} - {{periodEnd}}",
|
|
62253
62646
|
"creditNotes.refundChargeName": "Reembolso pela fatura",
|
|
@@ -62260,7 +62653,9 @@ var pt = {
|
|
|
62260
62653
|
"invoices.outstandingProduct.descriptionPeriod": "Valor em aberto da fatura{{invoiceNumber}} de {{periodStart}} a {{periodEnd}}",
|
|
62261
62654
|
"invoices.outstandingProduct.name": "Saldo em aberto",
|
|
62262
62655
|
"invoices.prorata.paymentForItem": "Pagamento proporcional por",
|
|
62656
|
+
"invoices.prorata.paymentForItemFullPeriod": "Pagamento por",
|
|
62263
62657
|
"invoices.prorata.refundForItem": "Reembolso proporcional por",
|
|
62658
|
+
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
62264
62659
|
"subscriptions.closingChargeName": "Taxa de encerramento da assinatura",
|
|
62265
62660
|
"subscriptions.correction": "Ajuste do per\xEDodo anterior",
|
|
62266
62661
|
"subscriptions.updates.addCoupon": "Adicionar cupom {{couponName}}",
|
|
@@ -62382,10 +62777,16 @@ function buildHttpClient(dependencies) {
|
|
|
62382
62777
|
return response;
|
|
62383
62778
|
}, (error48) => {
|
|
62384
62779
|
if (error48.response) {
|
|
62385
|
-
const { config: responseConfig, status } = error48.response;
|
|
62780
|
+
const { config: responseConfig, status, headers } = error48.response;
|
|
62386
62781
|
const timeStart = responseConfig.metadata.timeStart;
|
|
62387
62782
|
const responseTime = timeStart ? Date.now() - timeStart : void 0;
|
|
62388
|
-
logHttpResponse(logger2, {
|
|
62783
|
+
logHttpResponse(logger2, {
|
|
62784
|
+
request: toLogRequest(responseConfig),
|
|
62785
|
+
statusCode: status,
|
|
62786
|
+
// Surfaces upstream response headers on error responses (e.g. the
|
|
62787
|
+
// rate-limit headers on a 429); redacted in logHttpResponse.
|
|
62788
|
+
responseHeaders: headers
|
|
62789
|
+
}, responseTime, { metadata: { error: error48.message } });
|
|
62389
62790
|
}
|
|
62390
62791
|
return Promise.reject(error48);
|
|
62391
62792
|
});
|
|
@@ -62478,6 +62879,9 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
|
|
|
62478
62879
|
|
|
62479
62880
|
// ../hyperline-mcp/build/server/server.js
|
|
62480
62881
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
62882
|
+
var defaultToolOutputSchema = {
|
|
62883
|
+
result: external_exports.unknown()
|
|
62884
|
+
};
|
|
62481
62885
|
|
|
62482
62886
|
// ../hyperline-mcp/build/session/sessionKey.js
|
|
62483
62887
|
import { createHmac } from "node:crypto";
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hyperline/cli",
|
|
3
|
-
"version": "0.1.0-build.1.
|
|
3
|
+
"version": "0.1.0-build.1.63ae408",
|
|
4
4
|
"description": "Agent-first CLI for Hyperline API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -48,7 +48,7 @@
|
|
|
48
48
|
"@hyperline/vitest-config": "workspace:*",
|
|
49
49
|
"@types/node": "24.10.1",
|
|
50
50
|
"esbuild": "0.28.0",
|
|
51
|
-
"typescript": "
|
|
51
|
+
"typescript": "7.0.2",
|
|
52
52
|
"vitest": "4.1.5"
|
|
53
53
|
},
|
|
54
54
|
"publishConfig": {
|