@teemill/platform 0.28.0 → 0.29.2
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 +2 -2
- package/api.ts +230 -64
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +148 -42
- package/dist/api.js +113 -49
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +148 -42
- package/dist/esm/api.js +112 -48
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CustomersApi.md +59 -23
- package/docs/Statistics.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.29.2
|
|
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.
|
|
39
|
+
npm install @teemill/platform@0.29.2 --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.
|
|
7
|
+
* The version of the OpenAPI document: 0.29.2
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1779,6 +1779,12 @@ export interface Statistics {
|
|
|
1779
1779
|
* @memberof Statistics
|
|
1780
1780
|
*/
|
|
1781
1781
|
'lastPurchased': string | null;
|
|
1782
|
+
/**
|
|
1783
|
+
*
|
|
1784
|
+
* @type {boolean}
|
|
1785
|
+
* @memberof Statistics
|
|
1786
|
+
*/
|
|
1787
|
+
'usedDiscount': boolean;
|
|
1782
1788
|
}
|
|
1783
1789
|
/**
|
|
1784
1790
|
*
|
|
@@ -1975,18 +1981,24 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1975
1981
|
* @summary Export customers
|
|
1976
1982
|
* @param {string} project Project unique identifier
|
|
1977
1983
|
* @param {string} platformId The platform identifier
|
|
1984
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1978
1985
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
1986
|
+
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
1979
1987
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1980
|
-
* @param {number} [
|
|
1981
|
-
* @param {
|
|
1982
|
-
* @param {number} [
|
|
1983
|
-
* @param {
|
|
1988
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
1989
|
+
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
1990
|
+
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
1991
|
+
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
1992
|
+
* @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
|
|
1993
|
+
* @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
|
|
1994
|
+
* @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
|
|
1995
|
+
* @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1984
1996
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1985
1997
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1986
1998
|
* @param {*} [options] Override http request option.
|
|
1987
1999
|
* @throws {RequiredError}
|
|
1988
2000
|
*/
|
|
1989
|
-
exportCustomers: async (project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum,
|
|
2001
|
+
exportCustomers: async (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1990
2002
|
// verify required parameter 'project' is not null or undefined
|
|
1991
2003
|
assertParamExists('exportCustomers', 'project', project)
|
|
1992
2004
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -2015,28 +2027,52 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2015
2027
|
localVarQueryParameter['project'] = project;
|
|
2016
2028
|
}
|
|
2017
2029
|
|
|
2030
|
+
if (sortBy) {
|
|
2031
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
2018
2034
|
if (countries) {
|
|
2019
2035
|
localVarQueryParameter['countries'] = countries;
|
|
2020
2036
|
}
|
|
2021
2037
|
|
|
2038
|
+
if (projects) {
|
|
2039
|
+
localVarQueryParameter['projects'] = projects;
|
|
2040
|
+
}
|
|
2041
|
+
|
|
2022
2042
|
if (gender !== undefined) {
|
|
2023
2043
|
localVarQueryParameter['gender'] = gender;
|
|
2024
2044
|
}
|
|
2025
2045
|
|
|
2026
|
-
if (
|
|
2027
|
-
localVarQueryParameter['
|
|
2046
|
+
if (productTypes) {
|
|
2047
|
+
localVarQueryParameter['productTypes'] = productTypes;
|
|
2028
2048
|
}
|
|
2029
2049
|
|
|
2030
|
-
if (
|
|
2031
|
-
localVarQueryParameter['
|
|
2050
|
+
if (usedDiscount !== undefined) {
|
|
2051
|
+
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
2032
2052
|
}
|
|
2033
2053
|
|
|
2034
|
-
if (
|
|
2035
|
-
localVarQueryParameter['
|
|
2054
|
+
if (minimumTotalOrderCount !== undefined) {
|
|
2055
|
+
localVarQueryParameter['minimumTotalOrderCount'] = minimumTotalOrderCount;
|
|
2036
2056
|
}
|
|
2037
2057
|
|
|
2038
|
-
if (
|
|
2039
|
-
localVarQueryParameter['
|
|
2058
|
+
if (maximumTotalOrderCount !== undefined) {
|
|
2059
|
+
localVarQueryParameter['maximumTotalOrderCount'] = maximumTotalOrderCount;
|
|
2060
|
+
}
|
|
2061
|
+
|
|
2062
|
+
if (minimumRefundedOrderCount !== undefined) {
|
|
2063
|
+
localVarQueryParameter['minimumRefundedOrderCount'] = minimumRefundedOrderCount;
|
|
2064
|
+
}
|
|
2065
|
+
|
|
2066
|
+
if (maximumRefundedOrderCount !== undefined) {
|
|
2067
|
+
localVarQueryParameter['maximumRefundedOrderCount'] = maximumRefundedOrderCount;
|
|
2068
|
+
}
|
|
2069
|
+
|
|
2070
|
+
if (minimumLifetimeValue !== undefined) {
|
|
2071
|
+
localVarQueryParameter['minimumLifetimeValue'] = minimumLifetimeValue;
|
|
2072
|
+
}
|
|
2073
|
+
|
|
2074
|
+
if (maximumLifetimeValue !== undefined) {
|
|
2075
|
+
localVarQueryParameter['maximumLifetimeValue'] = maximumLifetimeValue;
|
|
2040
2076
|
}
|
|
2041
2077
|
|
|
2042
2078
|
if (lastPurchasedStart !== undefined) {
|
|
@@ -2122,16 +2158,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2122
2158
|
* @param {string} [search] Search term to filter results
|
|
2123
2159
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2124
2160
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
2161
|
+
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2125
2162
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2126
|
-
* @param {number} [
|
|
2127
|
-
* @param {
|
|
2128
|
-
* @param {number} [
|
|
2163
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2164
|
+
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2165
|
+
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2166
|
+
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
2167
|
+
* @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
|
|
2168
|
+
* @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
|
|
2169
|
+
* @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
|
|
2170
|
+
* @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2129
2171
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2130
2172
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2131
2173
|
* @param {*} [options] Override http request option.
|
|
2132
2174
|
* @throws {RequiredError}
|
|
2133
2175
|
*/
|
|
2134
|
-
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum,
|
|
2176
|
+
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2135
2177
|
// verify required parameter 'project' is not null or undefined
|
|
2136
2178
|
assertParamExists('listCustomers', 'project', project)
|
|
2137
2179
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -2180,20 +2222,44 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2180
2222
|
localVarQueryParameter['countries'] = countries;
|
|
2181
2223
|
}
|
|
2182
2224
|
|
|
2225
|
+
if (projects) {
|
|
2226
|
+
localVarQueryParameter['projects'] = projects;
|
|
2227
|
+
}
|
|
2228
|
+
|
|
2183
2229
|
if (gender !== undefined) {
|
|
2184
2230
|
localVarQueryParameter['gender'] = gender;
|
|
2185
2231
|
}
|
|
2186
2232
|
|
|
2187
|
-
if (
|
|
2188
|
-
localVarQueryParameter['
|
|
2233
|
+
if (productTypes) {
|
|
2234
|
+
localVarQueryParameter['productTypes'] = productTypes;
|
|
2235
|
+
}
|
|
2236
|
+
|
|
2237
|
+
if (usedDiscount !== undefined) {
|
|
2238
|
+
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
2189
2239
|
}
|
|
2190
2240
|
|
|
2191
|
-
if (
|
|
2192
|
-
localVarQueryParameter['
|
|
2241
|
+
if (minimumTotalOrderCount !== undefined) {
|
|
2242
|
+
localVarQueryParameter['minimumTotalOrderCount'] = minimumTotalOrderCount;
|
|
2193
2243
|
}
|
|
2194
2244
|
|
|
2195
|
-
if (
|
|
2196
|
-
localVarQueryParameter['
|
|
2245
|
+
if (maximumTotalOrderCount !== undefined) {
|
|
2246
|
+
localVarQueryParameter['maximumTotalOrderCount'] = maximumTotalOrderCount;
|
|
2247
|
+
}
|
|
2248
|
+
|
|
2249
|
+
if (minimumRefundedOrderCount !== undefined) {
|
|
2250
|
+
localVarQueryParameter['minimumRefundedOrderCount'] = minimumRefundedOrderCount;
|
|
2251
|
+
}
|
|
2252
|
+
|
|
2253
|
+
if (maximumRefundedOrderCount !== undefined) {
|
|
2254
|
+
localVarQueryParameter['maximumRefundedOrderCount'] = maximumRefundedOrderCount;
|
|
2255
|
+
}
|
|
2256
|
+
|
|
2257
|
+
if (minimumLifetimeValue !== undefined) {
|
|
2258
|
+
localVarQueryParameter['minimumLifetimeValue'] = minimumLifetimeValue;
|
|
2259
|
+
}
|
|
2260
|
+
|
|
2261
|
+
if (maximumLifetimeValue !== undefined) {
|
|
2262
|
+
localVarQueryParameter['maximumLifetimeValue'] = maximumLifetimeValue;
|
|
2197
2263
|
}
|
|
2198
2264
|
|
|
2199
2265
|
if (lastPurchasedStart !== undefined) {
|
|
@@ -2232,19 +2298,25 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2232
2298
|
* @summary Export customers
|
|
2233
2299
|
* @param {string} project Project unique identifier
|
|
2234
2300
|
* @param {string} platformId The platform identifier
|
|
2301
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2235
2302
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
2303
|
+
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2236
2304
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2237
|
-
* @param {number} [
|
|
2238
|
-
* @param {
|
|
2239
|
-
* @param {number} [
|
|
2240
|
-
* @param {
|
|
2305
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2306
|
+
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2307
|
+
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2308
|
+
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
2309
|
+
* @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
|
|
2310
|
+
* @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
|
|
2311
|
+
* @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
|
|
2312
|
+
* @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2241
2313
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2242
2314
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2243
2315
|
* @param {*} [options] Override http request option.
|
|
2244
2316
|
* @throws {RequiredError}
|
|
2245
2317
|
*/
|
|
2246
|
-
async exportCustomers(project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum,
|
|
2247
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, countries, gender,
|
|
2318
|
+
async exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
2319
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2248
2320
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2249
2321
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2250
2322
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2274,17 +2346,23 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2274
2346
|
* @param {string} [search] Search term to filter results
|
|
2275
2347
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2276
2348
|
* @param {Array<string>} [countries] Filter customers by country code
|
|
2349
|
+
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2277
2350
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2278
|
-
* @param {number} [
|
|
2279
|
-
* @param {
|
|
2280
|
-
* @param {number} [
|
|
2351
|
+
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2352
|
+
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2353
|
+
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2354
|
+
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
2355
|
+
* @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
|
|
2356
|
+
* @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
|
|
2357
|
+
* @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
|
|
2358
|
+
* @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2281
2359
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2282
2360
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2283
2361
|
* @param {*} [options] Override http request option.
|
|
2284
2362
|
* @throws {RequiredError}
|
|
2285
2363
|
*/
|
|
2286
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum,
|
|
2287
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, gender,
|
|
2364
|
+
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2365
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2288
2366
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2289
2367
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2290
2368
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2307,7 +2385,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2307
2385
|
* @throws {RequiredError}
|
|
2308
2386
|
*/
|
|
2309
2387
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
2310
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.
|
|
2388
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2311
2389
|
},
|
|
2312
2390
|
/**
|
|
2313
2391
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -2327,7 +2405,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2327
2405
|
* @throws {RequiredError}
|
|
2328
2406
|
*/
|
|
2329
2407
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
2330
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.
|
|
2408
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2331
2409
|
},
|
|
2332
2410
|
};
|
|
2333
2411
|
};
|
|
@@ -2352,6 +2430,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2352
2430
|
*/
|
|
2353
2431
|
readonly platformId: string
|
|
2354
2432
|
|
|
2433
|
+
/**
|
|
2434
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2435
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2436
|
+
* @memberof CustomersApiExportCustomers
|
|
2437
|
+
*/
|
|
2438
|
+
readonly sortBy?: Array<ExportCustomersSortByEnum>
|
|
2439
|
+
|
|
2355
2440
|
/**
|
|
2356
2441
|
* Filter customers by country code
|
|
2357
2442
|
* @type {Array<string>}
|
|
@@ -2359,6 +2444,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2359
2444
|
*/
|
|
2360
2445
|
readonly countries?: Array<string>
|
|
2361
2446
|
|
|
2447
|
+
/**
|
|
2448
|
+
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2449
|
+
* @type {Array<string>}
|
|
2450
|
+
* @memberof CustomersApiExportCustomers
|
|
2451
|
+
*/
|
|
2452
|
+
readonly projects?: Array<string>
|
|
2453
|
+
|
|
2362
2454
|
/**
|
|
2363
2455
|
* Filter customers by gender equal to the value provided
|
|
2364
2456
|
* @type {'male' | 'female'}
|
|
@@ -2367,32 +2459,60 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2367
2459
|
readonly gender?: ExportCustomersGenderEnum
|
|
2368
2460
|
|
|
2369
2461
|
/**
|
|
2370
|
-
* Filter customers by
|
|
2462
|
+
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2463
|
+
* @type {Array<number>}
|
|
2464
|
+
* @memberof CustomersApiExportCustomers
|
|
2465
|
+
*/
|
|
2466
|
+
readonly productTypes?: Array<number>
|
|
2467
|
+
|
|
2468
|
+
/**
|
|
2469
|
+
* Filter customers by whether they have used a discount
|
|
2470
|
+
* @type {boolean}
|
|
2471
|
+
* @memberof CustomersApiExportCustomers
|
|
2472
|
+
*/
|
|
2473
|
+
readonly usedDiscount?: boolean
|
|
2474
|
+
|
|
2475
|
+
/**
|
|
2476
|
+
* Filter customers by total order count greater than or equal to the value provided
|
|
2371
2477
|
* @type {number}
|
|
2372
2478
|
* @memberof CustomersApiExportCustomers
|
|
2373
2479
|
*/
|
|
2374
|
-
readonly
|
|
2480
|
+
readonly minimumTotalOrderCount?: number
|
|
2375
2481
|
|
|
2376
2482
|
/**
|
|
2377
|
-
* Filter customers by
|
|
2483
|
+
* Filter customers by total order count less than or equal to the value provided
|
|
2378
2484
|
* @type {number}
|
|
2379
2485
|
* @memberof CustomersApiExportCustomers
|
|
2380
2486
|
*/
|
|
2381
|
-
readonly
|
|
2487
|
+
readonly maximumTotalOrderCount?: number
|
|
2382
2488
|
|
|
2383
2489
|
/**
|
|
2384
|
-
* Filter customers by
|
|
2490
|
+
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2385
2491
|
* @type {number}
|
|
2386
2492
|
* @memberof CustomersApiExportCustomers
|
|
2387
2493
|
*/
|
|
2388
|
-
readonly
|
|
2494
|
+
readonly minimumRefundedOrderCount?: number
|
|
2389
2495
|
|
|
2390
2496
|
/**
|
|
2391
|
-
*
|
|
2392
|
-
* @type {
|
|
2497
|
+
* Filter customers by refunded order count less than or equal to the value provided
|
|
2498
|
+
* @type {number}
|
|
2393
2499
|
* @memberof CustomersApiExportCustomers
|
|
2394
2500
|
*/
|
|
2395
|
-
readonly
|
|
2501
|
+
readonly maximumRefundedOrderCount?: number
|
|
2502
|
+
|
|
2503
|
+
/**
|
|
2504
|
+
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2505
|
+
* @type {number}
|
|
2506
|
+
* @memberof CustomersApiExportCustomers
|
|
2507
|
+
*/
|
|
2508
|
+
readonly minimumLifetimeValue?: number
|
|
2509
|
+
|
|
2510
|
+
/**
|
|
2511
|
+
* Filter customers by lifetime value less than or equal to the value provided
|
|
2512
|
+
* @type {number}
|
|
2513
|
+
* @memberof CustomersApiExportCustomers
|
|
2514
|
+
*/
|
|
2515
|
+
readonly maximumLifetimeValue?: number
|
|
2396
2516
|
|
|
2397
2517
|
/**
|
|
2398
2518
|
* Start of date range to filter customers by last purchase date
|
|
@@ -2480,7 +2600,7 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2480
2600
|
|
|
2481
2601
|
/**
|
|
2482
2602
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2483
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2603
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2484
2604
|
* @memberof CustomersApiListCustomers
|
|
2485
2605
|
*/
|
|
2486
2606
|
readonly sortBy?: Array<ListCustomersSortByEnum>
|
|
@@ -2492,6 +2612,13 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2492
2612
|
*/
|
|
2493
2613
|
readonly countries?: Array<string>
|
|
2494
2614
|
|
|
2615
|
+
/**
|
|
2616
|
+
* Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2617
|
+
* @type {Array<string>}
|
|
2618
|
+
* @memberof CustomersApiListCustomers
|
|
2619
|
+
*/
|
|
2620
|
+
readonly projects?: Array<string>
|
|
2621
|
+
|
|
2495
2622
|
/**
|
|
2496
2623
|
* Filter customers by gender equal to the value provided
|
|
2497
2624
|
* @type {'male' | 'female'}
|
|
@@ -2500,25 +2627,60 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2500
2627
|
readonly gender?: ListCustomersGenderEnum
|
|
2501
2628
|
|
|
2502
2629
|
/**
|
|
2503
|
-
* Filter customers by
|
|
2630
|
+
* Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2631
|
+
* @type {Array<number>}
|
|
2632
|
+
* @memberof CustomersApiListCustomers
|
|
2633
|
+
*/
|
|
2634
|
+
readonly productTypes?: Array<number>
|
|
2635
|
+
|
|
2636
|
+
/**
|
|
2637
|
+
* Filter customers by whether they have used a discount
|
|
2638
|
+
* @type {boolean}
|
|
2639
|
+
* @memberof CustomersApiListCustomers
|
|
2640
|
+
*/
|
|
2641
|
+
readonly usedDiscount?: boolean
|
|
2642
|
+
|
|
2643
|
+
/**
|
|
2644
|
+
* Filter customers by total order count greater than or equal to the value provided
|
|
2645
|
+
* @type {number}
|
|
2646
|
+
* @memberof CustomersApiListCustomers
|
|
2647
|
+
*/
|
|
2648
|
+
readonly minimumTotalOrderCount?: number
|
|
2649
|
+
|
|
2650
|
+
/**
|
|
2651
|
+
* Filter customers by total order count less than or equal to the value provided
|
|
2652
|
+
* @type {number}
|
|
2653
|
+
* @memberof CustomersApiListCustomers
|
|
2654
|
+
*/
|
|
2655
|
+
readonly maximumTotalOrderCount?: number
|
|
2656
|
+
|
|
2657
|
+
/**
|
|
2658
|
+
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2504
2659
|
* @type {number}
|
|
2505
2660
|
* @memberof CustomersApiListCustomers
|
|
2506
2661
|
*/
|
|
2507
|
-
readonly
|
|
2662
|
+
readonly minimumRefundedOrderCount?: number
|
|
2508
2663
|
|
|
2509
2664
|
/**
|
|
2510
|
-
* Filter customers by refunded order count equal to the value provided
|
|
2665
|
+
* Filter customers by refunded order count less than or equal to the value provided
|
|
2511
2666
|
* @type {number}
|
|
2512
2667
|
* @memberof CustomersApiListCustomers
|
|
2513
2668
|
*/
|
|
2514
|
-
readonly
|
|
2669
|
+
readonly maximumRefundedOrderCount?: number
|
|
2670
|
+
|
|
2671
|
+
/**
|
|
2672
|
+
* Filter customers by lifetime value greater than or equal to the value provided
|
|
2673
|
+
* @type {number}
|
|
2674
|
+
* @memberof CustomersApiListCustomers
|
|
2675
|
+
*/
|
|
2676
|
+
readonly minimumLifetimeValue?: number
|
|
2515
2677
|
|
|
2516
2678
|
/**
|
|
2517
2679
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2518
2680
|
* @type {number}
|
|
2519
2681
|
* @memberof CustomersApiListCustomers
|
|
2520
2682
|
*/
|
|
2521
|
-
readonly
|
|
2683
|
+
readonly maximumLifetimeValue?: number
|
|
2522
2684
|
|
|
2523
2685
|
/**
|
|
2524
2686
|
* Start of date range to filter customers by last purchase date
|
|
@@ -2551,7 +2713,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
2551
2713
|
* @memberof CustomersApi
|
|
2552
2714
|
*/
|
|
2553
2715
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2554
|
-
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.countries, requestParameters.gender, requestParameters.
|
|
2716
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2555
2717
|
}
|
|
2556
2718
|
|
|
2557
2719
|
/**
|
|
@@ -2575,18 +2737,10 @@ export class CustomersApi extends BaseAPI {
|
|
|
2575
2737
|
* @memberof CustomersApi
|
|
2576
2738
|
*/
|
|
2577
2739
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2578
|
-
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.gender, requestParameters.
|
|
2740
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2579
2741
|
}
|
|
2580
2742
|
}
|
|
2581
2743
|
|
|
2582
|
-
/**
|
|
2583
|
-
* @export
|
|
2584
|
-
*/
|
|
2585
|
-
export const ExportCustomersGenderEnum = {
|
|
2586
|
-
Male: 'male',
|
|
2587
|
-
Female: 'female'
|
|
2588
|
-
} as const;
|
|
2589
|
-
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2590
2744
|
/**
|
|
2591
2745
|
* @export
|
|
2592
2746
|
*/
|
|
@@ -2598,9 +2752,19 @@ export const ExportCustomersSortByEnum = {
|
|
|
2598
2752
|
RefundedOrderCount: '+refundedOrderCount',
|
|
2599
2753
|
RefundedOrderCount2: '-refundedOrderCount',
|
|
2600
2754
|
LastPurchased: '+lastPurchased',
|
|
2601
|
-
LastPurchased2: '-lastPurchased'
|
|
2755
|
+
LastPurchased2: '-lastPurchased',
|
|
2756
|
+
UsedDiscount: '+usedDiscount',
|
|
2757
|
+
UsedDiscount2: '-usedDiscount'
|
|
2602
2758
|
} as const;
|
|
2603
2759
|
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
2760
|
+
/**
|
|
2761
|
+
* @export
|
|
2762
|
+
*/
|
|
2763
|
+
export const ExportCustomersGenderEnum = {
|
|
2764
|
+
Male: 'male',
|
|
2765
|
+
Female: 'female'
|
|
2766
|
+
} as const;
|
|
2767
|
+
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2604
2768
|
/**
|
|
2605
2769
|
* @export
|
|
2606
2770
|
*/
|
|
@@ -2612,7 +2776,9 @@ export const ListCustomersSortByEnum = {
|
|
|
2612
2776
|
RefundedOrderCount: '+refundedOrderCount',
|
|
2613
2777
|
RefundedOrderCount2: '-refundedOrderCount',
|
|
2614
2778
|
LastPurchased: '+lastPurchased',
|
|
2615
|
-
LastPurchased2: '-lastPurchased'
|
|
2779
|
+
LastPurchased2: '-lastPurchased',
|
|
2780
|
+
UsedDiscount: '+usedDiscount',
|
|
2781
|
+
UsedDiscount2: '-usedDiscount'
|
|
2616
2782
|
} as const;
|
|
2617
2783
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2618
2784
|
/**
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED