btrz-api-client 8.16.0 → 8.18.0

package/lib/client.js

@@ -121,6 +121,7 @@ function createInventory(_ref) {
     travellerCardProvidersTypes: require("./endpoints/inventory/traveller-card-providers-types.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     travellerCardTypes: require("./endpoints/inventory/traveller-card-types.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     travelRoutes: require("./endpoints/inventory/travel-routes.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
+    vehicleTypes: require("./endpoints/inventory/vehicle-types.js")({ client: client, internalAuthTokenProvider: internalAuthTokenProvider }),
     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 }),

package/lib/endpoints/accounts/lexicons.js

@@ -180,6 +180,29 @@ function lexiconsFactory(_ref) {
     },
 
 
+    /**
+     * Delete a lexicon suggestion by id. Only suggestions with status "under 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/vehicle-types.js

@@ -0,0 +1,36 @@
+"use strict";
+
+var _require = require("../endpoints_helpers.js"),
+    authorizationHeaders = _require.authorizationHeaders;
+
+function vehicleTypesFactory(_ref) {
+  var client = _ref.client,
+      internalAuthTokenProvider = _ref.internalAuthTokenProvider;
+
+  /**
+   * GET all vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
+   * Used when configuring schedule vehicle type or displaying vehicle type in trips/manifests.
+   * @param {Object} opts
+   * @param {string} opts.token - API key token
+   * @param {Object} [opts.query] - Optional query params
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<{data: {vehicleTypes: Array<{_id: string, name: string}>}}>}
+   */
+  function all(_ref2) {
+    var token = _ref2.token,
+        _ref2$query = _ref2.query,
+        query = _ref2$query === undefined ? {} : _ref2$query,
+        headers = _ref2.headers;
+
+    return client.get("/vehicle-types", {
+      params: query,
+      headers: authorizationHeaders({ token: token, internalAuthTokenProvider: internalAuthTokenProvider, headers: headers })
+    });
+  }
+
+  return {
+    all: all
+  };
+}
+
+module.exports = vehicleTypesFactory;

package/package.json

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

package/src/client.js

@@ -108,6 +108,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     travellerCardProvidersTypes: require("./endpoints/inventory/traveller-card-providers-types.js")({client, internalAuthTokenProvider}),
     travellerCardTypes: require("./endpoints/inventory/traveller-card-types.js")({client, internalAuthTokenProvider}),
     travelRoutes: require("./endpoints/inventory/travel-routes.js")({client, internalAuthTokenProvider}),
+    vehicleTypes: require("./endpoints/inventory/vehicle-types.js")({client, internalAuthTokenProvider}),
     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}),

package/src/endpoints/accounts/lexicons.js

@@ -147,6 +147,23 @@ function lexiconsFactory({
       });
     },
 
+    /**
+     * Delete a lexicon suggestion by id. Only suggestions with status "under 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/vehicle-types.js

@@ -0,0 +1,27 @@
+const {
+  authorizationHeaders
+} = require("../endpoints_helpers.js");
+
+function vehicleTypesFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET all vehicle types (e.g. Bus, Shuttle, Van, Train, Ferry, Tram).
+   * Used when configuring schedule vehicle type or displaying vehicle type in trips/manifests.
+   * @param {Object} opts
+   * @param {string} opts.token - API key token
+   * @param {Object} [opts.query] - Optional query params
+   * @param {Object} [opts.headers] - Optional request headers
+   * @returns {Promise<{data: {vehicleTypes: Array<{_id: string, name: string}>}}>}
+   */
+  function all({token, query = {}, headers}) {
+    return client.get("/vehicle-types", {
+      params: query,
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {
+    all
+  };
+}
+
+module.exports = vehicleTypesFactory;

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

@@ -120,11 +120,11 @@ describe("accounts/lexicons", () => {
       axiosMock.onGet("/lexicons/suggestions").reply(expectRequest({
         statusCode: 200,
         token,
-        query: {status: "for review"}
+        query: {status: "under review"}
       }));
       return api.accounts.lexicons.suggestions.list({
         token,
-        params: {status: "for review"}
+        params: {status: "under review"}
       });
     });
 
@@ -173,5 +173,19 @@ describe("accounts/lexicons", () => {
         superUserHash: "hash1"
       });
     });
+
+    it("should delete lexicon suggestion (when status is under 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/types/client.d.ts

@@ -2078,6 +2078,20 @@ export function createApiClient(options: {
                 headers: any;
             }) => any;
         };
+        vehicleTypes: {
+            all: ({ token, query, headers }: {
+                token: string;
+                query?: any;
+                headers?: any;
+            }) => Promise<{
+                data: {
+                    vehicleTypes: Array<{
+                        _id: string;
+                        name: string;
+                    }>;
+                };
+            }>;
+        };
         vehicles: {
             all: ({ token, query, headers }: {
                 token: any;
@@ -2665,6 +2679,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 "under 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/vehicle-types.d.ts

@@ -0,0 +1,18 @@
+export = vehicleTypesFactory;
+declare function vehicleTypesFactory({ client, internalAuthTokenProvider }: {
+    client: any;
+    internalAuthTokenProvider: any;
+}): {
+    all: ({ token, query, headers }: {
+        token: string;
+        query?: any;
+        headers?: any;
+    }) => Promise<{
+        data: {
+            vehicleTypes: Array<{
+                _id: string;
+                name: string;
+            }>;
+        };
+    }>;
+};

package/types/initializedClient.d.ts

@@ -2032,6 +2032,20 @@ declare const _exports: {
                 headers: any;
             }) => any;
         };
+        vehicleTypes: {
+            all: ({ token, query, headers }: {
+                token: string;
+                query?: any;
+                headers?: any;
+            }) => Promise<{
+                data: {
+                    vehicleTypes: Array<{
+                        _id: string;
+                        name: string;
+                    }>;
+                };
+            }>;
+        };
         vehicles: {
             all: ({ token, query, headers }: {
                 token: any;
@@ -2619,6 +2633,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;