feat: allow total_method param in customer endpoint

Author: ellanan

src/endpoints/customers.js

@@ -1,4 +1,5 @@
 import CRUDExtend from '../extends/crud'
+import { buildURL } from '../utils/helpers'
 
 class CustomersEndpoint extends CRUDExtend {
   constructor(endpoint) {
@@ -44,5 +45,33 @@ class CustomersEndpoint extends CRUDExtend {
   Token(email, password) {
     return this.TokenViaPassword(email, password)
   }
+
+  TotalMethod(totalMethod) {
+    this.total_method = totalMethod
+    return this
+  }
+
+  All(token = null) {
+    const { includes, sort, limit, offset, filter, total_method } = this
+
+    this.call = this.request.send(
+      buildURL(this.endpoint, {
+        includes,
+        sort,
+        limit,
+        offset,
+        filter,
+        total_method: total_method ?? 'exact'
+      }),
+      'GET',
+      undefined,
+      token,
+      this
+    )
+
+    this.total_method = undefined
+
+    return this.call
+  }
 }
 export default CustomersEndpoint

src/types/core.d.ts

@@ -61,6 +61,7 @@ export interface ResourcePage<R, I = never> extends ResourceList<R> {
     }
     results: {
       total: number
+      total_method?: 'observed' | 'exact'
     }
   }
   included?: I

src/types/customer.d.ts

@@ -135,4 +135,12 @@ export interface CustomersEndpoint
     codeVerifier: string,
     headers?: object
   ): Promise<Resource<CustomerToken>>
+
+  /**
+   * Total Method
+   * Description: The total method to use for the customer endpoint.
+   * DOCS: https://documentation.elasticpath.com/commerce-cloud/docs/api/orders-and-customers/customers/index.html
+   * @param totalMethod [string] the total method to use for the customer endpoint
+   */
+  TotalMethod(totalMethod: string): this
 }

src/utils/formatQueryString.js

@@ -23,6 +23,10 @@ export function formatQueryString(key, value) {
     return `page${value}`
   }
 
+  if (key === 'total_method') {
+    return `page[total_method]=${value}`
+  }
+
   if (key === 'filter') {
     const filterValues = []
 

src/utils/helpers.js

@@ -90,7 +90,7 @@ export function parseJSON(response) {
   })
 }
 
-function buildQueryParams({ includes, sort, limit, offset, filter, useTemplateSlugs}) {
+function buildQueryParams({ includes, sort, limit, offset, filter, useTemplateSlugs, total_method }) {
   const query = {}
 
   if (includes) {
@@ -117,6 +117,10 @@ function buildQueryParams({ includes, sort, limit, offset, filter, useTemplateSl
     query.useTemplateSlugs = useTemplateSlugs
   }
 
+  if(total_method) {
+    query.total_method = total_method
+  }
+
   return Object.keys(query)
     .map(k => formatQueryString(k, query[k]))
     .join('&')
@@ -135,7 +139,8 @@ export function buildURL(endpoint, params) {
     params.limit ||
     params.offset ||
     params.filter ||
-    params.useTemplateSlugs
+    params.useTemplateSlugs ||
+    params.total_method
   ) {
     const paramsString = buildQueryParams(params)