btrz-api-client 9.25.0 → 9.27.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/lib/endpoints/reports/custom-reports.js

@@ -15,7 +15,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ create: function, all: function, remove: function }}
+ * @returns {{ create: function, all: function, get: function, update: function, remove: function }}
  */
 function customReportsFactory({
   client,
@@ -78,6 +78,65 @@ function customReportsFactory({
     });
   }
 
+  /**
+   * GET /custom-report/:customReportId - get one custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({
+    token,
+    jwtToken,
+    customReportId,
+    headers
+  }) {
+    return client({
+      url: `/custom-report/${customReportId}`,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
+  /**
+   * PUT /custom-reports/:customReportId - update a custom report.
+   * Today the API only accepts deliveryMethod inside customReport.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} opts.customReport - Fields to update
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({
+    token,
+    jwtToken,
+    customReportId,
+    customReport,
+    headers
+  }) {
+    return client({
+      url: `/custom-reports/${customReportId}`,
+      method: "put",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: {
+        customReport
+      }
+    });
+  }
+
   /**
    * DELETE /custom-reports/:customReportId - remove custom report.
    * @param {Object} opts
@@ -107,6 +166,8 @@ function customReportsFactory({
   return {
     create,
     all,
+    get,
+    update,
     remove
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.25.0",
+  "version": "9.27.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/src/endpoints/reports/custom-reports.js

@@ -13,7 +13,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ create: function, all: function, remove: function }}
+ * @returns {{ create: function, all: function, get: function, update: function, remove: function }}
  */
 function customReportsFactory({client, internalAuthTokenProvider}) {
   /**
@@ -51,6 +51,42 @@ function customReportsFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /custom-report/:customReportId - get one custom report.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, customReportId, headers}) {
+    return client({
+      url: `/custom-report/${customReportId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /custom-reports/:customReportId - update a custom report.
+   * Today the API only accepts deliveryMethod inside customReport.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customReportId - Custom report id
+   * @param {Object} opts.customReport - Fields to update
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, customReportId, customReport, headers}) {
+    return client({
+      url: `/custom-reports/${customReportId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: {customReport}
+    });
+  }
+
   /**
    * DELETE /custom-reports/:customReportId - remove custom report.
    * @param {Object} opts
@@ -71,6 +107,8 @@ function customReportsFactory({client, internalAuthTokenProvider}) {
   return {
     create,
     all,
+    get,
+    update,
     remove
   };
 }

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");