btrz-api-client 9.1.1 → 9.3.0

package/lib/client.js

@@ -135,6 +135,10 @@ function createInventory({
       client,
       internalAuthTokenProvider
     }),
+    events: require("./endpoints/inventory/events.js")({
+      client,
+      internalAuthTokenProvider
+    }),
     externalPasses: require("./endpoints/inventory/external-passes.js")({
       client,
       internalAuthTokenProvider

package/lib/endpoints/accounts/customers.js

@@ -23,7 +23,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ put: function, all: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
+ * @returns {{ put: function, all: function, get: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
  */
 function customersFactory({
   client,
@@ -91,6 +91,32 @@ function customersFactory({
     });
   }
 
+  /**
+   * GET /customers/:customerId - get a customer by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customerId - Customer id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string, customerNumber: string, ... }>>}
+   */
+  function get({
+    customerId,
+    token,
+    jwtToken,
+    headers
+  }) {
+    return client({
+      url: `/customers/${customerId}`,
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+
   /**
    * POST /customer - create a customer. Body: { customer }. If password is included, activation token is created and activation email sent. Side effect: may emit customer.created webhook.
    * @param {Object} opts
@@ -247,6 +273,7 @@ function customersFactory({
   return {
     put,
     all,
+    get,
     create,
     signIn,
     signInCas,

package/lib/endpoints/endpoints_helpers.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 const constants = require("../constants.js");
 
 /**
@@ -45,6 +44,7 @@ function authorizationHeaders({
       });
     }
   } catch (e) {
+    // eslint-disable-next-line no-console
     console.log(e);
   }
   return _headers;

package/lib/endpoints/inventory/events.js

@@ -0,0 +1,41 @@
+const {
+  authorizationHeaders
+} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for inventory event endpoint (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function eventsFactory({
+  client,
+  internalAuthTokenProvider
+}) {
+  /**
+   * GET /event/:eventId - get event by id.
+   * @param {Object} opts
+   * @param {string} opts.eventId - Event id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({
+    eventId,
+    token,
+    headers
+  }) {
+    return client.get(`/event/${eventId}`, {
+      headers: authorizationHeaders({
+        token,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
+  return {
+    get
+  };
+}
+module.exports = eventsFactory;

package/lib/endpoints/inventory/parcel-zones.js

@@ -13,7 +13,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, create: function, update: function }}
+ * @returns {{ all: function, create: function, update: function, bucket: function }}
  */
 function parcelZonesFactory({
   client,
@@ -103,10 +103,34 @@ function parcelZonesFactory({
       }
     });
   }
+
+  /**
+   * GET /parcel-zones/bucket - get matching parcel bucket.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params for bucket lookup
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function bucket({
+    token,
+    query = {},
+    headers
+  }) {
+    return client.get("/parcel-zones/bucket", {
+      params: query,
+      headers: authorizationHeaders({
+        token,
+        internalAuthTokenProvider,
+        headers
+      })
+    });
+  }
   return {
     all,
     create,
-    update
+    update,
+    bucket
   };
 }
 module.exports = parcelZonesFactory;

package/lib/endpoints/inventory/zone-prices.js

@@ -17,7 +17,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, forParcels: function }}
  */
 function zonePriceFactory({
   client,
@@ -156,12 +156,41 @@ function zonePriceFactory({
       }
     });
   }
+
+  /**
+   * POST /zone-prices-for-parcels - calculate zone prices for parcel payload.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.payload - Parcel pricing payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function forParcels({
+    jwtToken,
+    token,
+    payload,
+    headers
+  }) {
+    return client({
+      url: "/zone-prices-for-parcels",
+      method: "post",
+      headers: authorizationHeaders({
+        token,
+        jwtToken,
+        internalAuthTokenProvider,
+        headers
+      }),
+      data: payload
+    });
+  }
   return {
     all,
     get,
     create,
     update,
-    remove
+    remove,
+    forParcels
   };
 }
 module.exports = zonePriceFactory;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "btrz-api-client",
-  "version": "9.1.1",
+  "version": "9.3.0",
   "description": "Api client for Betterez endpoints",
   "main": "index.js",
   "scripts": {
@@ -14,7 +14,8 @@
     "transpile": "node ./node_modules/@babel/cli/bin/babel.js -d lib/ src/",
     "preversion": "npm test && npm run transpile && npm run esbuild && npm run commit-transpile",
     "postversion": "git push origin master && git push --tags",
-    "version": "git tag $1"
+    "version": "git tag $1",
+    "prepare": "git config core.hooksPath .githooks"
   },
   "repository": {
     "type": "git",

package/src/client.js

@@ -72,6 +72,7 @@ function createInventory({baseURL, headers, timeout, overrideFn, internalAuthTok
     customFields: require("./endpoints/inventory/custom-fields.js")({client, internalAuthTokenProvider}),
     docs: require("./endpoints/inventory/docs.js")({client}),
     documentTypes: require("./endpoints/inventory/document-types.js")({client, internalAuthTokenProvider}),
+    events: require("./endpoints/inventory/events.js")({client, internalAuthTokenProvider}),
     externalPasses: require("./endpoints/inventory/external-passes.js")({client, internalAuthTokenProvider}),
     externalWallets: require("./endpoints/inventory/external-wallets.js")({client, internalAuthTokenProvider}),
     fareTypeModifiers: require("./endpoints/inventory/fare-type-modifiers.js")({client, internalAuthTokenProvider}),

package/src/endpoints/accounts/customers.js

@@ -18,7 +18,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ put: function, all: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
+ * @returns {{ put: function, all: function, get: function, create: function, signIn: function, signInCas: function, update: function, merge: function }}
  */
 function customersFactory({client, internalAuthTokenProvider}) {
   /**
@@ -59,6 +59,22 @@ function customersFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /customers/:customerId - get a customer by id.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} opts.customerId - Customer id (24-char hex ObjectId)
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse<{ _id: string, customerNumber: string, ... }>>}
+   */
+  function get({customerId, token, jwtToken, headers}) {
+    return client({
+      url: `/customers/${customerId}`,
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers})
+    });
+  }
+
   /**
    * POST /customer - create a customer. Body: { customer }. If password is included, activation token is created and activation email sent. Side effect: may emit customer.created webhook.
    * @param {Object} opts
@@ -168,6 +184,7 @@ function customersFactory({client, internalAuthTokenProvider}) {
   return {
     put,
     all,
+    get,
     create,
     signIn,
     signInCas,

package/src/endpoints/endpoints_helpers.js

@@ -1,4 +1,3 @@
-/* eslint-disable max-len */
 const constants = require("../constants.js");
 
 /**
@@ -47,6 +46,7 @@ function authorizationHeaders({
       });
     }
   } catch (e) {
+    // eslint-disable-next-line no-console
     console.log(e);
   }
 

package/src/endpoints/inventory/events.js

@@ -0,0 +1,28 @@
+const {authorizationHeaders} = require("./../endpoints_helpers.js");
+
+/**
+ * Factory for inventory event endpoint (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+function eventsFactory({client, internalAuthTokenProvider}) {
+  /**
+   * GET /event/:eventId - get event by id.
+   * @param {Object} opts
+   * @param {string} opts.eventId - Event id
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function get({eventId, token, headers}) {
+    return client.get(`/event/${eventId}`, {
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
+  return {get};
+}
+
+module.exports = eventsFactory;

package/src/endpoints/inventory/parcel-zones.js

@@ -11,7 +11,7 @@ const {authorizationHeaders} = require("./../endpoints_helpers.js");
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, create: function, update: function }}
+ * @returns {{ all: function, create: function, update: function, bucket: function }}
  */
 function parcelZonesFactory({client, internalAuthTokenProvider}) {
   /**
@@ -66,10 +66,26 @@ function parcelZonesFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * GET /parcel-zones/bucket - get matching parcel bucket.
+   * @param {Object} opts
+   * @param {string} [opts.token] - API key
+   * @param {Object} [opts.query] - Query params for bucket lookup
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function bucket({token, query = {}, headers}) {
+    return client.get("/parcel-zones/bucket", {
+      params: query,
+      headers: authorizationHeaders({token, internalAuthTokenProvider, headers})
+    });
+  }
+
   return {
     all,
     create,
-    update
+    update,
+    bucket
   };
 }
 

package/src/endpoints/inventory/zone-prices.js

@@ -17,7 +17,7 @@ const {
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, forParcels: function }}
  */
 function zonePriceFactory({client, internalAuthTokenProvider}) {
   /**
@@ -111,12 +111,31 @@ function zonePriceFactory({client, internalAuthTokenProvider}) {
     });
   }
 
+  /**
+   * POST /zone-prices-for-parcels - calculate zone prices for parcel payload.
+   * @param {Object} opts
+   * @param {string} [opts.jwtToken] - JWT or internal auth symbol
+   * @param {string} [opts.token] - API key
+   * @param {Object} opts.payload - Parcel pricing payload
+   * @param {Object} [opts.headers] - Optional headers
+   * @returns {Promise<import("axios").AxiosResponse>}
+   */
+  function forParcels({jwtToken, token, payload, headers}) {
+    return client({
+      url: "/zone-prices-for-parcels",
+      method: "post",
+      headers: authorizationHeaders({token, jwtToken, internalAuthTokenProvider, headers}),
+      data: payload
+    });
+  }
+
   return {
     all,
     get,
     create,
     update,
-    remove
+    remove,
+    forParcels
   };
 }
 

package/test/endpoints/accounts/customers.js

@@ -29,6 +29,12 @@ describe("accounts/customers", () => {
     return api.accounts.customers.all({jwtToken, token, query});
   });
 
+  it("should GET a customer by id", () => {
+    const customerId = "66f6d6d5f57d8b6eb95a1122";
+    axiosMock.onGet(`/customers/${customerId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
+    return api.accounts.customers.get({jwtToken, token, customerId});
+  });
+
   it("should POST a customer", () => {
     const customer = {
       firstName: "someFirstName",

package/test/endpoints/inventory/events.test.js

@@ -0,0 +1,19 @@
+const {axiosMock, expectRequest} = require("./../../test-helpers.js");
+const api = require("./../../../src/client.js").createApiClient({baseURL: "http://test.com"});
+
+describe("inventory/events", () => {
+  const token = "I owe you a token";
+
+  afterEach(() => {
+    axiosMock.reset();
+  });
+
+  it("should get an event by id", () => {
+    const eventId = "event123";
+    axiosMock.onGet(`/event/${eventId}`).reply(expectRequest({statusCode: 200, token}));
+    return api.inventory.events.get({
+      token,
+      eventId
+    });
+  });
+});

package/test/endpoints/inventory/parcel-zones.test.js

@@ -24,4 +24,17 @@ describe("inventory/parcel-zones", () => {
     axiosMock.onPut(`/parcel-zone/${parcelZoneId}`).reply(expectRequest({statusCode: 200, token, jwtToken}));
     return api.inventory.parcelZones.update({jwtToken, token, parcelZoneId, parcelZone: {productId: "6789"}});
   });
+
+  it("should get bucket for parcel zone", () => {
+    axiosMock.onGet("/parcel-zones/bucket").reply(expectRequest({statusCode: 200, token}));
+    return api.inventory.parcelZones.bucket({
+      token,
+      query: {
+        productId: "product1",
+        fromId: "origin1",
+        toId: "destination1",
+        faresAndWeights: "[{\"fare\":\"adult\",\"weight\":1000}]"
+      }
+    });
+  });
 });

package/test/endpoints/inventory/zone-prices.test.js

@@ -73,4 +73,21 @@ describe("inventory/zone-prices", () => {
       zonePriceId
     });
   });
+
+  it("should get zone prices for parcels", () => {
+    const payload = {
+      providerId: "provider1",
+      originId: "origin1",
+      destinationId: "destination1",
+      productId: "product1"
+    };
+    axiosMock.onPost("/zone-prices-for-parcels").reply(expectRequest({
+      statusCode: 200, token, jwtToken
+    }));
+    return api.inventory.zonePrices.forParcels({
+      jwtToken,
+      token,
+      payload
+    });
+  });
 });

package/types/endpoints/inventory/events.d.ts

@@ -0,0 +1,16 @@
+export = eventsFactory;
+/**
+ * Factory for inventory event endpoint (btrz-api-inventory).
+ * @param {Object} deps
+ * @param {import("axios").AxiosInstance} deps.client
+ * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
+ * @returns {{ get: function }}
+ */
+declare function eventsFactory({ client, internalAuthTokenProvider }: {
+    client: import("axios").AxiosInstance;
+    internalAuthTokenProvider?: {
+        getToken: () => string;
+    };
+}): {
+    get: Function;
+};

package/types/endpoints/inventory/parcel-zones.d.ts

@@ -8,7 +8,7 @@ export = parcelZonesFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, create: function, update: function }}
+ * @returns {{ all: function, create: function, update: function, bucket: function }}
  */
 declare function parcelZonesFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -19,6 +19,7 @@ declare function parcelZonesFactory({ client, internalAuthTokenProvider }: {
     all: Function;
     create: Function;
     update: Function;
+    bucket: Function;
 };
 declare namespace parcelZonesFactory {
     export { InventoryParcelZonesQuery };

package/types/endpoints/inventory/zone-prices.d.ts

@@ -8,7 +8,7 @@ export = zonePriceFactory;
  * @param {Object} deps
  * @param {import("axios").AxiosInstance} deps.client
  * @param {{ getToken: function(): string }} [deps.internalAuthTokenProvider]
- * @returns {{ all: function, get: function, create: function, update: function, remove: function }}
+ * @returns {{ all: function, get: function, create: function, update: function, remove: function, forParcels: function }}
  */
 declare function zonePriceFactory({ client, internalAuthTokenProvider }: {
     client: import("axios").AxiosInstance;
@@ -21,6 +21,7 @@ declare function zonePriceFactory({ client, internalAuthTokenProvider }: {
     create: Function;
     update: Function;
     remove: Function;
+    forParcels: Function;
 };
 declare namespace zonePriceFactory {
     export { InventoryZonePricesQuery };