@teemill/platform 0.12.3 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @teemill/platform@0.12.3
1
+ ## @teemill/platform@0.13.0
2
2
 
3
3
  This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @teemill/platform@0.12.3 --save
39
+ npm install @teemill/platform@0.13.0 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
package/api.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1748,13 +1748,14 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1748
1748
  * @param {string} project Project unique identifier
1749
1749
  * @param {string} platformId The platform identifier
1750
1750
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1751
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1751
1752
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1752
1753
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1753
1754
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1754
1755
  * @param {*} [options] Override http request option.
1755
1756
  * @throws {RequiredError}
1756
1757
  */
1757
- exportCustomers: async (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1758
+ exportCustomers: async (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1758
1759
  // verify required parameter 'project' is not null or undefined
1759
1760
  assertParamExists('exportCustomers', 'project', project)
1760
1761
  // verify required parameter 'platformId' is not null or undefined
@@ -1787,6 +1788,10 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1787
1788
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
1788
1789
  }
1789
1790
 
1791
+ if (lifetimeValue !== undefined) {
1792
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
1793
+ }
1794
+
1790
1795
  if (sortBy) {
1791
1796
  localVarQueryParameter['sortBy'] = sortBy;
1792
1797
  }
@@ -1874,12 +1879,13 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1874
1879
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1875
1880
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1876
1881
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1882
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1877
1883
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1878
1884
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1879
1885
  * @param {*} [options] Override http request option.
1880
1886
  * @throws {RequiredError}
1881
1887
  */
1882
- listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1888
+ listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1883
1889
  // verify required parameter 'project' is not null or undefined
1884
1890
  assertParamExists('listCustomers', 'project', project)
1885
1891
  // verify required parameter 'platformId' is not null or undefined
@@ -1928,6 +1934,10 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1928
1934
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
1929
1935
  }
1930
1936
 
1937
+ if (lifetimeValue !== undefined) {
1938
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
1939
+ }
1940
+
1931
1941
  if (lastPurchasedStart !== undefined) {
1932
1942
  localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart as any instanceof Date) ?
1933
1943
  (lastPurchasedStart as any).toISOString() :
@@ -1965,14 +1975,15 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1965
1975
  * @param {string} project Project unique identifier
1966
1976
  * @param {string} platformId The platform identifier
1967
1977
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1978
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1968
1979
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1969
1980
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1970
1981
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1971
1982
  * @param {*} [options] Override http request option.
1972
1983
  * @throws {RequiredError}
1973
1984
  */
1974
- async exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
1975
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
1985
+ async exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
1986
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
1976
1987
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1977
1988
  const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
1978
1989
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2002,13 +2013,14 @@ export const CustomersApiFp = function(configuration?: Configuration) {
2002
2013
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2003
2014
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2004
2015
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
2016
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
2005
2017
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
2006
2018
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
2007
2019
  * @param {*} [options] Override http request option.
2008
2020
  * @throws {RequiredError}
2009
2021
  */
2010
- async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
2011
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options);
2022
+ async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
2023
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
2012
2024
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
2013
2025
  const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
2014
2026
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -2031,7 +2043,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
2031
2043
  * @throws {RequiredError}
2032
2044
  */
2033
2045
  exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
2034
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
2046
+ return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
2035
2047
  },
2036
2048
  /**
2037
2049
  * Get a customer for a platform by a given customer ID.
@@ -2051,7 +2063,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
2051
2063
  * @throws {RequiredError}
2052
2064
  */
2053
2065
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
2054
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
2066
+ return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
2055
2067
  },
2056
2068
  };
2057
2069
  };
@@ -2083,6 +2095,13 @@ export interface CustomersApiExportCustomersRequest {
2083
2095
  */
2084
2096
  readonly totalOrderCount?: number
2085
2097
 
2098
+ /**
2099
+ * Filter customers by lifetime value less than or equal to the value provided
2100
+ * @type {number}
2101
+ * @memberof CustomersApiExportCustomers
2102
+ */
2103
+ readonly lifetimeValue?: number
2104
+
2086
2105
  /**
2087
2106
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2088
2107
  * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
@@ -2188,6 +2207,13 @@ export interface CustomersApiListCustomersRequest {
2188
2207
  */
2189
2208
  readonly totalOrderCount?: number
2190
2209
 
2210
+ /**
2211
+ * Filter customers by lifetime value less than or equal to the value provided
2212
+ * @type {number}
2213
+ * @memberof CustomersApiListCustomers
2214
+ */
2215
+ readonly lifetimeValue?: number
2216
+
2191
2217
  /**
2192
2218
  * Start of date range to filter customers by last purchase date
2193
2219
  * @type {string}
@@ -2219,7 +2245,7 @@ export class CustomersApi extends BaseAPI {
2219
2245
  * @memberof CustomersApi
2220
2246
  */
2221
2247
  public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
2222
- return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2248
+ return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2223
2249
  }
2224
2250
 
2225
2251
  /**
@@ -2243,7 +2269,7 @@ export class CustomersApi extends BaseAPI {
2243
2269
  * @memberof CustomersApi
2244
2270
  */
2245
2271
  public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
2246
- return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2272
+ return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2247
2273
  }
2248
2274
  }
2249
2275
 
package/base.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/common.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/configuration.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -92,7 +92,7 @@ export class Configuration {
92
92
  this.baseOptions = {
93
93
  headers: {
94
94
  ...param.baseOptions?.headers,
95
- 'User-Agent': "OpenAPI-Generator/0.12.3/typescript-axios"
95
+ 'User-Agent': "OpenAPI-Generator/0.13.0/typescript-axios"
96
96
  },
97
97
  ...param.baseOptions
98
98
  };
package/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1718,13 +1718,14 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1718
1718
  * @param {string} project Project unique identifier
1719
1719
  * @param {string} platformId The platform identifier
1720
1720
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1721
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1721
1722
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1722
1723
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1723
1724
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1724
1725
  * @param {*} [options] Override http request option.
1725
1726
  * @throws {RequiredError}
1726
1727
  */
1727
- exportCustomers: (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
+ exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
1729
  /**
1729
1730
  * Get a customer for a platform by a given customer ID.
1730
1731
  * @summary Get customer
@@ -1745,12 +1746,13 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1745
1746
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1746
1747
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1747
1748
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1749
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1748
1750
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1749
1751
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1750
1752
  * @param {*} [options] Override http request option.
1751
1753
  * @throws {RequiredError}
1752
1754
  */
1753
- listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1755
+ listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1754
1756
  };
1755
1757
  /**
1756
1758
  * CustomersApi - functional programming interface
@@ -1763,13 +1765,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1763
1765
  * @param {string} project Project unique identifier
1764
1766
  * @param {string} platformId The platform identifier
1765
1767
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1768
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1766
1769
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1767
1770
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1768
1771
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1769
1772
  * @param {*} [options] Override http request option.
1770
1773
  * @throws {RequiredError}
1771
1774
  */
1772
- exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1775
+ exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1773
1776
  /**
1774
1777
  * Get a customer for a platform by a given customer ID.
1775
1778
  * @summary Get customer
@@ -1790,12 +1793,13 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1790
1793
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1791
1794
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1792
1795
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1796
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1793
1797
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1794
1798
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1795
1799
  * @param {*} [options] Override http request option.
1796
1800
  * @throws {RequiredError}
1797
1801
  */
1798
- listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1802
+ listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1799
1803
  };
1800
1804
  /**
1801
1805
  * CustomersApi - factory interface
@@ -1851,6 +1855,12 @@ export interface CustomersApiExportCustomersRequest {
1851
1855
  * @memberof CustomersApiExportCustomers
1852
1856
  */
1853
1857
  readonly totalOrderCount?: number;
1858
+ /**
1859
+ * Filter customers by lifetime value less than or equal to the value provided
1860
+ * @type {number}
1861
+ * @memberof CustomersApiExportCustomers
1862
+ */
1863
+ readonly lifetimeValue?: number;
1854
1864
  /**
1855
1865
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1856
1866
  * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
@@ -1943,6 +1953,12 @@ export interface CustomersApiListCustomersRequest {
1943
1953
  * @memberof CustomersApiListCustomers
1944
1954
  */
1945
1955
  readonly totalOrderCount?: number;
1956
+ /**
1957
+ * Filter customers by lifetime value less than or equal to the value provided
1958
+ * @type {number}
1959
+ * @memberof CustomersApiListCustomers
1960
+ */
1961
+ readonly lifetimeValue?: number;
1946
1962
  /**
1947
1963
  * Start of date range to filter customers by last purchase date
1948
1964
  * @type {string}
package/dist/api.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.12.3
8
+ * The version of the OpenAPI document: 0.13.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -81,13 +81,14 @@ const CustomersApiAxiosParamCreator = function (configuration) {
81
81
  * @param {string} project Project unique identifier
82
82
  * @param {string} platformId The platform identifier
83
83
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
84
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
84
85
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
85
86
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
86
87
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
87
88
  * @param {*} [options] Override http request option.
88
89
  * @throws {RequiredError}
89
90
  */
90
- exportCustomers: (project_1, platformId_1, totalOrderCount_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
91
+ exportCustomers: (project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
91
92
  // verify required parameter 'project' is not null or undefined
92
93
  (0, common_1.assertParamExists)('exportCustomers', 'project', project);
93
94
  // verify required parameter 'platformId' is not null or undefined
@@ -114,6 +115,9 @@ const CustomersApiAxiosParamCreator = function (configuration) {
114
115
  if (totalOrderCount !== undefined) {
115
116
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
116
117
  }
118
+ if (lifetimeValue !== undefined) {
119
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
120
+ }
117
121
  if (sortBy) {
118
122
  localVarQueryParameter['sortBy'] = sortBy;
119
123
  }
@@ -187,12 +191,13 @@ const CustomersApiAxiosParamCreator = function (configuration) {
187
191
  * @param {string} [search] Search term to filter based on order reference, customer name and email
188
192
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
189
193
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
194
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
190
195
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
191
196
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
192
197
  * @param {*} [options] Override http request option.
193
198
  * @throws {RequiredError}
194
199
  */
195
- listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options = {}) {
200
+ listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
196
201
  // verify required parameter 'project' is not null or undefined
197
202
  (0, common_1.assertParamExists)('listCustomers', 'project', project);
198
203
  // verify required parameter 'platformId' is not null or undefined
@@ -231,6 +236,9 @@ const CustomersApiAxiosParamCreator = function (configuration) {
231
236
  if (totalOrderCount !== undefined) {
232
237
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
233
238
  }
239
+ if (lifetimeValue !== undefined) {
240
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
241
+ }
234
242
  if (lastPurchasedStart !== undefined) {
235
243
  localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart instanceof Date) ?
236
244
  lastPurchasedStart.toISOString() :
@@ -263,16 +271,17 @@ const CustomersApiFp = function (configuration) {
263
271
  * @param {string} project Project unique identifier
264
272
  * @param {string} platformId The platform identifier
265
273
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
274
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
266
275
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
267
276
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
268
277
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
269
278
  * @param {*} [options] Override http request option.
270
279
  * @throws {RequiredError}
271
280
  */
272
- exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
281
+ exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
273
282
  return __awaiter(this, void 0, void 0, function* () {
274
283
  var _a, _b, _c;
275
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
284
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
276
285
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
277
286
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
278
287
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -306,15 +315,16 @@ const CustomersApiFp = function (configuration) {
306
315
  * @param {string} [search] Search term to filter based on order reference, customer name and email
307
316
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
308
317
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
318
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
309
319
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
310
320
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
311
321
  * @param {*} [options] Override http request option.
312
322
  * @throws {RequiredError}
313
323
  */
314
- listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options) {
324
+ listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
315
325
  return __awaiter(this, void 0, void 0, function* () {
316
326
  var _a, _b, _c;
317
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options);
327
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
318
328
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
319
329
  const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
320
330
  return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -338,7 +348,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
338
348
  * @throws {RequiredError}
339
349
  */
340
350
  exportCustomers(requestParameters, options) {
341
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
351
+ return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
342
352
  },
343
353
  /**
344
354
  * Get a customer for a platform by a given customer ID.
@@ -358,7 +368,7 @@ const CustomersApiFactory = function (configuration, basePath, axios) {
358
368
  * @throws {RequiredError}
359
369
  */
360
370
  listCustomers(requestParameters, options) {
361
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
371
+ return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
362
372
  },
363
373
  };
364
374
  };
@@ -379,7 +389,7 @@ class CustomersApi extends base_1.BaseAPI {
379
389
  * @memberof CustomersApi
380
390
  */
381
391
  exportCustomers(requestParameters, options) {
382
- return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
392
+ return (0, exports.CustomersApiFp)(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
383
393
  }
384
394
  /**
385
395
  * Get a customer for a platform by a given customer ID.
@@ -401,7 +411,7 @@ class CustomersApi extends base_1.BaseAPI {
401
411
  * @memberof CustomersApi
402
412
  */
403
413
  listCustomers(requestParameters, options) {
404
- return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
414
+ return (0, exports.CustomersApiFp)(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
405
415
  }
406
416
  }
407
417
  exports.CustomersApi = CustomersApi;
package/dist/base.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.12.3
8
+ * The version of the OpenAPI document: 0.13.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.12.3
8
+ * The version of the OpenAPI document: 0.13.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.12.3
8
+ * The version of the OpenAPI document: 0.13.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -23,7 +23,7 @@ class Configuration {
23
23
  this.accessToken = param.accessToken;
24
24
  this.basePath = param.basePath;
25
25
  this.serverIndex = param.serverIndex;
26
- this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.12.3/typescript-axios" }) }, param.baseOptions);
26
+ this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.13.0/typescript-axios" }) }, param.baseOptions);
27
27
  this.formDataCtor = param.formDataCtor;
28
28
  }
29
29
  /**
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -1718,13 +1718,14 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1718
1718
  * @param {string} project Project unique identifier
1719
1719
  * @param {string} platformId The platform identifier
1720
1720
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1721
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1721
1722
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1722
1723
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1723
1724
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1724
1725
  * @param {*} [options] Override http request option.
1725
1726
  * @throws {RequiredError}
1726
1727
  */
1727
- exportCustomers: (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
+ exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
1729
  /**
1729
1730
  * Get a customer for a platform by a given customer ID.
1730
1731
  * @summary Get customer
@@ -1745,12 +1746,13 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1745
1746
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1746
1747
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1747
1748
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1749
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1748
1750
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1749
1751
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1750
1752
  * @param {*} [options] Override http request option.
1751
1753
  * @throws {RequiredError}
1752
1754
  */
1753
- listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1755
+ listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1754
1756
  };
1755
1757
  /**
1756
1758
  * CustomersApi - functional programming interface
@@ -1763,13 +1765,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1763
1765
  * @param {string} project Project unique identifier
1764
1766
  * @param {string} platformId The platform identifier
1765
1767
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1768
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1766
1769
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1767
1770
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1768
1771
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1769
1772
  * @param {*} [options] Override http request option.
1770
1773
  * @throws {RequiredError}
1771
1774
  */
1772
- exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1775
+ exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1773
1776
  /**
1774
1777
  * Get a customer for a platform by a given customer ID.
1775
1778
  * @summary Get customer
@@ -1790,12 +1793,13 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1790
1793
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1791
1794
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1792
1795
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1796
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1793
1797
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1794
1798
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1795
1799
  * @param {*} [options] Override http request option.
1796
1800
  * @throws {RequiredError}
1797
1801
  */
1798
- listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1802
+ listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1799
1803
  };
1800
1804
  /**
1801
1805
  * CustomersApi - factory interface
@@ -1851,6 +1855,12 @@ export interface CustomersApiExportCustomersRequest {
1851
1855
  * @memberof CustomersApiExportCustomers
1852
1856
  */
1853
1857
  readonly totalOrderCount?: number;
1858
+ /**
1859
+ * Filter customers by lifetime value less than or equal to the value provided
1860
+ * @type {number}
1861
+ * @memberof CustomersApiExportCustomers
1862
+ */
1863
+ readonly lifetimeValue?: number;
1854
1864
  /**
1855
1865
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1856
1866
  * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
@@ -1943,6 +1953,12 @@ export interface CustomersApiListCustomersRequest {
1943
1953
  * @memberof CustomersApiListCustomers
1944
1954
  */
1945
1955
  readonly totalOrderCount?: number;
1956
+ /**
1957
+ * Filter customers by lifetime value less than or equal to the value provided
1958
+ * @type {number}
1959
+ * @memberof CustomersApiListCustomers
1960
+ */
1961
+ readonly lifetimeValue?: number;
1946
1962
  /**
1947
1963
  * Start of date range to filter customers by last purchase date
1948
1964
  * @type {string}
package/dist/esm/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -78,13 +78,14 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
78
78
  * @param {string} project Project unique identifier
79
79
  * @param {string} platformId The platform identifier
80
80
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
81
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
81
82
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
82
83
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
83
84
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
84
85
  * @param {*} [options] Override http request option.
85
86
  * @throws {RequiredError}
86
87
  */
87
- exportCustomers: (project_1, platformId_1, totalOrderCount_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
88
+ exportCustomers: (project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, totalOrderCount_1, lifetimeValue_1, sortBy_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options = {}) {
88
89
  // verify required parameter 'project' is not null or undefined
89
90
  assertParamExists('exportCustomers', 'project', project);
90
91
  // verify required parameter 'platformId' is not null or undefined
@@ -111,6 +112,9 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
111
112
  if (totalOrderCount !== undefined) {
112
113
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
113
114
  }
115
+ if (lifetimeValue !== undefined) {
116
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
117
+ }
114
118
  if (sortBy) {
115
119
  localVarQueryParameter['sortBy'] = sortBy;
116
120
  }
@@ -184,12 +188,13 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
184
188
  * @param {string} [search] Search term to filter based on order reference, customer name and email
185
189
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
186
190
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
191
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
187
192
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
188
193
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
189
194
  * @param {*} [options] Override http request option.
190
195
  * @throws {RequiredError}
191
196
  */
192
- listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options = {}) {
197
+ listCustomers: (project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1) => __awaiter(this, [project_1, platformId_1, pageToken_1, pageSize_1, search_1, sortBy_1, totalOrderCount_1, lifetimeValue_1, lastPurchasedStart_1, lastPurchasedEnd_1, ...args_1], void 0, function* (project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options = {}) {
193
198
  // verify required parameter 'project' is not null or undefined
194
199
  assertParamExists('listCustomers', 'project', project);
195
200
  // verify required parameter 'platformId' is not null or undefined
@@ -228,6 +233,9 @@ export const CustomersApiAxiosParamCreator = function (configuration) {
228
233
  if (totalOrderCount !== undefined) {
229
234
  localVarQueryParameter['totalOrderCount'] = totalOrderCount;
230
235
  }
236
+ if (lifetimeValue !== undefined) {
237
+ localVarQueryParameter['lifetimeValue'] = lifetimeValue;
238
+ }
231
239
  if (lastPurchasedStart !== undefined) {
232
240
  localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart instanceof Date) ?
233
241
  lastPurchasedStart.toISOString() :
@@ -259,16 +267,17 @@ export const CustomersApiFp = function (configuration) {
259
267
  * @param {string} project Project unique identifier
260
268
  * @param {string} platformId The platform identifier
261
269
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
270
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
262
271
  * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
263
272
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
264
273
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
265
274
  * @param {*} [options] Override http request option.
266
275
  * @throws {RequiredError}
267
276
  */
268
- exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
277
+ exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options) {
269
278
  return __awaiter(this, void 0, void 0, function* () {
270
279
  var _a, _b, _c;
271
- const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
280
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
272
281
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
273
282
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.exportCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
274
283
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -302,15 +311,16 @@ export const CustomersApiFp = function (configuration) {
302
311
  * @param {string} [search] Search term to filter based on order reference, customer name and email
303
312
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
304
313
  * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
314
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
305
315
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
306
316
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
307
317
  * @param {*} [options] Override http request option.
308
318
  * @throws {RequiredError}
309
319
  */
310
- listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options) {
320
+ listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options) {
311
321
  return __awaiter(this, void 0, void 0, function* () {
312
322
  var _a, _b, _c;
313
- const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options);
323
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
314
324
  const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
315
325
  const localVarOperationServerBasePath = (_c = (_b = operationServerMap['CustomersApi.listCustomers']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
316
326
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -333,7 +343,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
333
343
  * @throws {RequiredError}
334
344
  */
335
345
  exportCustomers(requestParameters, options) {
336
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
346
+ return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
337
347
  },
338
348
  /**
339
349
  * Get a customer for a platform by a given customer ID.
@@ -353,7 +363,7 @@ export const CustomersApiFactory = function (configuration, basePath, axios) {
353
363
  * @throws {RequiredError}
354
364
  */
355
365
  listCustomers(requestParameters, options) {
356
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
366
+ return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
357
367
  },
358
368
  };
359
369
  };
@@ -373,7 +383,7 @@ export class CustomersApi extends BaseAPI {
373
383
  * @memberof CustomersApi
374
384
  */
375
385
  exportCustomers(requestParameters, options) {
376
- return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
386
+ return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
377
387
  }
378
388
  /**
379
389
  * Get a customer for a platform by a given customer ID.
@@ -395,7 +405,7 @@ export class CustomersApi extends BaseAPI {
395
405
  * @memberof CustomersApi
396
406
  */
397
407
  listCustomers(requestParameters, options) {
398
- return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
408
+ return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
399
409
  }
400
410
  }
401
411
  /**
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/base.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,7 +20,7 @@ export class Configuration {
20
20
  this.accessToken = param.accessToken;
21
21
  this.basePath = param.basePath;
22
22
  this.serverIndex = param.serverIndex;
23
- this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.12.3/typescript-axios" }) }, param.baseOptions);
23
+ this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.13.0/typescript-axios" }) }, param.baseOptions);
24
24
  this.formDataCtor = param.formDataCtor;
25
25
  }
26
26
  /**
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/esm/index.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.3
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.12.3
8
+ * The version of the OpenAPI document: 0.13.0
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.12.3
7
+ * The version of the OpenAPI document: 0.13.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.12.3",
3
+ "version": "0.13.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {