btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/loyalty/movements.js

@@ -1,7 +1,32 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function movementsFactory({ client, internalAuthTokenProvider }) {
-  function all({ token, jwtToken, programId, query = {}, headers }) {
+/**
+ * Query params for GET /programs/:programId/movements and related (loyalty). Documented from client; backend may support pagination/filters.
+ * @typedef {Object} LoyaltyMovementsQuery
+ * @property {number} [page] - Page (if supported)
+ * @property {number} [recordsPerPage] - Records per page (if supported)
+ */
+
+/**
+ * Factory for loyalty movements API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, balance: Object }}
+ */
+function movementsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /programs/:programId/movements - list movements.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, programId, query = {}, headers}) {
     return client({
       url: `/programs/${programId}/movements`,
       params: query,
@@ -9,7 +34,18 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function create({ token, jwtToken, programId, movement, query = {}, headers }) {
+  /**
+   * POST /programs/:programId/movements - create movement.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {Object} opts.movement - Movement payload
+   * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, programId, movement, query = {}, headers}) {
     return client({
       url: `/programs/${programId}/movements`,
       method: "post",
@@ -20,7 +56,18 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
   }
 
   const balance = {
-    get({ token, jwtToken, programId, customerId, query = {}, headers }) {
+    /**
+     * GET /programs/:programId/movements/balance/:customerId - get balance.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.programId - Program id
+     * @param {string} opts.customerId - Customer id
+     * @param {LoyaltyMovementsQuery} [opts.query] - page, recordsPerPage (if supported by backend); forwarded to API
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
+    get({token, jwtToken, programId, customerId, query = {}, headers}) {
       return client({
         url: `/programs/${programId}/movements/balance/${customerId}`,
         params: query,
@@ -34,7 +81,6 @@ function movementsFactory({ client, internalAuthTokenProvider }) {
     create,
     balance
   };
-
 }
 
 module.exports = movementsFactory;

package/src/endpoints/loyalty/programs.js

@@ -1,10 +1,32 @@
-const { authorizationHeaders } = require("./../endpoints_helpers");
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
-function programsFactory({ client, internalAuthTokenProvider }) {
-  
-  function all({ token, context, query = {}, headers }) {
+/**
+ * Query params for GET /programs (loyalty). Client merges context into query.
+ * @typedef {Object} LoyaltyProgramsListQuery
+ * @property {string} [context] - Context (merged from opts.context by client)
+ * @property {string} [providerId] - Provider id (if supported by backend)
+ */
+
+/**
+ * Factory for loyalty programs API.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, put: function }}
+ */
+function programsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /programs - list loyalty programs. Query is merged with context (context takes precedence in merge).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.context] - Context; merged into query as query.context
+   * @param {LoyaltyProgramsListQuery} [opts.query] - Additional query params (merged with context)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, context, query = {}, headers}) {
     const queryObj = Object.assign({}, query, {context});
-    
+
     return client({
       url: "/programs",
       params: queryObj,
@@ -12,7 +34,16 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function create({ token, jwtToken, program, headers }) {
+  /**
+   * POST /programs - create loyalty program.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.program - Program payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, program, headers}) {
     return client({
       url: "/programs",
       method: "post",
@@ -21,7 +52,17 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     });
   }
 
-  function put({ token, jwtToken, programId, program, headers }) {
+  /**
+   * PUT /programs/:programId - update loyalty program.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.programId - Program id
+   * @param {Object} opts.program - Program payload
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function put({token, jwtToken, programId, program, headers}) {
     return client({
       url: `/programs/${programId}`,
       method: "put",
@@ -35,7 +76,6 @@ function programsFactory({ client, internalAuthTokenProvider }) {
     create,
     put
   };
-
 }
 
-module.exports = programsFactory;
+module.exports = programsFactory;

package/src/endpoints/notifications/customers.js

@@ -1,10 +1,51 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * 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
+ */
+
+/**
+ * Factory for customers notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ sendResetPasswordEmail: function, sendActivationEmail: function }}
+ */
 function customersFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * POST /customers/reset - send reset password email to customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CustomersResetPostQuery} [opts.query] - Query params (providerId, lang required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function sendResetPasswordEmail({
     token, jwtToken, query = {}, headers
   }) {
@@ -16,6 +57,15 @@ function customersFactory({
     });
   }
 
+  /**
+   * POST /customers/activation - send activation email to customer.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @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>}
+   */
   function sendActivationEmail({
     token, query = {}, data, headers
   }) {

package/src/endpoints/notifications/email.js

@@ -1,10 +1,36 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for email API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function emailFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * 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] - Query params (trxId required)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, jwtToken, query = {}, headers
   }) {

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

@@ -1,11 +1,34 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * 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)
+ */
+
+/**
+ * Factory for manifest-notifications API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function, all: function }}
+ */
 function manifestNotificationsFactory({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * POST /manifest-notifications - create a manifest notification.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, jwtToken, query = {}, data, headers
   }) {
@@ -18,6 +41,14 @@ function manifestNotificationsFactory({
     });
   }
 
+  /**
+   * GET /manifest-notifications - list manifest notifications.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({
     token,
     query = {},

package/src/endpoints/notifications/notify.js

@@ -1,12 +1,50 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * 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")
+ */
+
+/**
+ * Factory for notify (child users, tickets, vouchers, manifest) API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function } }}
+ */
 function notifyTicketFactory({
   client, internalAuthTokenProvider
 }) {
   return {
     childUsers: {
+      /**
+       * POST /notify-child-user - notify a child user (e.g. email with lang).
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {string} opts.email - Recipient email
+       * @param {string} opts.lang - Language code
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create({token, jwtToken, email, lang, headers}) {
         return client({
           url: "/notify-child-user",
@@ -20,6 +58,18 @@ function notifyTicketFactory({
       }
     },
     tickets: {
+      /**
+       * POST /notify-tickets/:ticketId - send ticket notification (to, operation).
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @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
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create({token, jwtToken, query, operation, to, ticketId, headers}) {
         return client({
           url: `/notify-tickets/${ticketId}`,
@@ -34,6 +84,16 @@ function notifyTicketFactory({
       }
     },
     vouchers: {
+      /**
+       * POST /notify-vouchers - send voucher notification.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @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>}
+       */
       create({token, jwtToken, query, data, headers}) {
         return client({
           url: "/notify-vouchers",
@@ -45,6 +105,15 @@ function notifyTicketFactory({
       }
     },
     manifest: {
+      /**
+       * POST /notify-manifest - send manifest notification.
+       * @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 {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create({token, jwtToken, data, headers}) {
         return client({
           url: "/notify-manifest",

package/src/endpoints/notifications/orders-rules-validations.js

@@ -1,11 +1,27 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * Factory for orders-rules-validations API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ create: function }}
+ */
 function ordersRulesValidations({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * POST /orders-rules-validations - validate a rule using the data (body only). 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.orderRulesValidation - Validation payload (rule and facts)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({
     token, jwtToken, query = {}, orderRulesValidation, headers
   }) {

package/src/endpoints/notifications/pdf-data.js

@@ -1,11 +1,36 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET pdf-templates-processing routes (btrz-api-notifications). Client uses type/family to resolve path.
+ * @typedef {Object} PdfDataGetQuery
+ * @property {string} type - Document type; determines path (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, order_confirmation, cancellation, change, shift, invoice, parcelManifest, startingBalance, partialShiftDeposits, bankDepositSlip, terminalVoucher, manualTickets, etc.)
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ */
+
+/**
+ * Factory for PDF data (JSON) endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function pdfDataFactory({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * GET PDF data (JSON) by item id and type.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PdfDataGetQuery} [opts.query] - type (required for correct path); family when type is "product"
+   * @param {string} opts.itemId - Item id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data is JSON (structure depends on type)
+   */
   // eslint-disable-next-line max-statements
   function get({
     token,
@@ -42,22 +67,52 @@ function pdfDataFactory({
           break;
       }
     }
-    if (query.type === "giftCertificate") {
+
+    if (query.type === "parcel_confirmation") {
+      url = `/pdf-parcels/${itemId}`;
+    }
+    if (query.type === "redeemable_items_confirmation") {
+      url = `/pdf-redeemable-items/${itemId}`;
+    }
+    if (query.type === "sold_item_confirmation") {
+      url = `/pdf-sold-items/${itemId}`;
+    }
+    if (query.type === "customer_card_membership" ||
+      query.type === "scanning_badge" ||
+      query.type === "customer_activation" ||
+      query.type === "customer_activation_mobile" ||
+      query.type === "customer_password_reset" ||
+      query.type === "customer_password_reset_mobile") {
+      url = `/pdf-customer/${itemId}`;
+    }
+    if (query.type === "giftCertificate" || query.type === "gift_certificate_notification") {
       url = `/pdf-gift-certificates/${itemId}`;
     }
-    if (query.type === "voucher") {
+    if (query.type === "user_password_reset") {
+      url = `/pdf-users/${itemId}`;
+    }
+    if (query.type === "voucher" || query.type === "voucher_notification" || query.type === "compensation_voucher") {
       url = `/pdf-vouchers/${itemId}`;
     }
-    if (query.type === "transaction") {
+    if (query.type === "new_account" || query.type === "new_seller_account" || query.type === "interline_provider_invite") {
+      url = `/pdf-accounts/${itemId}`;
+    }
+    if (query.type === "transaction" || query.type === "operator_purchase" || query.type === "operator_ssr") {
       url = `/pdf-transactions/${itemId}`;
     }
+    if (query.type === "operator_manifest_capacity") {
+      url = `/pdf-operator-manifest-capacities/${itemId}`;
+    }
     if (query.type === "ssr") {
       url = `/pdf-ssrs/${itemId}`;
     }
     if (query.type === "passengersManifest") {
       url = `/pdf-passengers-manifests/${itemId}`;
     }
-    if (query.type === "manifest") {
+    if (query.type === "reaccomodation" || query.type === "ticket_movement") {
+      url = `/pdf-reaccomodation/${itemId}`;
+    }
+    if (query.type === "manifest" || query.type === "manifest_notification") {
       url = `/pdf-manifests/${itemId}`;
     }
     const orderTypes = ["order", "order_confirmation", "cancellation", "change"];

package/src/endpoints/notifications/pdfs.js

@@ -1,11 +1,37 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET pdf-templates-processing binary routes (btrz-api-notifications). Client uses type/family to resolve path.
+ * @typedef {Object} PdfGetQuery
+ * @property {string} type - Document type (e.g. product, giftCertificate, voucher, transaction, ssr, manifest, passengersManifest, order, shift, remainderSlip, exchange, invoice, locationClosure, parcelManifest, startingBalance, partialShiftDeposits, shiftLocationClosure, bankDepositSlip, terminalVoucher, manualTickets)
+ * @property {string} [family] - When type is "product": "ticket" | "reservation" | "paid in" | "paid out" | "parcel" | "flexpass" | "bundle"
+ */
+
+/**
+ * Factory for PDF binary endpoints (btrz-api-notifications). Resolves URL by query.type (and query.family when type is "product").
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function pdfFactory({
   client,
   internalAuthTokenProvider
 }) {
+  /**
+   * GET a PDF by item id and type. Returns binary (blob) by default.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PdfGetQuery} [opts.query] - type (required for correct path); family when type is "product"
+   * @param {string} opts.itemId - Item id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} [opts.responseType] - Axios responseType (default "blob")
+   * @returns {Promise<import("axios").AxiosResponse<Blob|ArrayBuffer>>}
+   */
   // eslint-disable-next-line max-statements
   function get({
     token,

package/src/endpoints/notifications/printed-tickets.js

@@ -1,16 +1,45 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers");
+} = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /printed-tickets (btrz-api-notifications). See get-printed-tickets getSpec().
+ * @typedef {Object} PrintedTicketsGetQuery
+ * @property {string} trxId - Transaction id to print its tickets (required)
+ * @property {string} [channel] - Optional channel of the transaction
+ * @property {string} [lang] - Language (handler uses for PDF URL)
+ * @property {string} [date] - Date (handler uses for PDF URL)
+ */
+
+/**
+ * Factory for printed-tickets API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 function printedTicketsFactory({
   client, internalAuthTokenProvider
 }) {
+  /**
+   * GET /printed-tickets - get printed tickets PDF (trxId required; lang, date optional).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.responseType] - Response type ("json" or "blob")
+   * @param {string} opts.trxId - Transaction id (required)
+   * @param {string} [opts.lang] - Language code
+   * @param {string} [opts.date] - Date
+   * @param {string} [opts.channel] - Optional channel of the transaction
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({
-    token, jwtToken, responseType = "json", trxId, lang, date, headers
+    token, jwtToken, responseType = "json", trxId, lang, date, channel, headers
   }) {
     return client({
       url: "/printed-tickets",
-      params: {trxId, lang, date},
+      params: {trxId, lang, date, channel},
       responseType,
       headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
     });

package/src/endpoints/notifications/salesforce.js

@@ -1,12 +1,28 @@
 const {
   authorizationHeaders
-} = require("./../endpoints_helpers.js");
+} = require("../endpoints_helpers.js");
 
+/**
+ * Factory for salesforce API (btrz-api-notifications).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ sms: { create: function } }}
+ */
 function salesforceFactory({
   client, internalAuthTokenProvider
 }) {
   return {
     sms: {
+      /**
+       * POST /salesforce/sms - send SMS via Salesforce.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {Object} [opts.smsMsg] - SMS message payload
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
       create({
         token, jwtToken, smsMsg = {}, headers
       }) {
@@ -20,7 +36,6 @@ function salesforceFactory({
         });
       }
     }
-
   };
 }