btrz-api-client 9.27.0 → 9.28.0

package/lib/endpoints/operations/manifest.js

@@ -127,6 +127,7 @@ const {
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
  * @returns {Object} manifest API methods
  */
+// eslint-disable-next-line max-statements
 function manifestFactory({
   client,
   internalAuthTokenProvider
@@ -595,6 +596,66 @@ function manifestFactory({
     });
   }
 
+  /**
+   * GET /manifests/:manifestKey/fare-capacity-limits - get the manifest's per-fare capacity limit overrides.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestKey - Manifest id or {scheduleId}+{date}
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getFareCapacityLimits({
+    token,
+    jwtToken,
+    manifestKey,
+    headers
+  }) {
+    return client({
+      url: `/manifests/${manifestKey}/fare-capacity-limits`,
+      method: "get",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /manifests/:manifestKey/fare-capacity-limits - replace the per-fare capacity limit overrides.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestKey - Manifest id or {scheduleId}+{date}
+   * @param {Object} [opts.query] - Optional query, e.g. {routeId}
+   * @param {Object} opts.data - Request body, {passengerLimitOverrides: [...]}
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function updateFareCapacityLimits({
+    token,
+    jwtToken,
+    manifestKey,
+    query = {},
+    data,
+    headers
+  }) {
+    return client({
+      url: `/manifests/${manifestKey}/fare-capacity-limits`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      params: query,
+      data
+    });
+  }
+
   /**
    * DELETE /manifests/:manifestId/capacity-exceptions/:exceptionId - remove capacity exception.
    * @param {Object} opts
@@ -1241,6 +1302,8 @@ function manifestFactory({
     updateStatus,
     addCapacityException,
     removeCapacityException,
+    getFareCapacityLimits,
+    updateFareCapacityLimits,
     dispatch,
     updateDispatchReporting,
     createDispatchReporting,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.27.0",
+  "version": "9.28.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {

package/src/endpoints/operations/manifest.js

@@ -123,6 +123,7 @@ const {
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
  * @returns {Object} manifest API methods
  */
+// eslint-disable-next-line max-statements
 function manifestFactory({
   client, internalAuthTokenProvider
 }) {
@@ -447,6 +448,52 @@ function manifestFactory({
   }
 
 
+  /**
+   * GET /manifests/:manifestKey/fare-capacity-limits - get the manifest's per-fare capacity limit overrides.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestKey - Manifest id or {scheduleId}+{date}
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function getFareCapacityLimits({
+    token, jwtToken, manifestKey, headers
+  }) {
+    return client({
+      url: `/manifests/${manifestKey}/fare-capacity-limits`,
+      method: "get",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      })
+    });
+  }
+
+  /**
+   * PUT /manifests/:manifestKey/fare-capacity-limits - replace the per-fare capacity limit overrides.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.manifestKey - Manifest id or {scheduleId}+{date}
+   * @param {Object} [opts.query] - Optional query, e.g. {routeId}
+   * @param {Object} opts.data - Request body, {passengerLimitOverrides: [...]}
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function updateFareCapacityLimits({
+    token, jwtToken, manifestKey, query = {}, data, headers
+  }) {
+    return client({
+      url: `/manifests/${manifestKey}/fare-capacity-limits`,
+      method: "put",
+      headers: authorizationHeaders({
+        token, jwtToken, internalAuthTokenProvider, headers
+      }),
+      params: query,
+      data
+    });
+  }
+
   /**
    * DELETE /manifests/:manifestId/capacity-exceptions/:exceptionId - remove capacity exception.
    * @param {Object} opts
@@ -885,6 +932,8 @@ function manifestFactory({
     updateStatus,
     addCapacityException,
     removeCapacityException,
+    getFareCapacityLimits,
+    updateFareCapacityLimits,
     dispatch,
     updateDispatchReporting,
     createDispatchReporting,

package/test/endpoints/operations/manifest.test.js

@@ -222,6 +222,40 @@ describe("operations/manifest", () => {
     });
   });
 
+  it("should read the fare capacity limits from the manifest", async () => {
+    const manifestKey = "theId";
+
+    axiosMock.onGet(`/manifests/${manifestKey}/fare-capacity-limits`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.operations.manifest.getFareCapacityLimits({token, jwtToken, manifestKey});
+  });
+
+  it("should replace the fare capacity limits on the manifest", async () => {
+    const manifestKey = "theId";
+    const data = {
+      passengerLimitOverrides: [
+        {fareId: "610aebf7476dc22c1f2d0fee", maxPassengers: 5},
+        {fareId: "60b94ceb1516d01a41ccbbc4", unlimited: true}
+      ]
+    };
+
+    axiosMock.onPut(`/manifests/${manifestKey}/fare-capacity-limits`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    const call = await api.operations.manifest.updateFareCapacityLimits({token, jwtToken, manifestKey, data});
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    return call;
+  });
+
+  it("should replace the fare capacity limits addressed by a composite key, passing routeId", async () => {
+    // routeId is required only when the composite key names a manifest that does not exist yet.
+    const manifestKey = "5cab127c-2c70-4fea-9031-4131e2751cdb+2024-07-25";
+    const data = {passengerLimitOverrides: []};
+    const query = {routeId: "61a8d5e4adb79606bba26a3f"};
+
+    axiosMock.onPut(`/manifests/${manifestKey}/fare-capacity-limits`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    const call = await api.operations.manifest.updateFareCapacityLimits({token, jwtToken, manifestKey, data, query});
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
   it("should add user to the manifest", async () => {
     const manifestId = "theId";
     const data = {