@hyperline/cli 0.1.0-build.1.85484d1 → 0.1.0-build.1.8a38d1a
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 +214 -49
- package/dist/external-deps.json +1 -0
- package/package.json +2 -1
|
@@ -34894,10 +34894,10 @@ var require_shared = __commonJS({
|
|
|
34894
34894
|
ZodId: () => ZodId,
|
|
34895
34895
|
ZodTranslationsSchemaFn: () => ZodTranslationsSchemaFn
|
|
34896
34896
|
});
|
|
34897
|
-
var
|
|
34897
|
+
var import_zod19 = require_lib();
|
|
34898
34898
|
var countryIds2 = ["all", ...countries.map(({ id }) => id)];
|
|
34899
|
-
var ZodId =
|
|
34900
|
-
var ZodTranslationsSchemaFn = (schema) =>
|
|
34899
|
+
var ZodId = import_zod19.z.enum(countryIds2);
|
|
34900
|
+
var ZodTranslationsSchemaFn = (schema) => import_zod19.z.record(import_zod19.z.string(), schema.optional());
|
|
34901
34901
|
var UsStates = [
|
|
34902
34902
|
{ id: "AA", name: "Armed Forces Americas" },
|
|
34903
34903
|
{ id: "AE", name: "Armed Forces Europe" },
|
|
@@ -38020,7 +38020,7 @@ Examples:
|
|
|
38020
38020
|
queryParamKeys: ["take", "skip"]
|
|
38021
38021
|
});
|
|
38022
38022
|
});
|
|
38023
|
-
resource.command("create").description(`Create a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38023
|
+
resource.command("create").description(`Create a new coupon with discount rules. Supports percentage or fixed amount discounts, duration limits, and redemption restrictions.`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).option("--repeat <value>", `Default repeat behaviour applied when the coupon is attached to a subscription. Valid values: \`once\`, \`forever\`, \`duration\`. Can be overridden at attach time.`).option("--duration <value>", `Default duration applied when \`repeat\` is \`duration\`. Required when \`repeat\` is \`duration\`, must be null otherwise.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38024
38024
|
Examples:
|
|
38025
38025
|
hyperline coupons create --name <name> --type <type>
|
|
38026
38026
|
hyperline coupons create --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38039,6 +38039,10 @@ Examples:
|
|
|
38039
38039
|
args.expiration_date = opts.expirationDate;
|
|
38040
38040
|
if (opts.productIds !== void 0)
|
|
38041
38041
|
args.product_ids = opts.productIds;
|
|
38042
|
+
if (opts.repeat !== void 0)
|
|
38043
|
+
args.repeat = opts.repeat;
|
|
38044
|
+
if (opts.duration !== void 0)
|
|
38045
|
+
args.duration = opts.duration;
|
|
38042
38046
|
if (opts.type !== void 0)
|
|
38043
38047
|
args.type = opts.type;
|
|
38044
38048
|
if (opts.currency !== void 0)
|
|
@@ -38074,7 +38078,7 @@ Examples:
|
|
|
38074
38078
|
queryParamKeys: []
|
|
38075
38079
|
});
|
|
38076
38080
|
});
|
|
38077
|
-
resource.command("update").description(`Update an existing coupon's name, discount rules, or restrictions.`).requiredOption("--id <value>", `id parameter`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38081
|
+
resource.command("update").description(`Update an existing coupon's name, discount rules, or restrictions.`).requiredOption("--id <value>", `id parameter`).requiredOption("--name <value>", `Coupon name.`).option("--description <value>", `Coupon description.`).option("--expiration-date <value>", `Date corresponding to the expiration of the coupon.`).option("--redemption-limit <number>", `Maximum number of subscriptions to which a single coupon can be applied.`).option("--product-ids <value>", `List of product IDs the coupon can be applied to. If empty, the coupon can be applied to any product.`).option("--repeat <value>", `Default repeat behaviour applied when the coupon is attached to a subscription. Valid values: \`once\`, \`forever\`, \`duration\`. Can be overridden at attach time.`).option("--duration <value>", `Default duration applied when \`repeat\` is \`duration\`. Required when \`repeat\` is \`duration\`, must be null otherwise.`).requiredOption("--type <value>", `type`).option("--discount-amount <number>", `Amount to apply as a discount on the total amount (excluding taxes) of a subscription. Expressed in the currency's smallest unit.`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--discount-percent <number>", `Percentage to apply as a discount on the amount (excluding taxes) of a product.`).addHelpText("after", `
|
|
38078
38082
|
Examples:
|
|
38079
38083
|
hyperline coupons update --id <id> --name <name> --type <type>
|
|
38080
38084
|
hyperline coupons update --id <id> --name <name> --type <type> --description <description> --expiration-date <expiration_date>
|
|
@@ -38095,6 +38099,10 @@ Examples:
|
|
|
38095
38099
|
args.expiration_date = opts.expirationDate;
|
|
38096
38100
|
if (opts.productIds !== void 0)
|
|
38097
38101
|
args.product_ids = opts.productIds;
|
|
38102
|
+
if (opts.repeat !== void 0)
|
|
38103
|
+
args.repeat = opts.repeat;
|
|
38104
|
+
if (opts.duration !== void 0)
|
|
38105
|
+
args.duration = opts.duration;
|
|
38098
38106
|
if (opts.type !== void 0)
|
|
38099
38107
|
args.type = opts.type;
|
|
38100
38108
|
if (opts.currency !== void 0)
|
|
@@ -38429,16 +38437,24 @@ Examples:
|
|
|
38429
38437
|
// build/commands/generated/customers.js
|
|
38430
38438
|
function registerCustomersCommands(parent) {
|
|
38431
38439
|
const resource = parent.command("customers").description("Manage customers");
|
|
38432
|
-
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, created_at, updated_at. Paginated with
|
|
38440
|
+
resource.command("list").description(`List customers with optional filters for name, type, status, currency, country, external_id, billing_email, search, tax_id, subscription_status, invoicing_entity_id, segment_id, custom_properties, payment_method_type, integration_entity_id, created_at, and updated_at. Sortable by created_at or updated_at. Paginated with limit/cursor.`).option("--limit <number>", `Maximum number of items to return (1-100).`).option("--cursor <value>", `Opaque cursor returned in the previous response's \`next_cursor\`. Omit to fetch the first page.`).option("--include-total <value>", `Set to \`true\` to include \`total\` in the response.`).option("--order <value>", `Sort direction.`).option("--sort <value>", `Field used to sort the results.`).option("--name <value>", `name`).option("--name.not <value>", `name__not`).option("--name.is-null <value>", `name__isNull`).option("--name.is-not-null <value>", `name__isNotNull`).option("--name.equals <value>", `name__equals`).option("--name.contains <value>", `name__contains`).option("--name.starts-with <value>", `name__startsWith`).option("--name.end-with <value>", `name__endWith`).option("--type <value>", `type`).option("--type.in <value>", `type__in`).option("--status <value>", `status`).option("--status.in <value>", `status__in`).option("--currency <value>", `currency`).option("--currency.not <value>", `currency__not`).option("--currency.is-null <value>", `currency__isNull`).option("--currency.is-not-null <value>", `currency__isNotNull`).option("--currency.equals <value>", `currency__equals`).option("--currency.contains <value>", `currency__contains`).option("--currency.starts-with <value>", `currency__startsWith`).option("--currency.end-with <value>", `currency__endWith`).option("--country <value>", `country`).option("--country.not <value>", `country__not`).option("--country.is-null <value>", `country__isNull`).option("--country.is-not-null <value>", `country__isNotNull`).option("--country.equals <value>", `country__equals`).option("--country.contains <value>", `country__contains`).option("--country.starts-with <value>", `country__startsWith`).option("--country.end-with <value>", `country__endWith`).option("--external-id <value>", `external_id`).option("--external-id.not <value>", `external_id__not`).option("--external-id.is-null <value>", `external_id__isNull`).option("--external-id.is-not-null <value>", `external_id__isNotNull`).option("--external-id.equals <value>", `external_id__equals`).option("--external-id.contains <value>", `external_id__contains`).option("--external-id.starts-with <value>", `external_id__startsWith`).option("--external-id.end-with <value>", `external_id__endWith`).option("--billing-email <value>", `billing_email`).option("--billing-email.not <value>", `billing_email__not`).option("--billing-email.is-null <value>", `billing_email__isNull`).option("--billing-email.is-not-null <value>", `billing_email__isNotNull`).option("--billing-email.equals <value>", `billing_email__equals`).option("--billing-email.contains <value>", `billing_email__contains`).option("--billing-email.starts-with <value>", `billing_email__startsWith`).option("--billing-email.end-with <value>", `billing_email__endWith`).option("--search <value>", `search`).option("--tax-id <value>", `tax_id`).option("--tax-id.not <value>", `tax_id__not`).option("--tax-id.is-null <value>", `tax_id__isNull`).option("--tax-id.is-not-null <value>", `tax_id__isNotNull`).option("--tax-id.equals <value>", `tax_id__equals`).option("--tax-id.contains <value>", `tax_id__contains`).option("--tax-id.starts-with <value>", `tax_id__startsWith`).option("--tax-id.end-with <value>", `tax_id__endWith`).option("--subscription-status <value>", `subscription_status`).option("--subscription-status.in <value>", `subscription_status__in`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--invoicing-entity-id.not <value>", `invoicing_entity_id__not`).option("--invoicing-entity-id.is-null <value>", `invoicing_entity_id__isNull`).option("--invoicing-entity-id.is-not-null <value>", `invoicing_entity_id__isNotNull`).option("--invoicing-entity-id.equals <value>", `invoicing_entity_id__equals`).option("--invoicing-entity-id.contains <value>", `invoicing_entity_id__contains`).option("--invoicing-entity-id.starts-with <value>", `invoicing_entity_id__startsWith`).option("--invoicing-entity-id.end-with <value>", `invoicing_entity_id__endWith`).option("--segment-id <value>", `segment_id`).option("--custom-properties <value>", `custom_properties`).option("--payment-method-type <value>", `payment_method_type`).option("--payment-method-type.in <value>", `payment_method_type__in`).option("--integration-entity-id <value>", `integration_entity_id`).option("--created-at <value>", `created_at`).option("--created-at.not <value>", `created_at__not`).option("--created-at.is-null <value>", `created_at__isNull`).option("--created-at.is-not-null <value>", `created_at__isNotNull`).option("--created-at.equals <value>", `created_at__equals`).option("--created-at.lt <value>", `created_at__lt`).option("--created-at.lte <value>", `created_at__lte`).option("--created-at.gt <value>", `created_at__gt`).option("--created-at.gte <value>", `created_at__gte`).option("--updated-at <value>", `updated_at`).option("--updated-at.not <value>", `updated_at__not`).option("--updated-at.is-null <value>", `updated_at__isNull`).option("--updated-at.is-not-null <value>", `updated_at__isNotNull`).option("--updated-at.equals <value>", `updated_at__equals`).option("--updated-at.lt <value>", `updated_at__lt`).option("--updated-at.lte <value>", `updated_at__lte`).option("--updated-at.gt <value>", `updated_at__gt`).option("--updated-at.gte <value>", `updated_at__gte`).addHelpText("after", `
|
|
38433
38441
|
Examples:
|
|
38434
38442
|
hyperline customers list
|
|
38435
|
-
hyperline customers list --
|
|
38443
|
+
hyperline customers list --limit <limit> --cursor <cursor>`).action(async (opts) => {
|
|
38436
38444
|
const ctx = resource.parent?.opts()._ctx;
|
|
38437
38445
|
if (!ctx) {
|
|
38438
38446
|
process.stderr.write("Error: Not authenticated\n");
|
|
38439
38447
|
process.exit(1);
|
|
38440
38448
|
}
|
|
38441
38449
|
const args = {};
|
|
38450
|
+
if (opts.cursor !== void 0)
|
|
38451
|
+
args.cursor = opts.cursor;
|
|
38452
|
+
if (opts.includeTotal !== void 0)
|
|
38453
|
+
args.include_total = opts.includeTotal;
|
|
38454
|
+
if (opts.order !== void 0)
|
|
38455
|
+
args.order = opts.order;
|
|
38456
|
+
if (opts.sort !== void 0)
|
|
38457
|
+
args.sort = opts.sort;
|
|
38442
38458
|
if (opts.name !== void 0)
|
|
38443
38459
|
args.name = opts.name;
|
|
38444
38460
|
if (opts["name.not"] !== void 0)
|
|
@@ -38611,17 +38627,18 @@ Examples:
|
|
|
38611
38627
|
args.updated_at__gt = opts["updatedAt.gt"];
|
|
38612
38628
|
if (opts["updatedAt.gte"] !== void 0)
|
|
38613
38629
|
args.updated_at__gte = opts["updatedAt.gte"];
|
|
38614
|
-
if (opts.
|
|
38615
|
-
args.
|
|
38616
|
-
if (opts.skip !== void 0)
|
|
38617
|
-
args.skip = Number(opts.skip);
|
|
38630
|
+
if (opts.limit !== void 0)
|
|
38631
|
+
args.limit = Number(opts.limit);
|
|
38618
38632
|
await ctx.execute({
|
|
38619
38633
|
method: "GET",
|
|
38620
|
-
path: "/
|
|
38634
|
+
path: "/v2/customers",
|
|
38621
38635
|
args,
|
|
38622
38636
|
queryParamKeys: [
|
|
38623
|
-
"
|
|
38624
|
-
"
|
|
38637
|
+
"limit",
|
|
38638
|
+
"cursor",
|
|
38639
|
+
"include_total",
|
|
38640
|
+
"order",
|
|
38641
|
+
"sort",
|
|
38625
38642
|
"name",
|
|
38626
38643
|
"name__not",
|
|
38627
38644
|
"name__isNull",
|
|
@@ -38711,13 +38728,35 @@ Examples:
|
|
|
38711
38728
|
]
|
|
38712
38729
|
});
|
|
38713
38730
|
});
|
|
38731
|
+
resource.command("get").description(`Retrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, integrations, payment method, and bank account.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38732
|
+
Examples:
|
|
38733
|
+
hyperline customers get --id <id>`).action(async (opts) => {
|
|
38734
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
38735
|
+
if (!ctx) {
|
|
38736
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
38737
|
+
process.exit(1);
|
|
38738
|
+
}
|
|
38739
|
+
const args = {};
|
|
38740
|
+
if (opts.id !== void 0)
|
|
38741
|
+
args.id = opts.id;
|
|
38742
|
+
await ctx.execute({
|
|
38743
|
+
method: "GET",
|
|
38744
|
+
path: "/v2/customers/{id}",
|
|
38745
|
+
args,
|
|
38746
|
+
queryParamKeys: []
|
|
38747
|
+
});
|
|
38748
|
+
});
|
|
38714
38749
|
resource.command("create-customer").description(`Create a new customer with billing details, address, currency, and optional provider mappings. Returns the full customer object.`).option("--name <value>", `Customer name.`).option("--type <value>", `
|
|
38715
38750
|
Customer type.
|
|
38716
38751
|
|
|
38717
38752
|
- \`corporate\`: The customer is a business entity.
|
|
38718
38753
|
- \`person\`: The customer is a natural person.
|
|
38719
38754
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38720
|
-
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--
|
|
38755
|
+
`).option("--currency <value>", `Currency code. See [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes).`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--taxability <value>", `Customer taxability.
|
|
38756
|
+
|
|
38757
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38758
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38759
|
+
`).option("--registration-number <value>", `Customer registration number.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38721
38760
|
How customer invoices are issued from the parent organisation.
|
|
38722
38761
|
|
|
38723
38762
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -38742,6 +38781,8 @@ Examples:
|
|
|
38742
38781
|
args.currency = opts.currency;
|
|
38743
38782
|
if (opts.taxIds !== void 0)
|
|
38744
38783
|
args.tax_ids = opts.taxIds;
|
|
38784
|
+
if (opts.taxability !== void 0)
|
|
38785
|
+
args.taxability = opts.taxability;
|
|
38745
38786
|
if (opts.registrationNumber !== void 0)
|
|
38746
38787
|
args.registration_number = opts.registrationNumber;
|
|
38747
38788
|
if (opts.externalId !== void 0)
|
|
@@ -38812,24 +38853,6 @@ Examples:
|
|
|
38812
38853
|
queryParamKeys: []
|
|
38813
38854
|
});
|
|
38814
38855
|
});
|
|
38815
|
-
resource.command("get").description(`Retrieve full details of a customer by ID including billing info, address, subscriptions, custom properties, and provider mappings.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38816
|
-
Examples:
|
|
38817
|
-
hyperline customers get --id <id>`).action(async (opts) => {
|
|
38818
|
-
const ctx = resource.parent?.opts()._ctx;
|
|
38819
|
-
if (!ctx) {
|
|
38820
|
-
process.stderr.write("Error: Not authenticated\n");
|
|
38821
|
-
process.exit(1);
|
|
38822
|
-
}
|
|
38823
|
-
const args = {};
|
|
38824
|
-
if (opts.id !== void 0)
|
|
38825
|
-
args.id = opts.id;
|
|
38826
|
-
await ctx.execute({
|
|
38827
|
-
method: "GET",
|
|
38828
|
-
path: "/v1/customers/{id}",
|
|
38829
|
-
args,
|
|
38830
|
-
queryParamKeys: []
|
|
38831
|
-
});
|
|
38832
|
-
});
|
|
38833
38856
|
resource.command("get-customer-portal-url").description(`Get a portal URL for a customer. The portal allows the customer to view invoices, update payment methods, and manage their account.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
38834
38857
|
Examples:
|
|
38835
38858
|
hyperline customers get-customer-portal-url --id <id>`).action(async (opts) => {
|
|
@@ -38854,7 +38877,11 @@ Customer type.
|
|
|
38854
38877
|
- \`corporate\`: The customer is a business entity.
|
|
38855
38878
|
- \`person\`: The customer is a natural person.
|
|
38856
38879
|
- \`automatically_created\`: The customer was automatically imported (e.g. from a data loader). This value cannot be used when creating/editing.
|
|
38857
|
-
`).option("--currency <value>", `Customer currency. Can only be changed if the customer doesn't have existing invoices, a wallet or a payment method saved.`).option("--tax-ids <value>", `Customer tax IDs.`).option("--tax-rate-custom <number>", `Customer custom tax rate. If not defined, the rate will be automatically determined based on the customer's country, your country, and applicable legal requirements.`).option("--
|
|
38880
|
+
`).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.
|
|
38881
|
+
|
|
38882
|
+
- \`taxable\`: Taxes are automatically determined for the customer.
|
|
38883
|
+
- \`exempt\`: The customer is exempt from tax.
|
|
38884
|
+
`).option("--registration-number <value>", `Customer registration number.`).option("--is-government-affiliated", `Indicates if the customer is affiliated with a government entity.`).option("--external-id <value>", `ID of the customer in your system. This helps matching your customer with the one on Hyperline.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity this customer will be attached to.`).option("--billing-address <value>", `Customer billing address.`).option("--shipping-address <value>", `Customer shipping address.`).option("--billing-email <value>", `Email to which all communications will be sent.`).option("--invoice-emails <value>", `Emails to which invoices will be sent (e.g. payer, finance team, accounting firm). If not defined, invoices will be sent to the \`billing_email\`; otherwise, they won't be sent to the \`billing_email\`.`).option("--language <value>", `Language used for invoices, emails, and hosted pages.`).option("--timezone <value>", `Customer timezone.`).option("--available-payment-methods <value>", `List of payment methods you allow your customer to pay with. You customer will be able to select one of them in their portal page and those will be the default options when creating a checkout session.`).option("--payment-method-type <value>", `Default payment method type used to pay subscriptions and one-off invoices.`).option("--payment-method-id <value>", `ID of the default payment method of the customer. Only applies to card and direct debit.`).option("--bank-account <value>", `Custom bank account for the customer. If not defined and customer paying by bank transfer, the bank accounts configured in your account settings will be used.`).option("--custom-payment-delay <number>", `Custom payment terms in days. If not defined, the default one defined on the related invoicing entity will be used.`).option("--custom-payment-initiation-delay <number>", `Custom initiation delay in days before triggering payment. If not defined, the default one defined on the related invoicing entity will be used.`).option("--organisation-id <value>", `Parent organization ID to which the client is attached.`).option("--organisation-invoicing <value>", `
|
|
38858
38885
|
How customer invoices are issued from the parent organisation.
|
|
38859
38886
|
|
|
38860
38887
|
- \`none\`: Invoices will keep being issued from this customer.
|
|
@@ -38881,6 +38908,8 @@ Examples:
|
|
|
38881
38908
|
args.currency = opts.currency;
|
|
38882
38909
|
if (opts.taxIds !== void 0)
|
|
38883
38910
|
args.tax_ids = opts.taxIds;
|
|
38911
|
+
if (opts.taxability !== void 0)
|
|
38912
|
+
args.taxability = opts.taxability;
|
|
38884
38913
|
if (opts.registrationNumber !== void 0)
|
|
38885
38914
|
args.registration_number = opts.registrationNumber;
|
|
38886
38915
|
if (opts.externalId !== void 0)
|
|
@@ -40175,7 +40204,7 @@ Payment method strategy used to charge the invoice. Only applies to \`to_pay\` s
|
|
|
40175
40204
|
|
|
40176
40205
|
- \`current\`: Use the current default payment method of the customer.
|
|
40177
40206
|
- \`external\`: Manage the payment of the invoice outside of Hyperline.
|
|
40178
|
-
`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--emitted-at <value>", `Issue date of the invoice.`).option("--due-at <value>", `Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.`).option("--settled-at <value>", `Date the invoice was fully paid.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).requiredOption("--line-items <value>", `line_items`).option("--transactions <value>", `transactions`).option("--coupons <value>", `coupons`).addHelpText("after", `
|
|
40207
|
+
`).option("--payment-method-id <value>", `ID of the default payment method used to pay the invoice. Transactions related to the invoice may use different payment methods.`).option("--bank-account-id <value>", `ID of the bank account displayed on the invoice. Transactions related to the invoice may use different bank accounts.`).option("--subscription-id <value>", `ID of the subscription related to the invoice.`).option("--emitted-at <value>", `Issue date of the invoice.`).option("--due-at <value>", `Due date of the invoice. Computed from the issue date and the payment delay configured in your settings.`).option("--settled-at <value>", `Date the invoice was fully paid.`).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `Values for custom properties defined for the \`invoice\` entity, keyed by slug.`).requiredOption("--line-items <value>", `line_items`).option("--transactions <value>", `transactions`).option("--coupons <value>", `coupons`).addHelpText("after", `
|
|
40179
40208
|
Examples:
|
|
40180
40209
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items>
|
|
40181
40210
|
hyperline invoices create-invoice --customer-id <customer_id> --line-items <line_items> --currency <currency> --status <status>
|
|
@@ -40228,6 +40257,8 @@ Examples:
|
|
|
40228
40257
|
args.settled_at = opts.settledAt;
|
|
40229
40258
|
if (opts.properties !== void 0)
|
|
40230
40259
|
args.properties = opts.properties;
|
|
40260
|
+
if (opts.customProperties !== void 0)
|
|
40261
|
+
args.custom_properties = opts.customProperties;
|
|
40231
40262
|
if (opts.lineItems !== void 0)
|
|
40232
40263
|
args.line_items = opts.lineItems;
|
|
40233
40264
|
if (opts.transactions !== void 0)
|
|
@@ -40241,10 +40272,15 @@ Examples:
|
|
|
40241
40272
|
queryParamKeys: []
|
|
40242
40273
|
});
|
|
40243
40274
|
});
|
|
40244
|
-
resource.command("create-credit-note").description(`Create a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount.`).requiredOption("--id <value>", `id parameter`).option("--amount-including-tax <number>", `Amount of the credit note. If not specified, the amount will be computed from the original invoice.`).option("--status <value>", `Status of the credit note.
|
|
40275
|
+
resource.command("create-credit-note").description(`Create a credit note for an existing invoice by ID. Credit notes partially or fully reverse an invoice amount. Optionally trigger a refund via wallet, original payment method, or external settlement.`).requiredOption("--id <value>", `id parameter`).option("--amount-including-tax <number>", `Amount of the credit note. If not specified, the amount will be computed from the original invoice.`).option("--status <value>", `Status of the credit note.
|
|
40245
40276
|
|
|
40246
40277
|
- \`to_pay\`: Credit note is awaiting payment.
|
|
40247
40278
|
- \`draft\`: Credit note is in draft mode (not finalized yet).
|
|
40279
|
+
`).option("--trigger-refund", `Whether to trigger a refund for the credit note amount. Defaults to \`false\`. When \`true\`, the refund is issued using \`refund_method\`.`).option("--refund-method <value>", `How the refund should be settled. Only used when \`trigger_refund\` is \`true\`. Defaults to \`original_payment_method\`.
|
|
40280
|
+
|
|
40281
|
+
- \`wallet\`: Credit the customer's wallet with the refunded amount.
|
|
40282
|
+
- \`original_payment_method\`: Refund to the payment method used on the original invoice.
|
|
40283
|
+
- \`external\`: Mark the refund as settled externally (no automatic transfer).
|
|
40248
40284
|
`).addHelpText("after", `
|
|
40249
40285
|
Examples:
|
|
40250
40286
|
hyperline invoices create-credit-note --id <id>
|
|
@@ -40260,8 +40296,12 @@ Examples:
|
|
|
40260
40296
|
args.id = opts.id;
|
|
40261
40297
|
if (opts.status !== void 0)
|
|
40262
40298
|
args.status = opts.status;
|
|
40299
|
+
if (opts.refundMethod !== void 0)
|
|
40300
|
+
args.refund_method = opts.refundMethod;
|
|
40263
40301
|
if (opts.amountIncludingTax !== void 0)
|
|
40264
40302
|
args.amount_including_tax = Number(opts.amountIncludingTax);
|
|
40303
|
+
if (opts.triggerRefund !== void 0)
|
|
40304
|
+
args.trigger_refund = true;
|
|
40265
40305
|
await ctx.execute({
|
|
40266
40306
|
method: "POST",
|
|
40267
40307
|
path: "/v1/invoices/{id}/credit-notes",
|
|
@@ -40400,7 +40440,7 @@ Examples:
|
|
|
40400
40440
|
|
|
40401
40441
|
- \`auto\`: Tax is automatically computed and applied.
|
|
40402
40442
|
- \`not_eligible\`: Tax collection is disabled for the invoice.
|
|
40403
|
-
`).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", `
|
|
40443
|
+
`).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", `
|
|
40404
40444
|
Examples:
|
|
40405
40445
|
hyperline invoices update --id <id>
|
|
40406
40446
|
hyperline invoices update --id <id> --type <type> --document-name <document_name>
|
|
@@ -40441,6 +40481,8 @@ Examples:
|
|
|
40441
40481
|
args.bank_account_id = opts.bankAccountId;
|
|
40442
40482
|
if (opts.properties !== void 0)
|
|
40443
40483
|
args.properties = opts.properties;
|
|
40484
|
+
if (opts.customProperties !== void 0)
|
|
40485
|
+
args.custom_properties = opts.customProperties;
|
|
40444
40486
|
if (opts.customer !== void 0)
|
|
40445
40487
|
args.customer = opts.customer;
|
|
40446
40488
|
await ctx.execute({
|
|
@@ -40633,7 +40675,7 @@ Examples:
|
|
|
40633
40675
|
queryParamKeys: []
|
|
40634
40676
|
});
|
|
40635
40677
|
});
|
|
40636
|
-
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", `
|
|
40678
|
+
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", `
|
|
40637
40679
|
Examples:
|
|
40638
40680
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
40639
40681
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -40712,6 +40754,8 @@ Examples:
|
|
|
40712
40754
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40713
40755
|
if (opts.isDefault !== void 0)
|
|
40714
40756
|
args.is_default = true;
|
|
40757
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40758
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40715
40759
|
await ctx.execute({
|
|
40716
40760
|
method: "POST",
|
|
40717
40761
|
path: "/v1/invoicing-entities",
|
|
@@ -40719,7 +40763,7 @@ Examples:
|
|
|
40719
40763
|
queryParamKeys: []
|
|
40720
40764
|
});
|
|
40721
40765
|
});
|
|
40722
|
-
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", `
|
|
40766
|
+
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", `
|
|
40723
40767
|
Examples:
|
|
40724
40768
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
40725
40769
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -40790,6 +40834,8 @@ Examples:
|
|
|
40790
40834
|
args.document_payment_initiation_delay = Number(opts.documentPaymentInitiationDelay);
|
|
40791
40835
|
if (opts.isDefault !== void 0)
|
|
40792
40836
|
args.is_default = true;
|
|
40837
|
+
if (opts.creditNoteWalletRefundEnabled !== void 0)
|
|
40838
|
+
args.credit_note_wallet_refund_enabled = true;
|
|
40793
40839
|
await ctx.execute({
|
|
40794
40840
|
method: "PUT",
|
|
40795
40841
|
path: "/v1/invoicing-entities/{id}",
|
|
@@ -41358,18 +41404,18 @@ Examples:
|
|
|
41358
41404
|
// build/commands/generated/quotes.js
|
|
41359
41405
|
function registerQuotesCommands(parent) {
|
|
41360
41406
|
const resource = parent.command("quotes").description("Manage quotes");
|
|
41361
|
-
resource.command("create").description(`Create a new quote for a customer
|
|
41407
|
+
resource.command("create").description(`Create a new quote for a customer. Use \`subscription\` (or \`template_id\`) for subscription quotes; use \`invoice\` for one-off quotes backed by a draft invoice with line items. Quotes can be sent for signature and converted to subscriptions or one-off invoices.`).option("--status <value>", `
|
|
41362
41408
|
Quote status.
|
|
41363
41409
|
|
|
41364
41410
|
- \`draft\`: The quote is a draft.
|
|
41365
41411
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
41366
41412
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
41367
|
-
`).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.
|
|
41413
|
+
`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner. If not specified, the Hyperline account owner will be assigned.`).requiredOption("--customer-id <value>", `ID of the customer.`).option("--invoicing-entity-id <value>", `ID of the invoicing entity attached to the quote.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. For subscription quotes, defaults to the computed subscription value if not specified. For one-off quotes, this field is ignored \u2014 the amount is always derived from the linked invoice's \`amount_excluding_tax\`.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <value>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
41368
41414
|
|
|
41369
41415
|
- \`all\`: Display all pricing tiers.
|
|
41370
41416
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41371
41417
|
- \`none\`: Hide all pricing tiers.
|
|
41372
|
-
`).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", `
|
|
41418
|
+
`).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", `
|
|
41373
41419
|
Examples:
|
|
41374
41420
|
hyperline quotes create --customer-id <customer_id>
|
|
41375
41421
|
hyperline quotes create --customer-id <customer_id> --status <status> --owner-email <owner_email>
|
|
@@ -41414,12 +41460,16 @@ Examples:
|
|
|
41414
41460
|
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41415
41461
|
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41416
41462
|
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41463
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41464
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41417
41465
|
if (opts.templateId !== void 0)
|
|
41418
41466
|
args.template_id = opts.templateId;
|
|
41419
41467
|
if (opts.expiresAt !== void 0)
|
|
41420
41468
|
args.expires_at = opts.expiresAt;
|
|
41421
41469
|
if (opts.subscription !== void 0)
|
|
41422
41470
|
args.subscription = opts.subscription;
|
|
41471
|
+
if (opts.invoice !== void 0)
|
|
41472
|
+
args.invoice = opts.invoice;
|
|
41423
41473
|
if (opts.amount !== void 0)
|
|
41424
41474
|
args.amount = Number(opts.amount);
|
|
41425
41475
|
await ctx.execute({
|
|
@@ -41648,6 +41698,69 @@ Examples:
|
|
|
41648
41698
|
queryParamKeys: []
|
|
41649
41699
|
});
|
|
41650
41700
|
});
|
|
41701
|
+
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass \`subscription\` to create or replace the draft subscription configuration, or pass \`invoice\` on a one-off quote to replace the linked draft invoice.`).requiredOption("--id <value>", `id parameter`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. Set to \`null\` to clear the manually set value.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <value>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
41702
|
+
|
|
41703
|
+
- \`all\`: Display all pricing tiers.
|
|
41704
|
+
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
41705
|
+
- \`none\`: Hide all pricing tiers.
|
|
41706
|
+
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--generate-draft-invoices <value>", `When \`true\`, the invoice issued after signature stays in \`draft\` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to \`false\`.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <value>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).option("--invoice <value>", `Invoice configuration constituting the one-off quote. When provided on a draft one-off quote, it deletes the previous draft invoice and creates a fresh one linked to the quote. \`invoice.invoicing_entity_id\` is ignored on update \u2014 the quote's existing invoicing entity is reused.`).addHelpText("after", `
|
|
41707
|
+
Examples:
|
|
41708
|
+
hyperline quotes update --id <id>
|
|
41709
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --comments <comments>
|
|
41710
|
+
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
41711
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
41712
|
+
if (!ctx) {
|
|
41713
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
41714
|
+
process.exit(1);
|
|
41715
|
+
}
|
|
41716
|
+
const args = {};
|
|
41717
|
+
if (opts.id !== void 0)
|
|
41718
|
+
args.id = opts.id;
|
|
41719
|
+
if (opts.ownerEmail !== void 0)
|
|
41720
|
+
args.owner_email = opts.ownerEmail;
|
|
41721
|
+
if (opts.comments !== void 0)
|
|
41722
|
+
args.comments = opts.comments;
|
|
41723
|
+
if (opts.terms !== void 0)
|
|
41724
|
+
args.terms = opts.terms;
|
|
41725
|
+
if (opts.collectPaymentDetails !== void 0)
|
|
41726
|
+
args.collect_payment_details = opts.collectPaymentDetails;
|
|
41727
|
+
if (opts.collectCustomPropertyIds !== void 0)
|
|
41728
|
+
args.collect_custom_property_ids = opts.collectCustomPropertyIds;
|
|
41729
|
+
if (opts.requireTaxId !== void 0)
|
|
41730
|
+
args.require_tax_id = opts.requireTaxId;
|
|
41731
|
+
if (opts.displayQuoteValue !== void 0)
|
|
41732
|
+
args.display_quote_value = opts.displayQuoteValue;
|
|
41733
|
+
if (opts.displayQuoteValueWithTax !== void 0)
|
|
41734
|
+
args.display_quote_value_with_tax = opts.displayQuoteValueWithTax;
|
|
41735
|
+
if (opts.displayTaxes !== void 0)
|
|
41736
|
+
args.display_taxes = opts.displayTaxes;
|
|
41737
|
+
if (opts.displayPriceTiers !== void 0)
|
|
41738
|
+
args.display_price_tiers = opts.displayPriceTiers;
|
|
41739
|
+
if (opts.displayPhaseValue !== void 0)
|
|
41740
|
+
args.display_phase_value = opts.displayPhaseValue;
|
|
41741
|
+
if (opts.displayFirstInvoiceAmount !== void 0)
|
|
41742
|
+
args.display_first_invoice_amount = opts.displayFirstInvoiceAmount;
|
|
41743
|
+
if (opts.displayDocumentsInPreview !== void 0)
|
|
41744
|
+
args.display_documents_in_preview = opts.displayDocumentsInPreview;
|
|
41745
|
+
if (opts.displaySubscriptionOnUpdate !== void 0)
|
|
41746
|
+
args.display_subscription_on_update = opts.displaySubscriptionOnUpdate;
|
|
41747
|
+
if (opts.generateDraftInvoices !== void 0)
|
|
41748
|
+
args.generate_draft_invoices = opts.generateDraftInvoices;
|
|
41749
|
+
if (opts.expiresAt !== void 0)
|
|
41750
|
+
args.expires_at = opts.expiresAt;
|
|
41751
|
+
if (opts.subscription !== void 0)
|
|
41752
|
+
args.subscription = opts.subscription;
|
|
41753
|
+
if (opts.invoice !== void 0)
|
|
41754
|
+
args.invoice = opts.invoice;
|
|
41755
|
+
if (opts.amount !== void 0)
|
|
41756
|
+
args.amount = Number(opts.amount);
|
|
41757
|
+
await ctx.execute({
|
|
41758
|
+
method: "PATCH",
|
|
41759
|
+
path: "/v1/quotes/{id}",
|
|
41760
|
+
args,
|
|
41761
|
+
queryParamKeys: []
|
|
41762
|
+
});
|
|
41763
|
+
});
|
|
41651
41764
|
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", `
|
|
41652
41765
|
Examples:
|
|
41653
41766
|
hyperline quotes download --id <id>
|
|
@@ -41798,7 +41911,7 @@ Examples:
|
|
|
41798
41911
|
// build/commands/generated/subscriptions.js
|
|
41799
41912
|
function registerSubscriptionsCommands(parent) {
|
|
41800
41913
|
const resource = parent.command("subscriptions").description("Manage subscriptions");
|
|
41801
|
-
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", `
|
|
41914
|
+
resource.command("create-subscription-update").description(`Apply a single update to an existing subscription (e.g. change quantity, add/remove product, modify price).`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--type <value>", `type`).requiredOption("--payload <value>", `payload`).addHelpText("after", `
|
|
41802
41915
|
Examples:
|
|
41803
41916
|
hyperline subscriptions create-subscription-update --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --type <type> --payload <payload>
|
|
41804
41917
|
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>
|
|
@@ -41821,6 +41934,8 @@ Examples:
|
|
|
41821
41934
|
args.charge_at = opts.chargeAt;
|
|
41822
41935
|
if (opts.calculationMethod !== void 0)
|
|
41823
41936
|
args.calculation_method = opts.calculationMethod;
|
|
41937
|
+
if (opts.refundMethod !== void 0)
|
|
41938
|
+
args.refund_method = opts.refundMethod;
|
|
41824
41939
|
if (opts.type !== void 0)
|
|
41825
41940
|
args.type = opts.type;
|
|
41826
41941
|
if (opts.payload !== void 0)
|
|
@@ -41832,7 +41947,7 @@ Examples:
|
|
|
41832
41947
|
queryParamKeys: []
|
|
41833
41948
|
});
|
|
41834
41949
|
});
|
|
41835
|
-
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", `
|
|
41950
|
+
resource.command("create-subscription-updates").description(`Apply multiple updates at once to an existing subscription in a single atomic operation.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
41836
41951
|
Examples:
|
|
41837
41952
|
hyperline subscriptions create-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
41838
41953
|
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>
|
|
@@ -41855,6 +41970,8 @@ Examples:
|
|
|
41855
41970
|
args.charge_at = opts.chargeAt;
|
|
41856
41971
|
if (opts.calculationMethod !== void 0)
|
|
41857
41972
|
args.calculation_method = opts.calculationMethod;
|
|
41973
|
+
if (opts.refundMethod !== void 0)
|
|
41974
|
+
args.refund_method = opts.refundMethod;
|
|
41858
41975
|
if (opts.updates !== void 0)
|
|
41859
41976
|
args.updates = opts.updates;
|
|
41860
41977
|
await ctx.execute({
|
|
@@ -41864,7 +41981,7 @@ Examples:
|
|
|
41864
41981
|
queryParamKeys: []
|
|
41865
41982
|
});
|
|
41866
41983
|
});
|
|
41867
|
-
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", `
|
|
41984
|
+
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", `
|
|
41868
41985
|
Examples:
|
|
41869
41986
|
hyperline subscriptions cancel --id <id>
|
|
41870
41987
|
hyperline subscriptions cancel --id <id> --cancel-at <cancel_at> --reason <reason>
|
|
@@ -41881,6 +41998,8 @@ Examples:
|
|
|
41881
41998
|
args.cancel_at = opts.cancelAt;
|
|
41882
41999
|
if (opts.reason !== void 0)
|
|
41883
42000
|
args.reason = opts.reason;
|
|
42001
|
+
if (opts.refundMethod !== void 0)
|
|
42002
|
+
args.refund_method = opts.refundMethod;
|
|
41884
42003
|
if (opts.proRata !== void 0)
|
|
41885
42004
|
args.pro_rata = true;
|
|
41886
42005
|
await ctx.execute({
|
|
@@ -41990,7 +42109,7 @@ Examples:
|
|
|
41990
42109
|
queryParamKeys: []
|
|
41991
42110
|
});
|
|
41992
42111
|
});
|
|
41993
|
-
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", `
|
|
42112
|
+
resource.command("simulate-subscription-updates").description(`Preview the effect of updates on a subscription without applying them. Returns simulated invoice and billing impact.`).requiredOption("--id <value>", `id parameter`).requiredOption("--application-schedule <value>", `application_schedule`).option("--apply-at <value>", `The date when the update should be applied. Required when application_schedule is 'scheduled'.`).requiredOption("--payment-schedule <value>", `payment_schedule`).option("--charge-at <value>", `The date when the resulting subscription update should be charged. Required when payment_schedule is 'custom'. Must be in the future.`).requiredOption("--calculation-method <value>", `calculation_method`).option("--refund-method <value>", `Override the refund destination when the update generates a refund credit note (e.g. seat reduction). When omitted, falls back to the invoicing entity's \`creditNoteWalletRefundEnabled\` setting.`).requiredOption("--updates <value>", `updates`).addHelpText("after", `
|
|
41994
42113
|
Examples:
|
|
41995
42114
|
hyperline subscriptions simulate-subscription-updates --id <id> --application-schedule <application_schedule> --payment-schedule <payment_schedule> --calculation-method <calculation_method> --updates <updates>
|
|
41996
42115
|
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>
|
|
@@ -42013,6 +42132,8 @@ Examples:
|
|
|
42013
42132
|
args.charge_at = opts.chargeAt;
|
|
42014
42133
|
if (opts.calculationMethod !== void 0)
|
|
42015
42134
|
args.calculation_method = opts.calculationMethod;
|
|
42135
|
+
if (opts.refundMethod !== void 0)
|
|
42136
|
+
args.refund_method = opts.refundMethod;
|
|
42016
42137
|
if (opts.updates !== void 0)
|
|
42017
42138
|
args.updates = opts.updates;
|
|
42018
42139
|
await ctx.execute({
|
|
@@ -42038,7 +42159,7 @@ Strategy used to cancel the subscription. If not specified \`do_nothing\` is use
|
|
|
42038
42159
|
- \`refund_custom\`: Will refund to the customer a custom amount.
|
|
42039
42160
|
- \`end_of_period\`: Will cancel the subscription at the end date of the current billing period.
|
|
42040
42161
|
- \`do_nothing\`: Will only cease the subscription without any additional actions.
|
|
42041
|
-
`).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>", `
|
|
42162
|
+
`).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>", `
|
|
42042
42163
|
Defines when invoices are generated relative to the billing period.
|
|
42043
42164
|
|
|
42044
42165
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42093,6 +42214,8 @@ Examples:
|
|
|
42093
42214
|
args.cancel_at = opts.cancelAt;
|
|
42094
42215
|
if (opts.cancellationStrategy !== void 0)
|
|
42095
42216
|
args.cancellation_strategy = opts.cancellationStrategy;
|
|
42217
|
+
if (opts.cancellationRefundMethod !== void 0)
|
|
42218
|
+
args.cancellation_refund_method = opts.cancellationRefundMethod;
|
|
42096
42219
|
if (opts.properties !== void 0)
|
|
42097
42220
|
args.properties = opts.properties;
|
|
42098
42221
|
if (opts.customProperties !== void 0)
|
|
@@ -42375,7 +42498,7 @@ Examples:
|
|
|
42375
42498
|
queryParamKeys: []
|
|
42376
42499
|
});
|
|
42377
42500
|
});
|
|
42378
|
-
resource.command("update").description(`Comprehensive subscription update: modify fields, manage phases (add/update/delete pending phases), update products within phases, and manage coupons.
|
|
42501
|
+
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>", `
|
|
42379
42502
|
Defines when invoices are generated relative to the billing period.
|
|
42380
42503
|
|
|
42381
42504
|
- \`period_start\`: Invoices are generated at the start of the billing period.
|
|
@@ -42949,6 +43072,30 @@ Examples:
|
|
|
42949
43072
|
});
|
|
42950
43073
|
}
|
|
42951
43074
|
|
|
43075
|
+
// build/commands/generated/transactions.js
|
|
43076
|
+
function registerTransactionsCommands(parent) {
|
|
43077
|
+
const resource = parent.command("transactions").description("Manage transactions");
|
|
43078
|
+
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", `
|
|
43079
|
+
Examples:
|
|
43080
|
+
hyperline transactions refund --id <id>
|
|
43081
|
+
hyperline transactions refund --id <id> --output json`).action(async (opts) => {
|
|
43082
|
+
const ctx = resource.parent?.opts()._ctx;
|
|
43083
|
+
if (!ctx) {
|
|
43084
|
+
process.stderr.write("Error: Not authenticated\n");
|
|
43085
|
+
process.exit(1);
|
|
43086
|
+
}
|
|
43087
|
+
const args = {};
|
|
43088
|
+
if (opts.id !== void 0)
|
|
43089
|
+
args.id = opts.id;
|
|
43090
|
+
await ctx.execute({
|
|
43091
|
+
method: "POST",
|
|
43092
|
+
path: "/v1/transactions/{id}/refund",
|
|
43093
|
+
args,
|
|
43094
|
+
queryParamKeys: []
|
|
43095
|
+
});
|
|
43096
|
+
});
|
|
43097
|
+
}
|
|
43098
|
+
|
|
42952
43099
|
// build/commands/generated/wallets.js
|
|
42953
43100
|
function registerWalletsCommands(parent) {
|
|
42954
43101
|
const resource = parent.command("wallets").description("Manage wallets");
|
|
@@ -43361,6 +43508,7 @@ function registerAllCommands(program2) {
|
|
|
43361
43508
|
registerSubscriptions_TransitionsCommands(program2);
|
|
43362
43509
|
registerSubscriptions_PhasesCommands(program2);
|
|
43363
43510
|
registerTaxesCommands(program2);
|
|
43511
|
+
registerTransactionsCommands(program2);
|
|
43364
43512
|
registerWalletsCommands(program2);
|
|
43365
43513
|
registerWebhooksCommands(program2);
|
|
43366
43514
|
}
|
|
@@ -57151,6 +57299,7 @@ var BooleanSchema = external_exports.boolean().or(external_exports.enum(["true",
|
|
|
57151
57299
|
});
|
|
57152
57300
|
var StringSchemaForMultipartForm = external_exports.string().transform((value) => value === "" ? null : value);
|
|
57153
57301
|
var StringArraySchemaForMultipartForm = external_exports.string().array().or(external_exports.string().length(0)).transform((value) => typeof value === "string" ? [] : value);
|
|
57302
|
+
var CommaSeparatedArraySchema = external_exports.string().optional().transform((raw) => raw ? raw.split(",").filter(Boolean) : void 0);
|
|
57154
57303
|
var urlRegex = /^(?:(?:https?):\/\/)?(?:www\.)?(?:[\w-]+\.)+[a-z]{2,7}(?:\/\S*)?$/i;
|
|
57155
57304
|
var ZodFlexibleUrl = external_exports.string({ message: "Invalid URL" }).regex(urlRegex).transform((url2) => {
|
|
57156
57305
|
if (!url2)
|
|
@@ -61463,6 +61612,7 @@ function getConfig(schema, testValues) {
|
|
|
61463
61612
|
var config3 = getConfig({
|
|
61464
61613
|
// config
|
|
61465
61614
|
APP_VERSION: types.string().optional(),
|
|
61615
|
+
DD_SERVICE: types.string().optional(),
|
|
61466
61616
|
LOGGER_CONSOLE_ENABLED: types.boolean().optional(),
|
|
61467
61617
|
LOGGER_STDOUT_ENABLED: types.boolean().optional(),
|
|
61468
61618
|
NODE_ENV: types.enum(["local", "test", "staging", "sandbox", "production"]),
|
|
@@ -61472,6 +61622,7 @@ var config3 = getConfig({
|
|
|
61472
61622
|
// secrets
|
|
61473
61623
|
}, {
|
|
61474
61624
|
APP_VERSION: void 0,
|
|
61625
|
+
DD_SERVICE: void 0,
|
|
61475
61626
|
LOGGER_CONSOLE_ENABLED: false,
|
|
61476
61627
|
LOGGER_STDOUT_ENABLED: false,
|
|
61477
61628
|
EVENT_LOOP_MONITORING_ENABLED: false,
|
|
@@ -61750,13 +61901,16 @@ var loggerFactory = buildLoggerFactory({
|
|
|
61750
61901
|
},
|
|
61751
61902
|
context: {
|
|
61752
61903
|
env: config3.NODE_ENV,
|
|
61753
|
-
service: "api",
|
|
61904
|
+
service: config3.DD_SERVICE ?? "api",
|
|
61754
61905
|
version: config3.APP_VERSION
|
|
61755
61906
|
}
|
|
61756
61907
|
});
|
|
61757
61908
|
var createLogger2 = loggerFactory.createLogger;
|
|
61758
61909
|
var logger = loggerFactory.createLogger({ serviceName: "default" });
|
|
61759
61910
|
|
|
61911
|
+
// ../hyperline-monitoring/build/tracing/tracing.js
|
|
61912
|
+
import tracer from "dd-trace";
|
|
61913
|
+
|
|
61760
61914
|
// ../hyperline-lib/build/utils/config/usStates.js
|
|
61761
61915
|
var usStates = [
|
|
61762
61916
|
"AA",
|
|
@@ -61941,6 +62095,7 @@ var languages = [
|
|
|
61941
62095
|
var de = {
|
|
61942
62096
|
"accounting.invoicePosted.entryDescription": "Buchungseintrag f\xFCr Rechnung {{invoiceId}}",
|
|
61943
62097
|
"accounting.transactionSettled.entryDescription": "Zahlungsabwicklung f\xFCr Rechnung {{invoiceId}}",
|
|
62098
|
+
"accounting.transactionRefunded.entryDescription": "R\xFCckerstattung f\xFCr Rechnung {{invoiceId}}",
|
|
61944
62099
|
"accounting.creditNotePosted.entryDescription": "Gutschrift {{creditNoteId}} f\xFCr Rechnung {{invoiceId}}",
|
|
61945
62100
|
"accounting.revrec.creditLineDescription": "Umsatz realisieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
61946
62101
|
"accounting.revrec.debitLineDescription": "Abgrenzungsposten reduzieren \u2013 Zeitplan {{scheduleId}}, Zeitraum {{periodDate}}",
|
|
@@ -62006,6 +62161,7 @@ var en = {
|
|
|
62006
62161
|
"subscriptions.updates.updateCount.description.full.not_committed.not_invoiced": "Amount of {{amount}} not invoiced for the full period",
|
|
62007
62162
|
"accounting.invoicePosted.entryDescription": "Posting entry for Invoice {{invoiceId}} issued",
|
|
62008
62163
|
"accounting.transactionSettled.entryDescription": "Payment settlement for Invoice {{invoiceId}}",
|
|
62164
|
+
"accounting.transactionRefunded.entryDescription": "Refund for Invoice {{invoiceId}}",
|
|
62009
62165
|
"accounting.creditNotePosted.entryDescription": "Credit note {{creditNoteId}} for Invoice {{invoiceId}}",
|
|
62010
62166
|
"accounting.revrec.entryDescription": "Revenue recognition for schedule {{scheduleId}}, period {{periodStart}} - {{periodEnd}}",
|
|
62011
62167
|
"accounting.revrec.debitLineDescription": "Decrease deferred revenue \u2013 schedule {{scheduleId}}, period {{periodDate}}",
|
|
@@ -62021,6 +62177,7 @@ var en = {
|
|
|
62021
62177
|
var es = {
|
|
62022
62178
|
"accounting.invoicePosted.entryDescription": "Asiento contable para la factura {{invoiceId}}",
|
|
62023
62179
|
"accounting.transactionSettled.entryDescription": "Liquidaci\xF3n de pago para la factura {{invoiceId}}",
|
|
62180
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso de la factura {{invoiceId}}",
|
|
62024
62181
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para la factura {{invoiceId}}",
|
|
62025
62182
|
"accounting.revrec.creditLineDescription": "Reconocer ingresos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62026
62183
|
"accounting.revrec.debitLineDescription": "Disminuci\xF3n de ingresos diferidos \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
@@ -62065,6 +62222,7 @@ var fr = {
|
|
|
62065
62222
|
"accounting.revrec.discountDebitLineDescription": "Diminution des remises diff\xE9r\xE9es \u2013 \xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodDate}}",
|
|
62066
62223
|
"accounting.invoicePosted.entryDescription": "\xC9criture de comptabilisation pour la facture {{invoiceId}}",
|
|
62067
62224
|
"accounting.transactionSettled.entryDescription": "R\xE8glement de la facture {{invoiceId}}",
|
|
62225
|
+
"accounting.transactionRefunded.entryDescription": "Remboursement de la facture {{invoiceId}}",
|
|
62068
62226
|
"accounting.creditNotePosted.entryDescription": "Avoir {{creditNoteId}} pour la facture {{invoiceId}}",
|
|
62069
62227
|
"accounting.revrec.entryDescription": "Reconnaissance du chiffre d'affaires pour l'\xE9ch\xE9ancier {{scheduleId}}, p\xE9riode {{periodStart}} - {{periodEnd}}",
|
|
62070
62228
|
"creditNotes.refundChargeName": "Remboursement pour facture",
|
|
@@ -62101,6 +62259,7 @@ var fr = {
|
|
|
62101
62259
|
var it = {
|
|
62102
62260
|
"accounting.invoicePosted.entryDescription": "Registrazione contabile per la fattura {{invoiceId}}",
|
|
62103
62261
|
"accounting.transactionSettled.entryDescription": "Regolamento pagamento per la fattura {{invoiceId}}",
|
|
62262
|
+
"accounting.transactionRefunded.entryDescription": "Rimborso per la fattura {{invoiceId}}",
|
|
62104
62263
|
"accounting.creditNotePosted.entryDescription": "Nota di credito {{creditNoteId}} per la fattura {{invoiceId}}",
|
|
62105
62264
|
"accounting.revrec.creditLineDescription": "Riconoscere i ricavi \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
62106
62265
|
"accounting.revrec.debitLineDescription": "Diminuzione dei ricavi differiti \u2013 programma {{scheduleId}}, periodo {{periodDate}}",
|
|
@@ -62141,6 +62300,7 @@ var it = {
|
|
|
62141
62300
|
var nl = {
|
|
62142
62301
|
"accounting.invoicePosted.entryDescription": "Boekingsregel voor factuur {{invoiceId}}",
|
|
62143
62302
|
"accounting.transactionSettled.entryDescription": "Betalingsafwikkeling voor factuur {{invoiceId}}",
|
|
62303
|
+
"accounting.transactionRefunded.entryDescription": "Terugbetaling voor factuur {{invoiceId}}",
|
|
62144
62304
|
"accounting.creditNotePosted.entryDescription": "Creditnota {{creditNoteId}} voor factuur {{invoiceId}}",
|
|
62145
62305
|
"accounting.revrec.creditLineDescription": "Omzet erkennen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
62146
62306
|
"accounting.revrec.debitLineDescription": "Uitgestelde omzet verlagen \u2013 schema {{scheduleId}}, periode {{periodDate}}",
|
|
@@ -62181,6 +62341,7 @@ var nl = {
|
|
|
62181
62341
|
var pl = {
|
|
62182
62342
|
"accounting.invoicePosted.entryDescription": "Zapis ksi\u0119gowy dla faktury {{invoiceId}}",
|
|
62183
62343
|
"accounting.transactionSettled.entryDescription": "Rozliczenie p\u0142atno\u015Bci dla faktury {{invoiceId}}",
|
|
62344
|
+
"accounting.transactionRefunded.entryDescription": "Zwrot za faktur\u0119 {{invoiceId}}",
|
|
62184
62345
|
"accounting.creditNotePosted.entryDescription": "Nota kredytowa {{creditNoteId}} dla faktury {{invoiceId}}",
|
|
62185
62346
|
"accounting.revrec.creditLineDescription": "Rozpoznanie przychodu \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
62186
62347
|
"accounting.revrec.debitLineDescription": "Zmniejszenie przychod\xF3w przysz\u0142ych okres\xF3w \u2013 harmonogram {{scheduleId}}, okres {{periodDate}}",
|
|
@@ -62221,6 +62382,7 @@ var pl = {
|
|
|
62221
62382
|
var pt = {
|
|
62222
62383
|
"accounting.invoicePosted.entryDescription": "Lan\xE7amento cont\xE1bil para a fatura {{invoiceId}}",
|
|
62223
62384
|
"accounting.transactionSettled.entryDescription": "Liquida\xE7\xE3o de pagamento para a fatura {{invoiceId}}",
|
|
62385
|
+
"accounting.transactionRefunded.entryDescription": "Reembolso da fatura {{invoiceId}}",
|
|
62224
62386
|
"accounting.creditNotePosted.entryDescription": "Nota de cr\xE9dito {{creditNoteId}} para a fatura {{invoiceId}}",
|
|
62225
62387
|
"accounting.revrec.creditLineDescription": "Reconhecer receita \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
62226
62388
|
"accounting.revrec.debitLineDescription": "Diminui\xE7\xE3o da receita diferida \u2013 cronograma {{scheduleId}}, per\xEDodo {{periodDate}}",
|
|
@@ -62455,6 +62617,9 @@ import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/
|
|
|
62455
62617
|
|
|
62456
62618
|
// ../hyperline-mcp/build/server/server.js
|
|
62457
62619
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
62620
|
+
var defaultToolOutputSchema = {
|
|
62621
|
+
result: external_exports.unknown()
|
|
62622
|
+
};
|
|
62458
62623
|
|
|
62459
62624
|
// ../hyperline-mcp/build/session/sessionKey.js
|
|
62460
62625
|
import { createHmac } from "node:crypto";
|
package/dist/external-deps.json
CHANGED
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.8a38d1a",
|
|
4
4
|
"description": "Agent-first CLI for Hyperline API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -27,6 +27,7 @@
|
|
|
27
27
|
"axios": "1.13.2",
|
|
28
28
|
"axios-retry": "4.5.0",
|
|
29
29
|
"commander": "13.1.0",
|
|
30
|
+
"dd-trace": "5.45.0",
|
|
30
31
|
"dotenv": "16.3.1",
|
|
31
32
|
"express": "5.2.1",
|
|
32
33
|
"express-idempotency": "2.0.0",
|