btrz-api-client 9.8.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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.8.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/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/types/endpoints/notifications/notify.d.ts

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