btrz-api-client 8.34.0 → 8.35.0

package/src/endpoints/operations/pago-express.js

@@ -0,0 +1,73 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Pago Express (Datalogic) endpoints for the Operations API.
+ * Used to get info, pay, and reverse reference payments.
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {Object} pagoExpress API methods
+ */
+function pagoExpressFactory({client, internalAuthTokenProvider}) {
+  /**
+   * POST /pago-express/info - get transaction information for a Pago Express reference.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio (20-digit string), id_terminal (number), local_date (string DD/MM/YYYY HH:mm:ss), trx_no (number)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostInfoResponse (code, message, result with folio, id_terminal, local_date, saldo, trx_no, responsecode, descriptioncode)
+   */
+  function info({token, jwtToken, payment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/info",
+      data: {payment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /pago-express/pay - pay a Pago Express reference payment.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.payment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostPayResponse (code, message, result with folio, id_terminal, local_date, trx_no, noauto, amount, responsecode, descriptioncode)
+   */
+  function pay({token, jwtToken, payment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/pay",
+      data: {payment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /pago-express/reverse - reverse (cancel) a Pago Express reference payment. Emits transaction.reversed webhook.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key (x-api-key)
+   * @param {string} [opts.jwtToken] - JWT or internal auth
+   * @param {Object} opts.reversePayment - Request body: folio, id_terminal, local_date, trx_no, amount (string)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>} 200 PostReverseResponse (code, message, result)
+   */
+  function reverse({token, jwtToken, reversePayment, headers}) {
+    return client({
+      method: "post",
+      url: "/pago-express/reverse",
+      data: {reversePayment},
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    info,
+    pay,
+    reverse
+  };
+}
+
+module.exports = pagoExpressFactory;

package/src/endpoints/operations/parcels.js

@@ -28,13 +28,13 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  */
 function parcelFactory({client, internalAuthTokenProvider}) {
   /**
-   * GET /parcels/:id - get parcel by id. API does not accept query params.
+   * GET /parcels/{parcelId} - get parcel by id. Requires JwtAuth. No query params.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
+   * @param {string} opts.id - Parcel id (24 hex characters)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 { parcel }; 400 INVALID_PARCEL_ID; 401 Unauthorized; 404 PARCEL_NOT_FOUND; 500
    */
   function get({token, jwtToken, id, headers}) {
     return client({
@@ -83,14 +83,14 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * POST /parcels/:id/user-comments - add comment to parcel. API does not accept query params.
+   * POST /parcels/{parcelId}/user-comments - add user comment to parcel. Requires JwtAuth. Body: { comment } (string).
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
-   * @param {Object} opts.comment - Comment payload
+   * @param {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.comment - Comment text (sent as body.comment)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND; 409
    */
   function addComment({token, jwtToken, headers, id, comment}) {
     return client({
@@ -102,14 +102,14 @@ function parcelFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * DELETE /parcels/:id/user-comments/:commentId - delete parcel comment. API does not accept query params.
+   * DELETE /parcels/{parcelId}/user-comments/{commentId} - delete user comment from parcel. Requires JwtAuth.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel id
-   * @param {string} opts.commentId - Comment id
+   * @param {string} opts.id - Parcel id (path parcelId)
+   * @param {string} opts.commentId - Comment id (path)
    * @param {Object} [opts.headers] - Optional headers
-   * @returns {Promise<import("axios").AxiosResponse>}
+   * @returns {Promise<import("axios").AxiosResponse>} 200 deleted ParcelUserComment; 400 MISSING_*; 401; 403; 404 PARCEL_NOT_FOUND, COMMENT_NOT_FOUND; 409
    */
   function deleteComment({token, jwtToken, headers, id, commentId}) {
     return client({

package/src/endpoints/operations/parcels_manifests.js

@@ -40,19 +40,21 @@ function parcelsManifestsFactory({client, internalAuthTokenProvider}) {
   }
 
   /**
-   * GET /parcels-manifests/:id - get parcels manifest by id. API does not accept query params.
+   * GET /parcels-manifests/:id - get parcels manifest by id.
    * @param {Object} opts
    * @param {string} [opts.token] - API key
    * @param {string} [opts.jwtToken] - JWT or internal auth symbol
-   * @param {string} opts.id - Parcel manifest id (ObjectId)
+   * @param {string} opts.id - Parcel manifest id (ObjectId, 24 hex chars)
+   * @param {"standard"|"webhook"} [opts.format="standard"] - Response format (standard | webhook)
    * @param {Object} [opts.headers] - Optional request headers
-   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 404 PARCELMANIFEST_NOT_FOUND
+   * @returns {Promise<import("axios").AxiosResponse>} response.data parcel manifest; 400 WRONG_DATA; 404 MANIFEST_NOT_FOUND, PARCELMANIFEST_NOT_FOUND
    */
-  function get({token, jwtToken, id, headers}) {
+  function get({token, jwtToken, id, format, headers}) {
     return client({
       url: `/parcels-manifests/${id}`,
       method: "get",
-      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: format != null ? {format} : undefined
     });
   }
 

package/test/endpoints/inventory/banks.test.js

@@ -12,18 +12,17 @@ describe("inventory/banks", () => {
   });
 
   it("should create a bank", () => {
-    axiosMock.onPost("/banks").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    const bank = {name: "My bank", accountNumbers: [{number: "123", currency: "USD", alias: "Main"}]};
+    axiosMock.onPost("/banks", {bank}).reply(expectRequest({statusCode: 200, token, jwtToken, body: {bank}}));
     return api.inventory.banks.create({
       jwtToken,
       token,
-      banks: {
-        name: "My bankl"
-      }
+      bank
     });
   });
 
   it("should get all pieces of bank", () => {
-    axiosMock.onGet("/banks").reply(expectRequest({statusCode: 200, token, jwtToken }));
+    axiosMock.onGet("/banks").reply(expectRequest({statusCode: 200, token, jwtToken}));
     return api.inventory.banks.all({
       jwtToken,
       token,
@@ -31,16 +30,15 @@ describe("inventory/banks", () => {
     });
   });
 
-  it("should update a piece of bank", () => {
+  it("should update a bank", () => {
     const bankId = "1234";
-    axiosMock.onPut(`/banks/${bankId}`).reply(expectRequest({ statusCode: 200, token, jwtToken }));
+    const bank = {name: "My Updated bank", accountNumbers: [{number: "123", currency: "USD", alias: "Main"}]};
+    axiosMock.onPut(`/banks/${bankId}`, {bank}).reply(expectRequest({statusCode: 200, token, jwtToken, body: {bank}}));
     return api.inventory.banks.update({
       jwtToken,
       token,
       bankId,
-      banks: {
-        name: "My Updated bank"
-      }
+      bank
     });
   });
 

package/test/endpoints/inventory/filtered-trips.test.js

@@ -28,4 +28,10 @@ describe("inventory/filtered-trips", () => {
     axiosMock.onPost("/filtered-trips").reply(expectRequest({statusCode: 200, token, jwtToken}));
     return api.inventory.filteredTrips.create({token, jwtToken, tripSegmentsId: "myTripSegmentId"});
   });
+
+  it("should remove a filtered trip", () => {
+    const filteredTripId = "60c9200d17bda93f5c896bf3";
+    axiosMock.onDelete(`/filtered-trip/${filteredTripId}`).reply(expectRequest({statusCode: 204, token, jwtToken}));
+    return api.inventory.filteredTrips.remove({token, jwtToken, filteredTripId});
+  });
 });

package/test/endpoints/inventory/holidays.test.js

@@ -0,0 +1,52 @@
+describe("inventory/holidays", () => {
+  const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+  const api = require("./../../../src/client.js").createApiClient({
+    baseURL: "http://test.com"
+  });
+
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+  const holidayId = "holiday-id-1";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should list holidays", () => {
+    const query = {page: 1, providerId: "providerId1"};
+    axiosMock.onGet("/holidays").reply(expectRequest({statusCode: 200, token, query}));
+    return api.inventory.holidays.all({token, query});
+  });
+
+  it("should get a specific holiday by id", () => {
+    axiosMock.onGet(`/holidays/${holidayId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.inventory.holidays.get({token, jwtToken, holidayId});
+  });
+
+  it("should create a new holiday", () => {
+    const holiday = {day: 25, month: 12, year: 2024, name: "Christmas"};
+    axiosMock.onPost("/holidays").reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {holiday}
+    }));
+    return api.inventory.holidays.create({jwtToken, token, holiday});
+  });
+
+  it("should update an existing holiday", () => {
+    const holiday = {day: 26, month: 12, year: 2024, name: "Boxing Day"};
+    axiosMock.onPut(`/holidays/${holidayId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {holiday}
+    }));
+    return api.inventory.holidays.update({
+      jwtToken, token, holiday, holidayId
+    });
+  });
+
+  it("should delete an existing holiday", () => {
+    axiosMock.onDelete(`/holidays/${holidayId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.inventory.holidays.remove({jwtToken, token, holidayId});
+  });
+});

package/test/endpoints/inventory/traveller-card-providers-types.test.js

@@ -1,3 +1,4 @@
+/* eslint-disable import/extensions */
 const {axiosMock, expectRequest} = require("./../../test-helpers");
 const api = require("./../../../src/client").createApiClient({baseURL: "http://test.com"});
 
@@ -8,8 +9,8 @@ describe("inventory/traveller-card-providers-types", () => {
     axiosMock.reset();
   });
 
-  it("should call the traveller card providers types endpoint", async () => {
+  it("should call the traveller card providers types endpoint", () => {
     axiosMock.onGet("/traveller-card-providers/types").reply(expectRequest({statusCode: 200, token}));
-    api.inventory.travellerCardProvidersTypes.all({token});
+    return api.inventory.travellerCardProvidersTypes.all({token});
   });
 });

package/test/endpoints/notifications/external-customers.test.js

@@ -0,0 +1,30 @@
+const {expect} = require("chai");
+const {axiosMock} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("notifications/external-customers", () => {
+  const jwtToken = "myJwtToken";
+  const token = "myApiKey";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should POST to request Saldo Max verification code (ado/registration)", () => {
+    const data = {email: "user@example.com"};
+    axiosMock.onPost("/external-customers/ado/registration").reply((config) => {
+      expect(config.data).to.equal(JSON.stringify(data));
+      expect(config.headers["x-api-key"]).to.eql(token);
+      expect(config.headers.authorization).to.eql(`Bearer ${jwtToken}`);
+      return [200, {code: "success", message: "Registration successful"}];
+    });
+
+    return api.notifications.externalCustomers.requestSaldoMaxVerificationCode({
+      token,
+      jwtToken,
+      data
+    }).then((res) => {
+      expect(res.data).to.eql({code: "success", message: "Registration successful"});
+    });
+  });
+});

package/test/endpoints/operations/gift_certificates.test.js

@@ -0,0 +1,37 @@
+const {axiosMock, expectRequest} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("operations/gift-certificates", () => {
+  const token = "test-api-key";
+  const jwtToken = "customer-jwt-token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should GET gift certificates for the given customer", () => {
+    const customer = "123-456-789";
+    axiosMock.onGet("/gift-certificates")
+      .reply(expectRequest({statusCode: 200, token, jwtToken, query: {customer}}));
+
+    return api.operations.giftCertificates.list({
+      jwtToken,
+      token,
+      customer
+    });
+  });
+
+  it("should GET gift certificates with optional page", () => {
+    const customer = "123-456-789";
+    const page = 2;
+    axiosMock.onGet("/gift-certificates")
+      .reply(expectRequest({statusCode: 200, token, jwtToken, query: {customer, page}}));
+
+    return api.operations.giftCertificates.list({
+      jwtToken,
+      token,
+      customer,
+      page
+    });
+  });
+});

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

@@ -17,3 +17,33 @@ describe('operations/segments', function() {
     return api.operations.segments.all({ token, jwtToken, productId, ticketId });
   });
 });
+
+describe("operations/pagoExpress", function() {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(function() {
+    axiosMock.reset();
+  });
+
+  it("should post pago-express info", function() {
+    const payment = { folio: "10305108982123541235", id_terminal: 45875263254987452135, local_date: "18/06/1988 15:04:20", trx_no: 12345 };
+    axiosMock.onPost("/pago-express/info")
+      .reply(expectRequest({ statusCode: 200, token, jwtToken, body: { payment } }));
+    return api.operations.pagoExpress.info({ token, jwtToken, payment });
+  });
+
+  it("should post pago-express pay", function() {
+    const payment = { folio: "10305108982123541235", id_terminal: 45875263254987452135, local_date: "18/06/1988 15:04:20", trx_no: 12345, amount: "999.00" };
+    axiosMock.onPost("/pago-express/pay")
+      .reply(expectRequest({ statusCode: 200, token, jwtToken, body: { payment } }));
+    return api.operations.pagoExpress.pay({ token, jwtToken, payment });
+  });
+
+  it("should post pago-express reverse", function() {
+    const reversePayment = { folio: "10305108982123541235", id_terminal: 45875263254987452135, local_date: "18/06/1988 15:04:20", trx_no: 12345, amount: "999.00" };
+    axiosMock.onPost("/pago-express/reverse")
+      .reply(expectRequest({ statusCode: 200, token, jwtToken, body: { reversePayment } }));
+    return api.operations.pagoExpress.reverse({ token, jwtToken, reversePayment });
+  });
+});