btrz-api-client 9.7.0 → 9.9.0

package/lib/endpoints/notifications/manifest-notifications.js

@@ -5,7 +5,28 @@ const {
 /**
  * Query params for GET /manifest-notifications (btrz-api-notifications). See get-manifest-notifications-handler getSpec().
  * @typedef {Object} ManifestNotificationsListQuery
- * @property {string} [manifestId] - Manifest id (ObjectId format)
+ * @property {string} [manifestId] - Manifest id (ObjectId format). When present, response includes attemptSummary.
+ */
+
+/**
+ * Per-passenger attempt rollup returned when manifestId is provided on GET.
+ * @typedef {Object} ManifestNotificationAttemptSummary
+ * @property {Array<{id: string, subject?: string, hasReliableTracking: boolean, sentAt?: string|null}>} parents
+ * @property {number} trackedParentCount
+ * @property {Object<string, {attemptedCount: number, byParent: Object<string, string>}>} byTicket
+ * @property {{id: string, resendEligibleTicketIds: string[]}|null} latestParent
+ */
+
+/**
+ * GET /manifest-notifications response when manifestId query param is used.
+ * @typedef {Object} ManifestNotificationsListResponse
+ * @property {Array<Object>} manifestNotifications
+ * @property {ManifestNotificationAttemptSummary} [attemptSummary]
+ */
+
+/**
+ * Optional query params forwarded to POST /manifest-notifications as-is.
+ * @typedef {Object.<string, *>} ManifestNotificationsCreateQuery
  */
 
 /**
@@ -24,7 +45,7 @@ function manifestNotificationsFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ManifestNotificationsCreateQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -56,7 +77,7 @@ function manifestNotificationsFactory({
    * @param {string} [opts.token] - API key
    * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<ManifestNotificationsListResponse>>}
    */
   function all({
     token,

package/lib/endpoints/notifications/notify.js

@@ -292,6 +292,33 @@ function notifyTicketFactory({
             headers
           })
         });
+      },
+      /**
+       * POST /notify-manifest/{parentId}/resend - resend a parent manifest notification to
+       * Resend-eligible (unnotified) passengers. Server computes eligibility; no request body.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {string} opts.parentId - Parent manifest notification shared id
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
+      resend({
+        token,
+        jwtToken,
+        parentId,
+        headers
+      }) {
+        return client({
+          url: `/notify-manifest/${parentId}/resend`,
+          method: "post",
+          headers: authorizationHeaders({
+            token,
+            jwtToken,
+            internalAuthTokenProvider,
+            headers
+          })
+        });
       }
     }
   };

package/lib/endpoints/operations/manifest.js

@@ -1028,6 +1028,108 @@ function manifestFactory({
       });
     }
   };
+
+  /**
+  * POST manifests/:manifestId/boarding/:stationId - board passengers at station.
+  * @param {Object} opts
+  * @param {string} [opts.token] - API key
+  * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+  * @param {Object} [opts.headers] - Optional headers
+  * @param {string} opts.manifestId - Manifest id
+  * @param {string} opts.stationId - Station id
+  * @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
+    });
+  }
+
+  /**
+   * POST manifests/:manifestId/dispatch/:stationId - dispatch manifest at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @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
+    });
+  }
+
+  /**
+  * POST manifests/:manifestId/sales-closure/:stationId - close sales at station.
+  * @param {Object} opts
+  * @param {string} [opts.token] - API key
+  * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+  * @param {Object} [opts.headers] - Optional headers
+  * @param {string} opts.manifestId - Manifest id
+  * @param {string} opts.stationId - Station id
+  * @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
+    });
+  }
   return {
     get,
     getAll,
@@ -1052,7 +1154,10 @@ function manifestFactory({
     reports,
     labels,
     driverRelays,
-    tripClose
+    tripClose,
+    stationBoarding,
+    stationDispatch,
+    stationSalesClosure
   };
 }
 module.exports = manifestFactory;

package/package.json

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

package/src/endpoints/notifications/manifest-notifications.js

@@ -5,7 +5,28 @@ const {
 /**
  * Query params for GET /manifest-notifications (btrz-api-notifications). See get-manifest-notifications-handler getSpec().
  * @typedef {Object} ManifestNotificationsListQuery
- * @property {string} [manifestId] - Manifest id (ObjectId format)
+ * @property {string} [manifestId] - Manifest id (ObjectId format). When present, response includes attemptSummary.
+ */
+
+/**
+ * Per-passenger attempt rollup returned when manifestId is provided on GET.
+ * @typedef {Object} ManifestNotificationAttemptSummary
+ * @property {Array<{id: string, subject?: string, hasReliableTracking: boolean, sentAt?: string|null}>} parents
+ * @property {number} trackedParentCount
+ * @property {Object<string, {attemptedCount: number, byParent: Object<string, string>}>} byTicket
+ * @property {{id: string, resendEligibleTicketIds: string[]}|null} latestParent
+ */
+
+/**
+ * GET /manifest-notifications response when manifestId query param is used.
+ * @typedef {Object} ManifestNotificationsListResponse
+ * @property {Array<Object>} manifestNotifications
+ * @property {ManifestNotificationAttemptSummary} [attemptSummary]
+ */
+
+/**
+ * Optional query params forwarded to POST /manifest-notifications as-is.
+ * @typedef {Object.<string, *>} ManifestNotificationsCreateQuery
  */
 
 /**
@@ -24,7 +45,7 @@ function manifestNotificationsFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {ManifestNotificationsQuery} [opts.query] - Optional query params (forwarded to API)
+   * @param {ManifestNotificationsCreateQuery} [opts.query] - Optional query params (forwarded to API)
    * @param {Object} opts.data - Request body
    * @param {Object} [opts.headers] - Optional headers
    * @returns {Promise<import("axios").AxiosResponse>}
@@ -47,7 +68,7 @@ function manifestNotificationsFactory({
    * @param {string} [opts.token] - API key
    * @param {ManifestNotificationsListQuery} [opts.query] - Query params (manifestId optional)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<ManifestNotificationsListResponse>>}
    */
   function all({
     token,

package/src/endpoints/notifications/notify.js

@@ -212,6 +212,23 @@ function notifyTicketFactory({
           data,
           headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
         });
+      },
+      /**
+       * POST /notify-manifest/{parentId}/resend - resend a parent manifest notification to
+       * Resend-eligible (unnotified) passengers. Server computes eligibility; no request body.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {string} opts.parentId - Parent manifest notification shared id
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse>}
+       */
+      resend({token, jwtToken, parentId, headers}) {
+        return client({
+          url: `/notify-manifest/${parentId}/resend`,
+          method: "post",
+          headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+        });
       }
     }
   };

package/src/endpoints/operations/manifest.js

@@ -730,6 +730,69 @@ function manifestFactory({
     }
   };
 
+    /**
+   * POST manifests/:manifestId/boarding/:stationId - board passengers at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @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
+      });
+    }
+    
+  /**
+   * POST manifests/:manifestId/dispatch/:stationId - dispatch manifest at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @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
+      });
+    }
+
+            /**
+   * POST manifests/:manifestId/sales-closure/:stationId - close sales at station.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.headers] - Optional headers
+   * @param {string} opts.manifestId - Manifest id
+   * @param {string} opts.stationId - Station id
+   * @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
+      });
+    }
+
   return {
     get,
     getAll,
@@ -754,7 +817,10 @@ function manifestFactory({
     reports,
     labels,
     driverRelays,
-    tripClose
+    tripClose,
+    stationBoarding,
+    stationDispatch,
+    stationSalesClosure
   };
 }
 

package/test/endpoints/notifications/notify.test.js

@@ -118,6 +118,23 @@ describe("notifications/notify-manifest", () => {
       headers: {}
     });
   });
+
+  it("should post a resend for a parent manifest notification", () => {
+    const parentId = "5f2a1b3c4d5e6f7a8b9c0d1e";
+    axiosMock.onPost(`/notify-manifest/${parentId}/resend`).reply(({headers}) => {
+      if (headers["x-api-key"] === token && headers.authorization === `Bearer ${jwtToken}`) {
+        return [200, {manifestNotifications: []}];
+      }
+      return [403];
+    });
+
+    return api.notifications.notify.manifest.resend({
+      token,
+      jwtToken,
+      parentId,
+      headers: {}
+    });
+  });
 });
 
 describe("notifications/notify/email", () => {

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

@@ -406,3 +406,83 @@ describe("operations/manifests/:manifestKey/manifests-exceptions", () => {
     return api.operations.manifest.manifestsExceptions.update({token, jwtToken, manifestKey, manifestException});
   });
 });
+
+describe("operations/manifests/:manifestId/station operations", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should board passengers at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "test@betterez.com"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/boarding/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationBoarding({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
+  it("should dispatch manifest at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "Test@betterez.com",
+        shiftId: "649f20a95679910784326e81",
+        shiftNumber: "S-WTN6LDX"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/dispatch/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationDispatch({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+
+  it("should close sales at station", async () => {
+    const manifestId = "manifestId";
+    const stationId = "stationId";
+    const data = {
+      user: {
+        firstName: "Test",
+        lastName: "Testing",
+        email: "Test@betterez.com"
+      }
+    };
+    const query = {bypassValidations: false};
+
+    axiosMock.onPost(`/manifests/${manifestId}/sales-closure/${stationId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    const call = await api.operations.manifest.stationSalesClosure({
+      token, jwtToken, manifestId, stationId, data, query
+    });
+    assert.deepStrictEqual(JSON.parse(call.config.data), data);
+    assert.deepStrictEqual(call.config.params, query);
+    return call;
+  });
+});

package/types/endpoints/notifications/notify.d.ts

@@ -35,6 +35,7 @@ declare function notifyTicketFactory({ client, internalAuthTokenProvider }: {
     };
     manifest: {
         create: Function;
+        resend: Function;
     };
 };
 declare namespace notifyTicketFactory {