btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/loyalty/movements.js

@@ -1,12 +1,39 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +49,17 @@ function movementsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -41,6 +79,17 @@ function movementsFactory(_ref) {
   }
 
   var balance = {
+    /**
+     * 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: function get(_ref4) {
       var token = _ref4.token,
           jwtToken = _ref4.jwtToken,

package/lib/endpoints/loyalty/programs.js

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         context = _ref2.context,
@@ -24,6 +48,15 @@ function programsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +71,16 @@ function programsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,

package/lib/endpoints/notifications/customers.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for customers notification endpoints (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} NotificationsCustomersQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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 {NotificationsCustomersQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function sendResetPasswordEmail(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +45,15 @@ function customersFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function sendActivationEmail(_ref3) {
     var token = _ref3.token,
         _ref3$query = _ref3.query,

package/lib/endpoints/notifications/email.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for POST /email (btrz-api-notifications). Define recipient, template, etc. Forwarded to API as-is.
+ * @typedef {Object} NotificationsEmailPostQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /email - send email (query params define recipient/template etc.).
+   * @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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for manifest-notifications endpoints (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} ManifestNotificationsQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -24,6 +48,14 @@ function manifestNotificationsFactory(_ref) {
     });
   }
 
+  /**
+   * 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref3) {
     var token = _ref3.token,
         _ref3$query = _ref3.query,

package/lib/endpoints/notifications/notify.js

@@ -1,14 +1,39 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for notify-tickets and notify-vouchers (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} NotifyQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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: function create(_ref2) {
         var token = _ref2.token,
             jwtToken = _ref2.jwtToken,
@@ -28,6 +53,18 @@ function notifyTicketFactory(_ref) {
       }
     },
     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 {NotifyQuery} [opts.query] - Optional query params (forwarded to API)
+       * @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: function create(_ref3) {
         var token = _ref3.token,
             jwtToken = _ref3.jwtToken,
@@ -50,6 +87,16 @@ function notifyTicketFactory(_ref) {
       }
     },
     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 {NotifyQuery} [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>}
+       */
       create: function create(_ref4) {
         var token = _ref4.token,
             jwtToken = _ref4.jwtToken,
@@ -67,6 +114,15 @@ function notifyTicketFactory(_ref) {
       }
     },
     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: function create(_ref5) {
         var token = _ref5.token,
             jwtToken = _ref5.jwtToken,

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

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for POST /orders-rules-validations (btrz-api-notifications). Forwarded to API as-is.
+ * @typedef {Object} OrdersRulesValidationsPostQuery
+ */
+
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * POST /orders-rules-validations - create an order rules validation (notification).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OrdersRulesValidationsPostQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} opts.orderRulesValidation - Validation payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

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

@@ -1,12 +1,38 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @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", "parcel_confirmation", "redeemable_items_confirmation", "sold_item_confirmation", "customer_card_membership", "user_password_reset", "new_account", "operator_manifest_capacity", "reaccomodation", "ticket_movement", "manifest_notification", "startingBalance", "partialShiftDeposits", "shiftLocationClosure", "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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,
@@ -44,22 +70,47 @@ function pdfDataFactory(_ref) {
           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;
     }
     var orderTypes = ["order", "order_confirmation", "cancellation", "change"];

package/lib/endpoints/notifications/pdfs.js

@@ -1,12 +1,39 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} PdfGetQuery
+ * @property {string} type - Document type: "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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var token = _ref2.token,

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

@@ -1,12 +1,33 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /printed-tickets - get printed tickets (by trxId, lang, date); responseType json or blob.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.responseType] - Response type (e.g. "json" or "blob")
+   * @param {string} opts.trxId - Transaction id
+   * @param {string} opts.lang - Language code
+   * @param {string} opts.date - Date
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,

package/lib/endpoints/notifications/salesforce.js

@@ -1,14 +1,32 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers.js"),
+var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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: function create(_ref2) {
         var token = _ref2.token,
             jwtToken = _ref2.jwtToken,
@@ -26,7 +44,6 @@ function salesforceFactory(_ref) {
         });
       }
     }
-
   };
 }