btrz-api-client 8.30.0 → 8.31.0

package/lib/endpoints/sales/custom-fields.js

@@ -5,8 +5,9 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} CustomFieldsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /custom-fields (btrz-api-sales get-custom-fields getSpec).
+ * @typedef {Object} CustomFieldsListQuery
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
  */
 
 /**
@@ -26,7 +27,7 @@ function customFieldsFactory(_ref) {
    * GET /custom-fields - list custom fields.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {CustomFieldsQuery} [opts.query] - Query params
+   * @param {CustomFieldsListQuery} [opts.query] - Query params (providerIds)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/flexpasses.js

@@ -4,11 +4,6 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-/**
- * @typedef {Object} FlexpassGetQuery
- * @property {string} [providerId] - Provider account ID
- */
-
 /**
  * Factory for flexpasses API (btrz-api-sales).
  * @param {Object} deps
@@ -23,12 +18,11 @@ function flexpassesEndpointsFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * GET /flexpasses/:flexpassId - get flexpass by id.
+   * GET /flexpasses/:flexpassId - get flexpass by id. API does not accept query params (btrz-api-sales).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.flexpassId - Flexpass id
-   * @param {FlexpassGetQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/gift-certificates.js

@@ -5,8 +5,10 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for GET /gift-certificates/:GCNumber (btrz-api-sales get-gift-certificate getSpec).
  * @typedef {Object} GiftCertificateGetQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Calculate available balance for the voucher applied to the cart
  */
 
 /**
@@ -27,7 +29,7 @@ function giftCertificatesFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} opts.GCNumber - Gift certificate number
-   * @param {GiftCertificateGetQuery} [opts.query] - Query params
+   * @param {GiftCertificateGetQuery} [opts.query] - Query params (providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/order.js

@@ -5,14 +5,16 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
+ * Query params for POST /orders/:orderId/payments (btrz-api-sales post-payments-handler getSpec).
  * @typedef {Object} OrderPaymentsQuery
- * @property {string} channel - Channel where cart is being purchased (see API for allowed values)
- * @property {string} [providerId] - Account ID the transaction belongs to
+ * @property {string} [channel] - Channel where cart is being purchased (defaults to 'none' when not provided)
+ * @property {string} [providerId] - Account id the transaction belongs to
  */
 
 /**
+ * Query params for GET /order/:orderId (btrz-api-sales get-order getSpec).
  * @typedef {Object} OrderGetQuery
- * @property {string} [providerId] - Account ID for the order
+ * @property {string} [providerId] - Provider account id
  */
 
 /**
@@ -82,7 +84,7 @@ function orderFactory(_ref) {
    * @param {Object} opts.payments - Payments payload
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {Object} [opts.headers] - Optional headers
-   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel required, providerId optional)
+   * @param {OrderPaymentsQuery} [opts.query] - Query params (channel, providerId)
    * @returns {Promise<import("axios").AxiosResponse>}
    */
   function overwrite(_ref4) {

package/lib/endpoints/sales/parcel-quotes.js

@@ -18,7 +18,7 @@ function parcelQuotesFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * POST /parcel-quotes - get parcel quote.
+   * POST /parcel-quotes - get parcel quote. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.parcelQuoteData - Parcel quote request payload

package/lib/endpoints/sales/payment-providers.js

@@ -5,8 +5,11 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} PaymentProvidersQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /payment-providers (btrz-api-sales get-payment-providers getSpec).
+ * @typedef {Object} PaymentProvidersListQuery
+ * @property {string} [providerId] - Provider id to get payment providers for
+ * @property {string} [channel] - Channel to get payment providers for
+ * @property {string} [enabled] - Filter by enabled [true, false]
  */
 
 /**
@@ -27,7 +30,7 @@ function paymentProvidersFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {PaymentProvidersQuery} [opts.query] - Query params
+   * @param {PaymentProvidersListQuery} [opts.query] - Query params (providerId, channel, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/redeemable-items.js

@@ -5,8 +5,19 @@ var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
 /**
- * @typedef {Object} RedeemableItemsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /redeemable-items/:redeemableItemId (btrz-api-sales get-redeemable-item getSpec).
+ * @typedef {Object} RedeemableItemsGetQuery
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [providerIds] - One or more provider account ids (comma-separated)
+ * @property {string} [cartId] - Current cart id (item can be redeemed once per cart)
+ */
+
+/**
+ * Query params for GET /redeemable-items list (btrz-api-sales get-redeemable-items getSpec).
+ * @typedef {Object} RedeemableItemsListQuery
+ * @property {string} [ids] - Redeemable item display ID or _id, comma-separated
+ * @property {string} [providerId] - Provider account id
+ * @property {string} [cartId] - Current cart id
  */
 
 /**
@@ -26,8 +37,8 @@ function redeemableItemsFactory(_ref) {
    * GET /redeemable-items/:redeemableItemId - get redeemable item by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
-   * @param {string} opts.redeemableItemId - Redeemable item id
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {string} opts.redeemableItemId - Redeemable item display ID or _id
+   * @param {RedeemableItemsGetQuery} [opts.query] - Query params (providerId, providerIds, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -50,7 +61,7 @@ function redeemableItemsFactory(_ref) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {RedeemableItemsQuery} [opts.query] - Query params
+   * @param {RedeemableItemsListQuery} [opts.query] - Query params (ids, providerId, cartId)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */

package/lib/endpoints/sales/sync-entry.js

@@ -18,7 +18,7 @@ function syncEntryFactory(_ref) {
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
   /**
-   * PATCH /sync-entry - patch sync entry.
+   * PATCH /sync-entry - patch sync entry. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {Object} opts.data - Request body

package/lib/endpoints/sales/voucher.js

@@ -13,7 +13,7 @@ var _require = require("./../endpoints_helpers.js"),
  * @property {string} [productType] - Product type of the voucher
  * @property {string} [from] - Station "from" to validate if voucher has routes
  * @property {string} [to] - Station "to" to validate if voucher has routes
- * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare
+ * @property {string} [fareTypes] - (DEPRECATED) Validates if voucher has one fare; use fareIds instead
  * @property {string} [fareIds] - Validates if voucher has one fare ID
  * @property {string} [displayCurrencyCode] - Display currency code for multi-currency accounts
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "8.30.0",
+  "version": "8.31.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

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

@@ -1,5 +1,10 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @typedef {Object} ApplicationSettingsQuery
+ * @property {string} [name] - The application name
+ */
+
 /**
  * Factory for application-settings API (btrz-api-accounts).
  * @param {Object} deps
@@ -14,7 +19,7 @@ function applicationSettingsFactory({client, internalAuthTokenProvider}) {
    * @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/src/endpoints/accounts/current-shifts.js

@@ -2,6 +2,11 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * @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
@@ -15,7 +20,7 @@ function currentShiftsFactory({client, internalAuthTokenProvider}) {
    * @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/src/endpoints/accounts/customers.js

@@ -3,6 +3,15 @@ const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
 
+/**
+ * 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
@@ -35,8 +44,8 @@ function customersFactory({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] - 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>}
    */
@@ -55,7 +64,6 @@ function customersFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -123,7 +131,6 @@ function customersFactory({client, internalAuthTokenProvider}) {
    * @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/src/endpoints/accounts/domains.js

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

@@ -1,6 +1,20 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("../endpoints_helpers.js");
 
+/**
+ * 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
@@ -15,8 +29,8 @@ function dynamicFormsFactory({client, internalAuthTokenProvider}) {
    * @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>}
    */
@@ -34,7 +48,7 @@ function dynamicFormsFactory({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 {DynamicFormsQuery} [opts.query] - Query params (dynamicFormFieldId, providerId, type)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -51,7 +65,6 @@ function dynamicFormsFactory({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 {Object} opts.data - Form payload
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -123,7 +136,6 @@ function dynamicFormsFactory({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 {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

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

@@ -10,11 +10,10 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function emailSettingsFactory({client, 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>}
    */
@@ -26,12 +25,11 @@ function emailSettingsFactory({client, internalAuthTokenProvider}) {
     });
   }
   /**
-   * 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/src/endpoints/accounts/email-templates.js

@@ -4,6 +4,7 @@ const {
 } = require("../endpoints_helpers.js");
 
 /**
+ * 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
@@ -16,6 +17,14 @@ const {
  * @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
@@ -76,7 +85,7 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
    * @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 }>>}
    */
@@ -169,7 +178,6 @@ function emailTemplatesFactory({client, internalAuthTokenProvider}) {
      * @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/src/endpoints/accounts/exchange-rates.js

@@ -1,3 +1,4 @@
+/* eslint-disable max-len */
 /* eslint-disable import/extensions */
 const {authorizationHeaders} = require("./../endpoints_helpers");
 
@@ -10,12 +11,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers");
  */
 function exchangeRatesFactory({client, 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/src/endpoints/accounts/exchange-receipts.js

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

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

@@ -10,11 +10,10 @@ const {authorizationHeaders} = require("./../endpoints_helpers");
  */
 function ImagesFactory({client, 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>}
    */
@@ -27,11 +26,10 @@ function ImagesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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/src/endpoints/accounts/interline.js

@@ -12,11 +12,10 @@ const {
 function interlineFactory({client, internalAuthTokenProvider}) {
   const 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>}
      */
@@ -28,7 +27,7 @@ function interlineFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * 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)
@@ -79,11 +78,10 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const 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>}
      */
@@ -98,11 +96,10 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const 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>}
      */
@@ -117,7 +114,7 @@ function interlineFactory({client, internalAuthTokenProvider}) {
 
   const 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/src/endpoints/accounts/journey-prices-settings.js

@@ -11,7 +11,7 @@ const {
  */
 function journeyPricesSettingsFactory({client, 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
@@ -26,7 +26,7 @@ function journeyPricesSettingsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * 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