btrz-api-client 8.15.1 → 8.17.0

package/lib/client.js

@@ -94,6 +94,7 @@ function createInventory(_ref) {
     mitTerminalsSettings: require("./endpoints/inventory/mit-terminal-settings.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     operatingCompanies: require("./endpoints/inventory/operating-companies.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     operationMessages: require("./endpoints/inventory/operation-messages.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    operationReasons: require("./endpoints/inventory/operation-reasons.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     parcelZones: require("./endpoints/inventory/parcel-zones.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     paymentTerminals: require("./endpoints/inventory/payment-terminals.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     payOnAccounts: require("./endpoints/inventory/pay-on-accounts.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),

package/lib/endpoints/accounts/lexicons.js

@@ -180,6 +180,29 @@ function lexiconsFactory(_ref) {
     },
 
 
+    /**
+     * Delete a lexicon suggestion by id. Only suggestions with status "for review" can be deleted.
+     * @param {Object} opts
+     * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion to delete
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<{status: number}>} Resolves with 204 on success
+     */
+    delete: function _delete(_ref10) {
+      var token = _ref10.token,
+          jwtToken = _ref10.jwtToken,
+          headers = _ref10.headers,
+          suggestionId = _ref10.suggestionId;
+
+      return client({
+        url: "/lexicons/suggestions/" + suggestionId,
+        method: "delete",
+        headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+      });
+    },
+
+
     /**
      * Submit a translation suggestion for an existing lexicon key and language.
      * @param {Object} opts
@@ -191,13 +214,13 @@ function lexiconsFactory(_ref) {
      * @param {Object} [opts.headers] - Optional request headers
      * @returns {Promise<{data: Object}>}
      */
-    create: function create(_ref10) {
-      var token = _ref10.token,
-          jwtToken = _ref10.jwtToken,
-          headers = _ref10.headers,
-          key = _ref10.key,
-          lang = _ref10.lang,
-          data = _ref10.data;
+    create: function create(_ref11) {
+      var token = _ref11.token,
+          jwtToken = _ref11.jwtToken,
+          headers = _ref11.headers,
+          key = _ref11.key,
+          lang = _ref11.lang,
+          data = _ref11.data;
 
       return client({
         url: "/lexicons/" + encodeURIComponent(key) + "/" + encodeURIComponent(lang) + "/suggestion",

package/lib/endpoints/inventory/operation-reasons.js

@@ -0,0 +1,101 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function operationReasonFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  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: "/operation-reasons",
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  function get(_ref3) {
+    var token = _ref3.token,
+        jwtToken = _ref3.jwtToken,
+        id = _ref3.id,
+        _ref3$query = _ref3.query,
+        query = _ref3$query === undefined ? {} : _ref3$query,
+        headers = _ref3.headers;
+
+    return client({
+      url: "/operation-reasons/" + id,
+      method: "get",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  function update(_ref4) {
+    var token = _ref4.token,
+        jwtToken = _ref4.jwtToken,
+        id = _ref4.id,
+        operationReason = _ref4.operationReason,
+        _ref4$query = _ref4.query,
+        query = _ref4$query === undefined ? {} : _ref4$query,
+        headers = _ref4.headers;
+
+    return client({
+      url: "/operation-reasons/" + id,
+      method: "put",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query,
+      data: { operationReason: operationReason }
+    });
+  }
+
+  function remove(_ref5) {
+    var token = _ref5.token,
+        jwtToken = _ref5.jwtToken,
+        id = _ref5.id,
+        _ref5$query = _ref5.query,
+        query = _ref5$query === undefined ? {} : _ref5$query,
+        headers = _ref5.headers;
+
+    return client({
+      url: "/operation-reasons/" + id,
+      method: "delete",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query
+    });
+  }
+
+  function create(_ref6) {
+    var token = _ref6.token,
+        jwtToken = _ref6.jwtToken,
+        operationReason = _ref6.operationReason,
+        _ref6$query = _ref6.query,
+        query = _ref6$query === undefined ? {} : _ref6$query,
+        headers = _ref6.headers;
+
+    return client({
+      url: "/operation-reasons",
+      method: "post",
+      headers: authorizationHeaders({ token: token, jwtToken: jwtToken, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers }),
+      params: query,
+      data: { operationReason: operationReason }
+    });
+  }
+
+  return {
+    all: all,
+    get: get,
+    update: update,
+    remove: remove,
+    create: create
+  };
+}
+
+module.exports = operationReasonFactory;

package/package.json

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

package/src/client.js

@@ -81,6 +81,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     mitTerminalsSettings: require("./endpoints/inventory/mit-terminal-settings.js")({client, internalAuthTokenProvider}),
     operatingCompanies: require("./endpoints/inventory/operating-companies.js")({client, internalAuthTokenProvider}),
     operationMessages: require("./endpoints/inventory/operation-messages.js")({client, internalAuthTokenProvider}),
+    operationReasons: require("./endpoints/inventory/operation-reasons.js")({client, internalAuthTokenProvider}),
     parcelZones: require("./endpoints/inventory/parcel-zones.js")({client, internalAuthTokenProvider}),
     paymentTerminals: require("./endpoints/inventory/payment-terminals.js")({client, internalAuthTokenProvider}),
     payOnAccounts: require("./endpoints/inventory/pay-on-accounts.js")({client, internalAuthTokenProvider}),

package/src/endpoints/accounts/lexicons.js

@@ -147,6 +147,23 @@ function lexiconsFactory({
       });
     },
 
+    /**
+     * Delete a lexicon suggestion by id. Only suggestions with status "for review" can be deleted.
+     * @param {Object} opts
+     * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion to delete
+     * @param {string} [opts.token] - API key
+     * @param {string} [opts.jwtToken] - JWT
+     * @param {Object} [opts.headers] - Optional request headers
+     * @returns {Promise<{status: number}>} Resolves with 204 on success
+     */
+    delete({token, jwtToken, headers, suggestionId}) {
+      return client({
+        url: `/lexicons/suggestions/${suggestionId}`,
+        method: "delete",
+        headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+      });
+    },
+
     /**
      * Submit a translation suggestion for an existing lexicon key and language.
      * @param {Object} opts

package/src/endpoints/inventory/operation-reasons.js

@@ -0,0 +1,60 @@
+const {authorizationHeaders} = require("../endpoints_helpers.js");
+
+function operationReasonFactory({client, internalAuthTokenProvider}) {
+  function all({token, jwtToken, query = {}, headers}) {
+    return client({
+      url: "/operation-reasons",
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  function get({token, jwtToken, id, query = {}, headers}) {
+    return client({
+      url: `/operation-reasons/${id}`,
+      method: "get",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  function update({token, jwtToken, id, operationReason, query = {}, headers}) {
+    return client({
+      url: `/operation-reasons/${id}`,
+      method: "put",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query,
+      data: {operationReason}
+    });
+  }
+
+  function remove({token, jwtToken, id, query = {}, headers}) {
+    return client({
+      url: `/operation-reasons/${id}`,
+      method: "delete",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query
+    });
+  }
+
+  function create({token, jwtToken, operationReason, query = {}, headers}) {
+    return client({
+      url: "/operation-reasons",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      params: query,
+      data: {operationReason}
+    });
+  }
+
+  return {
+    all,
+    get,
+    update,
+    remove,
+    create
+  };
+}
+
+module.exports = operationReasonFactory;

package/test/endpoints/accounts/lexicons.test.js

@@ -173,5 +173,19 @@ describe("accounts/lexicons", () => {
         superUserHash: "hash1"
       });
     });
+
+    it("should delete lexicon suggestion (when status is for review)", () => {
+      const suggestionId = "507f1f77bcf86cd799439012";
+      axiosMock.onDelete(`/lexicons/suggestions/${suggestionId}`).reply(expectRequest({
+        statusCode: 204,
+        token,
+        jwtToken
+      }));
+      return api.accounts.lexicons.suggestions.delete({
+        token,
+        jwtToken,
+        suggestionId
+      });
+    });
   });
 });

package/test/endpoints/inventory/operation-reasons.test..js

@@ -0,0 +1,76 @@
+const {
+  axiosMock, expectRequest
+} = require("../../test-helpers.js");
+const api = require("../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("inventory/operation-reasons", () => {
+  const token = "I owe you a token";
+  const jwtToken = "I owe you a JWT token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should create an operation reason", () => {
+    axiosMock.onPost("/operation-reasons").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.operationReasons.create({
+      jwtToken,
+      token,
+      operationReason: {
+        name: "a name",
+        type: "cut",
+        lexiconKeys: {
+          name: {
+            key: "operationreason-name-......",
+            values: {
+              "en-us": "A name",
+              "es-ar": "Un nombre"
+            }
+          }
+        }
+      }
+    });
+  });
+
+  it("should get all operation reasons", () => {
+    axiosMock.onGet("/operation-reasons").reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.operationReasons.all({
+      jwtToken,
+      token,
+      query: {}
+    });
+  });
+
+  it("should update an operation reason", () => {
+    const id = "1234";
+    axiosMock.onPut(`/operation-reasons/${id}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.operationReasons.update({
+      jwtToken,
+      token,
+      id,
+      serviceType: {
+        name: "My Updated label it"
+      }
+    });
+  });
+
+  it("should get an operation reason", () => {
+    const id = "1234";
+    axiosMock.onGet(`/operation-reasons/${id}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.operationReasons.get({
+      jwtToken,
+      token,
+      id
+    });
+  });
+
+  it("should delete an operation reason", () => {
+    const id = "1234";
+    axiosMock.onDelete(`/operation-reasons/${id}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.inventory.operationReasons.remove({
+      jwtToken,
+      token,
+      id
+    });
+  });
+});

package/types/client.d.ts

@@ -1133,6 +1133,43 @@ export function createApiClient(options: {
                 headers: any;
             }) => any;
         };
+        operationReasons: {
+            all: ({ token, jwtToken, query, headers }: {
+                token: any;
+                jwtToken: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            get: ({ token, jwtToken, id, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            update: ({ token, jwtToken, id, operationReason, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                operationReason: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            remove: ({ token, jwtToken, id, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            create: ({ token, jwtToken, operationReason, query, headers }: {
+                token: any;
+                jwtToken: any;
+                operationReason: any;
+                query?: {};
+                headers: any;
+            }) => any;
+        };
         parcelZones: {
             all: ({ token, query, headers }: {
                 token: any;
@@ -2628,6 +2665,14 @@ export function createApiClient(options: {
                 }): Promise<{
                     data: any;
                 }>;
+                delete({ token, jwtToken, headers, suggestionId }: {
+                    suggestionId: string;
+                    token?: string;
+                    jwtToken?: string;
+                    headers?: any;
+                }): Promise<{
+                    status: number;
+                }>;
                 create({ token, jwtToken, headers, key, lang, data }: {
                     key: string;
                     lang: string;

package/types/endpoints/accounts/lexicons.d.ts

@@ -100,6 +100,23 @@ declare function lexiconsFactory({ client, internalAuthTokenProvider }: {
         }): Promise<{
             data: any;
         }>;
+        /**
+         * Delete a lexicon suggestion by id. Only suggestions with status "for review" can be deleted.
+         * @param {Object} opts
+         * @param {string} opts.suggestionId - MongoDB ObjectId of the suggestion to delete
+         * @param {string} [opts.token] - API key
+         * @param {string} [opts.jwtToken] - JWT
+         * @param {Object} [opts.headers] - Optional request headers
+         * @returns {Promise<{status: number}>} Resolves with 204 on success
+         */
+        delete({ token, jwtToken, headers, suggestionId }: {
+            suggestionId: string;
+            token?: string;
+            jwtToken?: string;
+            headers?: any;
+        }): Promise<{
+            status: number;
+        }>;
         /**
          * Submit a translation suggestion for an existing lexicon key and language.
          * @param {Object} opts

package/types/endpoints/inventory/operation-reasons.d.ts

@@ -0,0 +1,41 @@
+export = operationReasonFactory;
+declare function operationReasonFactory({ client, internalAuthTokenProvider }: {
+    client: any;
+    internalAuthTokenProvider: any;
+}): {
+    all: ({ token, jwtToken, query, headers }: {
+        token: any;
+        jwtToken: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    get: ({ token, jwtToken, id, query, headers }: {
+        token: any;
+        jwtToken: any;
+        id: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    update: ({ token, jwtToken, id, operationReason, query, headers }: {
+        token: any;
+        jwtToken: any;
+        id: any;
+        operationReason: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    remove: ({ token, jwtToken, id, query, headers }: {
+        token: any;
+        jwtToken: any;
+        id: any;
+        query?: {};
+        headers: any;
+    }) => any;
+    create: ({ token, jwtToken, operationReason, query, headers }: {
+        token: any;
+        jwtToken: any;
+        operationReason: any;
+        query?: {};
+        headers: any;
+    }) => any;
+};

package/types/initializedClient.d.ts

@@ -1087,6 +1087,43 @@ declare const _exports: {
                 headers: any;
             }) => any;
         };
+        operationReasons: {
+            all: ({ token, jwtToken, query, headers }: {
+                token: any;
+                jwtToken: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            get: ({ token, jwtToken, id, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            update: ({ token, jwtToken, id, operationReason, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                operationReason: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            remove: ({ token, jwtToken, id, query, headers }: {
+                token: any;
+                jwtToken: any;
+                id: any;
+                query?: {};
+                headers: any;
+            }) => any;
+            create: ({ token, jwtToken, operationReason, query, headers }: {
+                token: any;
+                jwtToken: any;
+                operationReason: any;
+                query?: {};
+                headers: any;
+            }) => any;
+        };
         parcelZones: {
             all: ({ token, query, headers }: {
                 token: any;
@@ -2582,6 +2619,14 @@ declare const _exports: {
                 }): Promise<{
                     data: any;
                 }>;
+                delete({ token, jwtToken, headers, suggestionId }: {
+                    suggestionId: string;
+                    token?: string;
+                    jwtToken?: string;
+                    headers?: any;
+                }): Promise<{
+                    status: number;
+                }>;
                 create({ token, jwtToken, headers, key, lang, data }: {
                     key: string;
                     lang: string;