btrz-api-client 9.28.0 → 9.31.0

package/lib/client.js

@@ -1046,6 +1046,10 @@ function createNotifications({
       client,
       internalAuthTokenProvider
     }),
+    operatorNotifications: require("./endpoints/notifications/operator-notifications.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     notify: require("./endpoints/notifications/notify.js")({
       client,
       internalAuthTokenProvider

package/lib/endpoints/accounts/ticket-movement-settings.js

@@ -48,6 +48,7 @@ const {
  * @property {boolean} preventMovementsWhenFareSpecificCapacityLimitsAreExceeded - Prevent moves when fare capacity is exceeded.
  * @property {boolean} sendSMSNotifications - Enable SMS notifications for ticket movements.
  * @property {boolean} [allowSendingEmailNotification] - Enable email notifications for ticket movements.
+ * @property {boolean} [allowSendingWhatsAppNotification] - Enable WhatsApp notifications for bulk ticket movements.
  * @property {boolean} [useConfirmationRecipientForNotifications] - Send notifications to the confirmation recipient.
  * @property {number} maxMovementsPerTicket - Maximum ticket movements without authorization.
  * @property {number} [maxMovementsPerTicketWithAuthorization] - Maximum ticket movements with authorization.

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

@@ -0,0 +1,170 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Query params for GET /operator-notifications (btrz-api-notifications getSpec).
+ * @typedef {Object} OperatorNotificationsListQuery
+ * @property {number|string} [page] - Page number for pagination
+ */
+
+/**
+ * Factory for operator-notifications API (btrz-api-notifications).
+ * Operator purchase / capacity / SSR notification config documents.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} operator-notifications API methods
+ */
+function operatorNotificationsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /operator-notifications - list operator notification configs for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OperatorNotificationsListQuery} [opts.query] - page
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetOperatorNotificationsResponse
+   */
+  function all({
+    token,
+    jwtToken,
+    query = {},
+    headers
+  }) {
+    return client({
+      url: "/operator-notifications",
+      method: "get",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      params: query
+    });
+  }
+
+  /**
+   * GET /operator-notifications/:id - get operator notification by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 OPERATOR_NOTIFICATION_NOT_FOUND
+   */
+  function get({
+    token,
+    jwtToken,
+    id,
+    headers
+  }) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "get",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * POST /operator-notifications - create one document per product. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - OperatorNotificationCreateData (or {operatorNotification: ...})
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} CreateOperatorNotificationsResponse
+   */
+  function create({
+    token,
+    jwtToken,
+    data,
+    headers
+  }) {
+    return client({
+      url: "/operator-notifications",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data
+    });
+  }
+
+  /**
+   * PUT /operator-notifications/:id - update mutable fields. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} opts.data - OperatorNotificationUpdateData (or {operatorNotification: ...})
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 OPERATOR_NOTIFICATION_NOT_FOUND
+   */
+  function update({
+    token,
+    jwtToken,
+    id,
+    data,
+    headers
+  }) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data
+    });
+  }
+
+  /**
+   * DELETE /operator-notifications/:id - hard delete. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} DeletedOperatorNotificationResponse
+   */
+  function remove({
+    token,
+    jwtToken,
+    id,
+    headers
+  }) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "delete",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+module.exports = operatorNotificationsFactory;

package/package.json

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

package/src/client.js

@@ -377,6 +377,7 @@ function createNotifications({baseURL, headers, timeout, overrideFn, internalAut
     twilio: require("./endpoints/notifications/twilio.js")({client, internalAuthTokenProvider}),
     salesforce: require("./endpoints/notifications/salesforce.js")({client, internalAuthTokenProvider}),
     shortUrls: require("./endpoints/notifications/short-urls.js")({client, internalAuthTokenProvider}),
+    operatorNotifications: require("./endpoints/notifications/operator-notifications.js")({client, internalAuthTokenProvider}),
     notify: require("./endpoints/notifications/notify.js")({client, internalAuthTokenProvider}),
     ordersRulesValidations: require("./endpoints/notifications/orders-rules-validations.js")({client, internalAuthTokenProvider}),
     __test: {

package/src/endpoints/accounts/ticket-movement-settings.js

@@ -48,6 +48,7 @@ const {
  * @property {boolean} preventMovementsWhenFareSpecificCapacityLimitsAreExceeded - Prevent moves when fare capacity is exceeded.
  * @property {boolean} sendSMSNotifications - Enable SMS notifications for ticket movements.
  * @property {boolean} [allowSendingEmailNotification] - Enable email notifications for ticket movements.
+ * @property {boolean} [allowSendingWhatsAppNotification] - Enable WhatsApp notifications for bulk ticket movements.
  * @property {boolean} [useConfirmationRecipientForNotifications] - Send notifications to the confirmation recipient.
  * @property {number} maxMovementsPerTicket - Maximum ticket movements without authorization.
  * @property {number} [maxMovementsPerTicketWithAuthorization] - Maximum ticket movements with authorization.

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

@@ -0,0 +1,116 @@
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+/**
+ * Query params for GET /operator-notifications (btrz-api-notifications getSpec).
+ * @typedef {Object} OperatorNotificationsListQuery
+ * @property {number|string} [page] - Page number for pagination
+ */
+
+/**
+ * Factory for operator-notifications API (btrz-api-notifications).
+ * Operator purchase / capacity / SSR notification config documents.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} operator-notifications API methods
+ */
+function operatorNotificationsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /operator-notifications - list operator notification configs for the account.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {OperatorNotificationsListQuery} [opts.query] - page
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} GetOperatorNotificationsResponse
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/operator-notifications",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  /**
+   * GET /operator-notifications/:id - get operator notification by id. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 OPERATOR_NOTIFICATION_NOT_FOUND
+   */
+  function get({token, jwtToken, id, headers}) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /operator-notifications - create one document per product. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - OperatorNotificationCreateData (or {operatorNotification: ...})
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} CreateOperatorNotificationsResponse
+   */
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/operator-notifications",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * PUT /operator-notifications/:id - update mutable fields. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} opts.data - OperatorNotificationUpdateData (or {operatorNotification: ...})
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} 404 OPERATOR_NOTIFICATION_NOT_FOUND
+   */
+  function update({token, jwtToken, id, data, headers}) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * DELETE /operator-notifications/:id - hard delete. API does not accept query params.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.id - Operator notification id (ObjectId)
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<import("axios").AxiosResponse>} DeletedOperatorNotificationResponse
+   */
+  function remove({token, jwtToken, id, headers}) {
+    return client({
+      url: `/operator-notifications/${id}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    update,
+    remove
+  };
+}
+
+module.exports = operatorNotificationsFactory;

package/test/all.test.js

@@ -168,6 +168,7 @@ require("./endpoints/notifications/pdfs.test.js");
 require("./endpoints/notifications/printed-tickets.test.js");
 require("./endpoints/notifications/salesforce.test.js");
 require("./endpoints/notifications/short-urls.test.js");
+require("./endpoints/notifications/operator-notifications.test.js");
 require("./endpoints/notifications/twilio.test.js");
 require("./endpoints/operations/accounting_items.js");
 require("./endpoints/operations/applied_insurance.test.js");

package/test/endpoints/accounts/ticket-movement-settings.test.js

@@ -28,6 +28,7 @@ describe("accounts/ticket-movement-settings", () => {
       preventMovementsWhenFareSpecificCapacityLimitsAreExceeded: true,
       sendSMSNotifications: true,
       allowSendingEmailNotification: true,
+      allowSendingWhatsAppNotification: false,
       useConfirmationRecipientForNotifications: false,
       maxMovementsPerTicket: 1,
       maxMovementsPerTicketWithAuthorization: 2,

package/test/endpoints/notifications/operator-notifications.test.js

@@ -0,0 +1,82 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("notifications/operator-notifications", () => {
+  const token = "someToken";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should GET a list of operator notifications with query params", () => {
+    const query = {page: 1};
+    axiosMock.onGet("/operator-notifications").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      query
+    }));
+    return api.notifications.operatorNotifications.all({token, jwtToken, query});
+  });
+
+  it("should GET an operator notification by id", () => {
+    const id = "5f243d100617680712e78dd7";
+    axiosMock.onGet(`/operator-notifications/${id}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.notifications.operatorNotifications.get({token, jwtToken, id});
+  });
+
+  it("should POST create operator notifications", () => {
+    const data = {
+      operatorNotification: {
+        name: "Alert",
+        eventType: "purchase",
+        systemName: "email",
+        products: [{id: "5f243d100617680712e78dd7", name: "Route"}],
+        systemValues: {
+          senderName: "Ops",
+          senderAddress: "ops@example.com",
+          recipients: "a@example.com"
+        }
+      }
+    };
+    axiosMock.onPost("/operator-notifications").reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.notifications.operatorNotifications.create({token, jwtToken, data});
+  });
+
+  it("should PUT update an operator notification", () => {
+    const id = "5f243d100617680712e78dd7";
+    const data = {
+      operatorNotification: {
+        name: "Updated",
+        systemValues: {recipients: "b@example.com"}
+      }
+    };
+    axiosMock.onPut(`/operator-notifications/${id}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken,
+      body: data
+    }));
+    return api.notifications.operatorNotifications.update({token, jwtToken, id, data});
+  });
+
+  it("should DELETE an operator notification", () => {
+    const id = "5f243d100617680712e78dd7";
+    axiosMock.onDelete(`/operator-notifications/${id}`).reply(expectRequest({
+      statusCode: 200,
+      token,
+      jwtToken
+    }));
+    return api.notifications.operatorNotifications.remove({token, jwtToken, id});
+  });
+});

package/types/endpoints/notifications/operator-notifications.d.ts

@@ -0,0 +1,44 @@
+export interface OperatorNotificationsListQuery {
+  page?: number | string;
+}
+
+export interface OperatorNotificationsApi {
+  all(opts: {
+    token?: string;
+    jwtToken?: string;
+    query?: OperatorNotificationsListQuery;
+    headers?: Record<string, string>;
+  }): Promise<import("axios").AxiosResponse>;
+  get(opts: {
+    token?: string;
+    jwtToken?: string;
+    id: string;
+    headers?: Record<string, string>;
+  }): Promise<import("axios").AxiosResponse>;
+  create(opts: {
+    token?: string;
+    jwtToken?: string;
+    data: unknown;
+    headers?: Record<string, string>;
+  }): Promise<import("axios").AxiosResponse>;
+  update(opts: {
+    token?: string;
+    jwtToken?: string;
+    id: string;
+    data: unknown;
+    headers?: Record<string, string>;
+  }): Promise<import("axios").AxiosResponse>;
+  remove(opts: {
+    token?: string;
+    jwtToken?: string;
+    id: string;
+    headers?: Record<string, string>;
+  }): Promise<import("axios").AxiosResponse>;
+}
+
+declare const operatorNotificationsFactory: (deps: {
+  client: import("axios").AxiosInstance;
+  internalAuthTokenProvider?: {getToken: () => string};
+}) => OperatorNotificationsApi;
+
+export = operatorNotificationsFactory;