btrz-api-client 9.25.0 → 9.26.0

package/lib/client.js

@@ -191,6 +191,10 @@ function createInventory({
       client,
       internalAuthTokenProvider
     }),
+    cloverTerminals: require("./endpoints/inventory/clover-terminals.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({
       client,
       internalAuthTokenProvider

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

@@ -0,0 +1,181 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /clover-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} CloverTerminalsQuery
+ * @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 clover-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 cloverTerminalFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /clover-terminals - list Clover terminals (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CloverTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminals: 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("/clover-terminals", {
+      params: query,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * GET /clover-terminals/:cloverTerminalId - get a Clover terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_CLOVER_TERMINAL_ID, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 500)
+   */
+  function get({
+    cloverTerminalId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client.get(`/clover-terminals/${cloverTerminalId}`, {
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * POST /clover-terminals - create Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.cloverTerminal - Clover terminal payload (name, serialNumber, stationId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate name/serial, 500)
+   */
+  function create({
+    jwtToken,
+    token,
+    cloverTerminal,
+    headers
+  }) {
+    return client({
+      url: "/clover-terminals",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        cloverTerminal
+      }
+    });
+  }
+
+  /**
+   * DELETE /clover-terminals/:cloverTerminalId - remove Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_CLOVER_TERMINAL_ID, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 500)
+   */
+  function remove({
+    jwtToken,
+    cloverTerminalId,
+    token,
+    headers
+  }) {
+    return client({
+      url: `/clover-terminals/${cloverTerminalId}`,
+      method: "delete",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /clover-terminals/:cloverTerminalId - update Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} opts.cloverTerminal - Clover terminal payload (name, serialNumber, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 409 duplicate name/serial, 500)
+   */
+  function update({
+    jwtToken,
+    token,
+    cloverTerminalId,
+    cloverTerminal,
+    headers
+  }) {
+    const _cloverTerminalId = cloverTerminalId || cloverTerminal._id;
+    return client({
+      url: `/clover-terminals/${_cloverTerminalId}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        cloverTerminal: {
+          name: cloverTerminal.name,
+          serialNumber: cloverTerminal.serialNumber,
+          stationId: cloverTerminal.stationId
+        }
+      }
+    });
+  }
+  return {
+    all,
+    get,
+    create,
+    remove,
+    update
+  };
+}
+module.exports = cloverTerminalFactory;

package/package.json

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

package/src/client.js

@@ -86,6 +86,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     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}),
+    cloverTerminals: require("./endpoints/inventory/clover-terminals.js")({client, internalAuthTokenProvider}),
     giftCertificateDefinitions: require("./endpoints/inventory/gift-certificate-definitions.js")({client, internalAuthTokenProvider}),
     healthCheck: require("./endpoints/inventory/healthcheck.js")({client, internalAuthTokenProvider}),
     holidays: require("./endpoints/inventory/holidays.js")({client, internalAuthTokenProvider}),

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

@@ -0,0 +1,156 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+/**
+ * Query params for GET /clover-terminals (btrz-api-inventory). See get-handler getSpec().
+ * @typedef {Object} CloverTerminalsQuery
+ * @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 clover-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 cloverTerminalFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /clover-terminals - list Clover terminals (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {CloverTerminalsQuery} [opts.query] - Query params (page, stationId, serialNumber)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminals: 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("/clover-terminals", {
+      params: query,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * GET /clover-terminals/:cloverTerminalId - get a Clover terminal by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_CLOVER_TERMINAL_ID, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 500)
+   */
+  function get({
+    cloverTerminalId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client.get(`/clover-terminals/${cloverTerminalId}`, {
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /clover-terminals - create Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.cloverTerminal - Clover terminal payload (name, serialNumber, stationId optional)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400 WRONG_DATA/INVALID_STATION_ID/STATION_NOT_FOUND, 401, 409 duplicate name/serial, 500)
+   */
+  function create({
+    jwtToken,
+    token,
+    cloverTerminal,
+    headers
+  }) {
+    return client({
+      url: "/clover-terminals",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        cloverTerminal
+      }
+    });
+  }
+
+  /**
+   * DELETE /clover-terminals/:cloverTerminalId - remove Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminalId: string }>>}
+   * @throws When response is 4xx/5xx (400 INVALID_CLOVER_TERMINAL_ID, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 500)
+   */
+  function remove({
+    jwtToken,
+    cloverTerminalId,
+    token,
+    headers
+  }) {
+    return client({
+      url: `/clover-terminals/${cloverTerminalId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /clover-terminals/:cloverTerminalId - update Clover terminal.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.cloverTerminalId - Clover terminal id (24 hex characters)
+   * @param {Object} opts.cloverTerminal - Clover terminal payload (name, serialNumber, stationId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ cloverTerminal: Object }>>}
+   * @throws When response is 4xx/5xx (400, 401, 404 CLOVER_TERMINAL_NOT_FOUND, 409 duplicate name/serial, 500)
+   */
+  function update({
+    jwtToken,
+    token,
+    cloverTerminalId,
+    cloverTerminal,
+    headers
+  }) {
+    const _cloverTerminalId = cloverTerminalId || cloverTerminal._id;
+
+    return client({
+      url: `/clover-terminals/${_cloverTerminalId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {
+        cloverTerminal: {
+          name: cloverTerminal.name,
+          serialNumber: cloverTerminal.serialNumber,
+          stationId: cloverTerminal.stationId
+        }
+      }
+    });
+  }
+
+  return {
+    all,
+    get,
+    create,
+    remove,
+    update
+  };
+}
+
+module.exports = cloverTerminalFactory;

package/test/all.test.js

@@ -98,6 +98,7 @@ 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/clover-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/clover-terminals.test.js

@@ -0,0 +1,256 @@
+describe("inventory/clover-terminals", () => {
+  const assert = require("node:assert/strict");
+  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 Clover terminals", () => {
+    const query = {page: 2, stationId: "5f243d100617680712e78dd7", serialNumber: "DEV-001"};
+
+    axiosMock.onGet("/clover-terminals", {params: query}).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.cloverTerminals.all({
+      jwtToken,
+      token,
+      query
+    });
+  });
+
+  it("should retrieve an existing Clover terminal by id", () => {
+    const cloverTerminalId = "1234123412341234";
+
+    axiosMock.onGet(`/clover-terminals/${cloverTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.cloverTerminals.get({
+      jwtToken,
+      token,
+      cloverTerminalId
+    });
+  });
+
+  it("should create a new Clover terminal", async () => {
+    const cloverTerminal = {
+      name: "New Clover Terminal",
+      serialNumber: "Test Serial Number"
+    };
+
+    axiosMock.onPost("/clover-terminals").reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {cloverTerminal}
+    }));
+
+    return api.inventory.cloverTerminals.create({
+      jwtToken,
+      token,
+      cloverTerminal
+    });
+  });
+
+  it("should create a new Clover terminal with stationId (location)", async () => {
+    const cloverTerminal = {
+      name: "Clover Terminal at Station",
+      serialNumber: "SN-001",
+      stationId: "5f243d100617680712e78dd7"
+    };
+
+    axiosMock.onPost("/clover-terminals").reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {cloverTerminal}
+    }));
+
+    return api.inventory.cloverTerminals.create({
+      jwtToken,
+      token,
+      cloverTerminal
+    });
+  });
+
+  it("should delete a Clover terminal", () => {
+    const cloverTerminalId = "1234";
+
+    axiosMock.onDelete(`/clover-terminals/${cloverTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+
+    return api.inventory.cloverTerminals.remove({
+      jwtToken,
+      token,
+      cloverTerminalId
+    });
+  });
+
+  it("should update an existing Clover terminal", async () => {
+    const cloverTerminal = {
+      _id: "terminal-id-123",
+      name: "Updated Clover Terminal",
+      serialNumber: "Updated Serial Number"
+    };
+
+    const cloverTerminalFieldsToUpdate = {
+      name: cloverTerminal.name,
+      serialNumber: cloverTerminal.serialNumber,
+      stationId: cloverTerminal.stationId
+    };
+
+    axiosMock.onPut(`/clover-terminals/${cloverTerminal._id}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: {cloverTerminal: cloverTerminalFieldsToUpdate}
+    }));
+
+    return api.inventory.cloverTerminals.update({
+      jwtToken,
+      token,
+      cloverTerminal
+    });
+  });
+
+  it("should update an existing Clover terminal with stationId (location)", async () => {
+    const cloverTerminalId = "terminal-id-456";
+    const cloverTerminal = {
+      _id: cloverTerminalId,
+      name: "Terminal at Station",
+      serialNumber: "SN-789",
+      stationId: "5f243d100617680712e78dd7"
+    };
+
+    const expectedBody = {
+      cloverTerminal: {
+        name: cloverTerminal.name,
+        serialNumber: cloverTerminal.serialNumber,
+        stationId: cloverTerminal.stationId
+      }
+    };
+
+    axiosMock.onPut(`/clover-terminals/${cloverTerminalId}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: expectedBody
+    }));
+
+    return api.inventory.cloverTerminals.update({
+      jwtToken,
+      token,
+      cloverTerminalId,
+      cloverTerminal
+    });
+  });
+
+  it("should update an existing Clover terminal with empty stationId", async () => {
+    const cloverTerminal = {
+      _id: "terminal-id-999",
+      name: "Terminal No Location",
+      serialNumber: "SN-999",
+      stationId: ""
+    };
+
+    const expectedBody = {
+      cloverTerminal: {
+        name: cloverTerminal.name,
+        serialNumber: cloverTerminal.serialNumber,
+        stationId: ""
+      }
+    };
+
+    axiosMock.onPut(`/clover-terminals/${cloverTerminal._id}`).reply(expectRequest({
+      statusCode: 200, token, jwtToken, body: expectedBody
+    }));
+
+    return api.inventory.cloverTerminals.update({
+      jwtToken,
+      token,
+      cloverTerminal
+    });
+  });
+
+  it("should reject when Clover terminal is not found", async () => {
+    const cloverTerminalId = "5f243d100617680712e78dd7";
+
+    axiosMock.onGet(`/clover-terminals/${cloverTerminalId}`).reply(404, {
+      code: "CLOVER_TERMINAL_NOT_FOUND"
+    });
+
+    await assert.rejects(
+      () => {
+        return api.inventory.cloverTerminals.get({jwtToken, token, cloverTerminalId});
+      },
+      (err) => {
+        assert.equal(err.response.status, 404);
+        assert.equal(err.response.data.code, "CLOVER_TERMINAL_NOT_FOUND");
+        return true;
+      }
+    );
+  });
+
+  it("should reject when Clover terminal id is invalid", async () => {
+    const cloverTerminalId = "not-an-object-id";
+
+    axiosMock.onGet(`/clover-terminals/${cloverTerminalId}`).reply(400, {
+      code: "INVALID_CLOVER_TERMINAL_ID"
+    });
+
+    await assert.rejects(
+      () => {
+        return api.inventory.cloverTerminals.get({jwtToken, token, cloverTerminalId});
+      },
+      (err) => {
+        assert.equal(err.response.status, 400);
+        assert.equal(err.response.data.code, "INVALID_CLOVER_TERMINAL_ID");
+        return true;
+      }
+    );
+  });
+
+  it("should reject when Clover terminal name is duplicated", async () => {
+    const cloverTerminal = {
+      name: "Duplicate Name",
+      serialNumber: "SN-UNIQUE"
+    };
+
+    axiosMock.onPost("/clover-terminals").reply(409, {
+      code: "DUPLICATED_CLOVER_TERMINAL_NAME"
+    });
+
+    await assert.rejects(
+      () => {
+        return api.inventory.cloverTerminals.create({jwtToken, token, cloverTerminal});
+      },
+      (err) => {
+        assert.equal(err.response.status, 409);
+        assert.equal(err.response.data.code, "DUPLICATED_CLOVER_TERMINAL_NAME");
+        return true;
+      }
+    );
+  });
+
+  it("should reject when Clover terminal serial number is duplicated", async () => {
+    const cloverTerminal = {
+      name: "Unique Name",
+      serialNumber: "SN-DUPLICATE"
+    };
+
+    axiosMock.onPost("/clover-terminals").reply(409, {
+      code: "DUPLICATE_CLOVER_TERMINAL_SERIAL_NUMBER"
+    });
+
+    await assert.rejects(
+      () => {
+        return api.inventory.cloverTerminals.create({jwtToken, token, cloverTerminal});
+      },
+      (err) => {
+        assert.equal(err.response.status, 409);
+        assert.equal(err.response.data.code, "DUPLICATE_CLOVER_TERMINAL_SERIAL_NUMBER");
+        return true;
+      }
+    );
+  });
+});