btrz-api-client 8.29.0 → 8.30.0

package/src/endpoints/inventory/routes.js

@@ -1,6 +1,24 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Factory for routes API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function, prices: function, all: function, stations: function, create: function, update: function, remove: function, fareTables: object, stops: object, fareRules: object, priceBuckets: object, crossBorderDistances: object, prorationTables: object }}
+ */
 function routesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /routes/:routeId - get 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 {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({routeId, token, query = {}, headers}) {
     return client({
       url: `/routes/${routeId}`,
@@ -9,6 +27,19 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /routes/prices - get route prices.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id
+   * @param {string} opts.originId - Origin id
+   * @param {string} opts.destinationId - Destination id
+   * @param {string} opts.channel - Channel
+   * @param {Object} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function prices({token, productId, originId, destinationId, channel, query, headers}) {
     const params = Object.assign({}, query, {productId, originId, destinationId, channel});
 
@@ -19,6 +50,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /routes - list routes.
+   * @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({token, query = {}, headers}) {
     return client.get("/routes", {
       params: query,
@@ -26,6 +66,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /routes/:routeId/stations - get route stations.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function stations({token, routeId, headers}) {
     return client({
       url: `/routes/${routeId}/stations`,
@@ -33,6 +82,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /routes - create route.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({token, jwtToken, data, headers}) {
     return client({
       url: "/routes",
@@ -44,6 +102,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /routes/:routeId - update route.
+   * @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 - Route payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function update({token, jwtToken, data, routeId, headers}) {
     return client({
       url: `/routes/${routeId}`,
@@ -55,6 +123,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /routes/:routeId - remove route.
+   * @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.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({token, jwtToken, routeId, headers}) {
     return client({
       url: `/routes/${routeId}`,
@@ -65,7 +142,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ all: function, create: function, update: function }} */
   const fareTables = {
+    /**
+     * GET /routes/fare-tables - list fare tables.
+     * @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>}
+     */
     all({
       token, query = {}, headers
     }) {
@@ -77,6 +164,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/fare-tables - create fare table.
+     * @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.fareTable - Fare table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({
       token, jwtToken, routeId, fareTable, headers
     }) {
@@ -91,6 +188,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table.
+     * @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.fareTableId - Fare table id
+     * @param {Object} opts.fareTable - Fare table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({
       token, jwtToken, routeId, fareTableId, fareTable, headers
     }) {
@@ -106,7 +214,18 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     }
   };
+  /** @type {{ create: function }} */
   const stops = {
+    /**
+     * POST /routes/:routeId/stops - create stop.
+     * @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.stop - Stop payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, routeId, stop, headers}) {
       return client({
         url: `/routes/${routeId}/stops`,
@@ -119,7 +238,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   const fareRules = {
+    /**
+     * GET /routes/:routeId/fare-rules - get fare rules.
+     * @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.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, routeId, headers}) {
       return client({
         url: `/routes/${routeId}/fare-rules`,
@@ -128,6 +257,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/fare-rules - create fare rule.
+     * @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.fareRule - Fare rule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, routeId, fareRule, headers}) {
       return client({
         url: `/routes/${routeId}/fare-rules`,
@@ -140,6 +279,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule.
+     * @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.fareRuleId - Fare rule id
+     * @param {Object} opts.fareRule - Fare rule payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({token, jwtToken, routeId, fareRuleId, fareRule, headers}) {
       return client({
         url: `/routes/${routeId}/fare-rules/${fareRuleId}`,
@@ -152,6 +302,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule.
+     * @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.fareRuleId - Fare rule id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove({token, jwtToken, routeId, fareRuleId, headers}) {
       return client({
         url: `/routes/${routeId}/fare-rules/${fareRuleId}`,
@@ -163,7 +323,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   const priceBuckets = {
+    /**
+     * GET /routes/:routeId/price-buckets - get price buckets.
+     * @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.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, routeId, headers}) {
       return client({
         url: `/routes/${routeId}/price-buckets`,
@@ -172,6 +342,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/price-buckets - create price bucket.
+     * @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.bucket - Bucket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     create({token, jwtToken, routeId, bucket, headers}) {
       return client({
         url: `/routes/${routeId}/price-buckets`,
@@ -184,6 +364,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket.
+     * @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.bucketId - Bucket id
+     * @param {Object} opts.bucket - Bucket payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     update({token, jwtToken, routeId, bucketId, bucket, headers}) {
       return client({
         url: `/routes/${routeId}/price-buckets/${bucketId}`,
@@ -196,6 +387,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket.
+     * @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.bucketId - Bucket id
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     remove({token, jwtToken, routeId, bucketId, headers}) {
       return client({
         url: `/routes/${routeId}/price-buckets/${bucketId}`,
@@ -207,7 +408,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, update: function }} */
   const crossBorderDistances = {
+    /**
+     * GET /routes/:routeId/cross-border-distances - get cross border distances.
+     * @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.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     get({token, jwtToken, routeId, headers}) {
       return client({
         url: `/routes/${routeId}/cross-border-distances`,
@@ -216,6 +427,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * PUT /routes/:routeId/cross-border-distances - update cross border distances.
+     * @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.crossBorderDistances - Cross border distances payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     // eslint-disable-next-line no-shadow
     update({token, jwtToken, routeId, crossBorderDistances, headers}) {
       return client({
@@ -231,7 +452,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ all: function, getByRouteId: function, updateByRouteId: function }} */
   const prorationTables = {
+    /**
+     * GET /routes/proration-tables - list proration tables.
+     * @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>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/routes/proration-tables",
@@ -241,6 +472,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * GET /routes/:routeId/proration-tables - get proration tables 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 {string} [opts.productId] - Product id (optional query)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     getByRouteId({token, jwtToken, routeId, productId, headers}) {
       const query = productId ? {productId} : {};
       return client({
@@ -251,6 +492,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * PUT /routes/:routeId/proration-tables - update proration 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 {Object} opts.prorationTable - Proration table payload
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     updateByRouteId({token, jwtToken, routeId, prorationTable: prorationTableData, headers}) {
       return client({
         url: `/routes/${routeId}/proration-tables`,

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

@@ -1,6 +1,27 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * @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({client, 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({token, jwtToken, query = {}, headers}) {
     return client.get("/schedule-groups", {
       params: query,
@@ -8,6 +29,16 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, scheduleGroupId, query = {}, headers}) {
     return client.get(`/schedule-groups/${scheduleGroupId}`, {
       params: query,
@@ -15,6 +46,15 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, scheduleGroup, headers}) {
     return client({
       url: "/schedule-groups",
@@ -24,6 +64,16 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, scheduleGroupId, scheduleGroup, headers}) {
     return client({
       url: `/schedule-groups/${scheduleGroupId}`,

package/src/endpoints/inventory/schedules.js

@@ -1,6 +1,23 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * 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({client, 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({token, query = {}, headers}) {
     return client.get("/routes/schedules", {
       params: query,
@@ -8,6 +25,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, routeId, scheduleId, headers, query = {}}) {
     return client.get(`/routes/${routeId}/schedules/${scheduleId}`, {
       params: query,
@@ -15,6 +43,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, routeId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules`,
@@ -26,6 +64,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, data, routeId, scheduleId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules/${scheduleId}`,
@@ -37,6 +86,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * 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({token, jwtToken, routeId, scheduleId, headers}) {
     return client({
       url: `/routes/${routeId}/schedules/${scheduleId}`,
@@ -47,7 +106,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ create: function, delete: function }} */
   const 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: ({token, jwtToken, data, headers}) => {
       return client({
         url: "/routes/schedules/auto-bouncing",
@@ -58,6 +127,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         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: ({token, jwtToken, routeId, parentScheduleId, headers}) => {
       return client({
         url: `/routes/${routeId}/schedules/${parentScheduleId}/auto-bouncing`,
@@ -69,7 +148,18 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ create: function, delete: function, update: function }} */
   const 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: ({token, jwtToken, data, scheduleId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions`,
@@ -80,6 +170,16 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         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: ({token, jwtToken, scheduleId, exceptionId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,
@@ -89,6 +189,17 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * 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: ({token, jwtToken, data, scheduleId, exceptionId, headers}) => {
       return client({
         url: `/schedules/${scheduleId}/schedule-exceptions/${exceptionId}`,