btrz-api-client 8.29.0 → 8.31.0

package/lib/endpoints/inventory/routes.js

@@ -1,12 +1,52 @@
 "use strict";
 
+/* eslint-disable max-len */
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_ref) {
   var client = _ref.client,
       internalAuthTokenProvider = _ref.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(_ref2) {
     var routeId = _ref2.routeId,
         token = _ref2.token,
@@ -21,6 +61,19 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         productId = _ref3.productId,
@@ -39,6 +92,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         _ref4$query = _ref4.query,
@@ -51,6 +113,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         routeId = _ref5.routeId,
@@ -62,6 +133,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref6) {
     var token = _ref6.token,
         jwtToken = _ref6.jwtToken,
@@ -78,6 +158,16 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref7) {
     var token = _ref7.token,
         jwtToken = _ref7.jwtToken,
@@ -95,6 +185,15 @@ function routesFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref8) {
     var token = _ref8.token,
         jwtToken = _ref8.jwtToken,
@@ -110,7 +209,16 @@ function routesFactory(_ref) {
     });
   }
 
+  /** @type {{ all: function, create: function, update: function }} */
   var 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: function all(_ref9) {
       var token = _ref9.token,
           _ref9$query = _ref9.query,
@@ -125,6 +233,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * 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: function create(_ref10) {
       var token = _ref10.token,
           jwtToken = _ref10.jwtToken,
@@ -143,6 +262,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function update(_ref11) {
       var token = _ref11.token,
           jwtToken = _ref11.jwtToken,
@@ -163,7 +294,18 @@ function routesFactory(_ref) {
       });
     }
   };
+  /** @type {{ create: function }} */
   var 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: function create(_ref12) {
       var token = _ref12.token,
           jwtToken = _ref12.jwtToken,
@@ -182,7 +324,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   var 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: function get(_ref13) {
       var token = _ref13.token,
           jwtToken = _ref13.jwtToken,
@@ -196,6 +348,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * 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: function create(_ref14) {
       var token = _ref14.token,
           jwtToken = _ref14.jwtToken,
@@ -214,6 +377,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function update(_ref15) {
       var token = _ref15.token,
           jwtToken = _ref15.jwtToken,
@@ -233,6 +408,17 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function remove(_ref16) {
       var token = _ref16.token,
           jwtToken = _ref16.jwtToken,
@@ -250,7 +436,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, create: function, update: function, remove: function }} */
   var 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: function get(_ref17) {
       var token = _ref17.token,
           jwtToken = _ref17.jwtToken,
@@ -264,6 +460,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * 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: function create(_ref18) {
       var token = _ref18.token,
           jwtToken = _ref18.jwtToken,
@@ -282,6 +489,18 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function update(_ref19) {
       var token = _ref19.token,
           jwtToken = _ref19.jwtToken,
@@ -301,6 +520,17 @@ function routesFactory(_ref) {
         }
       });
     },
+
+    /**
+     * 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: function remove(_ref20) {
       var token = _ref20.token,
           jwtToken = _ref20.jwtToken,
@@ -318,7 +548,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ get: function, update: function }} */
   var 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: function get(_ref21) {
       var token = _ref21.token,
           jwtToken = _ref21.jwtToken,
@@ -333,6 +573,16 @@ function routesFactory(_ref) {
       });
     },
 
+    /**
+     * 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: function update(_ref22) {
       var token = _ref22.token,
@@ -354,7 +604,17 @@ function routesFactory(_ref) {
     }
   };
 
+  /** @type {{ all: function, getByRouteId: function, updateByRouteId: function }} */
   var 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: function all(_ref23) {
       var token = _ref23.token,
           jwtToken = _ref23.jwtToken,
@@ -370,6 +630,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * 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: function getByRouteId(_ref24) {
       var token = _ref24.token,
           jwtToken = _ref24.jwtToken,
@@ -386,6 +657,17 @@ function routesFactory(_ref) {
         })
       });
     },
+
+    /**
+     * 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: function updateByRouteId(_ref25) {
       var token = _ref25.token,
           jwtToken = _ref25.jwtToken,

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

@@ -3,10 +3,34 @@
 var _require = require("./../endpoints_helpers.js"),
     authorizationHeaders = _require.authorizationHeaders;
 
+/**
+ * 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(_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 {ScheduleGroupsListQuery} [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 +44,15 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref3) {
     var token = _ref3.token,
         jwtToken = _ref3.jwtToken,
@@ -34,6 +67,15 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref4) {
     var token = _ref4.token,
         jwtToken = _ref4.jwtToken,
@@ -48,6 +90,16 @@ function scheduleGroupsFactory(_ref) {
     });
   }
 
+  /**
+   * 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(_ref5) {
     var token = _ref5.token,
         jwtToken = _ref5.jwtToken,