@hyperline/cli 0.1.0-build.1.e3db9f3 → 0.1.0-build.1.e757438

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.
@@ -38762,7 +38762,7 @@ How customer invoices are issued from the parent organisation.
38762
38762
  - \`none\`: Invoices will keep being issued from this customer.
38763
38763
  - \`every_invoice\`: Customer invoices will be issued from the organisation individually.
38764
38764
  - \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
38765
- `).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).addHelpText("after", `
38765
+ `).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <value>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
38766
38766
  Examples:
38767
38767
  hyperline customers create-customer
38768
38768
  hyperline customers create-customer --name <name> --type <type>
@@ -38819,6 +38819,10 @@ Examples:
38819
38819
  args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
38820
38820
  if (opts.priceBookId !== void 0)
38821
38821
  args.price_book_id = opts.priceBookId;
38822
+ if (opts.ownerId !== void 0)
38823
+ args.owner_id = opts.ownerId;
38824
+ if (opts.followerIds !== void 0)
38825
+ args.follower_ids = opts.followerIds;
38822
38826
  if (opts.taxRateCustom !== void 0)
38823
38827
  args.tax_rate_custom = Number(opts.taxRateCustom);
38824
38828
  if (opts.customPaymentDelay !== void 0)
@@ -38887,7 +38891,7 @@ How customer invoices are issued from the parent organisation.
38887
38891
  - \`none\`: Invoices will keep being issued from this customer.
38888
38892
  - \`every_invoice\`: Customer invoices will be issued from the organisation individually.
38889
38893
  - \`concat\`: Customer invoices will be grouped into a global parent invoice at a regular schedule (configured on the organisation).
38890
- `).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).addHelpText("after", `
38894
+ `).option("--properties <value>", `Key/value pairs to store any metadata useful in your context.`).option("--custom-properties <value>", `A list of key value with the slug of the custom property as the key and the custom property value as value.`).option("--invoice-reminders-enabled <value>", `Indicates if invoice reminders are enabled for the customer.`).option("--price-book-id <value>", `Default price book ID assigned to the customer.`).option("--owner-id <value>", `ID of the Hyperline user responsible for this customer and targeted by customer agent notifications.`).option("--follower-ids <value>", `IDs of Hyperline users following this customer.`).addHelpText("after", `
38891
38895
  Examples:
38892
38896
  hyperline customers update --id <id>
38893
38897
  hyperline customers update --id <id> --name <name> --type <type>
@@ -38948,6 +38952,10 @@ Examples:
38948
38952
  args.invoice_reminders_enabled = opts.invoiceRemindersEnabled;
38949
38953
  if (opts.priceBookId !== void 0)
38950
38954
  args.price_book_id = opts.priceBookId;
38955
+ if (opts.ownerId !== void 0)
38956
+ args.owner_id = opts.ownerId;
38957
+ if (opts.followerIds !== void 0)
38958
+ args.follower_ids = opts.followerIds;
38951
38959
  if (opts.taxRateCustom !== void 0)
38952
38960
  args.tax_rate_custom = Number(opts.taxRateCustom);
38953
38961
  if (opts.customPaymentDelay !== void 0)
@@ -41801,6 +41809,25 @@ Examples:
41801
41809
  queryParamKeys: []
41802
41810
  });
41803
41811
  });
41812
+ resource.command("finalize").description(`Finalize a draft quote. The quote is submitted for approval when approval is required, otherwise it becomes approved and ready to be sent for signature.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
41813
+ Examples:
41814
+ hyperline quotes finalize --id <id>
41815
+ hyperline quotes finalize --id <id> --output json`).action(async (opts) => {
41816
+ const ctx = resource.parent?.opts()._ctx;
41817
+ if (!ctx) {
41818
+ process.stderr.write("Error: Not authenticated\n");
41819
+ process.exit(1);
41820
+ }
41821
+ const args = {};
41822
+ if (opts.id !== void 0)
41823
+ args.id = opts.id;
41824
+ await ctx.execute({
41825
+ method: "POST",
41826
+ path: "/v1/quotes/{id}/finalize",
41827
+ args,
41828
+ queryParamKeys: []
41829
+ });
41830
+ });
41804
41831
  resource.command("send").description(`Send a quote by email for customer signature. Requires the quote to be approved first.`).requiredOption("--id <value>", `id parameter`).requiredOption("--email <value>", `Email address to which the quote will be sent for signature.`).option("--message <value>", `Custom message used in the email content.`).addHelpText("after", `
41805
41832
  Examples:
41806
41833
  hyperline quotes send --id <id> --email <email>
@@ -42858,7 +42885,7 @@ Examples:
42858
42885
  ]
42859
42886
  });
42860
42887
  });
42861
- resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.`).requiredOption("--source-subscription-id <value>", `The ID of the subscription to transition from`).option("--name <value>", `An optional name for the transition`).option("--calculation-method <value>", `The calculation method to use for the transition. 'do_not_charge' will not generate any transition invoice. 'pro_rata' will generate a prorated invoice for the remaining period.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `Whether the transition should be applied 'immediately' or 'scheduled' for a specific date. Past dates within the current billing period are supported and will be applied immediately.`).option("--transition-date <value>", `The date at which the transition should occur. Only applicable if the application schedule is 'scheduled'. Can be a past date within the current billing period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).requiredOption("--target-subscription <value>", `The configuration of the subscription to transition to`).addHelpText("after", `
42888
+ resource.command("create-subscription-transition").description(`Create a transition from one subscription to another, configured from a subscription, plan, or template. Can be applied immediately or scheduled.`).requiredOption("--source-subscription-id <value>", `The ID of the subscription to transition from`).option("--name <value>", `An optional name for the transition`).option("--calculation-method <value>", `The calculation method to use for the transition. 'do_not_charge' will not generate any transition invoice. 'pro_rata' will generate a prorated invoice for the remaining period. 'refund_and_reinvoice' (only available with application_schedule 'last_renewal') issues a credit note for what was invoiced for the current period and a separate invoice for the new configuration.`).option("--billing-cycle-transition-method <value>", `The billing cycle transition method to use. 'keep_current_billing_cycle' will keep the current billing cycle dates if possible. 'align_to_new_billing_cycle' will align the billing cycle to the transition date.`).requiredOption("--application-schedule <value>", `When the transition should be applied: 'immediately', 'scheduled' for a specific date, or 'last_renewal' to apply it retroactively to the start of the current billing period (refunding what was already invoiced for that period and re-charging the new configuration). Past dates within the current billing period are supported and will be applied immediately.`).option("--transition-date <value>", `The date at which the transition should occur. Only applicable if the application schedule is 'scheduled'. Can be a past date within the current billing period. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).requiredOption("--target-subscription <value>", `The configuration of the subscription to transition to`).addHelpText("after", `
42862
42889
  Examples:
42863
42890
  hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
42864
42891
  hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription> --name <name> --calculation-method <calculation_method>
@@ -43256,10 +43283,10 @@ Examples:
43256
43283
  queryParamKeys: []
43257
43284
  });
43258
43285
  });
43259
- resource.command("load").description(`Add credits to a wallet by charging the customer's payment method. The customer must have an active payment method.`).requiredOption("--id <value>", `id parameter`).option("--amount <number>", `Amount to be loaded onto the wallet. A corresponding invoice to pay will be generated. Expressed in currency's smallest unit.`).option("--amount-free <number>", `Amount free/offered to be loaded onto the wallet. No invoice is generated. Expressed in currency's smallest unit.`).option("--document-status <value>", `Indicates the status of the document (credit note in case of free top-up or invoice)`).addHelpText("after", `
43286
+ resource.command("load").description(`Add paid credits by charging the customer's payment method, or add free credits by issuing a credit note.`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Wallet load type. Use \`paid\` to collect payment from the customer's payment method, or \`free\` to grant credits without collecting payment.`).option("--amount <number>", `Amount to be loaded onto the wallet as free credits. A corresponding credit note will be generated and no payment is collected. Expressed in currency's smallest unit.`).option("--comment <value>", `Internal comment stored on the wallet transaction for context.`).option("--document-status <value>", `Indicates the status of the generated credit note for free top-ups.`).option("--bank-account-id <value>", `Bank account ID to use when recording a paid wallet load by bank transfer.`).option("--reference <value>", `Reference stored on the generated payment document for a paid wallet load.`).addHelpText("after", `
43260
43287
  Examples:
43261
43288
  hyperline wallets load --id <id>
43262
- hyperline wallets load --id <id> --amount <amount> --amount-free <amount_free>
43289
+ hyperline wallets load --id <id> --type <type> --amount <amount>
43263
43290
  hyperline wallets load --id <id> --output json`).action(async (opts) => {
43264
43291
  const ctx = resource.parent?.opts()._ctx;
43265
43292
  if (!ctx) {
@@ -43269,12 +43296,18 @@ Examples:
43269
43296
  const args = {};
43270
43297
  if (opts.id !== void 0)
43271
43298
  args.id = opts.id;
43299
+ if (opts.type !== void 0)
43300
+ args.type = opts.type;
43301
+ if (opts.comment !== void 0)
43302
+ args.comment = opts.comment;
43272
43303
  if (opts.documentStatus !== void 0)
43273
43304
  args.document_status = opts.documentStatus;
43305
+ if (opts.bankAccountId !== void 0)
43306
+ args.bank_account_id = opts.bankAccountId;
43307
+ if (opts.reference !== void 0)
43308
+ args.reference = opts.reference;
43274
43309
  if (opts.amount !== void 0)
43275
43310
  args.amount = Number(opts.amount);
43276
- if (opts.amountFree !== void 0)
43277
- args.amount_free = Number(opts.amountFree);
43278
43311
  await ctx.execute({
43279
43312
  method: "POST",
43280
43313
  path: "/v1/wallets/{id}/load",
@@ -61638,6 +61671,7 @@ import * as winston from "winston";
61638
61671
 
61639
61672
  // ../hyperline-monitoring/build/logger/formatting/format.js
61640
61673
  import prune from "json-prune";
61674
+ var REDACTED_HEADER_KEY_PATTERN = /authorization|authenticate|cookie|secret|token|credential|signature|jwt|api[_-]?key|access[_-]?token|refresh[_-]?token|private[_-]?key/i;
61641
61675
  function jsonFormat(info) {
61642
61676
  const prunedInfo = JSON.parse(prune(info));
61643
61677
  for (const [key, value] of Object.entries(prunedInfo)) {
@@ -61720,17 +61754,26 @@ function formatAxiosError(error48) {
61720
61754
  url: request?.url,
61721
61755
  baseURL: request?.baseURL,
61722
61756
  params: request?.params,
61723
- headers: request?.headers,
61757
+ headers: redactHeaders({ headers: request?.headers }),
61724
61758
  "axios-retry": request?.["axios-retry"]
61725
61759
  },
61726
61760
  response: {
61727
61761
  status: response?.status,
61728
61762
  statusText: response?.statusText,
61729
- headers: response?.headers,
61763
+ headers: redactHeaders({ headers: response?.headers }),
61730
61764
  data: response?.data
61731
61765
  }
61732
61766
  };
61733
61767
  }
61768
+ function redactHeaders({ headers }) {
61769
+ if (!isRecord(headers)) {
61770
+ return headers;
61771
+ }
61772
+ return Object.fromEntries(Object.entries(headers).map(([headerKey, headerValue]) => [
61773
+ headerKey,
61774
+ REDACTED_HEADER_KEY_PATTERN.test(headerKey) ? "<redacted>" : headerValue
61775
+ ]));
61776
+ }
61734
61777
  function isRecord(value) {
61735
61778
  return typeof value === "object" && value !== null && !Array.isArray(value);
61736
61779
  }
@@ -62112,7 +62155,9 @@ var de = {
62112
62155
  "invoices.outstandingProduct.descriptionPeriod": "Unbezahlter Betrag der Rechnung{{invoiceNumber}} vom {{periodStart}} bis {{periodEnd}}",
62113
62156
  "invoices.outstandingProduct.name": "Offener Saldo",
62114
62157
  "invoices.prorata.paymentForItem": "Anteilig berechneter Betrag f\xFCr",
62158
+ "invoices.prorata.paymentForItemFullPeriod": "Zahlung f\xFCr",
62115
62159
  "invoices.prorata.refundForItem": "Anteilig erstatteter Betrag f\xFCr",
62160
+ "invoices.prorata.refundForItemFullPeriod": "Erstattung f\xFCr",
62116
62161
  "subscriptions.closingChargeName": "Abschlussgeb\xFChr f\xFCr das Abonnement",
62117
62162
  "subscriptions.correction": "Vorperiodische Anpassung",
62118
62163
  "subscriptions.updates.addCoupon": "Gutschein hinzuf\xFCgen {{couponName}}",
@@ -62141,7 +62186,9 @@ var en = {
62141
62186
  "invoices.outstandingProduct.descriptionPeriod": "Unpaid amount from the invoice{{invoiceNumber}} from {{periodStart}} to {{periodEnd}}",
62142
62187
  "invoices.outstandingProduct.name": "Outstanding balance",
62143
62188
  "invoices.prorata.paymentForItem": "Prorated payment for",
62189
+ "invoices.prorata.paymentForItemFullPeriod": "Payment for",
62144
62190
  "invoices.prorata.refundForItem": "Prorated refund for",
62191
+ "invoices.prorata.refundForItemFullPeriod": "Refund for",
62145
62192
  "subscriptions.closingChargeName": "Closing fee for subscription",
62146
62193
  "subscriptions.correction": "Adjustment previous period",
62147
62194
  "subscriptions.updates.addCoupon": "Add coupon {{couponName}}",
@@ -62194,7 +62241,9 @@ var es = {
62194
62241
  "invoices.outstandingProduct.descriptionPeriod": "Monto pendiente de la factura{{invoiceNumber}} del {{periodStart}} al {{periodEnd}}",
62195
62242
  "invoices.outstandingProduct.name": "Saldo pendiente",
62196
62243
  "invoices.prorata.paymentForItem": "Pago prorrateado por",
62244
+ "invoices.prorata.paymentForItemFullPeriod": "Pago por",
62197
62245
  "invoices.prorata.refundForItem": "Reembolso prorrateado por",
62246
+ "invoices.prorata.refundForItemFullPeriod": "Reembolso por",
62198
62247
  "subscriptions.closingChargeName": "Cargo por cierre de suscripci\xF3n",
62199
62248
  "subscriptions.correction": "Ajuste del periodo anterior",
62200
62249
  "subscriptions.updates.addCoupon": "A\xF1adir cup\xF3n {{couponName}}",
@@ -62235,7 +62284,9 @@ var fr = {
62235
62284
  "invoices.outstandingProduct.descriptionPeriod": "Montant impay\xE9 de la facture{{invoiceNumber}} du {{periodStart}} au {{periodEnd}}",
62236
62285
  "invoices.outstandingProduct.name": "Solde impay\xE9",
62237
62286
  "invoices.prorata.paymentForItem": "Paiement au prorata pour",
62287
+ "invoices.prorata.paymentForItemFullPeriod": "Paiement pour",
62238
62288
  "invoices.prorata.refundForItem": "Remboursement au prorata pour",
62289
+ "invoices.prorata.refundForItemFullPeriod": "Remboursement pour",
62239
62290
  "subscriptions.closingChargeName": "Frais de cl\xF4ture pour abonnement",
62240
62291
  "subscriptions.correction": "Ajustement p\xE9riode pr\xE9c\xE9dente",
62241
62292
  "subscriptions.updates.addCoupon": "Ajout du coupon {{couponName}}",
@@ -62276,7 +62327,9 @@ var it = {
62276
62327
  "invoices.outstandingProduct.descriptionPeriod": "Importo insoluto della fattura{{invoiceNumber}} dal {{periodStart}} al {{periodEnd}}",
62277
62328
  "invoices.outstandingProduct.name": "Saldo insoluto",
62278
62329
  "invoices.prorata.paymentForItem": "Pagamento proporzionale per",
62330
+ "invoices.prorata.paymentForItemFullPeriod": "Pagamento per",
62279
62331
  "invoices.prorata.refundForItem": "Rimborso proporzionale per",
62332
+ "invoices.prorata.refundForItemFullPeriod": "Rimborso per",
62280
62333
  "subscriptions.closingChargeName": "Costo di chiusura per abbonamento",
62281
62334
  "subscriptions.correction": "Correzione periodo precedente",
62282
62335
  "subscriptions.updates.addCoupon": "Aggiungi coupon {{couponName}}",
@@ -62317,7 +62370,9 @@ var nl = {
62317
62370
  "invoices.outstandingProduct.descriptionPeriod": "Onbetaald bedrag van de factuur{{invoiceNumber}} van {{periodStart}} tot {{periodEnd}}",
62318
62371
  "invoices.outstandingProduct.name": "Openstaand saldo",
62319
62372
  "invoices.prorata.paymentForItem": "Gedeeltelijke betaling voor",
62373
+ "invoices.prorata.paymentForItemFullPeriod": "Betaling voor",
62320
62374
  "invoices.prorata.refundForItem": "Gedeeltelijke terugbetaling voor",
62375
+ "invoices.prorata.refundForItemFullPeriod": "Terugbetaling voor",
62321
62376
  "subscriptions.closingChargeName": "Afsluitkosten voor abonnement",
62322
62377
  "subscriptions.correction": "Aanpassing vorige periode",
62323
62378
  "subscriptions.updates.addCoupon": "Coupon toevoegen {{couponName}}",
@@ -62358,7 +62413,9 @@ var pl = {
62358
62413
  "invoices.outstandingProduct.descriptionPeriod": "Nieop\u0142acona kwota z faktury{{invoiceNumber}} od {{periodStart}} do {{periodEnd}}",
62359
62414
  "invoices.outstandingProduct.name": "Niezap\u0142acone saldo",
62360
62415
  "invoices.prorata.paymentForItem": "P\u0142atno\u015B\u0107 proporcjonalna za",
62416
+ "invoices.prorata.paymentForItemFullPeriod": "P\u0142atno\u015B\u0107 za",
62361
62417
  "invoices.prorata.refundForItem": "Zwrot proporcjonalny za",
62418
+ "invoices.prorata.refundForItemFullPeriod": "Zwrot za",
62362
62419
  "subscriptions.closingChargeName": "Op\u0142ata za zamkni\u0119cie subskrypcji",
62363
62420
  "subscriptions.correction": "Korekta poprzedniego okresu",
62364
62421
  "subscriptions.updates.addCoupon": "Dodaj kupon {{couponName}}",
@@ -62399,7 +62456,9 @@ var pt = {
62399
62456
  "invoices.outstandingProduct.descriptionPeriod": "Valor em aberto da fatura{{invoiceNumber}} de {{periodStart}} a {{periodEnd}}",
62400
62457
  "invoices.outstandingProduct.name": "Saldo em aberto",
62401
62458
  "invoices.prorata.paymentForItem": "Pagamento proporcional por",
62459
+ "invoices.prorata.paymentForItemFullPeriod": "Pagamento por",
62402
62460
  "invoices.prorata.refundForItem": "Reembolso proporcional por",
62461
+ "invoices.prorata.refundForItemFullPeriod": "Reembolso por",
62403
62462
  "subscriptions.closingChargeName": "Taxa de encerramento da assinatura",
62404
62463
  "subscriptions.correction": "Ajuste do per\xEDodo anterior",
62405
62464
  "subscriptions.updates.addCoupon": "Adicionar cupom {{couponName}}",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hyperline/cli",
3
- "version": "0.1.0-build.1.e3db9f3",
3
+ "version": "0.1.0-build.1.e757438",
4
4
  "description": "Agent-first CLI for Hyperline API",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",