btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/accounts/people-lookups.js

@@ -2,9 +2,27 @@
 
 var _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; };
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /people-lookups (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} PeopleLookupsListQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ * @property {string} [documentNumber] - Document number to search for
+ * @property {string} [documentTypeId] - Document type id to search for
+ * @property {string} [email] - Email to search for
+ * @property {string} [customerNumber] - Customer number to search for
+ * @property {string} [phone] - Phone to search for
+ */
+
+/**
+ * Query params for GET /people-lookups/:personId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PeopleLookupGetByIdQuery
+ * @property {string} [dynamicFormId] - If provided, only include this dynamic form's data in response
+ */
+
 /**
  * Factory for people-lookups API (btrz-api-accounts).
  * @param {Object} deps
@@ -23,8 +41,8 @@ function peopleLookupsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {PeopleLookupsListQuery} [opts.query] - Query params (dynamicFormId, documentNumber, documentTypeId, email, customerNumber, phone)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -48,9 +66,9 @@ function peopleLookupsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
    * @param {string} opts.personId - Person id (ObjectId)
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {PeopleLookupGetByIdQuery} [opts.query] - Query params: dynamicFormId
+   * @param {string} [opts.providerId] - Provider id (ObjectId); merged into query for provider context
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -72,13 +90,13 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * PUT /people-lookups/:personId - update a person lookup.
+   * PUT /people-lookups/:personId - update a person lookup. 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.personId - Person id (ObjectId)
    * @param {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -106,12 +124,12 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * POST /people-lookups - create a person lookup.
+   * POST /people-lookups - create a person lookup. 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 {Object} opts.person - Person payload
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {string} [opts.providerId] - Provider id (ObjectId); sent as query for provider context
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -138,7 +156,7 @@ function peopleLookupsFactory(_ref) {
   }
 
   /**
-   * DELETE /people-lookups/:personId - remove a person lookup.
+   * DELETE /people-lookups/:personId - remove a person lookup. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/point-to-point-settings.js

@@ -17,7 +17,7 @@ function pointToPointSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /point-to-point-settings - get point-to-point settings.
+   * GET /point-to-point-settings - get point-to-point settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -36,7 +36,7 @@ function pointToPointSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /point-to-point-settings - update point-to-point settings.
+   * PUT /point-to-point-settings - update point-to-point settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/print-settings.js

@@ -17,10 +17,9 @@ function printSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /print-settings - list/get print settings.
+   * GET /print-settings - list/get print settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -37,7 +36,7 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /print-settings - update print settings.
+   * PUT /print-settings - update print settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/print-templates.js

@@ -3,6 +3,38 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /print-templates (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} PrintTemplatesListQuery
+ * @property {string} [providerId] - Filter by provider account (ObjectId)
+ * @property {string} [type] - Filter by type (product, ssr, transaction, invoice, shift, manifest, order, voucher, etc.)
+ * @property {string} [channel] - backoffice | agency-backoffice | websales | agency-websales
+ * @property {string} [consumer] - printer | attachment
+ * @property {string} [format] - default | esc
+ * @property {string} [productFamily] - Only when type is product or invoice
+ * @property {string} [productId] - Only when type is product or invoice (ObjectId)
+ * @property {string} [sort] - relevance | natural | createdAsc | createdDesc | updatedAsc | updatedDesc
+ * @property {string} [templateCollectionId] - default | epsontmt88v | zebralp2844 | zebragx420t
+ * @property {string} [status] - draft | published
+ * @property {string} [mainTemplateAccountId] - Filter by source provider (ObjectId)
+ * @property {number} [page] - 1-based page for pagination
+ */
+
+/**
+ * Query params for GET /print-templates/:printTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} PrintTemplateGetByIdQuery
+ * @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 /print-templates/:printTemplateId/versions/:versionId (btrz-api-accounts). See put-version-handler getSpec().
+ * @typedef {Object} PrintTemplateVersionUpdateQuery
+ * @property {string} [superUserId] - Super user ID (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * Factory for print-templates API (btrz-api-accounts).
  * @param {Object} deps
@@ -20,7 +52,7 @@ function printSettingsFactory(_ref) {
    * GET /print-templates - list print templates.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {PrintTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, consumer, format, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -40,8 +72,8 @@ function printSettingsFactory(_ref) {
    * GET /print-templates/:printTemplateId - get a print template.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
    * @param {string} opts.printTemplateId - Print template id (ObjectId)
+   * @param {PrintTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -59,13 +91,12 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /print-templates/:printTemplateId - update a print template.
+   * PUT /print-templates/:printTemplateId - update a print template. 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.printTemplateId - Print template id (ObjectId)
    * @param {Object} opts.printTemplate - Print template payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -91,7 +122,7 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * POST /print-templates - create a print template.
+   * POST /print-templates - create a print 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
@@ -118,7 +149,7 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * DELETE /print-templates/:printTemplateId - remove a print template.
+   * DELETE /print-templates/:printTemplateId - remove a print 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
@@ -143,13 +174,13 @@ function printSettingsFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /print-templates/:printTemplateId/versions/:versionId - update a print template version.
+     * PUT /print-templates/:printTemplateId/versions/:versionId - roll back print 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.printTemplateId - Print template id (ObjectId)
-     * @param {string} opts.versionId - Version id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {string} opts.versionId - Zero-based version index (e.g. "0", "1")
+     * @param {PrintTemplateVersionUpdateQuery} [opts.query] - Query params (superUserId, superUserHash)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/lib/endpoints/accounts/printers.js

@@ -17,10 +17,9 @@ function printersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /printers - list printers.
+   * GET /printers - list printers. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/rms-settings.js

@@ -17,7 +17,7 @@ function revenueManagementSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /rms-settings - get revenue management settings.
+   * GET /rms-settings - get revenue management settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -36,7 +36,7 @@ function revenueManagementSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /rms-settings - update revenue management settings.
+   * PUT /rms-settings - update revenue management settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/s3buckets.js

@@ -17,7 +17,7 @@ function s3BucketsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PUT /account/s3Buckets/:bucketId - update an S3 bucket.
+   * PUT /account/s3Buckets/:bucketId - update an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -42,7 +42,7 @@ function s3BucketsFactory(_ref) {
   }
 
   /**
-   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket.
+   * DELETE /account/s3Buckets/:bucketId - remove an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -64,7 +64,7 @@ function s3BucketsFactory(_ref) {
   }
 
   /**
-   * POST /account/s3Buckets - create an S3 bucket.
+   * POST /account/s3Buckets - create an S3 bucket. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/salesforce-settings.js

@@ -17,11 +17,10 @@ function salesforceSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /salesforce-settings - get Salesforce settings.
+   * GET /salesforce-settings - get Salesforce settings. 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.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,7 +38,7 @@ function salesforceSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /salesforce-settings - update Salesforce settings.
+   * PUT /salesforce-settings - update Salesforce settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/shift-settings.js

@@ -17,11 +17,10 @@ function shiftSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /shift-settings - get shift settings.
+   * GET /shift-settings - get shift settings. 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.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -39,7 +38,7 @@ function shiftSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /shift-settings - update shift settings.
+   * PUT /shift-settings - update shift settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/shifts.js

@@ -4,6 +4,42 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
@@ -22,7 +58,7 @@ function shiftsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {ShiftsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -41,7 +77,7 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * GET /shift/user/:userId - get shift for user.
+   * 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)
@@ -84,13 +120,12 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * PATCH /shifts/:shiftId - update a shift (operations).
+   * 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.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -204,7 +239,7 @@ function shiftsFactory(_ref) {
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-     * @param {Object} [opts.query] - Query params
+     * @param {ShiftsListQuery} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -223,7 +258,7 @@ function shiftsFactory(_ref) {
     },
 
     /**
-     * GET /shifts/location-closures/:locationClosureId - get a location closure.
+     * 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
@@ -602,7 +637,7 @@ function shiftsFactory(_ref) {
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.locationId - Location id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {PurchaseLimitPaymentsQuery} [opts.query] - Query params; day (YYYY-MM-DD) is required
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -628,7 +663,7 @@ function shiftsFactory(_ref) {
      * @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.query] - Query params
+     * @param {ShiftSalesSummaryQuery} [opts.query] - Query params (type, depositable, paymentsAndRefundsDetails)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

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

@@ -4,6 +4,35 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
@@ -18,7 +47,7 @@ function smsTemplatesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /sms-templates/types - returns available template types.
+   * 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
@@ -41,7 +70,7 @@ function smsTemplatesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {SmsTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, sort, etc.)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -65,7 +94,7 @@ function smsTemplatesFactory(_ref) {
    * @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.query] - Optional query params
+   * @param {SmsTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -85,7 +114,7 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * POST /sms-templates - create an SMS template.
+   * 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
@@ -108,7 +137,7 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * PUT /sms-templates/:smsTemplateId - update an SMS template.
+   * 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
@@ -133,7 +162,7 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * DELETE /sms-templates/:smsTemplateId - delete an SMS template.
+   * 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
@@ -155,7 +184,7 @@ function smsTemplatesFactory(_ref) {
   }
 
   /**
-   * POST /sub-sms-templates - create a sub SMS template from a main template.
+   * 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
@@ -181,13 +210,13 @@ function smsTemplatesFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /sms-templates/:smsTemplateId/versions/:versionId - update a template version.
+     * 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 - Version id (ObjectId)
-     * @param {Object} [opts.query] - Optional query params
+     * @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>}
      */

package/lib/endpoints/accounts/sub-print-templates.js

@@ -17,7 +17,7 @@ function subPrintTemplatesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /sub-print-templates - create a sub print template.
+   * POST /sub-print-templates - create a sub print 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

package/lib/endpoints/accounts/ticket-movement-settings.js

@@ -17,7 +17,7 @@ function ticketMovementSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /ticket-movement-settings - get ticket movement settings.
+   * GET /ticket-movement-settings - get ticket movement settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -36,7 +36,7 @@ function ticketMovementSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /ticket-movement-settings - update ticket movement settings.
+   * PUT /ticket-movement-settings - update ticket movement settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/tokens.js

@@ -3,6 +3,13 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /tokens (btrz-api-accounts). See get-tokens handler getSpec().
+ * @typedef {Object} TokensGetQuery
+ * @property {string} token - Token ID (required)
+ * @property {string} type - Token type (required; see API Token.getTypes())
+ */
+
 /**
  * Factory for tokens (applications) API (btrz-api-accounts).
  * @param {Object} deps
@@ -17,11 +24,11 @@ function applicationsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /tokens - get tokens (applications).
+   * GET /tokens - get a token by ID and type.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} [opts.query] - Query params
+   * @param {TokensGetQuery} [opts.query] - Query params: token (id), type (required)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -38,7 +45,7 @@ function applicationsFactory(_ref) {
   }
 
   /**
-   * POST /tokens - create a token (application).
+   * POST /tokens - create a token (application). API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol

package/lib/endpoints/accounts/transport-regulation-settings.js

@@ -17,7 +17,7 @@ function transportRegulationSettingsForCNRT(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings.
+   * GET /transport-regulation-settings/cnrt - get CNRT transport regulation settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -36,7 +36,7 @@ function transportRegulationSettingsForCNRT(_ref) {
   }
 
   /**
-   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings.
+   * PUT /transport-regulation-settings/cnrt - update CNRT transport regulation settings. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol