btrz-api-client 8.30.0 → 8.32.0

package/src/endpoints/inventory/products.js

@@ -1,5 +1,30 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /products (btrz-api-inventory). See get-products getSpec().
+ * @typedef {Object} ProductsListQuery
+ * @property {string} [providerIds] - Provider IDs to get products for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any' (default 'true')
+ * @property {string} [pricingType] - One of point-to-point, distance, journey, etc.
+ * @property {string} [hasRoutes] - 'true' or 'false' (deprecated, use family)
+ * @property {string} [hasDates] - 'true' or 'false' (deprecated)
+ * @property {string} [hasPassengerInfo] - 'true' or 'false' (deprecated)
+ * @property {string} [isParcel] - 'true' or 'false' (deprecated)
+ * @property {string} [family] - One of bundle, parcel, paid in, paid out, reservation, flexpass, ticket
+ * @property {string} [domain] - Filter by domain
+ * @property {string} [parentProductId] - Child products of this parent
+ * @property {string} [dynamicFormId] - Filter by dynamic form
+ */
+
+/**
+ * Query params for GET /products/:productId (btrz-api-inventory). See get-products-id getSpec().
+ * @typedef {Object} ProductGetQuery
+ * @property {string} [providerIds] - Provider IDs to get product for
+ * @property {string} [channels] - Filter by channels
+ * @property {string} [enabled] - 'true', 'false' or 'any'
+ */
+
 /**
  * Factory for products API (btrz-api-inventory).
  * @param {Object} deps
@@ -13,7 +38,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
    * @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 {ProductsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,7 +56,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.productId - Product id
-   * @param {Object} [opts.query] - Query params
+   * @param {ProductGetQuery} [opts.query] - Query params (providerIds, channels, enabled)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +69,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /products - create product.
+   * POST /products - create product. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -62,7 +87,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /products/:productId - update product.
+   * PUT /products/:productId - update product. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -83,7 +108,7 @@ function productsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ remove: function }} */
   const domains = {
     /**
-     * DELETE /products/domains/:domain - remove product domain.
+     * DELETE /products/domains/:domain - remove product domain. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -103,11 +128,10 @@ function productsFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function }} */
   const families = {
     /**
-     * GET /products/families - list product families.
+     * GET /products/families - list product families. 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */

package/src/endpoints/inventory/promos.js

@@ -2,8 +2,27 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * Query params for promos endpoints (btrz-api-inventory). Forwarded to API as-is.
- * @typedef {Object} InventoryPromosQuery
+ * 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)
  */
 
 /**
@@ -19,7 +38,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {PromosListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -31,12 +50,11 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /promos/:promoId - get promo by id.
+   * 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 {InventoryPromosQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -48,7 +66,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /promos - create promo.
+   * 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
@@ -66,7 +84,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /promos/:promoId - remove promo.
+   * 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
@@ -83,7 +101,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /promos/:promoId - update promo.
+   * 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
@@ -103,7 +121,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PATCH /promo/:promoId - patch promo with operations.
+   * 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
@@ -122,7 +140,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /promos/:promoId/rules - add promo rule.
+   * 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
@@ -141,7 +159,7 @@ function promosFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /promos/:promoId/rules/:ruleId - update promo rule.
+   * 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

package/src/endpoints/inventory/routes.js

@@ -1,6 +1,27 @@
 /* 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
@@ -10,12 +31,11 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function routesFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /routes/:routeId - get route by id.
+   * 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.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -28,15 +48,15 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/prices - get route prices.
+   * 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
-   * @param {string} opts.originId - Origin id
-   * @param {string} opts.destinationId - Destination id
-   * @param {string} opts.channel - Channel
-   * @param {Object} [opts.query] - Query params
+   * @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>}
    */
@@ -55,7 +75,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
    * @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 {RoutesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -67,7 +87,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/:routeId/stations - get route stations.
+   * 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
@@ -83,7 +103,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /routes - create route.
+   * 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
@@ -103,7 +123,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /routes/:routeId - update route.
+   * 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
@@ -124,7 +144,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /routes/:routeId - remove route.
+   * 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
@@ -145,11 +165,10 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ all: function, create: function, update: function }} */
   const fareTables = {
     /**
-     * GET /routes/fare-tables - list fare tables.
+     * 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.query] - Query params
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -165,7 +184,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/fare-tables - create fare table.
+     * 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
@@ -189,7 +208,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/fare-tables/:fareTableId - update fare table.
+     * 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
@@ -217,7 +236,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function }} */
   const stops = {
     /**
-     * POST /routes/:routeId/stops - create stop.
+     * 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
@@ -241,7 +260,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function, remove: function }} */
   const fareRules = {
     /**
-     * GET /routes/:routeId/fare-rules - get fare rules.
+     * 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
@@ -258,7 +277,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/fare-rules - create fare rule.
+     * 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
@@ -280,7 +299,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/fare-rules/:fareRuleId - update fare rule.
+     * 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
@@ -303,7 +322,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/fare-rules/:fareRuleId - remove fare rule.
+     * 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
@@ -326,7 +345,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, create: function, update: function, remove: function }} */
   const priceBuckets = {
     /**
-     * GET /routes/:routeId/price-buckets - get price buckets.
+     * 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
@@ -343,7 +362,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * POST /routes/:routeId/price-buckets - create price bucket.
+     * 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
@@ -365,7 +384,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/price-buckets/:bucketId - update price bucket.
+     * 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
@@ -388,7 +407,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/price-buckets/:bucketId - remove price bucket.
+     * 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
@@ -411,7 +430,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ get: function, update: function }} */
   const crossBorderDistances = {
     /**
-     * GET /routes/:routeId/cross-border-distances - get cross border distances.
+     * 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
@@ -428,7 +447,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/cross-border-distances - update cross border distances.
+     * 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
@@ -459,7 +478,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
      * @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 {RoutesProrationTablesListQuery} [opts.query] - Query params (routeId, providerId, productId)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -478,7 +497,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
      * @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 {string} [opts.productId] - Product id (optional query; filters by product)
      * @param {Object} [opts.headers] - Optional headers
      * @returns {Promise<import("axios").AxiosResponse>}
      */
@@ -493,7 +512,7 @@ function routesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /routes/:routeId/proration-tables - update proration table by route id.
+     * 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

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

@@ -1,8 +1,9 @@
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
 /**
- * @typedef {Object} ScheduleGroupsQuery
- * @property {string} [providerId] - Provider account ID
+ * Query params for GET /schedule-groups (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} ScheduleGroupsListQuery
+ * @property {number} [page] - Page number to retrieve
  */
 
 /**
@@ -18,7 +19,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
    * @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 {ScheduleGroupsListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -30,12 +31,11 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /schedule-groups/:scheduleGroupId - get schedule group by id.
+   * 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 {ScheduleGroupsQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -47,7 +47,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /schedule-groups - create schedule group.
+   * 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
@@ -65,7 +65,7 @@ function scheduleGroupsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /schedule-groups/:scheduleGroupId - update schedule group.
+   * 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

package/src/endpoints/inventory/schedules.js

@@ -1,6 +1,20 @@
 /* eslint-disable max-len */
 const {authorizationHeaders} = require("./../endpoints_helpers.js");
 
+/**
+ * Query params for GET /routes/schedules (btrz-api-inventory). See get-schedules getSpec().
+ * @typedef {Object} SchedulesListQuery
+ * @property {string} [displayName] - Exact schedule name (case sensitive)
+ * @property {string} [stationId] - Schedules that contain this station on legs
+ * @property {string} [routeId] - Filter by route id
+ * @property {string} [labelId] - Filter by label id
+ * @property {string} [onlyActive] - Get active schedules (mutually exclusive with onlyInactive)
+ * @property {string} [onlyInactive] - Get inactive schedules (mutually exclusive with onlyActive)
+ * @property {string} [date] - Schedules active on this date (MM/DD/YYYY)
+ * @property {number} [page] - Page for pagination
+ * @property {string} [providerId] - Filter by provider
+ */
+
 /**
  * Factory for schedules API (btrz-api-inventory).
  * @param {Object} deps
@@ -14,7 +28,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
    * @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 {SchedulesListQuery} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -26,13 +40,12 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /routes/:routeId/schedules/:scheduleId - get schedule by id.
+   * GET /routes/:routeId/schedules/:scheduleId - get schedule 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 {string} opts.scheduleId - Schedule id
-   * @param {Object} [opts.query] - Query params
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
    */
@@ -44,7 +57,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /routes/:routeId/schedules - create schedule.
+   * POST /routes/:routeId/schedules - create schedule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -65,7 +78,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * PUT /routes/:routeId/schedules/:scheduleId - update schedule.
+   * PUT /routes/:routeId/schedules/:scheduleId - update schedule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -87,7 +100,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule.
+   * DELETE /routes/:routeId/schedules/:scheduleId - delete schedule. API does not accept query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -109,7 +122,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function, delete: function }} */
   const autoBouncing = {
     /**
-     * POST /routes/schedules/auto-bouncing - create auto bouncing.
+     * POST /routes/schedules/auto-bouncing - create auto bouncing. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -128,7 +141,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /routes/:routeId/schedules/:parentScheduleId/auto-bouncing - delete auto bouncing.
+     * DELETE /routes/:routeId/schedules/:parentScheduleId/auto-bouncing - delete auto bouncing. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -151,7 +164,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
   /** @type {{ create: function, delete: function, update: function }} */
   const exceptions = {
     /**
-     * POST /schedules/:scheduleId/schedule-exceptions - create schedule exception.
+     * POST /schedules/:scheduleId/schedule-exceptions - create schedule exception. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -171,7 +184,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * DELETE /schedules/:scheduleId/schedule-exceptions/:exceptionId - delete schedule exception.
+     * DELETE /schedules/:scheduleId/schedule-exceptions/:exceptionId - delete schedule exception. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol
@@ -190,7 +203,7 @@ function schedulesFactory({client, internalAuthTokenProvider}) {
       });
     },
     /**
-     * PUT /schedules/:scheduleId/schedule-exceptions/:exceptionId - update schedule exception.
+     * PUT /schedules/:scheduleId/schedule-exceptions/:exceptionId - update schedule exception. API does not accept query params.
      * @param {Object} opts
      * @param {string} [opts.token] - API key
      * @param {string} [opts.jwtToken] - JWT or internal auth symbol