btrz-api-client 8.28.0 → 8.30.0

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

@@ -3,10 +3,33 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} ScheduleGroupsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for schedule-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 scheduleGroupsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /schedule-groups - list schedule groups.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ScheduleGroupsQuery} [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,16 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /schedule-groups/:scheduleGroupId - get schedule group by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.scheduleGroupId - Schedule group id
+   * @param {ScheduleGroupsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -34,6 +67,15 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /schedule-groups - create schedule group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.scheduleGroup - Schedule group payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -48,6 +90,16 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /schedule-groups/:scheduleGroupId - update schedule group.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.scheduleGroupId - Schedule group id
+   * @param {Object} opts.scheduleGroup - Schedule 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/schedules.js

@@ -1,12 +1,31 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Factory for schedules 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, delete: function, autoBouncing: object, exceptions: object }}
+ */
+
+
 function schedulesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /routes/schedules - list schedules.
+   * @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,
         _ref2$query = _ref2.query,
@@ -19,6 +38,17 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /routes/:routeId/schedules/:scheduleId - get schedule 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 {string} opts.scheduleId - Schedule id
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         routeId = _ref3.routeId,
@@ -33,6 +63,16 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /routes/:routeId/schedules - create schedule.
+   * @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 {Object} opts.data - Schedule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -50,6 +90,17 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /routes/:routeId/schedules/:scheduleId - update schedule.
+   * @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 {string} opts.scheduleId - Schedule id
+   * @param {Object} opts.data - Schedule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -68,6 +119,16 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule.
+   * @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 {string} opts.scheduleId - Schedule id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function deleteSchedule(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -84,7 +145,17 @@ function schedulesFactory(_ref) {
     });
   }
 
+  /** @type {{ create: function, delete: function }} */
   var autoBouncing = {
+    /**
+     * POST /routes/schedules/auto-bouncing - create auto bouncing.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {Object} opts.data - Auto bouncing payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref7) {
       var token = _ref7.token,
           jwtToken = _ref7.jwtToken,
@@ -100,6 +171,16 @@ function schedulesFactory(_ref) {
         data: data
       });
     },
+    /**
+     * DELETE /routes/:routeId/schedules/:parentScheduleId/auto-bouncing - delete auto bouncing.
+     * @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 {string} opts.parentScheduleId - Parent schedule id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref8) {
       var token = _ref8.token,
           jwtToken = _ref8.jwtToken,
@@ -117,7 +198,18 @@ function schedulesFactory(_ref) {
     }
   };
 
+  /** @type {{ create: function, delete: function, update: function }} */
   var exceptions = {
+    /**
+     * POST /schedules/:scheduleId/schedule-exceptions - create schedule exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {Object} opts.data - Exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create: function create(_ref9) {
       var token = _ref9.token,
           jwtToken = _ref9.jwtToken,
@@ -134,6 +226,16 @@ function schedulesFactory(_ref) {
         data: data
       });
     },
+    /**
+     * DELETE /schedules/:scheduleId/schedule-exceptions/:exceptionId - delete schedule exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} opts.exceptionId - Exception id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     delete: function _delete(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -149,6 +251,17 @@ function schedulesFactory(_ref) {
         })
       });
     },
+    /**
+     * PUT /schedules/:scheduleId/schedule-exceptions/:exceptionId - update schedule exception.
+     * @param {Object} opts
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+     * @param {string} opts.scheduleId - Schedule id
+     * @param {string} opts.exceptionId - Exception id
+     * @param {Object} opts.data - Exception payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update: function update(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,

package/lib/endpoints/inventory/seatclasses.js

@@ -4,10 +4,33 @@
 var _require = require("./../endpoints_helpers"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for seat-classes endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySeatclassesQuery
+ */
+
+/**
+ * Factory for seat-classes 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 seatClassesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /seat-classes - list seat classes.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,
@@ -23,6 +46,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /seat-classes/:id - get seat class by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -39,6 +72,17 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /seat-classes/:id - update seat class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {Object} opts.data - Request body
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -57,6 +101,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /seat-classes/:id - remove seat class.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Seat class id
+   * @param {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -73,6 +127,16 @@ function seatClassesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /seat-classes - create seat class.
+   * @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 {InventorySeatclassesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @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/seatfees.js

@@ -1,13 +1,34 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * Query params for seatfees endpoints (btrz-api-inventory). Forwarded to API as-is.
+ * @typedef {Object} InventorySeatfeesQuery
+ */
+
+/**
+ * Factory for seat-fees 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 seatfeesFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
-
+  /**
+   * GET /seat-fees - list seat fees.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {InventorySeatfeesQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all(_ref2) {
     var token = _ref2.token,
         _ref2$query = _ref2.query,
@@ -20,6 +41,14 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * GET /seat-fees/:seatfeeId - get seat fee by id.
+   * @param {Object} opts
+   * @param {string} opts.seatfeeId - Seat fee id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var seatfeeId = _ref3.seatfeeId,
         token = _ref3.token,
@@ -30,6 +59,15 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * POST /seat-fees - create seat fee.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref4) {
     var jwtToken = _ref4.jwtToken,
         token = _ref4.token,
@@ -46,6 +84,16 @@ function seatfeesFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /seat-fees/:seatfeeId - update seat fee.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {string} opts.seatfeeId - Seat fee id
+   * @param {Object} opts.seatfee - Seat fee payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref5) {
     var jwtToken = _ref5.jwtToken,
         token = _ref5.token,

package/lib/endpoints/inventory/seatmaps.js

@@ -1,12 +1,36 @@
 "use strict";
 
-var _require = require("./../endpoints_helpers"),
+/* eslint-disable max-len */
+var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} SeatmapsQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for seatmaps API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, getById: function, create: function, remove: function, update: function, getOccupiedSeats: function }}
+ */
+
+
 function seatmapsFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /seatmaps - list seatmaps.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {SeatmapsQuery} [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,
@@ -18,6 +42,19 @@ function seatmapsFactory(_ref) {
       headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
     });
   }
+  /**
+   * GET /seatmaps/:seatmapId/available-seats/:routeId/:scheduleId/:manifestDate - get available seats.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {string} opts.routeId - Route id
+   * @param {string} opts.scheduleId - Schedule id
+   * @param {string} opts.manifestDate - Manifest date
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref3) {
     var seatmapId = _ref3.seatmapId,
         routeId = _ref3.routeId,
@@ -34,6 +71,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /seatmaps/:seatmapId - get seatmap by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getById(_ref4) {
     var seatmapId = _ref4.seatmapId,
         token = _ref4.token,
@@ -48,6 +95,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * POST /seatmaps - create seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,
@@ -64,6 +120,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * PUT /seatmaps/:seatmapId - update seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} opts.seatmap - Seatmap payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -81,6 +147,15 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * DELETE /seatmaps/:seatmapId - remove seatmap.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -94,6 +169,16 @@ function seatmapsFactory(_ref) {
     });
   }
 
+  /**
+   * GET /seatmaps/:seatmapId/occupied-seats - get occupied seats.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.seatmapId - Seatmap id
+   * @param {SeatmapsQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function getOccupiedSeats(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,

package/lib/endpoints/inventory/segments-information-tables.js

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * @typedef {Object} SegmentsInformationTablesQuery
+ * @property {string} [providerId] - Provider account ID
+ */
+
+/**
+ * Factory for segments-information-tables API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+
+
 function segmentInformationTableFactory(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.internalAuthTokenProvider;
 
+  /**
+   * GET /segments-information-tables/:routeId - get segments information table by route 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 {SegmentsInformationTablesQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get(_ref2) {
     var token = _ref2.token,
         jwtToken = _ref2.jwtToken,