btrz-api-client 8.30.0 → 8.32.0

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

@@ -1,8 +1,42 @@
 "use strict";
 
+/* eslint-disable max-len */
 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} [agencyId] - Filter sub-templates for this agency (ObjectId)
+ * @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
@@ -17,44 +51,53 @@ function printSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /print-templates - list print templates.
+   * GET /print-templates - list print templates (paginated when page is provided).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PrintTemplatesListQuery} [opts.query] - Query params (providerId, type, channel, agencyId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplates: object[], next?: string, previous?: string, totalRecords?: number, page?: number }>>}
+   *   When page is used, response includes next, previous, totalRecords, page.
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA, INVALID_PRODUCT_ID; 401; 500
    */
   function all(_ref2) {
     var token = _ref2.token,
-        query = _ref2.query,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
         headers = _ref2.headers;
 
     return client({
       url: "/print-templates",
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
   /**
-   * GET /print-templates/:printTemplateId - get a print template.
+   * GET /print-templates/:printTemplateId - get a single print template.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @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>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 INVALID_PRINT_TEMPLATE_ID / INVALID_PROVIDER_ID, 401, 404 PRINT_TEMPLATE_NOT_FOUND, 500
    */
   function get(_ref3) {
     var token = _ref3.token,
-        query = _ref3.query,
-        headers = _ref3.headers,
-        printTemplateId = _ref3.printTemplateId;
+        jwtToken = _ref3.jwtToken,
+        printTemplateId = _ref3.printTemplateId,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
 
     return client({
       url: "/print-templates/" + printTemplateId,
       params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 
@@ -64,10 +107,11 @@ function printSettingsFactory(_ref) {
    * @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.printTemplate - Print template payload (name, type; type-specific fields)
+   * @param {Object} [opts.query] - Optional (superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA, type-specific; 401 NOT_SUPER_USER; 404; 500
    */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -91,13 +135,14 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * POST /print-templates - create a print template.
+   * POST /print-templates - create a print template. Body: printTemplate (name, type required; type-specific fields).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.printTemplate - Print template payload
+   * @param {Object} opts.printTemplate - Print template payload (see PrintTemplatePostData)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+   * @throws {import("axios").AxiosError} 400 WRONG_DATA / PRODUCT_* / INVOICE_* / META_* / TEMPLATE_*, 401 NOT_SUPER_USER, 500
    */
   function create(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -118,13 +163,14 @@ function printSettingsFactory(_ref) {
   }
 
   /**
-   * DELETE /print-templates/:printTemplateId - remove a print template.
+   * DELETE /print-templates/:printTemplateId - delete a print template.
    * @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.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printTemplateId: string }>>}
+   * @throws {import("axios").AxiosError} 400 PRINT_TEMPLATE_ID, 401, 404 PRINT_TEMPLATE_NOT_FOUND, 500
    */
   function remove(_ref6) {
     var printTemplateId = _ref6.printTemplateId,
@@ -143,15 +189,16 @@ function printSettingsFactory(_ref) {
 
   var versions = {
     /**
-     * PUT /print-templates/:printTemplateId/versions/:versionId - update a print template version.
+     * PUT /print-templates/:printTemplateId/versions/:versionId - roll back to a saved version (versionId = zero-based index).
      * @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>}
+     * @returns {Promise<import("axios").AxiosResponse<{ printTemplate: object }>>}
+     * @throws {import("axios").AxiosError} 400 WRONG_DATA; 401 NOT_SUPER_USER; 404; 500
      */
     update: function update(_ref7) {
       var printTemplateId = _ref7.printTemplateId,

package/lib/endpoints/accounts/printers.js

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -17,22 +18,26 @@ function printersFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /printers - list printers.
+   * GET /printers - list supported printers and their print templates. No query parameters accepted.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Unused; API accepts no query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ printers: Array<object> }>>}
+   *   Response printers array: each has id, name, itemTypes, templates (see GET /printers).
+   * @throws {import("axios").AxiosError} 401 Unauthorized, 500 Internal server error
    */
   function all(_ref2) {
     var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
         query = _ref2.query,
         headers = _ref2.headers;
 
     return client({
       url: "/printers",
-      params: query,
-      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      params: query || {},
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
 

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

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
@@ -17,12 +18,14 @@ function revenueManagementSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /rms-settings - get revenue management settings.
+   * GET /rms-settings — get revenue management settings for the account. No query parameters.
    * @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>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth token
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { revenueManagementSettings: { enabled: boolean, applicationId?: string, subscriptionId?: string, ratalityClientId?: string, userId?: string } } }>>}
+   * @throws {import("axios").AxiosError} 401 Unauthorized (missing or invalid API key/Authorization)
+   * @throws {import("axios").AxiosError} 500 Internal server error
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -36,13 +39,18 @@ function revenueManagementSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /rms-settings - update revenue management settings.
+   * PUT /rms-settings — update revenue management settings. Body is the settings object (e.g. { enabled: true }).
+   * When enabling, Ratality credentials must already exist on the account. Emits rms.enabled / rms.disabled webhooks.
    * @param {Object} opts
-   * @param {string} [opts.token] - API key
-   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.revenueManagementSettings - Settings payload
-   * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {string} [opts.token] - API key (X-API-KEY)
+   * @param {string} [opts.jwtToken] - JWT or internal auth token
+   * @param {{ enabled: boolean, ratalityUsername?: string, ratalityPassword?: string }} opts.revenueManagementSettings - Settings payload (at least enabled; credentials required when enabling)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse<{ data: { revenueManagementSettings: { enabled: boolean, applicationId?: string, subscriptionId?: string, ratalityClientId?: string, userId?: string } } }>>}
+   * @throws {import("axios").AxiosError} 400 ACCOUNT_ALREADY_HAS_RMS_SETTINGS_ENABLED, RATALITY_CREDENTIALS_REQUIRED, CREATE_CLIENT_*
+   * @throws {import("axios").AxiosError} 401 Unauthorized
+   * @throws {import("axios").AxiosError} 404 ACCOUNT_NOT_FOUND
+   * @throws {import("axios").AxiosError} 500 CREATE_USER_ERROR or internal server error
    */
   function update(_ref3) {
     var token = _ref3.token,

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

@@ -4,7 +4,7 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for salesforce-settings API (btrz-api-accounts).
+ * Factory for salesforce-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,13 +17,13 @@ function salesforceSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /salesforce-settings - get Salesforce settings.
+   * GET /salesforce-settings – get Salesforce settings for the current account. No 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.query] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ salesforceSettings: object }>>}
    */
   function get(_ref2) {
     var jwtToken = _ref2.jwtToken,
@@ -39,13 +39,14 @@ function salesforceSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /salesforce-settings - update Salesforce settings.
+   * PUT /salesforce-settings – update Salesforce settings. When enabled is true, mcInstanceId,
+   * messageId, clientId, clientSecret are required. Emits salesforcesettings.updated webhook.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.salesforceSettings - Settings payload
+   * @param {Object} opts.salesforceSettings - Settings payload (SalesforceSettingsPayload; enabled required)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ salesforceSettings: object }>>}
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,

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

@@ -4,7 +4,7 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * Factory for shift-settings API (btrz-api-accounts).
+ * Factory for shift-settings API (btrz-api-accounts). Requires BETTEREZ_APP audience.
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
@@ -17,13 +17,13 @@ function shiftSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /shift-settings - get shift settings.
+   * GET /shift-settings – get shift settings for the current account. No 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.query] - Optional query params
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shiftSettings: object }>>}
    */
   function get(_ref2) {
     var token = _ref2.token,
@@ -39,13 +39,13 @@ function shiftSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /shift-settings - update shift settings.
+   * PUT /shift-settings – update shift settings. Emits shiftsettings.updated webhook.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.shiftSettings - Settings payload
+   * @param {Object} opts.shiftSettings - Settings payload (ShiftSetting)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shiftSettings: object }>>}
    */
   function update(_ref3) {
     var jwtToken = _ref3.jwtToken,

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
@@ -18,13 +54,14 @@ function shiftsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /shifts - list shifts.
+   * GET /shifts - list shifts for the account. Returns shifts filtered by query params.
+   * See get-shifts handler getSpec() in btrz-api-accounts for full API details.
    * @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 (includeActivity, status, pendingShiftClosure, locationId, providerId, sort, fromDate, toDate)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shifts: Array }>>} Response body: { shifts }. Errors: 400 (validation), 401, 500
    */
   function all(_ref2) {
     var jwtToken = _ref2.jwtToken,
@@ -41,7 +78,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)
@@ -59,13 +96,14 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * POST /shifts - create a shift.
+   * POST /shifts - open a shift for a user. Body: PostShiftRequest (stationId, userId, counterNumber).
+   * See post-shift handler getSpec() in btrz-api-accounts for full API details.
    * @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.shiftData - Shift payload (stationId, userId, counterNumber)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 400, 401, 404 (USER_NOT_FOUND, STATION_NOT_FOUND), 409 (SHIFT_ALREADY_OPEN_FOR_USER, USER_WITHOUT_SHIFT_ENABLED), 500
    */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
@@ -84,15 +122,16 @@ function shiftsFactory(_ref) {
   }
 
   /**
-   * PATCH /shifts/:shiftId - update a shift (operations).
+   * PATCH /shifts/:shiftId - close a shift. Body: PatchShiftRequest (operations array with comment).
+   * See patch-shift handler getSpec() in btrz-api-accounts for full API details.
    * @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.operations - Operations payload (e.g. [{ comment }] for close)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @param {Object} [opts.query] - Optional query params
+   * @returns {Promise<import("axios").AxiosResponse<{ shift: Object }>>} Response body: { shift }. Errors: 401, 404 (SHIFT_NOT_FOUND, USER_NOT_FOUND), 409 (SHIFT_ALREADY_CLOSED, COMMENT_IS_MANDATORY_WHEN_VARIANCE_EXISTS, TOTAL_CHANGED), 500
    */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
@@ -204,7 +243,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 +262,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 +641,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 +667,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>}
      */