btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/accounts/shifts.js

@@ -1,6 +1,59 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /shifts (btrz-api-accounts). See get-shifts handler getSpec().
+ * @typedef {Object} ShiftsListQuery
+ * @property {string} [includeActivity] - 'true'|'false'; default 'true' (include sales activity)
+ * @property {string} [status] - open | closed (ignored if pendingShiftClosure is true)
+ * @property {string} [pendingShiftClosure] - 'true'|'false'; return shifts that need shift closure
+ * @property {string} [locationId] - Filter by location (ObjectId)
+ * @property {string} [providerId] - Provider for payments (ObjectId)
+ * @property {string} [sort] - closedAsc | closedDesc | openedAsc
+ * @property {string} [fromDate] - Start date (YYYY-MM-DD); requires toDate
+ * @property {string} [toDate] - End date (YYYY-MM-DD); requires fromDate
+ */
+
+/**
+ * Query params for GET /shifts/location-closures (btrz-api-accounts). See get-location-closures handler getSpec().
+ * @typedef {Object} LocationClosuresListQuery
+ * @property {string} [sort] - createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {number} [page] - Page number
+ * @property {string} [fromDate] - Start date (YYYY-MM-DD); requires toDate
+ * @property {string} [toDate] - End date (YYYY-MM-DD); requires fromDate
+ */
+
+/**
+ * Query params for GET /shifts/:locationId/purchase-limit-payments (btrz-api-accounts). See getSpec().
+ * @typedef {Object} PurchaseLimitPaymentsQuery
+ * @property {string} day - Date of payments (YYYY-MM-DD). Required.
+ */
+
+/**
+ * Query params for GET /shifts/:shiftId/sales-summary (btrz-api-accounts). See get-shift-sales-summary getSpec().
+ * @typedef {Object} ShiftSalesSummaryQuery
+ * @property {string} [type] - 'revenueOperatingCompany' to aggregate by revenue operating company
+ * @property {boolean} [depositable] - Get only depositable payment types
+ * @property {boolean} [paymentsAndRefundsDetails] - Include payments and refunds details per payment type and currency
+ */
+
+/**
+ * Factory for shifts API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, requiresAgencyShiftClosure: object, payments: object, transactions: object, tickets: object, fees: object, refunds: object, items: object, redeemableItems: object, giftCertificates: object, parcels: object, insurances: object, invoices: object, deposits: object, manualTickets: object, locationClosures: object, startingBalances: object, purchaseLimitPayments: object, salesSummary: object, commissions: object }}
+ */
 function shiftsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /shifts - list shifts.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ShiftsListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({jwtToken, token, query, headers}) {
     return client.get("/shifts", {
       headers: authorizationHeaders({
@@ -10,12 +63,29 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /shift/user/:userId - get shift for user. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.userId - User id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, userId, headers}) {
     return client.get(`/shift/user/${userId}`, {
       headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
     });
   }
 
+  /**
+   * POST /shifts - create a shift.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.shiftData - Shift payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, token, shiftData, headers}) {
     return client({
       url: "/shifts",
@@ -27,6 +97,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /shifts/:shiftId - update a shift (operations). API getSpec() does not define query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.shiftId - Shift id (ObjectId)
+   * @param {Object} opts.operations - Operations payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({jwtToken, token, shiftId, operations, headers, query}) {
     return client({
       url: `/shifts/${shiftId}`,
@@ -42,6 +122,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   const locationClosureComments = {
+    /**
+     * POST /shifts/location-closures/:locationClosureId/comments - add comment to location closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} opts.locationClosureComment - Comment payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, locationClosureId, locationClosureComment, headers}) {
       return client({
         url: `/shifts/location-closures/${locationClosureId}/comments`,
@@ -55,6 +145,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   };
 
   const locationClosureStatus = {
+    /**
+     * PUT /shifts/location-closures/:locationClosureId/status - update location closure status.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} opts.locationClosureStatusChange - Status change payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({jwtToken, token, locationClosureId, locationClosureStatusChange, headers}) {
       return client({
         url: `/shifts/location-closures/${locationClosureId}/status`,
@@ -68,6 +168,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   };
 
   const locationClosures = {
+    /**
+     * POST /shifts/location-closures - create a location closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.locationClosure - Location closure payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, locationClosure, headers}) {
       return client({
         url: "/shifts/location-closures",
@@ -78,6 +187,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
         data: locationClosure
       });
     },
+    /**
+     * GET /shifts/location-closures - list location closures.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {ShiftsListQuery} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({jwtToken, token, query, headers}) {
       return client.get("/shifts/location-closures", {
         headers: authorizationHeaders({
@@ -86,6 +204,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
         params: query
       });
     },
+    /**
+     * GET /shifts/location-closures/:locationClosureId - get a location closure. 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.locationClosureId - Location closure id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, locationClosureId, headers}) {
       return client.get(`/shifts/location-closures/${locationClosureId}`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -96,6 +223,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   };
 
   const payments = {
+    /**
+     * GET /shifts/:shiftId/payments - get payments for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/payments`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -103,6 +239,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const transactions = {
+    /**
+     * GET /shifts/:shiftId/transactions - get transactions for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/transactions`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -110,6 +255,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const tickets = {
+    /**
+     * GET /shifts/:shiftId/tickets - get tickets for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/tickets`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -117,6 +271,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const fees = {
+    /**
+     * GET /shifts/:shiftId/fees - get fees for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/fees`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -124,6 +287,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const refunds = {
+    /**
+     * GET /shifts/:shiftId/refunds - get refunds for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/refunds`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -131,6 +303,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const items = {
+    /**
+     * GET /shifts/:shiftId/items - get items for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/items`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -138,6 +319,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const redeemableItems = {
+    /**
+     * GET /shifts/:shiftId/redeemable-items - get redeemable items for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/redeemable-items`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -145,6 +335,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const giftCertificates = {
+    /**
+     * GET /shifts/:shiftId/gift-certificates - get gift certificates for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/gift-certificates`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -152,6 +351,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const parcels = {
+    /**
+     * GET /shifts/:shiftId/parcels - get parcels for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/parcels`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -159,6 +367,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const insurances = {
+    /**
+     * GET /shifts/:shiftId/insurances - get insurances for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/insurances`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -166,6 +383,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const invoices = {
+    /**
+     * GET /shifts/:shiftId/invoices - get invoices for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/invoices`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -173,11 +399,30 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const deposits = {
+    /**
+     * GET /shifts/:shiftId/deposits - get deposits for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/deposits`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /shifts/:shiftId/deposits - create a deposit for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.deposit - Deposit payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, shiftId, deposit, headers}) {
       return client({
         url: `/shifts/${shiftId}/deposits`,
@@ -188,11 +433,30 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const manualTickets = {
+    /**
+     * GET /shifts/:shiftId/manual-tickets - get manual tickets for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/manual-tickets`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
       });
     },
+    /**
+     * POST /shifts/:shiftId/manual-tickets - create a manual ticket for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.manualTicket - Manual ticket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, shiftId, manualTicket, headers}) {
       return client({
         url: `/shifts/${shiftId}/manual-tickets`,
@@ -203,6 +467,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const startingBalances = {
+    /**
+     * POST /shifts/:shiftId/starting-balance - create starting balance for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} opts.startingBalance - Starting balance payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({jwtToken, token, shiftId, startingBalance, headers}) {
       return client({
         url: `/shifts/${shiftId}/starting-balance`,
@@ -213,6 +487,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const purchaseLimitPayments = {
+    /**
+     * GET /shifts/:locationId/purchase-limit-payments - get purchase limit payments for location.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.locationId - Location id (ObjectId)
+     * @param {PurchaseLimitPaymentsQuery} [opts.query] - Query params; day (YYYY-MM-DD) is required
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, locationId, query, headers}) {
       return client.get(`/shifts/${locationId}/purchase-limit-payments`, {
         headers: authorizationHeaders({
@@ -223,6 +507,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const salesSummary = {
+    /**
+     * GET /shifts/:shiftId/sales-summary - get sales summary for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {ShiftSalesSummaryQuery} [opts.query] - Query params (type, depositable, paymentsAndRefundsDetails)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, query, headers}) {
       return client.get(`/shifts/${shiftId}/sales-summary`, {
         headers: authorizationHeaders({
@@ -233,6 +527,15 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
     }
   };
   const commissions = {
+    /**
+     * GET /shifts/:shiftId/commissions - get commissions for shift.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, shiftId, headers}) {
       return client.get(`/shifts/${shiftId}/commissions`, {
         headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
@@ -241,6 +544,16 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   };
 
   const requiresAgencyShiftClosure = {
+    /**
+     * PUT /shifts/:shiftId/requires-agency-shift-closure - set requires agency shift closure.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.shiftId - Shift id (ObjectId)
+     * @param {Object} [opts.shiftData] - Shift data payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     put({token, jwtToken, shiftId, headers, shiftData}) {
       return client({
         url: `/shifts/${shiftId}/requires-agency-shift-closure`,

package/src/endpoints/accounts/sms-templates.js

@@ -1,8 +1,53 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("../endpoints_helpers.js");
 
+/**
+ * Query params for GET /sms-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} SmsTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by template type
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales | any
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | custom
+ * @property {string} [status] - draft | published
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {string} [lang] - ISO language code (e.g. en-us)
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Query params for GET /sms-templates/:smsTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} SmsTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current, or global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Query params for PUT /sms-templates/:smsTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} SmsTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
+/**
+ * Factory for sms-templates API (btrz-api-accounts).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ getTypes: function, all: function, get: function, create: function, update: function, remove: function, createSub: function, versions: { update: function } }}
+ */
 function smsTemplatesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /sms-templates/types - returns available template types. 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getTypes({token, jwtToken, headers}) {
     return client({
       url: "/sms-templates/types",
@@ -10,6 +55,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /sms-templates - list SMS templates.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SmsTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, jwtToken, query = {}, headers}) {
     return client({
       url: "/sms-templates",
@@ -18,6 +72,16 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /sms-templates/:smsTemplateId - get a single SMS template.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.smsTemplateId - Template id (ObjectId)
+   * @param {SmsTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({token, jwtToken, smsTemplateId, query = {}, headers}) {
     return client({
       url: `/sms-templates/${smsTemplateId}`,
@@ -26,6 +90,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /sms-templates - create an SMS template. 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 {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/sms-templates",
@@ -35,6 +108,16 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /sms-templates/:smsTemplateId - update an SMS template. 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.smsTemplateId - Template id (ObjectId)
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, smsTemplateId, data, headers}) {
     return client({
       url: `/sms-templates/${smsTemplateId}`,
@@ -44,6 +127,15 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /sms-templates/:smsTemplateId - delete an SMS template. 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.smsTemplateId - Template id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, smsTemplateId, headers}) {
     return client({
       url: `/sms-templates/${smsTemplateId}`,
@@ -52,6 +144,16 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /sub-sms-templates - create a sub SMS template from a main template. 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.mainTemplateId - Main template id (ObjectId)
+   * @param {string} opts.agencyId - Agency id (ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function createSub({token, jwtToken, mainTemplateId, agencyId, headers}) {
     return client({
       url: "/sub-sms-templates",
@@ -62,6 +164,17 @@ function smsTemplatesFactory({client, internalAuthTokenProvider}) {
   }
 
   const versions = {
+    /**
+     * PUT /sms-templates/:smsTemplateId/versions/:versionId - roll back sms template to a version.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.smsTemplateId - Template id (ObjectId)
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {SmsTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({token, jwtToken, smsTemplateId, versionId, query = {}, headers}) {
       return client({
         url: `/sms-templates/${smsTemplateId}/versions/${versionId}`,