btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/inventory/zone-price-overages.js

@@ -2,11 +2,6 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
-/**
- * Query params for zone-price-overages endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryZonePriceOveragesQuery
- */
-
 /**
  * Factory for zone-price-overages API (btrz-api-inventory).
  * @param {Object} deps
@@ -16,10 +11,9 @@ const {
  */
 function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /zone-price-overages - list zone price overages.
+   * GET /zone-price-overages - list zone price overages. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryZonePriceOveragesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +29,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id.
+   * GET /zone-price-overages/:zonePriceOverageId - get zone price overage by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.zonePriceOverageId - Zone price overage id
    * @param {string} [opts.token] - API key
@@ -49,7 +43,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /zone-price-overages - create zone price overage(s).
+   * POST /zone-price-overages - create zone price overage(s). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -86,7 +80,7 @@ function zonePriceOverageFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage.
+   * PUT /zone-price-overages/:zonePriceOverageId - update zone price overage. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/src/endpoints/inventory/zone-prices.js

@@ -3,8 +3,13 @@ const {
 } = require("./../endpoints_helpers.js");
 
 /**
- * Query params for zone-prices endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryZonePricesQuery
+ * Query params for GET /zone-prices (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ZonePricesListQuery
+ * @property {number} [page] - Page number (20 records per page)
+ * @property {number} [weight] - Weight in grams
+ * @property {string} [serviceTypeIds] - Service type id(s), comma-separated
+ * @property {string} [departureZones] - Departure zone(s), comma-separated
+ * @property {string} [arrivalZones] - Arrival zone(s), comma-separated
  */
 
 /**
@@ -19,7 +24,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
    * GET /zone-prices - list zone prices.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {InventoryZonePricesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ZonePricesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -35,7 +40,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /zone-prices/:zonePriceId - get zone price by id.
+   * GET /zone-prices/:zonePriceId - get zone price by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} opts.zonePriceId - Zone price id
    * @param {string} [opts.token] - API key
@@ -49,7 +54,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /zone-prices - create zone price.
+   * POST /zone-prices - create zone price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key
@@ -69,7 +74,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /zone-prices/:zonePriceId - remove zone price.
+   * DELETE /zone-prices/:zonePriceId - remove zone price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.zonePriceId - Zone price id
@@ -86,7 +91,7 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /zone-prices/:zonePriceId - update zone price.
+   * PUT /zone-prices/:zonePriceId - update zone price. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} [opts.token] - API key

package/src/endpoints/invoices/dlink.js

@@ -2,9 +2,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /dlink (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /dlink (btrz-api-invoices). See post-dlink-handler getSpec().
  * @typedef {Object} InvoiceDlinkPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string} [providerId] - Invoice provider id to use
  */
 
 /**

package/src/endpoints/invoices/emails.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for POST /emails (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoiceEmailsPostQuery
- */
-
 /**
  * Factory for invoice emails API (btrz-api-invoices).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function emailsFactory({client, internalAuthTokenProvider}) {
   /**
-   * POST /emails - create/send invoice email.
+   * POST /emails - create/send invoice email. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.data - Request body
-   * @param {InvoiceEmailsPostQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/gti.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
 /**
- * Query params for POST /gti (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /gti (btrz-api-invoices). See post-gti-handler getSpec().
  * @typedef {Object} InvoiceGtiPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/infile.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /infile (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /infile (btrz-api-invoices). See post-infile-handler getSpec().
  * @typedef {Object} InvoiceInfilePostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/infileJson.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /infile-json (btrz-api-invoices). onlyValidateRequest optional.
+ * Query params for POST /infile-json (btrz-api-invoices). See post-infile-json-handler getSpec().
  * @typedef {Object} InvoiceInfileJsonPostQuery
- * @property {string} [onlyValidateRequest] - If true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/invoices.js

@@ -2,8 +2,15 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for invoices endpoints (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoicesQuery
+ * Query params for GET /invoices (btrz-api-invoices). See get-handler getSpec().
+ * @typedef {Object} InvoicesListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
+ */
+
+/**
+ * Query params for GET /failures (btrz-api-invoices). See get-failures-handler getSpec().
+ * @typedef {Object} InvoicesFailuresQuery
+ * @property {string} [transactionId] - Transaction id of the invoice failure
  */
 
 /**
@@ -19,7 +26,7 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InvoicesListQuery} [opts.query] - Query params (transactionId required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,12 +40,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /invoices/:id - get invoice by id.
+   * GET /invoices/:id - get invoice by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Invoice id
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -56,7 +62,7 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {InvoicesFailuresQuery} [opts.query] - Query params (transactionId optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -70,12 +76,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /retry - retry invoicing.
+   * POST /retry - retry invoicing. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.data - Request body
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -90,12 +95,11 @@ function invoicesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /retry - override buyer and retry invoicing.
+   * PUT /retry - override buyer and retry invoicing. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.data - Request body
-   * @param {InvoicesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/pdfs.js

@@ -2,8 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /pdfs (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoicePdfsListQuery
+ * Query params for GET /pdfs (btrz-api-invoices). See pdfs get-handler getSpec().
+ * @typedef {Object} PdfsListQuery
+ * @property {string} transactionId - Transaction id of the invoice (required)
  */
 
 /**
@@ -19,7 +20,7 @@ function pdfsFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoicePdfsListQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {PdfsListQuery} [opts.query] - Query params (transactionId required)
    * @param {string} [opts.responseType] - Response type (e.g. "json", "blob")
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/src/endpoints/invoices/providers.js

@@ -2,8 +2,13 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for invoice providers endpoints (btrz-api-invoices). Forwarded to API as-is.
- * @typedef {Object} InvoiceProvidersQuery
+ * Query params for GET /providers (btrz-api-invoices). See providers get-handler getSpec().
+ * @typedef {Object} ProvidersListQuery
+ * @property {boolean} [enabled] - If the provider is enabled or not
+ * @property {string} [invoiceProviderType] - The type of the provider
+ * @property {string} [channel] - Filter by channel (must be one of the allowed channels)
+ * @property {string} [country] - ISO code of the provider's country
+ * @property {string} [operatingCompany] - Operating company id associated with the provider
  */
 
 /**
@@ -19,7 +24,7 @@ function providersFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ProvidersListQuery} [opts.query] - Query params (all optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -33,12 +38,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /providers/:id - get invoice provider by id.
+   * GET /providers/:id - get invoice provider by id. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Provider id
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -52,13 +56,12 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /providers/:id - update invoice provider.
+   * PUT /providers/:id - update invoice provider. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Provider id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -73,12 +76,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /providers/:id - remove invoice provider.
+   * DELETE /providers/:id - remove invoice provider. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.id - Provider id
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -92,12 +94,11 @@ function providersFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /providers - create invoice provider.
+   * POST /providers - create invoice provider. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/providersSequences.js

@@ -1,11 +1,6 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-/**
- * Query params for provider sequences endpoints (btrz-api-invoices). Backend getSpec for list has no query; forwarded as-is.
- * @typedef {Object} InvoiceProvidersSequencesQuery
- */
-
 /**
  * Factory for invoice provider sequences API (btrz-api-invoices).
  * @param {Object} deps
@@ -15,12 +10,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function providersSequencesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /providers/:invoiceProviderId/sequences - list provider sequences.
+   * GET /providers/:invoiceProviderId/sequences - list provider sequences. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.invoiceProviderId - Invoice provider id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>} 404 PROVIDER_NOT_FOUND
    */
@@ -34,13 +28,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence.
+   * GET /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - get provider sequence. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.invoiceProviderId - Invoice provider id
    * @param {string} opts.invoiceProviderSequenceId - Sequence id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -54,13 +47,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence.
+   * DELETE /providers/:invoiceProviderId/sequences/:id - remove provider sequence. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.invoiceProviderId - Invoice provider id
    * @param {string} opts.id - Sequence id
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -74,13 +66,12 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /providers/:invoiceProviderId/sequences - create provider sequence.
+   * POST /providers/:invoiceProviderId/sequences - create provider sequence. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.invoiceProviderId - Invoice provider id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -95,14 +86,13 @@ function providersSequencesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence.
+   * PUT /providers/:invoiceProviderId/sequences/:invoiceProviderSequenceId - update provider sequence. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.invoiceProviderId - Invoice provider id
    * @param {string} opts.invoiceProviderSequenceId - Sequence id
    * @param {Object} opts.data - Request body
-   * @param {InvoiceProvidersSequencesQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/invoices/system.js

@@ -2,9 +2,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for POST /system (btrz-api-invoices getSpec).
+ * Query params for POST /system (btrz-api-invoices). See post-system-handler getSpec().
  * @typedef {Object} InvoiceSystemPostQuery
- * @property {string} [onlyValidateRequest] - If set to true, only validates the payload and does not process it
+ * @property {string|boolean} [onlyValidateRequest] - If true, only validates the payload and does not process it
  */
 
 /**

package/src/endpoints/invoices/tax-ids.js

@@ -2,7 +2,7 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for GET /tax-ids (btrz-api-invoices getSpec).
+ * Query params for GET /tax-ids (btrz-api-invoices). See tax-ids get-handler getSpec().
  * @typedef {Object} TaxIdsListQuery
  * @property {string} taxNumber - Tax number to look up (required)
  * @property {string} country - ISO code of the country of the tax information (required)

package/src/endpoints/notifications/customers.js

@@ -3,8 +3,28 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} NotificationsCustomersQuery
+ * Query params for POST /customers/reset (btrz-api-notifications). See post-customers-reset-password getSpec().
+ * @typedef {Object} CustomersResetPostQuery
+ * @property {string} providerId - Account id of the customer (required)
+ * @property {string} lang - Language of the email (required)
+ * @property {string} [customerNumber] - Customer number (include at least one of customerNumber or email)
+ * @property {string} [email] - Customer email (include at least one of customerNumber or email)
+ * @property {string} [channel] - Channel the customer is using to restore the pass
+ * @property {string} [platform] - "ios" | "android" | "web"
+ * @property {string} [appName] - Name of the app
+ * @property {string} [appVersion] - Version of the app
+ * @property {string} [cartPath] - (Deprecated) Initial path of the cart websales endpoint
+ */
+
+/**
+ * Query params for POST /customers/activation (btrz-api-notifications). See post-customers-activation getSpec().
+ * @typedef {Object} CustomersActivationPostQuery
+ * @property {string} providerId - Account id of the customer (required)
+ * @property {string} [lang] - Language of the email (default en-us)
+ * @property {string} [channel] - Channel (e.g. "mobileapp")
+ * @property {string} [platform] - "ios" | "android" | "web"
+ * @property {string} [appVersion] - Version of the client app
+ * @property {string} [appName] - Name of the client app
  */
 
 /**
@@ -22,7 +42,7 @@ function customersFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {CustomersResetPostQuery} [opts.query] - Query params (providerId, lang required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,8 +61,8 @@ function customersFactory({
    * POST /customers/activation - send activation email to customer.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
-   * @param {Object} [opts.data] - Request body
+   * @param {CustomersActivationPostQuery} [opts.query] - Query params (providerId required)
+   * @param {Object} [opts.data] - Request body (CustomerForActivation)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/email.js

@@ -3,8 +3,13 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for POST /email (btrz-api-notifications). Define recipient, template, etc. Forwarded to API as-is.
+ * Query params for POST /email (btrz-api-notifications). See post-emails getSpec().
  * @typedef {Object} NotificationsEmailPostQuery
+ * @property {string} trxId - Cart/transaction id to send by email (required)
+ * @property {string} [lang] - Email language (e.g. en-us, es-ar, de-de, fr-fr, nl-nl)
+ * @property {string} [channel] - Channel of the request
+ * @property {string} [appName] - App name of the request
+ * @property {string} [customEmail] - Email address different than customer.email (backoffice only)
  */
 
 /**
@@ -18,11 +23,11 @@ function emailFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * POST /email - send email (query params define recipient/template etc.).
+   * POST /email - send email to customer for the given cart (trxId).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {NotificationsEmailPostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {NotificationsEmailPostQuery} [opts.query] - Query params (trxId required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/manifest-notifications.js

@@ -3,8 +3,9 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for manifest-notifications endpoints (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} ManifestNotificationsQuery
+ * Query params for GET /manifest-notifications (btrz-api-notifications). See get-manifest-notifications-handler getSpec().
+ * @typedef {Object} ManifestNotificationsListQuery
+ * @property {string} [manifestId] - Manifest id (ObjectId format)
  */
 
 /**
@@ -44,7 +45,7 @@ function manifestNotificationsFactory({
    * GET /manifest-notifications - list manifest notifications.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/src/endpoints/notifications/notify.js

@@ -4,8 +4,23 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
- * Query params for notify-tickets and notify-vouchers (btrz-api-notifications). Forwarded to API as-is.
- * @typedef {Object} NotifyQuery
+ * Query params for POST /notify-tickets/:ticketId (btrz-api-notifications). See post-notify-tickets-by-id-handler getSpec().
+ * @typedef {Object} NotifyTicketsPostQuery
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales (default websales)
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [lang] - Valid language (default en-us)
+ * @property {string} [humanDate] - "mm" | "dd" (default "mm")
+ */
+
+/**
+ * Query params for POST /notify-vouchers (btrz-api-notifications). See post-notify-vouchers-handler getSpec().
+ * @typedef {Object} NotifyVouchersPostQuery
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales (default websales)
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [lang] - Valid language (default en-us)
+ * @property {string} [humanDate] - "mm" | "dd" (default "mm")
  */
 
 /**
@@ -48,7 +63,7 @@ function notifyTicketFactory({
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {NotifyQuery} [opts.query] - Optional query params (forwarded to API)
+       * @param {NotifyTicketsPostQuery} [opts.query] - Query params (all optional)
        * @param {string} opts.operation - Notification operation
        * @param {string} opts.to - Recipient (e.g. email)
        * @param {string} opts.ticketId - Ticket id
@@ -74,8 +89,8 @@ function notifyTicketFactory({
        * @param {Object} opts
        * @param {string} [opts.token] - API key
        * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-       * @param {NotifyQuery} [opts.query] - Optional query params (forwarded to API)
-       * @param {Object} opts.data - Request body
+       * @param {NotifyVouchersPostQuery} [opts.query] - Query params (all optional)
+       * @param {Object} opts.data - Request body (vouchersIds)
        * @param {Object} [opts.headers] - Optional headers
        * @returns {Promise<import("axios").AxiosResponse>}
        */