btrz-api-client 9.14.0 → 9.16.0

package/src/endpoints/operations/manifest.js

@@ -1,4 +1,4 @@
-/* eslint-disable max-len */
+
 const {
   authorizationHeaders
 } = require("./../endpoints_helpers.js");
@@ -75,6 +75,25 @@ const {
  * @property {boolean} [bypassValidations] - If true, bypass driver validations
  */
 
+/**
+ * Query params for GET /manifests/item-capacity-over-limit (btrz-api-operations).
+ * @typedef {Object} ItemCapacityOverLimitQuery
+ * @property {string} itemId - Catalog item id (sourceItemId)
+ * @property {number|string} limit - Proposed Manifest Item Capacity Limit (>= 1)
+ * @property {number|string} [page] - Page number (>= 1)
+ */
+
+/**
+ * Query params for GET /manifests/item-capacity-used (btrz-api-operations).
+ * @typedef {Object} ItemCapacityUsedQuery
+ * @property {string} routeId - Route id
+ * @property {string} scheduleId - Schedule id (manifest schedule key)
+ * @property {string} date - Travel date yyyy-mm-dd
+ * @property {string} fromId - Origin station id
+ * @property {string} toId - Destination station id
+ * @property {string} [itemIds] - Optional comma-separated catalog item ids
+ */
+
 /**
  * Factory for manifests API (btrz-api-operations).
  * @param {Object} deps
@@ -160,6 +179,42 @@ function manifestFactory({
     });
   }
 
+  /**
+   * GET /manifests/item-capacity-over-limit - future manifests over a proposed item capacity limit.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ItemCapacityOverLimitQuery} opts.query - itemId, limit, optional page
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function itemCapacityOverLimit({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/manifests/item-capacity-over-limit",
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /manifests/item-capacity-used - path max qty used per attach-to-ticket item.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {ItemCapacityUsedQuery} opts.query - routeId, scheduleId, date, fromId, toId, optional itemIds
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function itemCapacityUsed({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/manifests/item-capacity-used",
+      method: "get",
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   /**
    * GET /manifests/:manifestId - get manifest by id. API does not accept query params.
    * @param {Object} opts
@@ -730,7 +785,7 @@ function manifestFactory({
     }
   };
 
-    /**
+  /**
    * POST manifests/:manifestId/boarding/:stationId - board passengers at station.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
@@ -741,16 +796,16 @@ function manifestFactory({
    * @param {Object} opts.data - Request body
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-    function stationBoarding({token, jwtToken, headers, manifestId, stationId, data, query}) {
-      return client({
-        url: `/manifests/${manifestId}/boarding/${stationId}`,
-        method: "post",
-        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data,
-        params: query
-      });
-    }
-    
+  function stationBoarding({token, jwtToken, headers, manifestId, stationId, data, query}) {
+    return client({
+      url: `/manifests/${manifestId}/boarding/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data,
+      params: query
+    });
+  }
+
   /**
    * POST manifests/:manifestId/dispatch/:stationId - dispatch manifest at station.
    * @param {Object} opts
@@ -762,17 +817,17 @@ function manifestFactory({
    * @param {Object} opts.data - Request body
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-    function stationDispatch({token, jwtToken, headers, manifestId, stationId, data, query}) {
-      return client({
-        url: `/manifests/${manifestId}/dispatch/${stationId}`,
-        method: "post",
-        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data,
-        params: query
-      });
-    }
+  function stationDispatch({token, jwtToken, headers, manifestId, stationId, data, query}) {
+    return client({
+      url: `/manifests/${manifestId}/dispatch/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data,
+      params: query
+    });
+  }
 
-            /**
+  /**
    * POST manifests/:manifestId/sales-closure/:stationId - close sales at station.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
@@ -783,20 +838,22 @@ function manifestFactory({
    * @param {Object} opts.data - Request body
    * @returns {Promise<import("axios").AxiosResponse>}
    */
-    function stationSalesClosure({token, jwtToken, headers, manifestId, stationId, data, query}) {
-      return client({
-        url: `/manifests/${manifestId}/sales-closure/${stationId}`,
-        method: "post",
-        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
-        data,
-        params: query
-      });
-    }
+  function stationSalesClosure({token, jwtToken, headers, manifestId, stationId, data, query}) {
+    return client({
+      url: `/manifests/${manifestId}/sales-closure/${stationId}`,
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data,
+      params: query
+    });
+  }
 
   return {
     get,
     getAll,
     getById,
+    itemCapacityOverLimit,
+    itemCapacityUsed,
     outlook,
     patch,
     save,

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

@@ -40,6 +40,41 @@ describe("operations/manifest", () => {
     });
   });
 
+  it("should get item capacity over limit manifests", async () => {
+    const query = {
+      itemId: "507f1f77bcf86cd799439011",
+      limit: 5,
+      page: 1
+    };
+    axiosMock.onGet("/manifests/item-capacity-over-limit").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.itemCapacityOverLimit({
+      token, jwtToken, query
+    });
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
+  it("should get item capacity used on a path", async () => {
+    const query = {
+      routeId: "507f1f77bcf86cd799439011",
+      scheduleId: "5cab127c-2c70-4fea-9031-4131e2751cdb",
+      date: "2035-07-20",
+      fromId: "507f1f77bcf86cd799439012",
+      toId: "507f1f77bcf86cd799439013",
+      itemIds: "507f1f77bcf86cd799439014"
+    };
+    axiosMock.onGet("/manifests/item-capacity-used").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.itemCapacityUsed({
+      token, jwtToken, query
+    });
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
   it("should get many manifests", () => {
     const data = {
       query: [{

package/types/endpoints/inventory/segments-information-tables.d.ts

@@ -1,7 +1,7 @@
 export = segmentInformationTableFactory;
 /**
  * @typedef {Object} SegmentsInformationTablesQuery
- * @property {string} [providerId] - Provider account ID
+ * @property {string} [providerId] - Provider account ID when route belongs to a provider in the requester's network
  */
 /**
  * Factory for segments-information-tables API (btrz-api-inventory).
@@ -23,7 +23,7 @@ declare namespace segmentInformationTableFactory {
 }
 type SegmentsInformationTablesQuery = {
     /**
-     * - Provider account ID
+     * - Provider account ID when route belongs to a provider in the requester's network
      */
     providerId?: string;
 };