@elasticpath/js-sdk 24.3.3 → 25.0.0

package/dist/index.cjs.js

@@ -530,7 +530,7 @@ if (!globalThis.fetch) {
   globalThis.Response = fetch$1.Response;
 }
 
-var version = "24.3.3";
+var version = "25.0.0";
 
 var LocalStorageFactory = /*#__PURE__*/function () {
   function LocalStorageFactory() {
@@ -723,6 +723,9 @@ function formatQueryString(key, value) {
   if (key === 'limit' || key === 'offset') {
     return "page".concat(value);
   }
+  if (key === 'total_method') {
+    return "page[total_method]=".concat(value);
+  }
   if (key === 'filter') {
     var filterValues = [];
 
@@ -822,7 +825,8 @@ function buildQueryParams(_ref) {
     limit = _ref.limit,
     offset = _ref.offset,
     filter = _ref.filter,
-    useTemplateSlugs = _ref.useTemplateSlugs;
+    useTemplateSlugs = _ref.useTemplateSlugs,
+    total_method = _ref.total_method;
   var query = {};
   if (includes) {
     query.include = includes;
@@ -830,7 +834,7 @@ function buildQueryParams(_ref) {
   if (sort) {
     query.sort = "".concat(sort);
   }
-  if (limit) {
+  if (limit !== undefined && limit !== null) {
     query.limit = "[limit]=".concat(limit);
   }
   if (offset) {
@@ -842,6 +846,9 @@ function buildQueryParams(_ref) {
   if (useTemplateSlugs) {
     query.useTemplateSlugs = useTemplateSlugs;
   }
+  if (total_method) {
+    query.total_method = total_method;
+  }
   return Object.keys(query).map(function (k) {
     return formatQueryString(k, query[k]);
   }).join('&');
@@ -852,7 +859,7 @@ function formatQueryParams(query) {
   }).join('&');
 }
 function buildURL(endpoint, params) {
-  if (params.includes || params.sort || params.limit || params.offset || params.filter || params.useTemplateSlugs) {
+  if (params.includes || params.sort || params.limit !== undefined && params.limit !== null || params.offset || params.filter || params.useTemplateSlugs || params.total_method) {
     var paramsString = buildQueryParams(params);
     return "".concat(endpoint, "?").concat(paramsString);
   }
@@ -2206,6 +2213,34 @@ var CustomersEndpoint = /*#__PURE__*/function (_CRUDExtend) {
     value: function Token(email, password) {
       return this.TokenViaPassword(email, password);
     }
+  }, {
+    key: "TotalMethod",
+    value: function TotalMethod(totalMethod) {
+      this.total_method = totalMethod;
+      return this;
+    }
+  }, {
+    key: "All",
+    value: function All() {
+      var token = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+      var includes = this.includes,
+        sort = this.sort,
+        limit = this.limit,
+        offset = this.offset,
+        filter = this.filter,
+        total_method = this.total_method;
+      this.call = this.request.send(buildURL(this.endpoint, _objectSpread2({
+        includes: includes,
+        sort: sort,
+        limit: limit,
+        offset: offset,
+        filter: filter
+      }, total_method && {
+        total_method: total_method
+      })), 'GET', undefined, token, this);
+      this.total_method = undefined;
+      return this.call;
+    }
   }]);
   return CustomersEndpoint;
 }(CRUDExtend);

package/dist/index.d.ts

@@ -176,6 +176,7 @@ interface ResourcePage<R, I = never> extends ResourceList<R> {
     }
     results: {
       total: number
+      total_method?: 'observed' | 'exact'
     }
   }
   included?: I
@@ -2714,6 +2715,14 @@ 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
 }
 
 /**

package/dist/index.esm.js

@@ -519,7 +519,7 @@ if (!globalThis.fetch) {
   globalThis.Response = Response;
 }
 
-var version = "24.3.3";
+var version = "25.0.0";
 
 var LocalStorageFactory = /*#__PURE__*/function () {
   function LocalStorageFactory() {
@@ -712,6 +712,9 @@ function formatQueryString(key, value) {
   if (key === 'limit' || key === 'offset') {
     return "page".concat(value);
   }
+  if (key === 'total_method') {
+    return "page[total_method]=".concat(value);
+  }
   if (key === 'filter') {
     var filterValues = [];
 
@@ -811,7 +814,8 @@ function buildQueryParams(_ref) {
     limit = _ref.limit,
     offset = _ref.offset,
     filter = _ref.filter,
-    useTemplateSlugs = _ref.useTemplateSlugs;
+    useTemplateSlugs = _ref.useTemplateSlugs,
+    total_method = _ref.total_method;
   var query = {};
   if (includes) {
     query.include = includes;
@@ -819,7 +823,7 @@ function buildQueryParams(_ref) {
   if (sort) {
     query.sort = "".concat(sort);
   }
-  if (limit) {
+  if (limit !== undefined && limit !== null) {
     query.limit = "[limit]=".concat(limit);
   }
   if (offset) {
@@ -831,6 +835,9 @@ function buildQueryParams(_ref) {
   if (useTemplateSlugs) {
     query.useTemplateSlugs = useTemplateSlugs;
   }
+  if (total_method) {
+    query.total_method = total_method;
+  }
   return Object.keys(query).map(function (k) {
     return formatQueryString(k, query[k]);
   }).join('&');
@@ -841,7 +848,7 @@ function formatQueryParams(query) {
   }).join('&');
 }
 function buildURL(endpoint, params) {
-  if (params.includes || params.sort || params.limit || params.offset || params.filter || params.useTemplateSlugs) {
+  if (params.includes || params.sort || params.limit !== undefined && params.limit !== null || params.offset || params.filter || params.useTemplateSlugs || params.total_method) {
     var paramsString = buildQueryParams(params);
     return "".concat(endpoint, "?").concat(paramsString);
   }
@@ -2195,6 +2202,34 @@ var CustomersEndpoint = /*#__PURE__*/function (_CRUDExtend) {
     value: function Token(email, password) {
       return this.TokenViaPassword(email, password);
     }
+  }, {
+    key: "TotalMethod",
+    value: function TotalMethod(totalMethod) {
+      this.total_method = totalMethod;
+      return this;
+    }
+  }, {
+    key: "All",
+    value: function All() {
+      var token = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+      var includes = this.includes,
+        sort = this.sort,
+        limit = this.limit,
+        offset = this.offset,
+        filter = this.filter,
+        total_method = this.total_method;
+      this.call = this.request.send(buildURL(this.endpoint, _objectSpread2({
+        includes: includes,
+        sort: sort,
+        limit: limit,
+        offset: offset,
+        filter: filter
+      }, total_method && {
+        total_method: total_method
+      })), 'GET', undefined, token, this);
+      this.total_method = undefined;
+      return this.call;
+    }
   }]);
   return CustomersEndpoint;
 }(CRUDExtend);

package/dist/index.js

@@ -1085,7 +1085,7 @@
     globalThis.Response = browserPonyfill.exports.Response;
   }
 
-  var version = "24.3.3";
+  var version = "25.0.0";
 
   var LocalStorageFactory = /*#__PURE__*/function () {
     function LocalStorageFactory() {
@@ -1880,6 +1880,9 @@
     if (key === 'limit' || key === 'offset') {
       return "page".concat(value);
     }
+    if (key === 'total_method') {
+      return "page[total_method]=".concat(value);
+    }
     if (key === 'filter') {
       var filterValues = [];
 
@@ -1979,7 +1982,8 @@
       limit = _ref.limit,
       offset = _ref.offset,
       filter = _ref.filter,
-      useTemplateSlugs = _ref.useTemplateSlugs;
+      useTemplateSlugs = _ref.useTemplateSlugs,
+      total_method = _ref.total_method;
     var query = {};
     if (includes) {
       query.include = includes;
@@ -1987,7 +1991,7 @@
     if (sort) {
       query.sort = "".concat(sort);
     }
-    if (limit) {
+    if (limit !== undefined && limit !== null) {
       query.limit = "[limit]=".concat(limit);
     }
     if (offset) {
@@ -1999,6 +2003,9 @@
     if (useTemplateSlugs) {
       query.useTemplateSlugs = useTemplateSlugs;
     }
+    if (total_method) {
+      query.total_method = total_method;
+    }
     return Object.keys(query).map(function (k) {
       return formatQueryString(k, query[k]);
     }).join('&');
@@ -2009,7 +2016,7 @@
     }).join('&');
   }
   function buildURL(endpoint, params) {
-    if (params.includes || params.sort || params.limit || params.offset || params.filter || params.useTemplateSlugs) {
+    if (params.includes || params.sort || params.limit !== undefined && params.limit !== null || params.offset || params.filter || params.useTemplateSlugs || params.total_method) {
       var paramsString = buildQueryParams(params);
       return "".concat(endpoint, "?").concat(paramsString);
     }
@@ -3363,6 +3370,34 @@
       value: function Token(email, password) {
         return this.TokenViaPassword(email, password);
       }
+    }, {
+      key: "TotalMethod",
+      value: function TotalMethod(totalMethod) {
+        this.total_method = totalMethod;
+        return this;
+      }
+    }, {
+      key: "All",
+      value: function All() {
+        var token = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null;
+        var includes = this.includes,
+          sort = this.sort,
+          limit = this.limit,
+          offset = this.offset,
+          filter = this.filter,
+          total_method = this.total_method;
+        this.call = this.request.send(buildURL(this.endpoint, _objectSpread2({
+          includes: includes,
+          sort: sort,
+          limit: limit,
+          offset: offset,
+          filter: filter
+        }, total_method && {
+          total_method: total_method
+        })), 'GET', undefined, token, this);
+        this.total_method = undefined;
+        return this.call;
+      }
     }]);
     return CustomersEndpoint;
   }(CRUDExtend);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elasticpath/js-sdk",
   "description": "SDK for the Elastic Path eCommerce API",
-  "version": "24.3.3",
+  "version": "25.0.0",
   "homepage": "https://github.com/elasticpath/js-sdk",
   "author": "Elastic Path (https://elasticpath.com/)",
   "files": [