btrz-api-client 8.29.0 → 8.31.0

package/src/endpoints/inventory/promos.js

@@ -1,6 +1,47 @@
-const {authorizationHeaders} = require("./../endpoints_helpers");
+/* eslint-disable max-len */
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /promos (btrz-api-inventory). See get-promos getSpec().
+ * @typedef {Object} PromosListQuery
+ * @property {string} [providerIds] - Provider IDs to get promos for
+ * @property {string} [productId] - Product id
+ * @property {string} [productIds] - Comma-separated product IDs (mutually exclusive with productId)
+ * @property {string} [promoCode] - Promo internal id
+ * @property {string} [name] - Promo name
+ * @property {string} [campaign] - Campaign the promo belongs to
+ * @property {string} [origin] - Departure station name
+ * @property {string} [destination] - Destination station name
+ * @property {string} [fareIds] - Comma-separated fare IDs
+ * @property {string} [tripType] - 'oneway' or 'roundtrip'
+ * @property {string} [channels] - Filter by channels (mandatory if promoCode not given)
+ * @property {boolean} [autoApply] - Filter only auto-applied promos
+ * @property {string} [includeExpired] - Include expired promos (deprecated)
+ * @property {string} [searchOutboundTravelDate] - Outbound travel date for validity
+ * @property {string} [searchReturnTravelDate] - Return travel date for validity
+ * @property {string} [qty] - Number of tickets
+ * @property {number} [page] - Page for pagination
+ * @property {string} [orderBy] - Field to order by
+ * @property {string} [orderDir] - 'asc' (1) or 'desc' (-1)
+ */
+
+/**
+ * Factory for promos 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, patch: function, remove: function, addRule: function, updateRule: function }}
+ */
 function promosFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /promos - list promos.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {PromosListQuery} [opts.query] - Query params
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function all({token, query = {}, headers}) {
     return client.get("/promos", {
       params: query,
@@ -8,6 +49,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /promos/:promoId - get promo 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.promoId - Promo id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({promoId, token, query = {}, headers}) {
     return client.get(`/promos/${promoId}`, {
       params: query,
@@ -15,6 +65,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /promos - create promo. 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.promo - Promo payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function create({jwtToken, promo, token, headers}) {
     return client({
       url: "/promos",
@@ -24,6 +83,15 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /promos/:promoId - remove promo. 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.promoId - Promo id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function remove({jwtToken, promoId, token, headers}) {
     return client({
       url: `/promos/${promoId}`,
@@ -32,6 +100,17 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /promos/:promoId - update promo. 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.promoId - Promo id
+   * @param {Object} opts.update - Update payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  // eslint-disable-next-line no-shadow
   function update({jwtToken, token, promoId, update, headers}) {
     return client({
       url: `/promos/${promoId}`,
@@ -41,6 +120,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PATCH /promo/:promoId - patch promo with operations. 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.promoId - Promo id
+   * @param {Object} opts.operations - Patch operations
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function patch({jwtToken, token, promoId, operations, headers}) {
     return client({
       url: `/promo/${promoId}`,
@@ -50,6 +139,16 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /promos/:promoId/rules - add promo rule. 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.promoId - Promo id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function addRule({jwtToken, token, promoId, rule, headers}) {
     return client({
       url: `/promos/${promoId}/rules`,
@@ -59,6 +158,17 @@ function promosFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /promos/:promoId/rules/:ruleId - update promo rule. 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.promoId - Promo id
+   * @param {string} opts.ruleId - Rule id
+   * @param {Object} opts.rule - Rule payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function updateRule({jwtToken, token, promoId, ruleId, rule, headers}) {
     return client({
       url: `/promos/${promoId}/rules/${ruleId}`,

package/src/endpoints/inventory/routes.js

@@ -1,6 +1,44 @@
+/* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /routes (btrz-api-inventory). See get-routes getSpec().
+ * @typedef {Object} RoutesListQuery
+ * @property {string} [disabled] - Get enabled or disabled routes [true, false]
+ * @property {string} [productId] - Filter by product id (object id)
+ * @property {string} [routeGTFSID] - Filter by route external ID (GTFS)
+ * @property {string} [providerId] - Filter by provider
+ * @property {string} [name] - Filter by exact name (case sensitive)
+ * @property {string} [partialName] - Filter by partial name (case insensitive)
+ * @property {number} [page] - Page for pagination
+ * @property {boolean} [minimalPayload] - If true, schedules not included in response
+ */
+
+/**
+ * Query params for GET /routes/proration-tables (btrz-api-inventory). See get-proration-tables getSpec().
+ * @typedef {Object} RoutesProrationTablesListQuery
+ * @property {string} [routeId] - Route id
+ * @property {string} [providerId] - Provider id
+ * @property {string} [productId] - Product id (journey pricing)
+ */
+
+/**
+ * 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. 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.routeId - Route id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
   function get({routeId, token, query = {}, headers}) {
     return client({
       url: `/routes/${routeId}`,
@@ -9,6 +47,19 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /routes/prices - get route prices. Client merges productId, originId, destinationId, channel into query.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.productId - Product id (merged into query)
+   * @param {string} opts.originId - Origin id (merged into query)
+   * @param {string} opts.destinationId - Destination id (merged into query)
+   * @param {string} opts.channel - Channel (merged into query)
+   * @param {Object} [opts.query] - Additional 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 +70,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 {RoutesListQuery} [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 +86,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /routes/:routeId/stations - get route stations. 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.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 +102,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /routes - create route. 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 - 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 +122,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * PUT /routes/:routeId - update route. 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.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 +143,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * DELETE /routes/:routeId - remove route. 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.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 +162,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /** @type {{ all: function, create: function, update: function }} */
   const fareTables = {
+    /**
+     * GET /routes/fare-tables - list fare tables. 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>}
+     */
     all({
       token, query = {}, headers
     }) {
@@ -77,6 +183,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/fare-tables - create fare table. 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.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 +207,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table. 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.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 +233,18 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     }
   };
+  /** @type {{ create: function }} */
   const stops = {
+    /**
+     * POST /routes/:routeId/stops - create stop. 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.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 +257,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   const fareRules = {
+    /**
+     * GET /routes/:routeId/fare-rules - get fare rules. 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.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 +276,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/fare-rules - create fare rule. 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.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 +298,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule. 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.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 +321,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule. 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.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 +342,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   const priceBuckets = {
+    /**
+     * GET /routes/:routeId/price-buckets - get price buckets. 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.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 +361,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * POST /routes/:routeId/price-buckets - create price bucket. 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.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 +383,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket. 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.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 +406,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         }
       });
     },
+    /**
+     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket. 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.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 +427,17 @@ function routesFactory({client, internalAuthTokenProvider}) {
     }
   };
 
+  /** @type {{ get: function, update: function }} */
   const crossBorderDistances = {
+    /**
+     * GET /routes/:routeId/cross-border-distances - get cross border distances. 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.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 +446,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * PUT /routes/:routeId/cross-border-distances - update cross border distances. 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.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 +471,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 {RoutesProrationTablesListQuery} [opts.query] - Query params (routeId, providerId, productId)
+     * @param {Object} [opts.headers] - Optional headers
+     * @returns {Promise<import("axios").AxiosResponse>}
+     */
     all({token, jwtToken, query = {}, headers}) {
       return client({
         url: "/routes/proration-tables",
@@ -241,6 +491,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; filters by product)
+     * @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 +511,16 @@ function routesFactory({client, internalAuthTokenProvider}) {
         })
       });
     },
+    /**
+     * PUT /routes/:routeId/proration-tables - update proration table by route 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.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,28 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /schedule-groups (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ScheduleGroupsListQuery
+ * @property {number} [page] - Page number to retrieve
+ */
+
+/**
+ * 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 {ScheduleGroupsListQuery} [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 +30,15 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /schedule-groups/:scheduleGroupId - get schedule group 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.scheduleGroupId - Schedule group id
+   * @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. 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.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. 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.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}`,