btrz-api-client 8.29.0 → 8.30.0

package/lib/endpoints/gps/scanner-app-location.js

@@ -3,12 +3,35 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
-//TODO: add docs function when docs published
+/**
+ * Query params for GET /scanner-app-location (used by websales; GPS API).
+ * @typedef {Object} ScannerAppLocationQuery
+ * @property {string} [scheduleId] - Schedule id
+ * @property {string} [routeId] - Route id
+ * @property {string} [date] - Date (e.g. YYYY-MM-DD); defaults to today when omitted in websales
+ * @property {boolean} [includeTravelledPath] - Whether to include travelled path
+ */
+
+/**
+ * Factory for scanner app location API (GPS).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
 
 
 function scannerAppLocationFactory(_ref) {
   var client = _ref.client;
 
+  /**
+   * GET /scanner-app-location - get scanner app location.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {ScannerAppLocationQuery} [opts.query] - Query params (scheduleId, routeId, date, includeTravelledPath)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} response.data may contain location
+   */
   function get(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,

package/lib/endpoints/inventory/amenities.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} AmenitiesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for amenities 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 }}
+ */
+
+
 function amenitiesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /amenities - list amenities.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AmenitiesQuery} [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,
@@ -20,6 +42,16 @@ function amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /amenities/:amenityId - get amenity by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityId - Amenity id
+   * @param {AmenitiesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         amenityId = _ref3.amenityId,
@@ -33,6 +65,15 @@ function amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /amenities - create amenity.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.amenity - Amenity payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +88,16 @@ function amenitiesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /amenities/:amenityId - update amenity.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityId - Amenity id
+   * @param {Object} opts.amenity - Amenity payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/inventory/amenity-groups.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} AmenityGroupsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for amenity-groups 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 }}
+ */
+
+
 function amenityGroupsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /amenity-groups - list amenity groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {AmenityGroupsQuery} [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,
@@ -20,6 +42,16 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /amenity-groups/:amenityGroupId - get amenity group by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityGroupId - Amenity group id
+   * @param {AmenityGroupsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         amenityGroupId = _ref3.amenityGroupId,
@@ -33,6 +65,15 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /amenity-groups - create amenity group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -47,6 +88,16 @@ function amenityGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /amenity-groups/:amenityGroupId - update amenity group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.amenityGroupId - Amenity group id
+   * @param {Object} opts.amenityGroup - Amenity group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,

package/lib/endpoints/inventory/banks.js

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BanksQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for banks 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 banksFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /banks - list banks.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BanksQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +43,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * GET /banks/:bankId - get bank by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bankId - Bank id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var bankId = _ref3.bankId,
         token = _ref3.token,
@@ -31,6 +63,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * POST /banks - create bank.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.bank - Bank payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -47,6 +88,15 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /banks/:bankId - remove bank.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bankId - Bank id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var jwtToken = _ref5.jwtToken,
         bankId = _ref5.bankId,
@@ -60,6 +110,16 @@ function banksFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /banks/:bankId - update bank.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bankId - Bank id
+   * @param {Object} opts.bank - Bank 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/bare-routes.js

@@ -1,12 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BareRoutesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for bare-routes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+
+
 function bareRoutesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /bare-routes - list bare routes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BareRoutesQuery} [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,
@@ -20,6 +43,16 @@ function bareRoutesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /bare-routes/:routeId - get bare route by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.routeId - Route id
+   * @param {BareRoutesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var routeId = _ref3.routeId,
         token = _ref3.token,

package/lib/endpoints/inventory/brands.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BrandsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for brands API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, create: function, update: function, get: function }}
+ */
+
+
 function brandsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /brands - list brands.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BrandsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +44,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /brands - create brand.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.brand - Brand payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -36,6 +67,16 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /brands/:brandId - update brand.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.brandId - Brand id
+   * @param {Object} opts.brand - Brand payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -51,6 +92,15 @@ function brandsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /brands/:brandId - get brand by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.brandId - Brand id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref5) {
     var token = _ref5.token,
         brandId = _ref5.brandId,

package/lib/endpoints/inventory/bundle-fares.js

@@ -1,13 +1,37 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} BundleFaresQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for bundle-fares API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function }}
+ */
+
+
 function bundleFaresFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /bundle/:bundleId/product/:productId - list bundle fares.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bundleId - Bundle id
+   * @param {string} opts.productId - Product id
+   * @param {BundleFaresQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         bundleId = _ref2.bundleId,

package/lib/endpoints/inventory/bundles.js

@@ -1,13 +1,35 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} InventoryBundlesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for bundles API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function }}
+ */
+
+
 function bundlesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /bundles - list bundles.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventoryBundlesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -22,6 +44,15 @@ function bundlesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /bundles/:bundleId - get bundle by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.bundleId - Bundle id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,

package/lib/endpoints/inventory/change-requests.js

@@ -3,10 +3,28 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for change-requests 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, schedules: object }}
+ */
+
+
 function changeRequestsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /change-requests - list change requests.
+   * @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>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -20,6 +38,16 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /change-requests/:changerequestId/manifests - get change request manifests.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.changerequestId - Change request id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var changerequestId = _ref3.changerequestId,
         token = _ref3.token,
@@ -35,6 +63,15 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /change-requests/manifests - create change request manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var data = _ref4.data,
         token = _ref4.token,
@@ -49,6 +86,16 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /change-requests/:changerequestId/manifests - update change request manifest.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.changerequestId - Change request id
+   * @param {Object} opts.data - Manifest payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var changerequestId = _ref5.changerequestId,
         data = _ref5.data,
@@ -64,7 +111,18 @@ function changeRequestsFactory(_ref) {
     });
   }
 
+  /** @type {{ get: function, create: function, update: function }} */
   var schedules = {
+    /**
+     * GET /change-requests/:changeRequestId/schedules - get change request schedules.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.changeRequestId - Change request id
+     * @param {Object} [opts.query] - Query params
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get: function get(_ref6) {
       var changeRequestId = _ref6.changeRequestId,
           token = _ref6.token,
@@ -79,6 +137,17 @@ function changeRequestsFactory(_ref) {
         headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, jwtToken: jwtToken, headers: headers })
       });
     },
+
+
+    /**
+     * POST /change-requests/schedules - create change request schedule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref7) {
       var data = _ref7.data,
           token = _ref7.token,
@@ -92,6 +161,18 @@ function changeRequestsFactory(_ref) {
         data: data
       });
     },
+
+
+    /**
+     * PUT /change-requests/:changeRequestId/schedules - update change request schedule.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.changeRequestId - Change request id
+     * @param {Object} opts.data - Schedule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref8) {
       var changeRequestId = _ref8.changeRequestId,
           data = _ref8.data,