@hyperline/cli 0.1.0-build.1.eeaea56 → 0.1.0-build.1.efe955e
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 +36 -17
- package/dist/external-deps.json +0 -1
- package/package.json +1 -2
|
@@ -41112,7 +41112,7 @@ Examples:
|
|
|
41112
41112
|
]
|
|
41113
41113
|
});
|
|
41114
41114
|
});
|
|
41115
|
-
resource.command("create").description(`Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name
|
|
41115
|
+
resource.command("create").description(`Upload a new file (max 10MB). Requires multipart form data with a file field and metadata (name and customer_id).`).requiredOption("--name <value>", `Name of the file to be uploaded.`).requiredOption("--customer-id <value>", `ID of the customer to link the file to.`).addHelpText("after", `
|
|
41116
41116
|
Examples:
|
|
41117
41117
|
hyperline files create --name <name> --customer-id <customer_id>
|
|
41118
41118
|
hyperline files create --name <name> --customer-id <customer_id> --output json`).action(async (opts) => {
|
|
@@ -41652,7 +41652,7 @@ Examples:
|
|
|
41652
41652
|
queryParamKeys: []
|
|
41653
41653
|
});
|
|
41654
41654
|
});
|
|
41655
|
-
resource.command("validate").description(`
|
|
41655
|
+
resource.command("validate").description(`Submit a draft invoice for finalization. The result may be pending approval or finalized for payment.`).requiredOption("--id <value>", `id parameter`).addHelpText("after", `
|
|
41656
41656
|
Examples:
|
|
41657
41657
|
hyperline invoices validate --id <id>
|
|
41658
41658
|
hyperline invoices validate --id <id> --output json`).action(async (opts) => {
|
|
@@ -42000,7 +42000,7 @@ Examples:
|
|
|
42000
42000
|
queryParamKeys: []
|
|
42001
42001
|
});
|
|
42002
42002
|
});
|
|
42003
|
-
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 and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity.`).addHelpText("after", `
|
|
42003
|
+
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. It cannot be changed after creation.`).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 and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity.`).addHelpText("after", `
|
|
42004
42004
|
Examples:
|
|
42005
42005
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency>
|
|
42006
42006
|
hyperline invoicing-entities create-invoicing-entity --name <name> --country <country> --currency <currency> --accounting-currency <accounting_currency> --is-default --trade-name <trade_name>
|
|
@@ -42090,7 +42090,7 @@ Examples:
|
|
|
42090
42090
|
queryParamKeys: []
|
|
42091
42091
|
});
|
|
42092
42092
|
});
|
|
42093
|
-
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 and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity.`).addHelpText("after", `
|
|
42093
|
+
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. It cannot be changed after creation.`).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 and no \`refund_method\` is specified, credit note refunds default to the customer's wallet, including credit notes generated by subscription updates, cancellations, and transitions. An explicit \`refund_method\` always wins. Requires wallets to be enabled at the workspace level.`).option("--standalone-credit-note-creation-enabled", `Whether credit notes without an original invoice can be created under this invoicing entity.`).addHelpText("after", `
|
|
42094
42094
|
Examples:
|
|
42095
42095
|
hyperline invoicing-entities update-invoicing-entity --id <id>
|
|
42096
42096
|
hyperline invoicing-entities update-invoicing-entity --id <id> --name <name> --registration-number <registration_number>
|
|
@@ -42790,7 +42790,7 @@ Quote status.
|
|
|
42790
42790
|
- \`draft\`: The quote is a draft.
|
|
42791
42791
|
- \`approved\`: The quote is approved and ready to be sent to the customer.
|
|
42792
42792
|
- \`pending_signature\`: The quote is awaiting the customer's signature.
|
|
42793
|
-
`).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 <json>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--contract-clause-ids <json>", `IDs of the contract clauses used in the quote terms.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
42793
|
+
`).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("--catalog-version-id <value>", `ID of a published catalog version to price every product of the quote from, instead of the live products catalog. A product's own \`catalog_version_id\` takes precedence, and explicit \`prices\` always win over both.`).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 <json>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--contract-clause-ids <json>", `IDs of the contract clauses used in the quote terms.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
42794
42794
|
|
|
42795
42795
|
- \`all\`: Display all pricing tiers.
|
|
42796
42796
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
@@ -42814,6 +42814,8 @@ Examples:
|
|
|
42814
42814
|
args.customer_id = opts.customerId;
|
|
42815
42815
|
if (opts.invoicingEntityId !== void 0)
|
|
42816
42816
|
args.invoicing_entity_id = opts.invoicingEntityId;
|
|
42817
|
+
if (opts.catalogVersionId !== void 0)
|
|
42818
|
+
args.catalog_version_id = opts.catalogVersionId;
|
|
42817
42819
|
if (opts.comments !== void 0)
|
|
42818
42820
|
args.comments = opts.comments;
|
|
42819
42821
|
if (opts.terms !== void 0)
|
|
@@ -43080,7 +43082,7 @@ Examples:
|
|
|
43080
43082
|
queryParamKeys: []
|
|
43081
43083
|
});
|
|
43082
43084
|
});
|
|
43083
|
-
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass \`subscription\` to create or replace the draft subscription configuration, or pass \`invoice\` on a one-off quote to replace the linked draft invoice. For quotes created from \`template_id\`, use this tool for subscription overrides such as dates, contract terms, products, phases, coupons, discounts, prices, seats, and subscription custom properties. Omit \`terms\`, \`comments\`, and \`contract_clause_ids\` unless deliberately overriding template content.`).requiredOption("--id <value>", `id parameter`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner.`).option("--comments <value>", `Custom comments displayed on the quote.`).option("--terms <value>", `Custom quotation terms.`).option("--amount <number>", `Estimated contract value. Set to \`null\` to clear the manually set value.`).option("--collect-payment-details <value>", `Collect customer payment method mandate during signature flow or not.`).option("--collect-custom-property-ids <json>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--contract-clause-ids <json>", `IDs of the contract clauses used in the quote terms.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
43085
|
+
resource.command("update").description(`Update quote-level fields before a quote is finalized. On draft quotes, pass \`subscription\` to create or replace the draft subscription configuration, or pass \`invoice\` on a one-off quote to replace the linked draft invoice. For quotes created from \`template_id\`, use this tool for subscription overrides such as dates, contract terms, products, phases, coupons, discounts, prices, seats, and subscription custom properties. Omit \`terms\`, \`comments\`, and \`contract_clause_ids\` unless deliberately overriding template content.`).requiredOption("--id <value>", `id parameter`).option("--owner-email <value>", `Email address of the Hyperline user acting as the quote owner.`).option("--catalog-version-id <value>", `ID of a published catalog version to price every product of the quote from, instead of the live products catalog. A product's own \`catalog_version_id\` takes precedence, and explicit \`prices\` always win over both.`).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 <json>", `IDs of the customer custom properties required to be filled during the signature flow.`).option("--contract-clause-ids <json>", `IDs of the contract clauses used in the quote terms.`).option("--require-tax-id <value>", `Require the customer to provide a tax ID during the signature flow.`).option("--display-quote-value <value>", `Display the total quote value on the quote.`).option("--display-quote-value-with-tax <value>", `Display the total quote value including tax on the quote. Only applies to \`one_off\` quotes.`).option("--display-taxes <value>", `Display tax breakdown on the quote.`).option("--display-price-tiers <value>", `Controls which price tiers are displayed on the quote.
|
|
43084
43086
|
|
|
43085
43087
|
- \`all\`: Display all pricing tiers.
|
|
43086
43088
|
- \`matching\`: Only display the tiers used to compute the price based on quantity.
|
|
@@ -43088,7 +43090,7 @@ Examples:
|
|
|
43088
43090
|
`).option("--display-phase-value <value>", `Display per-phase value breakdown on the quote.`).option("--display-first-invoice-amount <value>", `Display the first invoice amount on the quote.`).option("--display-documents-in-preview <value>", `Display attached documents in the quote preview.`).option("--display-subscription-on-update <value>", `Display subscription details on subscription update quotes.`).option("--generate-draft-invoices <value>", `When \`true\`, the invoice issued after signature stays in \`draft\` status instead of being emitted for payment. Use this when you want to review the final invoice manually before sending it. Defaults to \`false\`.`).option("--crm-opportunity-id <value>", `ID of the related opportunity/deal in the connected CRM.`).option("--expires-at <value>", `Quote expiration date. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. Set to \`null\` to clear the expiration.`).option("--subscription <json>", `Subscription configuration constituting the quote. When provided on a draft quote, it creates or replaces the draft subscription attached to the quote.`).option("--invoice <json>", `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", `
|
|
43089
43091
|
Examples:
|
|
43090
43092
|
hyperline quotes update --id <id>
|
|
43091
|
-
hyperline quotes update --id <id> --owner-email <owner_email> --
|
|
43093
|
+
hyperline quotes update --id <id> --owner-email <owner_email> --catalog-version-id <catalog_version_id>
|
|
43092
43094
|
hyperline quotes update --id <id> --output json`).action(async (opts) => {
|
|
43093
43095
|
const ctx = resource.parent?.opts()._ctx;
|
|
43094
43096
|
if (!ctx) {
|
|
@@ -43100,6 +43102,8 @@ Examples:
|
|
|
43100
43102
|
args.id = opts.id;
|
|
43101
43103
|
if (opts.ownerEmail !== void 0)
|
|
43102
43104
|
args.owner_email = opts.ownerEmail;
|
|
43105
|
+
if (opts.catalogVersionId !== void 0)
|
|
43106
|
+
args.catalog_version_id = opts.catalogVersionId;
|
|
43103
43107
|
if (opts.comments !== void 0)
|
|
43104
43108
|
args.comments = opts.comments;
|
|
43105
43109
|
if (opts.terms !== void 0)
|
|
@@ -43704,7 +43708,7 @@ Payment method strategy used to bill the subscription. By default, the current p
|
|
|
43704
43708
|
- \`current\`: Use the current default payment method of the customer.
|
|
43705
43709
|
- \`external\`: Manage the payments of the subscription outside of Hyperline.
|
|
43706
43710
|
`).option("--available-payment-method-types <json>", `Set the allowed types of payment methods for the customer. Only applies to the \`new\` payment method strategy.`).option("--billing-cycle-alignment <value>", `
|
|
43707
|
-
Alignment of product billing cycles. Only applies when creating a subscription from a plan.
|
|
43711
|
+
Alignment of product billing cycles. Only applies when creating a subscription from a plan. If omitted, the billing cycles alignment configured in the account subscription settings applies.
|
|
43708
43712
|
|
|
43709
43713
|
- \`calendar_period\`: The billing cycles of the products will be aligned on the calendar period, after the first period which will be invoiced taking into account the prorata of the first cycle compared to the product periodicity.
|
|
43710
43714
|
- \`anniversary\`: The billing cycles of the products will be aligned on the anniversary of the phase initial billing date.
|
|
@@ -43796,7 +43800,16 @@ Examples:
|
|
|
43796
43800
|
queryParamKeys: []
|
|
43797
43801
|
});
|
|
43798
43802
|
});
|
|
43799
|
-
resource.command("list").description(`List subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, custom_properties. Draft, voided, and
|
|
43803
|
+
resource.command("list").description(`List subscriptions with filters for activation_strategy, status, currency, plan_id, original_quote_id, integration_entity_id, customer_id, invoicing_entity_id, purchase_order, updated_at, custom_properties. Draft, voided, cancelled and archived excluded by default (status=all applies the same exclusion); status=any returns every status. Paginated with take/skip.`).option("--take <number>", `take`).option("--skip <number>", `skip`).option("--activation-strategy <value>", `activation_strategy`).option("--activation-strategy.in <value>", `activation_strategy__in`).option("--status <value>", `
|
|
43804
|
+
Subscription status filter.
|
|
43805
|
+
|
|
43806
|
+
- \`active\`, \`pending\`, \`paused\`, \`errored\`, \`cancelled\`, \`draft\`, \`voided\`, \`archived\`: match that status.
|
|
43807
|
+
- \`inactive\`: shortcut for \`pending\` + \`paused\`.
|
|
43808
|
+
- \`all\`: every status except \`draft\`, \`voided\`, \`cancelled\` and \`archived\` \u2014 the same exclusion as omitting the filter.
|
|
43809
|
+
- \`any\`: every status, no exclusion.
|
|
43810
|
+
|
|
43811
|
+
Use \`status__in\` with comma-separated values to combine statuses. When the filter is omitted, \`draft\`, \`voided\`, \`cancelled\` and \`archived\` subscriptions are excluded.
|
|
43812
|
+
`).option("--status.in <value>", `Comma-separated list of subscription statuses to include. Same values as \`status\`.`).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("--plan-id <value>", `plan_id`).option("--plan-id.not <value>", `plan_id__not`).option("--plan-id.is-null <value>", `plan_id__isNull`).option("--plan-id.is-not-null <value>", `plan_id__isNotNull`).option("--plan-id.equals <value>", `plan_id__equals`).option("--plan-id.contains <value>", `plan_id__contains`).option("--plan-id.starts-with <value>", `plan_id__startsWith`).option("--plan-id.end-with <value>", `plan_id__endWith`).option("--original-quote-id <value>", `original_quote_id`).option("--original-quote-id.not <value>", `original_quote_id__not`).option("--original-quote-id.is-null <value>", `original_quote_id__isNull`).option("--original-quote-id.is-not-null <value>", `original_quote_id__isNotNull`).option("--original-quote-id.equals <value>", `original_quote_id__equals`).option("--original-quote-id.contains <value>", `original_quote_id__contains`).option("--original-quote-id.starts-with <value>", `original_quote_id__startsWith`).option("--original-quote-id.end-with <value>", `original_quote_id__endWith`).option("--customer-id <value>", `customer_id`).option("--customer-id.not <value>", `customer_id__not`).option("--customer-id.is-null <value>", `customer_id__isNull`).option("--customer-id.is-not-null <value>", `customer_id__isNotNull`).option("--customer-id.equals <value>", `customer_id__equals`).option("--customer-id.contains <value>", `customer_id__contains`).option("--customer-id.starts-with <value>", `customer_id__startsWith`).option("--customer-id.end-with <value>", `customer_id__endWith`).option("--invoicing-entity-id <value>", `invoicing_entity_id`).option("--purchase-order <value>", `purchase_order`).option("--purchase-order.not <value>", `purchase_order__not`).option("--purchase-order.is-null <value>", `purchase_order__isNull`).option("--purchase-order.is-not-null <value>", `purchase_order__isNotNull`).option("--purchase-order.equals <value>", `purchase_order__equals`).option("--purchase-order.contains <value>", `purchase_order__contains`).option("--purchase-order.starts-with <value>", `purchase_order__startsWith`).option("--purchase-order.end-with <value>", `purchase_order__endWith`).option("--custom-properties <value>", `custom_properties`).option("--invoice-drafts <value>", `invoice_drafts`).option("--integration-entity-id <value>", `integration_entity_id`).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", `
|
|
43800
43813
|
Examples:
|
|
43801
43814
|
hyperline subscriptions list
|
|
43802
43815
|
hyperline subscriptions list --take <take> --activation-strategy <activation_strategy>`).action(async (opts) => {
|
|
@@ -44423,7 +44436,7 @@ Examples:
|
|
|
44423
44436
|
]
|
|
44424
44437
|
});
|
|
44425
44438
|
});
|
|
44426
|
-
resource.command("create-subscription-transition").description(`
|
|
44439
|
+
resource.command("create-subscription-transition").description(`Submit a transition from one subscription to another. The result may be pending approval, 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. 'pro_rata_separate_documents' issues a credit note for the current period (the amount invoiced when 'last_renewal', otherwise a prorated cancellation credit) 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' (the default) keeps the current billing cycle dates; the request is rejected when the phases share no product billing periodicity, as the cycle cannot then be preserved \u2014 use 'align_to_new_billing_cycle' in that case. 'align_to_new_billing_cycle' aligns 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 <json>", `The configuration of the subscription to transition to`).addHelpText("after", `
|
|
44427
44440
|
Examples:
|
|
44428
44441
|
hyperline subscriptions-transitions create-subscription-transition --source-subscription-id <source_subscription_id> --application-schedule <application_schedule> --target-subscription <target_subscription>
|
|
44429
44442
|
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>
|
|
@@ -44860,7 +44873,7 @@ Examples:
|
|
|
44860
44873
|
queryParamKeys: []
|
|
44861
44874
|
});
|
|
44862
44875
|
});
|
|
44863
|
-
resource.command("load").description(`Add free credits, apply unallocated funds from an existing payment transaction, or record a new paid transaction.`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Wallet load type. Use \`paid\` to apply an existing payment transaction or record a new one, 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("--transaction-id <value>", `Existing payment transaction ID whose unallocated amount will be loaded onto the wallet.`).option("--date <value>", `Date of the new offline payment transaction recorded for the wallet load. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--bank-account-id <value>", `Bank account ID to use when recording a new paid wallet load by bank transfer.`).option("--reference <value>", `Reference stored on the new payment transaction for a paid wallet load.`).addHelpText("after", `
|
|
44876
|
+
resource.command("load").description(`Add free credits, load selected line items from a paid invoice, apply unallocated funds from an existing payment transaction, or record a new paid transaction.`).requiredOption("--id <value>", `id parameter`).option("--type <value>", `Wallet load type. Use \`paid\` to load paid invoice line items, apply an existing payment transaction, or record a new one, 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("--transaction-id <value>", `Existing payment transaction ID whose unallocated amount will be loaded onto the wallet.`).option("--invoice-id <value>", `Paid invoice ID whose selected line items will be loaded onto the wallet.`).option("--invoice-line-item-ids <json>", `IDs of paid invoice line items whose combined amount will be loaded onto the wallet.`).option("--date <value>", `Date of the new offline payment transaction recorded for the wallet load. UTC date time string in the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.`).option("--bank-account-id <value>", `Bank account ID to use when recording a new paid wallet load by bank transfer.`).option("--reference <value>", `Reference stored on the new payment transaction for a paid wallet load.`).addHelpText("after", `
|
|
44864
44877
|
Examples:
|
|
44865
44878
|
hyperline wallets load --id <id>
|
|
44866
44879
|
hyperline wallets load --id <id> --type <type> --amount <amount>
|
|
@@ -44881,6 +44894,8 @@ Examples:
|
|
|
44881
44894
|
args.document_status = opts.documentStatus;
|
|
44882
44895
|
if (opts.transactionId !== void 0)
|
|
44883
44896
|
args.transaction_id = opts.transactionId;
|
|
44897
|
+
if (opts.invoiceId !== void 0)
|
|
44898
|
+
args.invoice_id = opts.invoiceId;
|
|
44884
44899
|
if (opts.date !== void 0)
|
|
44885
44900
|
args.date = opts.date;
|
|
44886
44901
|
if (opts.bankAccountId !== void 0)
|
|
@@ -44889,6 +44904,8 @@ Examples:
|
|
|
44889
44904
|
args.reference = opts.reference;
|
|
44890
44905
|
if (opts.amount !== void 0)
|
|
44891
44906
|
args.amount = Number(opts.amount);
|
|
44907
|
+
if (opts.invoiceLineItemIds !== void 0)
|
|
44908
|
+
args.invoice_line_item_ids = JSON.parse(opts.invoiceLineItemIds);
|
|
44892
44909
|
await ctx.execute({
|
|
44893
44910
|
method: "POST",
|
|
44894
44911
|
path: "/v1/wallets/{id}/load",
|
|
@@ -61138,6 +61155,7 @@ var de = {
|
|
|
61138
61155
|
"invoices.prorata.paymentForItemFullPeriod": "Zahlung f\xFCr",
|
|
61139
61156
|
"invoices.prorata.refundForItem": "Anteilig erstatteter Betrag f\xFCr",
|
|
61140
61157
|
"invoices.prorata.refundForItemFullPeriod": "Erstattung f\xFCr",
|
|
61158
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 abgelaufenes Guthaben",
|
|
61141
61159
|
"subscriptions.closingChargeName": "Abschlussgeb\xFChr f\xFCr das Abonnement",
|
|
61142
61160
|
"subscriptions.correction": "Vorperiodische Anpassung",
|
|
61143
61161
|
"subscriptions.updates.addCoupon": "Gutschein hinzuf\xFCgen {{couponName}}",
|
|
@@ -61169,6 +61187,7 @@ var en = {
|
|
|
61169
61187
|
"invoices.prorata.paymentForItemFullPeriod": "Payment for",
|
|
61170
61188
|
"invoices.prorata.refundForItem": "Prorated refund for",
|
|
61171
61189
|
"invoices.prorata.refundForItemFullPeriod": "Refund for",
|
|
61190
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 expired balance",
|
|
61172
61191
|
"subscriptions.closingChargeName": "Closing fee for subscription",
|
|
61173
61192
|
"subscriptions.correction": "Adjustment previous period",
|
|
61174
61193
|
"subscriptions.updates.addCoupon": "Add coupon {{couponName}}",
|
|
@@ -61228,6 +61247,7 @@ var es = {
|
|
|
61228
61247
|
"invoices.prorata.paymentForItemFullPeriod": "Pago por",
|
|
61229
61248
|
"invoices.prorata.refundForItem": "Reembolso prorrateado por",
|
|
61230
61249
|
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
61250
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 saldo caducado",
|
|
61231
61251
|
"subscriptions.closingChargeName": "Cargo por cierre de suscripci\xF3n",
|
|
61232
61252
|
"subscriptions.correction": "Ajuste del periodo anterior",
|
|
61233
61253
|
"subscriptions.updates.addCoupon": "A\xF1adir cup\xF3n {{couponName}}",
|
|
@@ -61273,6 +61293,7 @@ var fr = {
|
|
|
61273
61293
|
"invoices.prorata.paymentForItemFullPeriod": "Paiement pour",
|
|
61274
61294
|
"invoices.prorata.refundForItem": "Remboursement au prorata pour",
|
|
61275
61295
|
"invoices.prorata.refundForItemFullPeriod": "Remboursement pour",
|
|
61296
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 solde expir\xE9",
|
|
61276
61297
|
"subscriptions.closingChargeName": "Frais de cl\xF4ture pour abonnement",
|
|
61277
61298
|
"subscriptions.correction": "Ajustement p\xE9riode pr\xE9c\xE9dente",
|
|
61278
61299
|
"subscriptions.updates.addCoupon": "Ajout du coupon {{couponName}}",
|
|
@@ -61318,6 +61339,7 @@ var it = {
|
|
|
61318
61339
|
"invoices.prorata.paymentForItemFullPeriod": "Pagamento per",
|
|
61319
61340
|
"invoices.prorata.refundForItem": "Rimborso proporzionale per",
|
|
61320
61341
|
"invoices.prorata.refundForItemFullPeriod": "Rimborso per",
|
|
61342
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 saldo scaduto",
|
|
61321
61343
|
"subscriptions.closingChargeName": "Costo di chiusura per abbonamento",
|
|
61322
61344
|
"subscriptions.correction": "Correzione periodo precedente",
|
|
61323
61345
|
"subscriptions.updates.addCoupon": "Aggiungi coupon {{couponName}}",
|
|
@@ -61363,6 +61385,7 @@ var nl = {
|
|
|
61363
61385
|
"invoices.prorata.paymentForItemFullPeriod": "Betaling voor",
|
|
61364
61386
|
"invoices.prorata.refundForItem": "Gedeeltelijke terugbetaling voor",
|
|
61365
61387
|
"invoices.prorata.refundForItemFullPeriod": "Terugbetaling voor",
|
|
61388
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 verlopen saldo",
|
|
61366
61389
|
"subscriptions.closingChargeName": "Afsluitkosten voor abonnement",
|
|
61367
61390
|
"subscriptions.correction": "Aanpassing vorige periode",
|
|
61368
61391
|
"subscriptions.updates.addCoupon": "Coupon toevoegen {{couponName}}",
|
|
@@ -61408,6 +61431,7 @@ var pl = {
|
|
|
61408
61431
|
"invoices.prorata.paymentForItemFullPeriod": "P\u0142atno\u015B\u0107 za",
|
|
61409
61432
|
"invoices.prorata.refundForItem": "Zwrot proporcjonalny za",
|
|
61410
61433
|
"invoices.prorata.refundForItemFullPeriod": "Zwrot za",
|
|
61434
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 wygas\u0142e saldo",
|
|
61411
61435
|
"subscriptions.closingChargeName": "Op\u0142ata za zamkni\u0119cie subskrypcji",
|
|
61412
61436
|
"subscriptions.correction": "Korekta poprzedniego okresu",
|
|
61413
61437
|
"subscriptions.updates.addCoupon": "Dodaj kupon {{couponName}}",
|
|
@@ -61453,6 +61477,7 @@ var pt = {
|
|
|
61453
61477
|
"invoices.prorata.paymentForItemFullPeriod": "Pagamento por",
|
|
61454
61478
|
"invoices.prorata.refundForItem": "Reembolso proporcional por",
|
|
61455
61479
|
"invoices.prorata.refundForItemFullPeriod": "Reembolso por",
|
|
61480
|
+
"wallets.expiredBalanceInvoiceLineName": "{{walletName}} \u2013 saldo expirado",
|
|
61456
61481
|
"subscriptions.closingChargeName": "Taxa de encerramento da assinatura",
|
|
61457
61482
|
"subscriptions.correction": "Ajuste do per\xEDodo anterior",
|
|
61458
61483
|
"subscriptions.updates.addCoupon": "Adicionar cupom {{couponName}}",
|
|
@@ -64404,12 +64429,6 @@ var defaultToolOutputSchema = {
|
|
|
64404
64429
|
result: external_exports.unknown()
|
|
64405
64430
|
};
|
|
64406
64431
|
|
|
64407
|
-
// ../hyperline-mcp/build/session/sessionKey.js
|
|
64408
|
-
import { createHmac } from "node:crypto";
|
|
64409
|
-
|
|
64410
|
-
// ../hyperline-mcp/build/session/sessionManager.js
|
|
64411
|
-
import { LRUCache } from "lru-cache";
|
|
64412
|
-
|
|
64413
64432
|
// build/output.js
|
|
64414
64433
|
function formatOutput({ data, format: format2 }) {
|
|
64415
64434
|
if (format2 === "json") {
|
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.efe955e",
|
|
4
4
|
"description": "Agent-first CLI for Hyperline API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -37,7 +37,6 @@
|
|
|
37
37
|
"helmet": "6.2.0",
|
|
38
38
|
"i18next": "22.5.1",
|
|
39
39
|
"json-prune": "1.1.0",
|
|
40
|
-
"lru-cache": "11.0.2",
|
|
41
40
|
"multer": "1.4.5-lts.1",
|
|
42
41
|
"rate-limiter-flexible": "11.0.0",
|
|
43
42
|
"stacktrace-parser": "0.1.10",
|