btrz-api-client 9.2.0 → 9.3.0

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/package.json

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

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/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",