btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/items.js

@@ -3,10 +3,47 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /items (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ItemsQuery
+ * @property {string} [productId] - The ids of the products to get products for
+ * @property {string} [associatedProductId] - The id of the associated products when used as an SSR
+ * @property {string} [disabled] - Filter by disabled: "true" | "false"
+ * @property {string} [type] - Filter by type: "paid_in" | "paid_out"
+ * @property {string} [providerIds] - The id of the provider to get products for
+ * @property {string} [filterToCurrentShiftLocation] - Filter items sellable in current location: "true" | "false". Requires JwtAuth
+ * @property {string} [channels] - Filter by channels (comma-separated, e.g. "backoffice,websales"). Requires JwtAuth
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
+/**
+ * Query params for GET /items/:itemId (btrz-api-inventory). See get-by-id-handler getSpec().
+ * @typedef {Object} ItemByIdQuery
+ * @property {string} [currency] - The isocode of the selected currency
+ */
+
+/**
+ * Factory for items API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, tickets: object }}
+ */
+
+
 function itemsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /items - list items.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ItemsQuery} [opts.query] - Query params (productId, disabled, type, providerIds, channels, currency, etc.)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -21,6 +58,16 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /items/:itemId - get item by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.itemId - Item id (ObjectId format)
+   * @param {ItemByIdQuery} [opts.query] - Query params (currency)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var itemId = _ref3.itemId,
         token = _ref3.token,
@@ -35,6 +82,15 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /items - create item.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.item - Item payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         item = _ref4.item,
@@ -49,6 +105,16 @@ function itemsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /items/:itemId - update item.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.itemId - Item id
+   * @param {Object} opts.item - Item payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -64,7 +130,18 @@ function itemsFactory(_ref) {
     });
   }
 
+  /** @type {{ update: function }} */
   var tickets = {
+    /**
+     * PUT /items/:soldItemId/tickets/:ticketId - update ticket.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.soldItemId - Sold item id
+     * @param {string} opts.ticketId - Ticket id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref6) {
       var jwtToken = _ref6.jwtToken,
           token = _ref6.token,

package/lib/endpoints/inventory/journey-prices.js

@@ -1,13 +1,64 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /journey-prices (btrz-api-inventory). See get-journey-prices getSpec().
+ * @typedef {Object} JourneyPricesListQuery
+ * @property {string} providerIds - Provider IDs (required). Comma-separated for multiple
+ * @property {string} [versionIds] - Version IDs filter. Comma-separated
+ * @property {string} [productIds] - Product IDs filter. Comma-separated
+ * @property {string} [fareClassIds] - Fare class IDs. Comma-separated
+ * @property {string} [seatClassIds] - Seat class IDs. Comma-separated
+ * @property {string} [fareIds] - Fare IDs. Comma-separated
+ * @property {string} [brandIds] - Brand IDs. Comma-separated
+ * @property {string} [amenityGroupIds] - Amenity group IDs. Comma-separated
+ * @property {string} [operatingCompanyIds] - Operating company IDs. Comma-separated
+ * @property {string} [routeIds] - Route IDs. Comma-separated
+ * @property {string} [travelRoutesIds] - Travel route IDs. Comma-separated
+ * @property {string} [shiftLocationIds] - Shift location IDs. Comma-separated
+ * @property {string} [originIds] - Origin (departure) station IDs. Comma-separated
+ * @property {string} [destinationIds] - Destination (arrival) station IDs. Comma-separated
+ * @property {number} [price.min] - Min price filter
+ * @property {number} [price.max] - Max price filter
+ * @property {number} [regularPrice.min] - Min regular price filter
+ * @property {number} [regularPrice.max] - Max regular price filter
+ * @property {number} [returnPriceModifier.min] - Min return price modifier filter
+ * @property {number} [returnPriceModifier.max] - Max return price modifier filter
+ * @property {string} [currencies] - ISO 4217 codes. Comma-separated (e.g. USD,MXN)
+ * @property {string} [taxExempted] - Filter by tax exempted [true, false]
+ */
+
+/**
+ * Query params for GET /journey-prices/:id (btrz-api-inventory). See get-journey-price getSpec().
+ * @typedef {Object} JourneyPriceGetQuery
+ * @property {boolean} [outdated] - If true, return history of updates
+ * @property {string} [versionId] - Return only this versionId (object id)
+ */
+
+/**
+ * Factory for journey-prices API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, deleteById: function, get: function, create: function, update: function }}
+ */
+
+
 function journeyPricesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /journey-prices - list journey prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {JourneyPricesListQuery} [opts.query] - Query params (providerIds required; see getSpec for full list)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +73,16 @@ function journeyPricesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /journey-prices/:id - get journey price by id.
+   * @param {Object} opts
+   * @param {string} opts.id - Journey price id
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {JourneyPriceGetQuery} [opts.query] - Query params (outdated, versionId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var id = _ref3.id,
         token = _ref3.token,
@@ -37,6 +98,15 @@ function journeyPricesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /journey-prices/:id - delete journey price. 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.id - Journey price id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteById(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +120,15 @@ function journeyPricesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /journey-prices - create journey price. 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.journeyPrice - Journey price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,6 +143,16 @@ function journeyPricesFactory(_ref) {
     });
   }
 
+  /**
+   * PATCH /journey-prices/:journeyPriceId - update journey price. 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.journeyPriceId - Journey price id
+   * @param {Object} opts.journeyPrice - Journey price payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/labels.js

@@ -3,10 +3,35 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /labels (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} LabelsQuery
+ * @property {string} [name] - The name of the label to search for; omit to return all
+ * @property {number} [page] - Page number; omit for first page
+ */
+
+/**
+ * Factory for labels API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+
+
 function labelsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /labels - list labels.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {LabelsQuery} [opts.query] - Query params (name, page)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +45,15 @@ function labelsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /labels/:labelId - get label by id. 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.labelId - Label id (ObjectId format)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var labelId = _ref3.labelId,
         token = _ref3.token,
@@ -34,6 +68,15 @@ function labelsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /labels - create label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.label - Label payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         label = _ref4.label,
@@ -48,6 +91,16 @@ function labelsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /labels/:labelId - update label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.labelId - Label id
+   * @param {Object} opts.label - Label payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,
@@ -63,6 +116,15 @@ function labelsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /labels/:labelId - remove label.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.labelId - Label id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/marital-status.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /marital-status (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MaritalStatusListQuery
+ * @property {string} [providerIds] - Provider IDs to get marital status for
+ */
+
+/**
+ * Factory for marital-status API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
+
+
 function maritalStatusFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /marital-status - list marital statuses.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {MaritalStatusListQuery} [opts.query] - Query params (providerIds)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +46,15 @@ function maritalStatusFactory(_ref) {
     });
   }
 
+  /**
+   * GET /marital-status/:id - get marital status by id. 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.id - Marital status id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -38,6 +71,16 @@ function maritalStatusFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /marital-status/:id - update marital status. 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.id - Marital status id
+   * @param {Object} opts.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -56,6 +99,15 @@ function maritalStatusFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /marital-status/:id - remove marital status. 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.id - Marital status id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -72,6 +124,15 @@ function maritalStatusFactory(_ref) {
     });
   }
 
+  /**
+   * POST /marital-status - create marital status. 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.data - Request body
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,

package/lib/endpoints/inventory/marketplace-modifiers.js

@@ -3,10 +3,41 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for GET /marketplace-modifiers (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} MarketplaceModifiersListQuery
+ * @property {string} [externalField1] - Filter by externalField1
+ * @property {string} [externalField2] - Filter by externalField2
+ * @property {string} [externalField3] - Filter by externalField3
+ * @property {string} [createdBy] - Comma-separated user IDs (created by)
+ * @property {string} [updatedBy] - Comma-separated user IDs (updated by)
+ * @property {string} [earliestPurchaseDate] - ISO 8601 datetime (purchase on or after)
+ * @property {string} [latestPurchaseDate] - ISO 8601 datetime (purchase on or before)
+ * @property {string} [earliestTravelDate] - ISO 8601 datetime (trip depart on or after)
+ * @property {string} [latestTravelDate] - ISO 8601 datetime (trip depart on or before)
+ */
+
+/**
+ * Factory for marketplace-modifiers API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+
+
 function marketplaceModifierFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /marketplace-modifiers - list marketplace modifiers.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {MarketplaceModifiersListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -19,6 +50,14 @@ function marketplaceModifierFactory(_ref) {
     });
   }
 
+  /**
+   * GET /marketplace-modifiers/:marketplaceModifierId - get marketplace modifier by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var marketplaceModifierId = _ref3.marketplaceModifierId,
         token = _ref3.token,
@@ -29,6 +68,15 @@ function marketplaceModifierFactory(_ref) {
     });
   }
 
+  /**
+   * POST /marketplace-modifiers - create marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -45,6 +93,15 @@ function marketplaceModifierFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /marketplace-modifiers/:marketplaceModifierId - remove marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         marketplaceModifierId = _ref5.marketplaceModifierId,
@@ -58,6 +115,16 @@ function marketplaceModifierFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /marketplace-modifiers/:marketplaceModifierId - update marketplace modifier. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.marketplaceModifierId - Marketplace modifier id
+   * @param {Object} opts.marketplaceModifier - Marketplace modifier payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,

package/lib/endpoints/inventory/mit-terminal-settings.js

@@ -3,10 +3,27 @@
 var _require = require("../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for mit-terminals-settings API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ */
+
+
 function mitTerminalFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /mit-terminals-settings - list MIT terminal 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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +37,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * GET /mit-terminals-settings/:id - get MIT terminal setting by id. 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.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var id = _ref3.id,
         token = _ref3.token,
@@ -31,6 +57,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * POST /mit-terminals-settings - create MIT terminal 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.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +82,15 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /mit-terminals-settings/:id - remove MIT terminal 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 {string} opts.id - MIT terminal setting id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         id = _ref5.id,
@@ -60,6 +104,16 @@ function mitTerminalFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /mit-terminals-settings/:id - update MIT terminal 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 {string} opts.id - MIT terminal setting id
+   * @param {Object} opts.mitTerminalSettings - MIT terminal settings payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var jwtToken = _ref6.jwtToken,
         token = _ref6.token,