btrz-api-client 9.4.0 → 9.6.0

package/lib/client.js

@@ -183,6 +183,10 @@ function createInventory({
       client,
       internalAuthTokenProvider
     }),
+    banorteTerminals: require("./endpoints/inventory/banorte-terminals.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     getnetTerminals: require("./endpoints/inventory/getnet-terminals.js")({
       client,
       internalAuthTokenProvider

package/lib/endpoints/inventory/banorte-terminals.js

@@ -0,0 +1,181 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /banorte-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} BanorteTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
+/**
+ * Factory for banorte-terminals API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, remove: function, update: function }}
+ */
+function banorteTerminalFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /banorte-terminals - list Banorte terminals (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BanorteTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminals: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
+   */
+  function all({
+    token,
+    jwtToken,
+    query = {},
+    headers
+  }) {
+    return client.get("/banorte-terminals", {
+      params: query,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * GET /banorte-terminals/:banorteTerminalId - get a Banorte terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_BANORTE_TERMINAL_ID, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 500)
+   */
+  function get({
+    banorteTerminalId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client.get(`/banorte-terminals/${banorteTerminalId}`, {
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * POST /banorte-terminals - create Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.banorteTerminal - Banorte terminal payload (name, serialNumber, stationId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate serial, 500)
+   */
+  function create({
+    jwtToken,
+    token,
+    banorteTerminal,
+    headers
+  }) {
+    return client({
+      url: "/banorte-terminals",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        banorteTerminal
+      }
+    });
+  }
+
+  /**
+   * DELETE /banorte-terminals/:banorteTerminalId - remove Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_BANORTE_TERMINAL_ID, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 500)
+   */
+  function remove({
+    jwtToken,
+    banorteTerminalId,
+    token,
+    headers
+  }) {
+    return client({
+      url: `/banorte-terminals/${banorteTerminalId}`,
+      method: "delete",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /banorte-terminals/:banorteTerminalId - update Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} opts.banorteTerminal - Banorte terminal payload (name, serialNumber, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 409 duplicate serial, 500)
+   */
+  function update({
+    jwtToken,
+    token,
+    banorteTerminalId,
+    banorteTerminal,
+    headers
+  }) {
+    const _banorteTerminalId = banorteTerminalId || banorteTerminal._id;
+    return client({
+      url: `/banorte-terminals/${_banorteTerminalId}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        banorteTerminal: {
+          name: banorteTerminal.name,
+          serialNumber: banorteTerminal.serialNumber,
+          stationId: banorteTerminal.stationId
+        }
+      }
+    });
+  }
+  return {
+    all,
+    get,
+    create,
+    remove,
+    update
+  };
+}
+module.exports = banorteTerminalFactory;

package/package.json

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

package/src/client.js

@@ -84,6 +84,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     filteredTripsV2: require("./endpoints/inventory/filtered-trips-v2.js")({client, internalAuthTokenProvider}),
     financingCosts: require("./endpoints/inventory/financing-costs.js")({client, internalAuthTokenProvider}),
     garages: require("./endpoints/inventory/garages.js")({client, internalAuthTokenProvider}),
+    banorteTerminals: require("./endpoints/inventory/banorte-terminals.js")({client, internalAuthTokenProvider}),
     getnetTerminals: require("./endpoints/inventory/getnet-terminals.js")({client, internalAuthTokenProvider}),
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({client, internalAuthTokenProvider}),
     healthCheck: require("./endpoints/inventory/healthcheck.js")({client, internalAuthTokenProvider}),

package/src/endpoints/inventory/banorte-terminals.js

@@ -0,0 +1,156 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /banorte-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} BanorteTerminalsQuery
+ * @property {number} [page] - The page number to retrieve
+ * @property {string} [stationId] - Filter terminals by station (location) ID
+ * @property {string} [serialNumber] - Filter terminals by serial number
+ */
+
+/**
+ * Factory for banorte-terminals API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, create: function, remove: function, update: function }}
+ */
+function banorteTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /banorte-terminals - list Banorte terminals (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {BanorteTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminals: Array, next?: string, previous?: string, count: number }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_PAGE, 401, 500)
+   */
+  function all({
+    token,
+    jwtToken,
+    query = {},
+    headers
+  }) {
+    return client.get("/banorte-terminals", {
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /banorte-terminals/:banorteTerminalId - get a Banorte terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_BANORTE_TERMINAL_ID, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 500)
+   */
+  function get({
+    banorteTerminalId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client.get(`/banorte-terminals/${banorteTerminalId}`, {
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /banorte-terminals - create Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.banorteTerminal - Banorte terminal payload (name, serialNumber, stationId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate serial, 500)
+   */
+  function create({
+    jwtToken,
+    token,
+    banorteTerminal,
+    headers
+  }) {
+    return client({
+      url: "/banorte-terminals",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        banorteTerminal
+      }
+    });
+  }
+
+  /**
+   * DELETE /banorte-terminals/:banorteTerminalId - remove Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_BANORTE_TERMINAL_ID, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 500)
+   */
+  function remove({
+    jwtToken,
+    banorteTerminalId,
+    token,
+    headers
+  }) {
+    return client({
+      url: `/banorte-terminals/${banorteTerminalId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /banorte-terminals/:banorteTerminalId - update Banorte terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.banorteTerminalId - Banorte terminal id (24 hex characters)
+   * @param {Object} opts.banorteTerminal - Banorte terminal payload (name, serialNumber, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ banorteTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 BANORTE_TERMINAL_NOT_FOUND, 409 duplicate serial, 500)
+   */
+  function update({
+    jwtToken,
+    token,
+    banorteTerminalId,
+    banorteTerminal,
+    headers
+  }) {
+    const _banorteTerminalId = banorteTerminalId || banorteTerminal._id;
+
+    return client({
+      url: `/banorte-terminals/${_banorteTerminalId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        banorteTerminal: {
+          name: banorteTerminal.name,
+          serialNumber: banorteTerminal.serialNumber,
+          stationId: banorteTerminal.stationId
+        }
+      }
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    remove,
+    update
+  };
+}
+
+module.exports = banorteTerminalFactory;

package/test/all.test.js

@@ -95,6 +95,7 @@ require("./endpoints/inventory/filtered-trips-v2.test.js");
 require("./endpoints/inventory/filtered-trips.test.js");
 require("./endpoints/inventory/financing-costs.test.js");
 require("./endpoints/inventory/garages.test.js");
+require("./endpoints/inventory/banorte-terminals.test.js");
 require("./endpoints/inventory/getnet-terminals.test.js");
 require("./endpoints/inventory/gift-certificate-definitions.test.js");
 require("./endpoints/inventory/holidays.test.js");

package/test/endpoints/inventory/banorte-terminals.test.js

@@ -0,0 +1,173 @@
+describe("inventory/banorte-terminals", () => {
+  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";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should retrieve a list of Banorte terminals", () => {
+    const query = {page: 2};
+
+    axiosMock.onGet("/banorte-terminals", {params: query}).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.banorteTerminals.all({
+      jwtToken,
+      token,
+      query
+    });
+  });
+
+  it("should retrieve an existing Banorte terminal by id", () => {
+    const banorteTerminalId = "1234123412341234";
+
+    axiosMock.onGet(`/banorte-terminals/${banorteTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.banorteTerminals.get({
+      jwtToken,
+      token,
+      banorteTerminalId
+    });
+  });
+
+  it("should create a new Banorte terminal", async () => {
+    const banorteTerminal = {
+      name: "New Banorte Terminal",
+      serialNumber: "Test Serial Number"
+    };
+
+    axiosMock.onPost("/banorte-terminals").reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {banorteTerminal}
+    }));
+
+    return api.inventory.banorteTerminals.create({
+      jwtToken,
+      token,
+      banorteTerminal
+    });
+  });
+
+  it("should create a new Banorte terminal with stationId (location)", async () => {
+    const banorteTerminal = {
+      name: "Banorte Terminal at Station",
+      serialNumber: "SN-001",
+      stationId: "5f243d100617680712e78dd7"
+    };
+
+    axiosMock.onPost("/banorte-terminals").reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {banorteTerminal}
+    }));
+
+    return api.inventory.banorteTerminals.create({
+      jwtToken,
+      token,
+      banorteTerminal
+    });
+  });
+
+  it("should delete a Banorte terminal", () => {
+    const banorteTerminalId = "1234";
+
+    axiosMock.onDelete(`/banorte-terminals/${banorteTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.banorteTerminals.remove({
+      jwtToken,
+      token,
+      banorteTerminalId
+    });
+  });
+
+  it("should update an existing Banorte terminal", async () => {
+    const banorteTerminal = {
+      _id: "terminal-id-123",
+      name: "Updated Banorte Terminal",
+      serialNumber: "Updated Serial Number"
+    };
+
+    const banorteTerminalFieldsToUpdate = {
+      name: banorteTerminal.name,
+      serialNumber: banorteTerminal.serialNumber,
+      stationId: banorteTerminal.stationId
+    };
+
+    axiosMock.onPut(`/banorte-terminals/${banorteTerminal._id}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {banorteTerminal: banorteTerminalFieldsToUpdate}
+    }));
+
+    return api.inventory.banorteTerminals.update({
+      jwtToken,
+      token,
+      banorteTerminal
+    });
+  });
+
+  it("should update an existing Banorte terminal with stationId (location)", async () => {
+    const banorteTerminalId = "terminal-id-456";
+    const banorteTerminal = {
+      _id: banorteTerminalId,
+      name: "Terminal at Station",
+      serialNumber: "SN-789",
+      stationId: "5f243d100617680712e78dd7"
+    };
+
+    const expectedBody = {
+      banorteTerminal: {
+        name: banorteTerminal.name,
+        serialNumber: banorteTerminal.serialNumber,
+        stationId: banorteTerminal.stationId
+      }
+    };
+
+    axiosMock.onPut(`/banorte-terminals/${banorteTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: expectedBody
+    }));
+
+    return api.inventory.banorteTerminals.update({
+      jwtToken,
+      token,
+      banorteTerminalId,
+      banorteTerminal
+    });
+  });
+
+  it("should update an existing Banorte terminal with empty stationId", async () => {
+    const banorteTerminal = {
+      _id: "terminal-id-999",
+      name: "Terminal No Location",
+      serialNumber: "SN-999",
+      stationId: ""
+    };
+
+    const expectedBody = {
+      banorteTerminal: {
+        name: banorteTerminal.name,
+        serialNumber: banorteTerminal.serialNumber,
+        stationId: ""
+      }
+    };
+
+    axiosMock.onPut(`/banorte-terminals/${banorteTerminal._id}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: expectedBody
+    }));
+
+    return api.inventory.banorteTerminals.update({
+      jwtToken,
+      token,
+      banorteTerminal
+    });
+  });
+});