btrz-api-client 9.17.0 → 9.18.0

package/lib/endpoints/inventory/vehicles.js

@@ -22,6 +22,53 @@ const {
  * @property {string} [providerIds] - Provider IDs to scope the request (internal use)
  */
 
+/**
+ * Assigned seatmap snapshot on vehicle GET responses (btrz-api-inventory VehicleSeatmap).
+ * Present when a seatmap is assigned; omitted when the vehicle has none.
+ * Written only by POST/DELETE /vehicles/{vehicleId}/seatmaps, not by POST or PUT /vehicles.
+ * @typedef {Object} VehicleSeatmap
+ * @property {string} _id - Assigned seatmap id (24-char hex)
+ * @property {string} name - Assigned seatmap name
+ */
+
+/**
+ * Vehicle returned by GET /vehicles and GET /vehicles/{vehicleId} (btrz-api-inventory Vehicle).
+ * @typedef {Object} Vehicle
+ * @property {string} _id - Vehicle id
+ * @property {string} accountId - Account the vehicle belongs to
+ * @property {string} name - Vehicle name
+ * @property {number} capacity - Vehicle capacity
+ * @property {string} [licensePlate] - License plate
+ * @property {string} [certification] - Certification
+ * @property {string} [brand] - Brand name
+ * @property {boolean} [disabled] - Whether the vehicle is unavailable
+ * @property {string} [garageId] - Garage id
+ * @property {string} [externalId] - External id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [brandId] - Brand id
+ * @property {number} [number] - Numeric identifier when the name is numeric
+ * @property {VehicleSeatmap} [seatmap] - Assigned seatmap snapshot; omitted when not assigned
+ * @property {string} [createdBy] - User id that created the vehicle
+ * @property {string} [updatedBy] - User id that last updated the vehicle
+ * @property {Object} [createdAt] - Creation date (BzDate)
+ * @property {Object} [updatedAt] - Last update date (BzDate)
+ */
+
+/**
+ * GET /vehicles response (btrz-api-inventory GetVehiclesResponse).
+ * @typedef {Object} GetVehiclesResponse
+ * @property {Vehicle[]} vehicles
+ * @property {string} [next] - Next page link; empty if none
+ * @property {string} [previous] - Previous page link; empty if none
+ * @property {number} count - Total matching vehicles
+ */
+
+/**
+ * GET /vehicles/{vehicleId} response (btrz-api-inventory VehicleResponse).
+ * @typedef {Object} VehicleResponse
+ * @property {Vehicle} vehicle
+ */
+
 /**
  * Factory for vehicles API (btrz-api-inventory).
  * @param {Object} deps
@@ -40,7 +87,7 @@ function vehiclesFactory({
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {VehiclesQuery} [opts.query] - Query params (disabled, page, name, garageId, brandId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<GetVehiclesResponse>>}
    */
   function all({
     token,
@@ -66,7 +113,7 @@ function vehiclesFactory({
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.vehicleId - Vehicle id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function get({
     vehicleId,
@@ -89,9 +136,9 @@ function vehiclesFactory({
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} opts.vehicle - Vehicle payload (VehiclePostData). Does not accept seatmap; assign with vehicles.seatmaps.create.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function create({
     jwtToken,
@@ -147,9 +194,9 @@ function vehiclesFactory({
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.vehicleId - Vehicle id
-   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} opts.vehicle - Vehicle payload (VehiclePostData). Does not accept or change seatmap.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function update({
     jwtToken,

package/lib/endpoints/notifications/notify.js

@@ -27,6 +27,19 @@ const {
  * @property {string} [humanDate] - "mm" | "dd"
  */
 
+/**
+ * Request body for POST /notify/whatsapp (btrz-api-notifications). See post-notify-whatsapp getSpec() and NotifyWhatsappPostData.
+ * @typedef {Object} NotifyWhatsappPostData
+ * @property {string} type - Document/template type (e.g. product, voucher, order)
+ * @property {string} itemId - ObjectId of the item (24-char hex)
+ * @property {string} [templateType] - Accounts template type when it differs from `type` (same enum as GET /sms-templates/types). Twilio only: the Salesforce branch uses the Meta approved template referenced by the account `waDefinitionKey`
+ * @property {string} [to] - Recipient phone (E.164). Optional; derived from item when omitted. The Salesforce branch only supports Mexican numbers with the 52 country code (12 digits starting with 52)
+ * @property {string} [lang] - ISO language code. Twilio only: used for template selection
+ * @property {string} [channel] - Channel filter for template selection. Twilio only
+ * @property {string} [family] - Required when type is 'product'. One of: ticket, reservation, paid in, paid out, parcel, flexpass, bundle
+ * @property {string} [humanDate] - "mm" | "dd". Twilio only
+ */
+
 /**
  * Query params for POST /notify-tickets/:ticketId (btrz-api-notifications). See post-notify-tickets-by-id-handler getSpec().
  * @typedef {Object} NotifyTicketsPostQuery
@@ -52,7 +65,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function }, emailByType: { create: function }, smsByType: { create: function } }}
+ * @returns {{ childUsers: { create: function }, newSeller: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function, resend: function }, emailByType: { create: function }, smsByType: { create: function }, whatsapp: { create: function } }}
  */
 function notifyTicketFactory({
   client,
@@ -320,6 +333,37 @@ function notifyTicketFactory({
           })
         });
       }
+    },
+    whatsapp: {
+      /**
+       * POST /notify/whatsapp - sends WhatsApp notification specifying document type and id
+       * Uses the account's WhatsApp provider: for Twilio it uses the most relevant published SMS template;
+       * for Salesforce it uses a Meta approved WhatsApp template configured via `waDefinitionKey` in the account.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {NotifyWhatsappPostData} opts.data - Request body (type, itemId; optional templateType, to, lang, channel, family, humanDate)
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse<{ success: boolean }>>}
+       */
+      create({
+        token,
+        jwtToken,
+        data,
+        headers
+      }) {
+        return client({
+          url: "/notify/whatsapp",
+          method: "post",
+          data: data || {},
+          headers: authorizationHeaders({
+            token,
+            jwtToken,
+            internalAuthTokenProvider,
+            headers
+          })
+        });
+      }
     }
   };
 }

package/package.json

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

package/src/endpoints/inventory/vehicles.js

@@ -22,6 +22,53 @@ const {
  * @property {string} [providerIds] - Provider IDs to scope the request (internal use)
  */
 
+/**
+ * Assigned seatmap snapshot on vehicle GET responses (btrz-api-inventory VehicleSeatmap).
+ * Present when a seatmap is assigned; omitted when the vehicle has none.
+ * Written only by POST/DELETE /vehicles/{vehicleId}/seatmaps, not by POST or PUT /vehicles.
+ * @typedef {Object} VehicleSeatmap
+ * @property {string} _id - Assigned seatmap id (24-char hex)
+ * @property {string} name - Assigned seatmap name
+ */
+
+/**
+ * Vehicle returned by GET /vehicles and GET /vehicles/{vehicleId} (btrz-api-inventory Vehicle).
+ * @typedef {Object} Vehicle
+ * @property {string} _id - Vehicle id
+ * @property {string} accountId - Account the vehicle belongs to
+ * @property {string} name - Vehicle name
+ * @property {number} capacity - Vehicle capacity
+ * @property {string} [licensePlate] - License plate
+ * @property {string} [certification] - Certification
+ * @property {string} [brand] - Brand name
+ * @property {boolean} [disabled] - Whether the vehicle is unavailable
+ * @property {string} [garageId] - Garage id
+ * @property {string} [externalId] - External id
+ * @property {string} [amenityGroupId] - Amenity group id
+ * @property {string} [brandId] - Brand id
+ * @property {number} [number] - Numeric identifier when the name is numeric
+ * @property {VehicleSeatmap} [seatmap] - Assigned seatmap snapshot; omitted when not assigned
+ * @property {string} [createdBy] - User id that created the vehicle
+ * @property {string} [updatedBy] - User id that last updated the vehicle
+ * @property {Object} [createdAt] - Creation date (BzDate)
+ * @property {Object} [updatedAt] - Last update date (BzDate)
+ */
+
+/**
+ * GET /vehicles response (btrz-api-inventory GetVehiclesResponse).
+ * @typedef {Object} GetVehiclesResponse
+ * @property {Vehicle[]} vehicles
+ * @property {string} [next] - Next page link; empty if none
+ * @property {string} [previous] - Previous page link; empty if none
+ * @property {number} count - Total matching vehicles
+ */
+
+/**
+ * GET /vehicles/{vehicleId} response (btrz-api-inventory VehicleResponse).
+ * @typedef {Object} VehicleResponse
+ * @property {Vehicle} vehicle
+ */
+
 /**
  * Factory for vehicles API (btrz-api-inventory).
  * @param {Object} deps
@@ -37,7 +84,7 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {VehiclesQuery} [opts.query] - Query params (disabled, page, name, garageId, brandId, etc.)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<GetVehiclesResponse>>}
    */
   function all({
     token,
@@ -58,7 +105,7 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.vehicleId - Vehicle id
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function get({vehicleId, token, jwtToken, headers}) {
     return client.get(`/vehicles/${vehicleId}`, {
@@ -71,9 +118,9 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} opts.vehicle - Vehicle payload (VehiclePostData). Does not accept seatmap; assign with vehicles.seatmaps.create.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function create({jwtToken, token, vehicle, headers}) {
     return client({
@@ -109,9 +156,9 @@ function vehiclesFactory({client, internalAuthTokenProvider}) {
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
    * @param {string} opts.vehicleId - Vehicle id
-   * @param {Object} opts.vehicle - Vehicle payload
+   * @param {Object} opts.vehicle - Vehicle payload (VehiclePostData). Does not accept or change seatmap.
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse<VehicleResponse>>}
    */
   function update({jwtToken, token, vehicleId, vehicle, headers}) {
     return client({

package/src/endpoints/notifications/notify.js

@@ -27,6 +27,19 @@ const {
  * @property {string} [humanDate] - "mm" | "dd"
  */
 
+/**
+ * Request body for POST /notify/whatsapp (btrz-api-notifications). See post-notify-whatsapp getSpec() and NotifyWhatsappPostData.
+ * @typedef {Object} NotifyWhatsappPostData
+ * @property {string} type - Document/template type (e.g. product, voucher, order)
+ * @property {string} itemId - ObjectId of the item (24-char hex)
+ * @property {string} [templateType] - Accounts template type when it differs from `type` (same enum as GET /sms-templates/types). Twilio only: the Salesforce branch uses the Meta approved template referenced by the account `waDefinitionKey`
+ * @property {string} [to] - Recipient phone (E.164). Optional; derived from item when omitted. The Salesforce branch only supports Mexican numbers with the 52 country code (12 digits starting with 52)
+ * @property {string} [lang] - ISO language code. Twilio only: used for template selection
+ * @property {string} [channel] - Channel filter for template selection. Twilio only
+ * @property {string} [family] - Required when type is 'product'. One of: ticket, reservation, paid in, paid out, parcel, flexpass, bundle
+ * @property {string} [humanDate] - "mm" | "dd". Twilio only
+ */
+
 /**
  * Query params for POST /notify-tickets/:ticketId (btrz-api-notifications). See post-notify-tickets-by-id-handler getSpec().
  * @typedef {Object} NotifyTicketsPostQuery
@@ -52,7 +65,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function }, emailByType: { create: function }, smsByType: { create: function } }}
+ * @returns {{ childUsers: { create: function }, newSeller: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function, resend: function }, emailByType: { create: function }, smsByType: { create: function }, whatsapp: { create: function } }}
  */
 function notifyTicketFactory({
   client, internalAuthTokenProvider
@@ -230,6 +243,27 @@ function notifyTicketFactory({
           headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
         });
       }
+    },
+    whatsapp: {
+      /**
+       * POST /notify/whatsapp - sends WhatsApp notification specifying document type and id
+       * Uses the account's WhatsApp provider: for Twilio it uses the most relevant published SMS template;
+       * for Salesforce it uses a Meta approved WhatsApp template configured via `waDefinitionKey` in the account.
+       * @param {Object} opts
+       * @param {string} [opts.token] - API key
+       * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+       * @param {NotifyWhatsappPostData} opts.data - Request body (type, itemId; optional templateType, to, lang, channel, family, humanDate)
+       * @param {Object} [opts.headers] - Optional headers
+       * @returns {Promise<import("axios").AxiosResponse<{ success: boolean }>>}
+       */
+      create({token, jwtToken, data, headers}) {
+        return client({
+          url: "/notify/whatsapp",
+          method: "post",
+          data: data || {},
+          headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+        });
+      }
     }
   };
 }

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

@@ -202,3 +202,37 @@ describe("notifications/notify/sms", () => {
     });
   });
 });
+
+describe("notifications/notify/whatsapp", () => {
+  const token = "my-api-key";
+  const jwtToken = "my-jwt";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should POST send WhatsApp by type and itemId", () => {
+    axiosMock.onPost("/notify/whatsapp").reply(({headers, data}) => {
+      if (headers["x-api-key"] !== token || headers.authorization !== `Bearer ${jwtToken}`) {
+        return [403];
+      }
+      const body = typeof data === "string" ? JSON.parse(data) : data;
+      if (body.type === "order" && body.itemId === "507f1f77bcf86cd799439011" && body.to === "5215555555555") {
+        return [200, {success: true}];
+      }
+      return [400];
+    });
+    return api.notifications.notify.whatsapp.create({
+      token,
+      jwtToken,
+      data: {
+        type: "order",
+        itemId: "507f1f77bcf86cd799439011",
+        to: "5215555555555"
+      }
+    }).then((res) => {
+      assert.deepStrictEqual(res.status, 200);
+      assert.deepStrictEqual(res.data.success, true);
+    });
+  });
+});

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

@@ -8,7 +8,7 @@ export = notifyTicketFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ childUsers: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function }, emailByType: { create: function }, smsByType: { create: function } }}
+ * @returns {{ childUsers: { create: function }, newSeller: { create: function }, tickets: { create: function }, vouchers: { create: function }, manifest: { create: function, resend: function }, emailByType: { create: function }, smsByType: { create: function }, whatsapp: { create: function } }}
  */
 declare function notifyTicketFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -24,9 +24,16 @@ declare function notifyTicketFactory({ client, internalAuthTokenProvider }: {
         /** @param opts.data type, itemId; optional to, lang, channel, family, humanDate */
         create: (opts: { token?: string; jwtToken?: string; data: { type: string; itemId: string; to?: string; lang?: string; channel?: string; family?: string; humanDate?: string }; headers?: object }) => Promise<import("axios").AxiosResponse<{ success: boolean }>>;
     };
+    whatsapp: {
+        /** @param opts.data type, itemId; optional templateType, to, lang, channel, family, humanDate */
+        create: (opts: { token?: string; jwtToken?: string; data?: { type: string; itemId: string; templateType?: string; to?: string; lang?: string; channel?: string; family?: string; humanDate?: string }; headers?: object }) => Promise<import("axios").AxiosResponse<{ success: boolean }>>;
+    };
     childUsers: {
         create: Function;
     };
+    newSeller: {
+        create: Function;
+    };
     tickets: {
         create: Function;
     };