btrz-api-client 8.30.0 → 8.31.0

package/src/endpoints/accounts/lexicons.js

@@ -3,6 +3,35 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /lexicons/:lexiconCollectionId (btrz-api-accounts). See get-lexicons handler getSpec().
+ * @typedef {Object} LexiconsListQuery
+ * @property {string} [providerIds] - Provider ids to get lexicons for
+ * @property {string} [context] - Context of the lexicons to search
+ * @property {boolean} [accountOnly] - Filter lexicons only for the given providerIds; context ignored when true
+ * @property {string} [key] - Specific lexicon key to search for
+ * @property {string} [keys] - Comma-separated list of keys to search for
+ * @property {string} [lang] - ISO language code to filter values
+ * @property {string} [langs] - Comma-separated ISO language codes to filter values
+ */
+
+/**
+ * Query params for GET /lexicons/suggestions (btrz-api-accounts). See get-lexicons-suggestions handler getSpec().
+ * @typedef {Object} LexiconSuggestionsListQuery
+ * @property {string} [status] - Filter by status: under review | accepted | rejected
+ * @property {string} [lang] - Filter by language code (e.g. en-us, pt-br)
+ * @property {string} [key] - Filter by lexicon key
+ * @property {string} [superUserId] - Super user id; with superUserHash returns suggestions for all accounts
+ * @property {string} [superUserHash] - Super user hash; with superUserId returns suggestions for all accounts
+ */
+
+/**
+ * Query params for GET /lexicons/suggestions/:id (btrz-api-accounts). See get-lexicons-suggestion-by-id handler getSpec().
+ * @typedef {Object} LexiconSuggestionGetByIdQuery
+ * @property {string} [superUserId] - Super user id; with superUserHash any suggestion can be retrieved
+ * @property {string} [superUserHash] - Super user hash; with superUserId any suggestion can be retrieved
+ */
+
 /**
  * Factory for lexicons API (btrz-api-accounts).
  * @param {Object} deps
@@ -14,11 +43,11 @@ function lexiconsFactory({
   client, internalAuthTokenProvider
 }) {
   /**
-   * GET lexicons/buscompany - list lexicons for bus company context.
+   * GET /lexicons/buscompany - list lexicons (collection buscompany). Query params from get-lexicons getSpec().
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.context - Context (e.g. buscompany)
-   * @param {Object} [opts.query] - Query params
+   * @param {string} [opts.context] - Context of the lexicons to search (merged into query)
+   * @param {LexiconsListQuery} [opts.query] - Query params: providerIds, context, accountOnly, key, keys, lang, langs
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -134,12 +163,12 @@ function lexiconsFactory({
 
   const suggestions = {
     /**
-     * List lexicon suggestions for the account (or all accounts when super user params are provided).
+     * GET /lexicons/suggestions - list lexicon suggestions (or all accounts when super user params provided).
      * @param {Object} opts
      * @param {string} [opts.token] - API key (x-api-key)
      * @param {string} [opts.jwtToken] - JWT or constants.INTERNAL_AUTH_TOKEN_SYMBOL for internal auth
      * @param {Object} [opts.headers] - Optional request headers
-     * @param {Object} [opts.params] - Query params: status, lang, key, superUserId, superUserHash
+     * @param {LexiconSuggestionsListQuery} [opts.params] - Query params: status, lang, key, superUserId, superUserHash
      * @returns {Promise<{data: { suggestions: Array }}>}
      */
     list({token, jwtToken, headers, params = {}}) {
@@ -151,13 +180,13 @@ function lexiconsFactory({
     },
 
     /**
-     * Get a single lexicon suggestion by id.
+     * GET /lexicons/suggestions/:id - get a single lexicon suggestion by id.
      * @param {Object} opts
      * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {Object} [opts.headers] - Optional request headers
-     * @param {Object} [opts.params] - Query params: superUserId, superUserHash (to access any account's suggestion)
+     * @param {LexiconSuggestionGetByIdQuery} [opts.params] - Query params: superUserId, superUserHash (to access any account's suggestion)
      * @returns {Promise<{data: Object}>}
      */
     getById({token, jwtToken, headers, suggestionId, params = {}}) {

package/src/endpoints/accounts/market-pricing-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /market-pricing-settings - get market pricing settings.
+   * GET /market-pricing-settings - get market pricing 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
@@ -26,7 +26,7 @@ function marketPricingSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /market-pricing-settings - update market pricing settings.
+   * PUT /market-pricing-settings - update market pricing 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/src/endpoints/accounts/multiproduct-sales-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /multiproduct-sales-settings - get multiproduct sales settings.
+   * GET /multiproduct-sales-settings - get multiproduct sales 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
@@ -26,7 +26,7 @@ function multiproductSalesSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /multiproduct-sales-settings - update multiproduct sales settings.
+   * PUT /multiproduct-sales-settings - update multiproduct sales 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/src/endpoints/accounts/network.js

@@ -13,11 +13,10 @@ const {
 function networkFactory({client, internalAuthTokenProvider}) {
   const agencies = {
     /**
-     * GET /network/agencies - list agencies.
+     * GET /network/agencies - list agencies. 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -29,11 +28,10 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * GET /network/agencies/:sellerId - get an agency by seller id.
+     * GET /network/agencies/:agencyId - get an agency by id. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
-     * @param {string} opts.sellerId - Seller/agency id (ObjectId)
-     * @param {Object} [opts.query] - Query params
+     * @param {string} opts.sellerId - Seller/agency id (ObjectId), maps to path agencyId
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -45,13 +43,12 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /network/agencies/:sellerId - update an agency.
+     * PUT /network/agencies/:sellerId - update an agency. 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.sellerId - Seller/agency id (ObjectId)
      * @param {Object} opts.agency - Agency payload
-     * @param {Object} [opts.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -90,7 +87,7 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /network/agencies/remove-product - remove product from agency.
+     * PUT /network/agencies/remove-product - remove product from agency. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -111,7 +108,7 @@ function networkFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /network/agencies/remove-fare - remove fare from agency.
+     * PUT /network/agencies/remove-fare - remove fare from agency. 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/src/endpoints/accounts/operation-settings.js

@@ -11,11 +11,10 @@ const {
  */
 function operationSettingsFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /operation-settings - get operation settings.
+   * GET /operation-settings - get operation 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>}
    */
@@ -28,7 +27,7 @@ function operationSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /operation-settings - update operation settings.
+   * PUT /operation-settings - update operation 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/src/endpoints/accounts/people-lookups.js

@@ -1,7 +1,25 @@
+/* eslint-disable max-len */
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -15,8 +33,8 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -34,9 +52,9 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -51,13 +69,13 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -78,12 +96,12 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -104,7 +122,7 @@ function peopleLookupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/point-to-point-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function pointToPointSettingsFactory({client, 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
@@ -26,7 +26,7 @@ function pointToPointSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/print-settings.js

@@ -11,10 +11,9 @@ const {
  */
 function printSettingsFactory({client, 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>}
    */
@@ -27,7 +26,7 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/print-templates.js

@@ -2,6 +2,38 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -14,7 +46,7 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
    * 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>}
    */
@@ -30,8 +62,8 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
    * 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>}
    */
@@ -44,13 +76,12 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -69,7 +100,7 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -91,7 +122,7 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -111,13 +142,13 @@ function printSettingsFactory({client, internalAuthTokenProvider}) {
 
   const 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/src/endpoints/accounts/printers.js

@@ -11,10 +11,9 @@ const {
  */
 function printersFactory({client, 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/src/endpoints/accounts/rms-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function revenueManagementSettingsFactory({client, 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
@@ -26,7 +26,7 @@ function revenueManagementSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/s3buckets.js

@@ -9,7 +9,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function s3BucketsFactory({client, 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
@@ -28,7 +28,7 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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
@@ -45,7 +45,7 @@ function s3BucketsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/salesforce-settings.js

@@ -11,11 +11,10 @@ const {
  */
 function salesforceSettingsFactory({client, 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>}
    */
@@ -28,7 +27,7 @@ function salesforceSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/shift-settings.js

@@ -11,11 +11,10 @@ const {
  */
 function shiftSettingsFactory({client, 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>}
    */
@@ -28,7 +27,7 @@ function shiftSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/shifts.js

@@ -1,6 +1,42 @@
 /* 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
@@ -14,7 +50,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -28,7 +64,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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)
@@ -62,13 +98,12 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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>}
    */
@@ -157,7 +192,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @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>}
      */
@@ -170,7 +205,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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
@@ -458,7 +493,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @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>}
      */
@@ -478,7 +513,7 @@ function shiftsFactory({client, internalAuthTokenProvider}) {
      * @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>}
      */