btrz-api-client 8.57.0 → 8.58.0

package/lib/client.js

@@ -143,6 +143,7 @@ function createInventory(_ref) {
     vehicles: require("./endpoints/inventory/vehicles.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     zonePriceOverages: require("./endpoints/inventory/zone-price-overages.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     zonePrices: require("./endpoints/inventory/zone-prices.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    regions: require("./endpoints/inventory/regions.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     __test: {
       client: client
     }

package/lib/endpoints/inventory/regions.js

@@ -0,0 +1,144 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+/**
+ * Factory for regions API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
+
+
+function regionsFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET /regions - list regions (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params (page, name, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all(_ref2) {
+    var token = _ref2.token,
+        jwtToken = _ref2.jwtToken,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client({
+      url: "/regions",
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  /**
+   * GET /regions/:regionId - get region by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        regionId = _ref3.regionId,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/regions/" + regionId,
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * PUT /regions/:regionId - update region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} opts.data - Region payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        regionId = _ref4.regionId,
+        data = _ref4.data,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/regions/" + regionId,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  /**
+   * DELETE /regions/:regionId - delete region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        regionId = _ref5.regionId,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/regions/" + regionId,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  /**
+   * POST /regions - create region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Region payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        data = _ref6.data,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/regions",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      data: data
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    update: update,
+    remove: remove,
+    create: create
+  };
+}
+
+module.exports = regionsFactory;

package/package.json

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

package/src/client.js

@@ -128,6 +128,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     vehicles: require("./endpoints/inventory/vehicles.js")({client, internalAuthTokenProvider}),
     zonePriceOverages: require("./endpoints/inventory/zone-price-overages.js")({client, internalAuthTokenProvider}),
     zonePrices: require("./endpoints/inventory/zone-prices.js")({client, internalAuthTokenProvider}),
+    regions: require("./endpoints/inventory/regions.js")({client, internalAuthTokenProvider}),
     __test: {
       client
     }

package/src/endpoints/inventory/regions.js

@@ -0,0 +1,109 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+/**
+ * Factory for regions API (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ all: function, get: function, update: function, remove: function, create: function }}
+ */
+function regionsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /regions - list regions (paginated).
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} [opts.query] - Query params (page, name, enabled)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/regions",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  /**
+   * GET /regions/:regionId - get region by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({token, jwtToken, regionId, headers}) {
+    return client({
+      url: `/regions/${regionId}`,
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * PUT /regions/:regionId - update region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} opts.data - Region payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function update({token, jwtToken, regionId, data, headers}) {
+    return client({
+      url: `/regions/${regionId}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  /**
+   * DELETE /regions/:regionId - delete region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.regionId - Region id
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function remove({token, jwtToken, regionId, headers}) {
+    return client({
+      url: `/regions/${regionId}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
+  /**
+   * POST /regions - create region.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {Object} opts.data - Region payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function create({token, jwtToken, data, headers}) {
+    return client({
+      url: "/regions",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data
+    });
+  }
+
+  return {
+    all,
+    get,
+    update,
+    remove,
+    create
+  };
+}
+
+module.exports = regionsFactory;

package/test/endpoints/inventory/regions.test.js

@@ -0,0 +1,50 @@
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("inventory/regions", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.restore();
+  });
+
+  it("should list regions", () => {
+    axiosMock.onGet("/regions").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.regions.all({token, jwtToken});
+  });
+
+  it("should get a region", () => {
+    const regionId = "123123123123";
+    axiosMock.onGet(`/regions/${regionId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.regions.get({token, jwtToken, regionId});
+  });
+
+  it("should create a region", () => {
+    axiosMock.onPost("/regions").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.regions.create({
+      jwtToken,
+      token,
+      data: {
+        name: "North",
+        enabled: true
+      }
+    });
+  });
+
+  it("should update a region", () => {
+    const regionId = "123123123123";
+    const data = {
+      name: "North",
+      enabled: false
+    };
+    axiosMock.onPut(`/regions/${regionId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.regions.update({jwtToken, token, regionId, data});
+  });
+
+  it("should delete a region", () => {
+    const regionId = "123123123123";
+    axiosMock.onDelete(`/regions/${regionId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.regions.remove({jwtToken, token, regionId});
+  });
+});