btrz-api-client 8.30.0 → 8.31.0

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

@@ -3,6 +3,11 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} ApplicationSettingsQuery
+ * @property {string} [name] - The application name
+ */
+
 /**
  * Factory for application-settings API (btrz-api-accounts).
  * @param {Object} deps
@@ -22,7 +27,7 @@ function applicationSettingsFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.providerId - Provider id (ObjectId)
-   * @param {Object} [opts.query] - Query params
+   * @param {ApplicationSettingsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/current-shifts.js

@@ -3,6 +3,11 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} CurrentShiftsQuery
+ * @property {string} [includeActivity] - Set to 'false' to avoid returning sales activity data for the shift (default 'true')
+ */
+
 /**
  * Factory for current-shift (per user) API (btrz-api-accounts).
  * @param {Object} deps
@@ -21,7 +26,7 @@ function currentShiftsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.userId - User id (ObjectId)
-   * @param {Object} [opts.query] - Query params
+   * @param {CurrentShiftsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/customers.js

@@ -7,6 +7,15 @@ var base64 = require("base-64");
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /customers (btrz-api-accounts). See get-customers getSpec().
+ * @typedef {Object} CustomersQuery
+ * @property {string} [customerNumber] - A particular customer number; only that customer will be listed
+ * @property {string} [externalId] - A particular externalId (same format as when creating the customer)
+ * @property {string} [providerIds] - Provider ids to get customers from (comma-separated if more than one)
+ * @property {string} [lookupSearchParams] - Lookup search data in format "documentTypeId|DNI,documentNumber|1234567"
+ */
+
 /**
  * Factory for customers API (btrz-api-accounts).
  * @param {Object} deps
@@ -50,8 +59,8 @@ function customersFactory(_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] - Filter by provider id (ObjectId)
+   * @param {CustomersQuery} [opts.query] - Query params (customerNumber, externalId, providerIds, lookupSearchParams)
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience for single provider)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -77,7 +86,6 @@ function customersFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} opts.customer - Customer payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -160,7 +168,6 @@ function customersFactory(_ref) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.customerId - Customer id (ObjectId)
    * @param {Object} opts.data - Partial customer payload
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/domains.js

@@ -17,10 +17,9 @@ function domainsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /domains - list domains.
+   * GET /domains - list domains. 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/dynamic-forms.js

@@ -6,6 +6,20 @@ var _extends = Object.assign || function (target) { for (var i = 1; i < argument
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /dynamic-forms (btrz-api-accounts). See get-handler getSpec().
+ * @typedef {Object} DynamicFormsQuery
+ * @property {string} [dynamicFormFieldId] - Get all dynamic forms for the given field id (ObjectId)
+ * @property {string} [providerId] - Get all dynamic forms for the given provider id (ObjectId)
+ * @property {string} [type] - Filter by type: "reservation" | "parcel" | "checkin" | "paid_in" | "pay_on_account"
+ */
+
+/**
+ * Query params for GET /dynamic-forms/:dynamicFormId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} DynamicFormByIdQuery
+ * @property {string} [providerId] - Fetch the dynamic form for the given providerId (ObjectId)
+ */
+
 /**
  * Factory for dynamic-forms API (btrz-api-accounts).
  * @param {Object} deps
@@ -25,8 +39,8 @@ function dynamicFormsFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.dynamicFormId - Dynamic form id (ObjectId)
-   * @param {Object} [opts.query] - Query params
-   * @param {string} [opts.providerId] - Provider id (ObjectId)
+   * @param {DynamicFormByIdQuery} [opts.query] - Query params (providerId)
+   * @param {string} [opts.providerId] - Provider id; if set, added to query (convenience)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -52,7 +66,7 @@ function dynamicFormsFactory(_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 {DynamicFormsQuery} [opts.query] - Query params (dynamicFormFieldId, providerId, type)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -75,7 +89,6 @@ function dynamicFormsFactory(_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 {Object} opts.data - Form payload
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -172,7 +185,6 @@ function dynamicFormsFactory(_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 {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

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

@@ -18,11 +18,10 @@ function emailSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /email-settings - list email settings.
+   * GET /email-settings - list email 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>}
    */
@@ -40,12 +39,11 @@ function emailSettingsFactory(_ref) {
     });
   }
   /**
-   * GET /email-settings/:email - get email settings by email.
+   * GET /email-settings/:email - get email settings by email. 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.email - Email address
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

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

@@ -5,6 +5,7 @@ var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /email-templates (btrz-api-accounts). See get-handler getSpec().
  * @typedef {Object} EmailTemplatesListQuery
  * @property {string} [providerId] - Filter by provider account (ObjectId)
  * @property {string} [type] - Filter by template type
@@ -17,6 +18,14 @@ var _require = require("../endpoints_helpers.js"),
  * @property {number} [page] - 1-based page for pagination
  */
 
+/**
+ * Query params for GET /email-templates/:emailTemplateId (btrz-api-accounts). See get-by-id-handler getSpec().
+ * @typedef {Object} EmailTemplateGetByIdQuery
+ * @property {string} [providerId] - Filter by provider; template must belong to this account, current account, or be global (ObjectId)
+ * @property {string} [superUserId] - Super user ID for authentication (ObjectId)
+ * @property {string} [superUserHash] - Super user hash for authentication
+ */
+
 /**
  * @typedef {Object} EmailTemplatePostData
  * @property {string} name - Template name
@@ -92,7 +101,7 @@ function emailTemplatesFactory(_ref) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.emailTemplateId - Template id (ObjectId)
-   * @param {Object} [opts.query] - Optional query params
+   * @param {EmailTemplateGetByIdQuery} [opts.query] - Query params (providerId, superUserId, superUserHash)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse<{ emailTemplate: object }>>}
    */
@@ -214,7 +223,6 @@ function emailTemplatesFactory(_ref) {
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
      * @param {string} opts.emailTemplateId - Template id (ObjectId)
      * @param {string} opts.versionId - Version id (ObjectId)
-     * @param {Object} [opts.query] - Optional query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/lib/endpoints/accounts/exchange-rates.js

@@ -1,5 +1,6 @@
 "use strict";
 
+/* eslint-disable max-len */
 /* eslint-disable import/extensions */
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
@@ -18,12 +19,11 @@ function exchangeRatesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /exchange-rates/:isoCode - get exchange rates by ISO code.
+   * GET /exchange-rates/:isoCode - get exchange rates by ISO code. API does not define query params in getSpec().
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.isoCode - Currency ISO code
-   * @param {Object} [opts.query] - Query params
+   * @param {string} opts.isoCode - Currency ISO code (3 characters)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/accounts/exchange-receipts.js

@@ -18,7 +18,7 @@ function exchangeReceiptsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PUT /exchange-receipt-settings - update exchange receipt settings.
+   * PUT /exchange-receipt-settings - update exchange receipt 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
@@ -41,7 +41,7 @@ function exchangeReceiptsFactory(_ref) {
   }
 
   /**
-   * GET /exchange-receipt-settings - get exchange receipt settings.
+   * GET /exchange-receipt-settings - get exchange receipt 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/goal-settings.js

@@ -17,11 +17,10 @@ function goalSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /goal-settings - get goal settings.
+   * GET /goal-settings - get goal 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 goalSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /goal-settings - update goal settings.
+   * PUT /goal-settings - update goal 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/images.js

@@ -18,11 +18,10 @@ function ImagesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /images - list images.
+   * GET /images - list images. 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>}
    */
@@ -41,11 +40,10 @@ function ImagesFactory(_ref) {
   }
 
   /**
-   * GET /images/:imageId - get an image.
+   * GET /images/:imageId - get an image. 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 {string} opts.imageId - Image id (ObjectId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}

package/lib/endpoints/accounts/interline.js

@@ -18,11 +18,10 @@ function interlineFactory(_ref) {
 
   var invitations = {
     /**
-     * GET /interline/invitations - list interline invitations.
+     * GET /interline/invitations - list interline invitations. 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>}
      */
@@ -41,7 +40,7 @@ function interlineFactory(_ref) {
     },
 
     /**
-     * GET /interline/invitations/:invitationId - get an invitation.
+     * GET /interline/invitations/:invitationId - get an invitation. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.invitationId - Invitation id (ObjectId)
@@ -109,11 +108,10 @@ function interlineFactory(_ref) {
 
   var consumers = {
     /**
-     * GET /interline/consumers - list interline consumers.
+     * GET /interline/consumers - list interline consumers. 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>}
      */
@@ -134,11 +132,10 @@ function interlineFactory(_ref) {
 
   var providers = {
     /**
-     * GET /interline/providers - list interline providers.
+     * GET /interline/providers - list interline providers. 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>}
      */
@@ -159,7 +156,7 @@ function interlineFactory(_ref) {
 
   var network = {
     /**
-     * GET /interline/:interlineId/network - get interline network.
+     * GET /interline/:interlineId/network - get interline network. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} opts.interlineId - Interline id (ObjectId)

package/lib/endpoints/accounts/journey-prices-settings.js

@@ -17,7 +17,7 @@ function journeyPricesSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /journey-prices-settings - get journey prices settings.
+   * GET /journey-prices-settings - get journey prices 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 journeyPricesSettingsFactory(_ref) {
   }
 
   /**
-   * PUT /journey-prices-settings - update journey prices settings.
+   * PUT /journey-prices-settings - update journey prices 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/lexicons.js

@@ -4,6 +4,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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
@@ -18,11 +47,11 @@ function lexiconsFactory(_ref) {
       internalAuthTokenProvider = _ref.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>}
    */
@@ -145,12 +174,12 @@ function lexiconsFactory(_ref) {
 
   var 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: function list(_ref7) {
@@ -169,13 +198,13 @@ function lexiconsFactory(_ref) {
 
 
     /**
-     * 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: function getById(_ref8) {

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

@@ -17,7 +17,7 @@ function marketPricingSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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
@@ -36,7 +36,7 @@ function marketPricingSettingsFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/accounts/multiproduct-sales-settings.js

@@ -17,7 +17,7 @@ function multiproductSalesSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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
@@ -36,7 +36,7 @@ function multiproductSalesSettingsFactory(_ref) {
   }
 
   /**
-   * 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/lib/endpoints/accounts/network.js

@@ -19,11 +19,10 @@ function networkFactory(_ref) {
 
   var 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>}
      */
@@ -42,11 +41,10 @@ function networkFactory(_ref) {
     },
 
     /**
-     * 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>}
      */
@@ -64,13 +62,12 @@ function networkFactory(_ref) {
     },
 
     /**
-     * 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>}
      */
@@ -123,7 +120,7 @@ function networkFactory(_ref) {
     },
 
     /**
-     * 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
@@ -150,7 +147,7 @@ function networkFactory(_ref) {
     },
 
     /**
-     * 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/lib/endpoints/accounts/operation-settings.js

@@ -17,11 +17,10 @@ function operationSettingsFactory(_ref) {
       internalAuthTokenProvider = _ref.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>}
    */
@@ -39,7 +38,7 @@ function operationSettingsFactory(_ref) {
   }
 
   /**
-   * 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