@teemill/platform 0.27.0 → 0.29.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 +12 -2
- package/api.ts +681 -64
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +478 -42
- package/dist/api.js +289 -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 +478 -42
- package/dist/esm/api.js +288 -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/ConfirmOrderFulfillment.md +24 -0
- package/docs/ConfirmOrderFulfillmentShipment.md +21 -0
- package/docs/ConfirmOrderRequest.md +20 -0
- package/docs/CreateOrder.md +33 -0
- package/docs/CreateOrderContactInformation.md +23 -0
- package/docs/CustomersApi.md +59 -23
- package/docs/CustomsInformation.md +27 -0
- package/docs/OrderItem1.md +24 -0
- package/docs/OrderItem1RecipientCost.md +22 -0
- package/docs/OrdersApi.md +128 -0
- package/docs/Statistics.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -122,6 +122,57 @@ export interface Client {
|
|
|
122
122
|
*/
|
|
123
123
|
'name'?: string;
|
|
124
124
|
}
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @export
|
|
128
|
+
* @interface ConfirmOrderFulfillment
|
|
129
|
+
*/
|
|
130
|
+
export interface ConfirmOrderFulfillment {
|
|
131
|
+
/**
|
|
132
|
+
* Unique object identifier
|
|
133
|
+
* @type {string}
|
|
134
|
+
* @memberof ConfirmOrderFulfillment
|
|
135
|
+
*/
|
|
136
|
+
'fulfillmentId': string;
|
|
137
|
+
/**
|
|
138
|
+
* Unique object identifier
|
|
139
|
+
* @type {string}
|
|
140
|
+
* @memberof ConfirmOrderFulfillment
|
|
141
|
+
*/
|
|
142
|
+
'shippingMethodId'?: string;
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @type {ConfirmOrderFulfillmentShipment}
|
|
146
|
+
* @memberof ConfirmOrderFulfillment
|
|
147
|
+
*/
|
|
148
|
+
'shipment'?: ConfirmOrderFulfillmentShipment;
|
|
149
|
+
}
|
|
150
|
+
/**
|
|
151
|
+
* This field is only required if you are using your own shipping label.
|
|
152
|
+
* @export
|
|
153
|
+
* @interface ConfirmOrderFulfillmentShipment
|
|
154
|
+
*/
|
|
155
|
+
export interface ConfirmOrderFulfillmentShipment {
|
|
156
|
+
/**
|
|
157
|
+
* Only required if you are generating shipping labels outside of PodOS
|
|
158
|
+
* @type {string}
|
|
159
|
+
* @memberof ConfirmOrderFulfillmentShipment
|
|
160
|
+
*/
|
|
161
|
+
'image': string;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
*
|
|
165
|
+
* @export
|
|
166
|
+
* @interface ConfirmOrderRequest
|
|
167
|
+
*/
|
|
168
|
+
export interface ConfirmOrderRequest {
|
|
169
|
+
/**
|
|
170
|
+
*
|
|
171
|
+
* @type {Array<ConfirmOrderFulfillment>}
|
|
172
|
+
* @memberof ConfirmOrderRequest
|
|
173
|
+
*/
|
|
174
|
+
'fulfillments': Array<ConfirmOrderFulfillment>;
|
|
175
|
+
}
|
|
125
176
|
/**
|
|
126
177
|
* Order recipient contact information, used only for courier tracking/updates.
|
|
127
178
|
* @export
|
|
@@ -186,6 +237,74 @@ export interface CreateDomainRequest {
|
|
|
186
237
|
*/
|
|
187
238
|
'domain'?: string;
|
|
188
239
|
}
|
|
240
|
+
/**
|
|
241
|
+
* Create an order
|
|
242
|
+
* @export
|
|
243
|
+
* @interface CreateOrder
|
|
244
|
+
*/
|
|
245
|
+
export interface CreateOrder {
|
|
246
|
+
/**
|
|
247
|
+
* A custom reference to the merchant\'s order.
|
|
248
|
+
* @type {string}
|
|
249
|
+
* @memberof CreateOrder
|
|
250
|
+
*/
|
|
251
|
+
'merchantReference'?: string | null;
|
|
252
|
+
/**
|
|
253
|
+
*
|
|
254
|
+
* @type {CreateOrderContactInformation}
|
|
255
|
+
* @memberof CreateOrder
|
|
256
|
+
*/
|
|
257
|
+
'contactInformation': CreateOrderContactInformation;
|
|
258
|
+
/**
|
|
259
|
+
*
|
|
260
|
+
* @type {Address}
|
|
261
|
+
* @memberof CreateOrder
|
|
262
|
+
*/
|
|
263
|
+
'shippingAddress': Address;
|
|
264
|
+
/**
|
|
265
|
+
*
|
|
266
|
+
* @type {CustomsInformation}
|
|
267
|
+
* @memberof CreateOrder
|
|
268
|
+
*/
|
|
269
|
+
'customsInformation'?: CustomsInformation;
|
|
270
|
+
/**
|
|
271
|
+
* Items to be ordered
|
|
272
|
+
* @type {Array<OrderItem1>}
|
|
273
|
+
* @memberof CreateOrder
|
|
274
|
+
*/
|
|
275
|
+
'items': Array<OrderItem1>;
|
|
276
|
+
/**
|
|
277
|
+
*
|
|
278
|
+
* @type {Array<string>}
|
|
279
|
+
* @memberof CreateOrder
|
|
280
|
+
*/
|
|
281
|
+
'preferredFulfillers'?: Array<string>;
|
|
282
|
+
/**
|
|
283
|
+
* A reference to the resource location
|
|
284
|
+
* @type {string}
|
|
285
|
+
* @memberof CreateOrder
|
|
286
|
+
*/
|
|
287
|
+
'originalOrderRef'?: string;
|
|
288
|
+
}
|
|
289
|
+
/**
|
|
290
|
+
* Contact information for the order
|
|
291
|
+
* @export
|
|
292
|
+
* @interface CreateOrderContactInformation
|
|
293
|
+
*/
|
|
294
|
+
export interface CreateOrderContactInformation {
|
|
295
|
+
/**
|
|
296
|
+
*
|
|
297
|
+
* @type {string}
|
|
298
|
+
* @memberof CreateOrderContactInformation
|
|
299
|
+
*/
|
|
300
|
+
'email': string;
|
|
301
|
+
/**
|
|
302
|
+
*
|
|
303
|
+
* @type {string}
|
|
304
|
+
* @memberof CreateOrderContactInformation
|
|
305
|
+
*/
|
|
306
|
+
'phone'?: string | null;
|
|
307
|
+
}
|
|
189
308
|
/**
|
|
190
309
|
* The customer that has placed an order on your platform
|
|
191
310
|
* @export
|
|
@@ -254,6 +373,44 @@ export interface CustomersResponse {
|
|
|
254
373
|
*/
|
|
255
374
|
'nextPageToken'?: number | null;
|
|
256
375
|
}
|
|
376
|
+
/**
|
|
377
|
+
* Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
|
|
378
|
+
* @export
|
|
379
|
+
* @interface CustomsInformation
|
|
380
|
+
*/
|
|
381
|
+
export interface CustomsInformation {
|
|
382
|
+
/**
|
|
383
|
+
* Pre-registration type
|
|
384
|
+
* @type {string}
|
|
385
|
+
* @memberof CustomsInformation
|
|
386
|
+
*/
|
|
387
|
+
'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
|
|
388
|
+
/**
|
|
389
|
+
* Pre-registration number
|
|
390
|
+
* @type {string}
|
|
391
|
+
* @memberof CustomsInformation
|
|
392
|
+
*/
|
|
393
|
+
'preRegistrationNumber'?: string;
|
|
394
|
+
/**
|
|
395
|
+
* VAT number
|
|
396
|
+
* @type {string}
|
|
397
|
+
* @memberof CustomsInformation
|
|
398
|
+
*/
|
|
399
|
+
'vatNumber'?: string;
|
|
400
|
+
/**
|
|
401
|
+
* EORI number
|
|
402
|
+
* @type {string}
|
|
403
|
+
* @memberof CustomsInformation
|
|
404
|
+
*/
|
|
405
|
+
'eoriNumber'?: string;
|
|
406
|
+
}
|
|
407
|
+
|
|
408
|
+
export const CustomsInformationPreRegistrationTypeEnum = {
|
|
409
|
+
Ioss: 'IOSS'
|
|
410
|
+
} as const;
|
|
411
|
+
|
|
412
|
+
export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
|
|
413
|
+
|
|
257
414
|
/**
|
|
258
415
|
*
|
|
259
416
|
* @export
|
|
@@ -985,6 +1142,50 @@ export interface OrderItem {
|
|
|
985
1142
|
*/
|
|
986
1143
|
'recipientCost'?: Price;
|
|
987
1144
|
}
|
|
1145
|
+
/**
|
|
1146
|
+
*
|
|
1147
|
+
* @export
|
|
1148
|
+
* @interface OrderItem1
|
|
1149
|
+
*/
|
|
1150
|
+
export interface OrderItem1 {
|
|
1151
|
+
/**
|
|
1152
|
+
* A reference to the variant being ordered
|
|
1153
|
+
* @type {string}
|
|
1154
|
+
* @memberof OrderItem1
|
|
1155
|
+
*/
|
|
1156
|
+
'variantRef': string;
|
|
1157
|
+
/**
|
|
1158
|
+
*
|
|
1159
|
+
* @type {number}
|
|
1160
|
+
* @memberof OrderItem1
|
|
1161
|
+
*/
|
|
1162
|
+
'quantity': number;
|
|
1163
|
+
/**
|
|
1164
|
+
*
|
|
1165
|
+
* @type {OrderItem1RecipientCost}
|
|
1166
|
+
* @memberof OrderItem1
|
|
1167
|
+
*/
|
|
1168
|
+
'recipientCost'?: OrderItem1RecipientCost;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
*
|
|
1172
|
+
* @export
|
|
1173
|
+
* @interface OrderItem1RecipientCost
|
|
1174
|
+
*/
|
|
1175
|
+
export interface OrderItem1RecipientCost {
|
|
1176
|
+
/**
|
|
1177
|
+
*
|
|
1178
|
+
* @type {string}
|
|
1179
|
+
* @memberof OrderItem1RecipientCost
|
|
1180
|
+
*/
|
|
1181
|
+
'amount': string;
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @type {string}
|
|
1185
|
+
* @memberof OrderItem1RecipientCost
|
|
1186
|
+
*/
|
|
1187
|
+
'currencyCode': string;
|
|
1188
|
+
}
|
|
988
1189
|
/**
|
|
989
1190
|
*
|
|
990
1191
|
* @export
|
|
@@ -1578,6 +1779,12 @@ export interface Statistics {
|
|
|
1578
1779
|
* @memberof Statistics
|
|
1579
1780
|
*/
|
|
1580
1781
|
'lastPurchased': string | null;
|
|
1782
|
+
/**
|
|
1783
|
+
*
|
|
1784
|
+
* @type {boolean}
|
|
1785
|
+
* @memberof Statistics
|
|
1786
|
+
*/
|
|
1787
|
+
'usedDiscount': boolean;
|
|
1581
1788
|
}
|
|
1582
1789
|
/**
|
|
1583
1790
|
*
|
|
@@ -1774,18 +1981,24 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1774
1981
|
* @summary Export customers
|
|
1775
1982
|
* @param {string} project Project unique identifier
|
|
1776
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.
|
|
1777
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.
|
|
1778
1987
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1779
|
-
* @param {
|
|
1780
|
-
* @param {
|
|
1781
|
-
* @param {number} [
|
|
1782
|
-
* @param {
|
|
1988
|
+
* @param {Array<string>} [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
|
|
1783
1996
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1784
1997
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1785
1998
|
* @param {*} [options] Override http request option.
|
|
1786
1999
|
* @throws {RequiredError}
|
|
1787
2000
|
*/
|
|
1788
|
-
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<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1789
2002
|
// verify required parameter 'project' is not null or undefined
|
|
1790
2003
|
assertParamExists('exportCustomers', 'project', project)
|
|
1791
2004
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1814,28 +2027,52 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1814
2027
|
localVarQueryParameter['project'] = project;
|
|
1815
2028
|
}
|
|
1816
2029
|
|
|
2030
|
+
if (sortBy) {
|
|
2031
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
2032
|
+
}
|
|
2033
|
+
|
|
1817
2034
|
if (countries) {
|
|
1818
2035
|
localVarQueryParameter['countries'] = countries;
|
|
1819
2036
|
}
|
|
1820
2037
|
|
|
2038
|
+
if (projects) {
|
|
2039
|
+
localVarQueryParameter['projects'] = projects;
|
|
2040
|
+
}
|
|
2041
|
+
|
|
1821
2042
|
if (gender !== undefined) {
|
|
1822
2043
|
localVarQueryParameter['gender'] = gender;
|
|
1823
2044
|
}
|
|
1824
2045
|
|
|
1825
|
-
if (
|
|
1826
|
-
localVarQueryParameter['
|
|
2046
|
+
if (productTypes) {
|
|
2047
|
+
localVarQueryParameter['productTypes'] = productTypes;
|
|
1827
2048
|
}
|
|
1828
2049
|
|
|
1829
|
-
if (
|
|
1830
|
-
localVarQueryParameter['
|
|
2050
|
+
if (usedDiscount !== undefined) {
|
|
2051
|
+
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
1831
2052
|
}
|
|
1832
2053
|
|
|
1833
|
-
if (
|
|
1834
|
-
localVarQueryParameter['
|
|
2054
|
+
if (minimumTotalOrderCount !== undefined) {
|
|
2055
|
+
localVarQueryParameter['minimumTotalOrderCount'] = minimumTotalOrderCount;
|
|
1835
2056
|
}
|
|
1836
2057
|
|
|
1837
|
-
if (
|
|
1838
|
-
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;
|
|
1839
2076
|
}
|
|
1840
2077
|
|
|
1841
2078
|
if (lastPurchasedStart !== undefined) {
|
|
@@ -1921,16 +2158,22 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1921
2158
|
* @param {string} [search] Search term to filter results
|
|
1922
2159
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1923
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.
|
|
1924
2162
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
1925
|
-
* @param {
|
|
1926
|
-
* @param {
|
|
1927
|
-
* @param {number} [
|
|
2163
|
+
* @param {Array<string>} [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
|
|
1928
2171
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1929
2172
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1930
2173
|
* @param {*} [options] Override http request option.
|
|
1931
2174
|
* @throws {RequiredError}
|
|
1932
2175
|
*/
|
|
1933
|
-
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<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1934
2177
|
// verify required parameter 'project' is not null or undefined
|
|
1935
2178
|
assertParamExists('listCustomers', 'project', project)
|
|
1936
2179
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1979,20 +2222,44 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1979
2222
|
localVarQueryParameter['countries'] = countries;
|
|
1980
2223
|
}
|
|
1981
2224
|
|
|
2225
|
+
if (projects) {
|
|
2226
|
+
localVarQueryParameter['projects'] = projects;
|
|
2227
|
+
}
|
|
2228
|
+
|
|
1982
2229
|
if (gender !== undefined) {
|
|
1983
2230
|
localVarQueryParameter['gender'] = gender;
|
|
1984
2231
|
}
|
|
1985
2232
|
|
|
1986
|
-
if (
|
|
1987
|
-
localVarQueryParameter['
|
|
2233
|
+
if (productTypes) {
|
|
2234
|
+
localVarQueryParameter['productTypes'] = productTypes;
|
|
1988
2235
|
}
|
|
1989
2236
|
|
|
1990
|
-
if (
|
|
1991
|
-
localVarQueryParameter['
|
|
2237
|
+
if (usedDiscount !== undefined) {
|
|
2238
|
+
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
1992
2239
|
}
|
|
1993
2240
|
|
|
1994
|
-
if (
|
|
1995
|
-
localVarQueryParameter['
|
|
2241
|
+
if (minimumTotalOrderCount !== undefined) {
|
|
2242
|
+
localVarQueryParameter['minimumTotalOrderCount'] = minimumTotalOrderCount;
|
|
2243
|
+
}
|
|
2244
|
+
|
|
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;
|
|
1996
2263
|
}
|
|
1997
2264
|
|
|
1998
2265
|
if (lastPurchasedStart !== undefined) {
|
|
@@ -2031,19 +2298,25 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2031
2298
|
* @summary Export customers
|
|
2032
2299
|
* @param {string} project Project unique identifier
|
|
2033
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.
|
|
2034
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.
|
|
2035
2304
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2036
|
-
* @param {
|
|
2037
|
-
* @param {
|
|
2038
|
-
* @param {number} [
|
|
2039
|
-
* @param {
|
|
2305
|
+
* @param {Array<string>} [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
|
|
2040
2313
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2041
2314
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2042
2315
|
* @param {*} [options] Override http request option.
|
|
2043
2316
|
* @throws {RequiredError}
|
|
2044
2317
|
*/
|
|
2045
|
-
async exportCustomers(project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum,
|
|
2046
|
-
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<string>, 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);
|
|
2047
2320
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2048
2321
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2049
2322
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2073,17 +2346,23 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2073
2346
|
* @param {string} [search] Search term to filter results
|
|
2074
2347
|
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2075
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.
|
|
2076
2350
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2077
|
-
* @param {
|
|
2078
|
-
* @param {
|
|
2079
|
-
* @param {number} [
|
|
2351
|
+
* @param {Array<string>} [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
|
|
2080
2359
|
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2081
2360
|
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
2082
2361
|
* @param {*} [options] Override http request option.
|
|
2083
2362
|
* @throws {RequiredError}
|
|
2084
2363
|
*/
|
|
2085
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum,
|
|
2086
|
-
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<string>, 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);
|
|
2087
2366
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2088
2367
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2089
2368
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2106,7 +2385,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2106
2385
|
* @throws {RequiredError}
|
|
2107
2386
|
*/
|
|
2108
2387
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
2109
|
-
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));
|
|
2110
2389
|
},
|
|
2111
2390
|
/**
|
|
2112
2391
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -2126,7 +2405,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2126
2405
|
* @throws {RequiredError}
|
|
2127
2406
|
*/
|
|
2128
2407
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
2129
|
-
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));
|
|
2130
2409
|
},
|
|
2131
2410
|
};
|
|
2132
2411
|
};
|
|
@@ -2151,6 +2430,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2151
2430
|
*/
|
|
2152
2431
|
readonly platformId: string
|
|
2153
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
|
+
|
|
2154
2440
|
/**
|
|
2155
2441
|
* Filter customers by country code
|
|
2156
2442
|
* @type {Array<string>}
|
|
@@ -2158,6 +2444,13 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2158
2444
|
*/
|
|
2159
2445
|
readonly countries?: Array<string>
|
|
2160
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
|
+
|
|
2161
2454
|
/**
|
|
2162
2455
|
* Filter customers by gender equal to the value provided
|
|
2163
2456
|
* @type {'male' | 'female'}
|
|
@@ -2166,32 +2459,60 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2166
2459
|
readonly gender?: ExportCustomersGenderEnum
|
|
2167
2460
|
|
|
2168
2461
|
/**
|
|
2169
|
-
* 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<string>}
|
|
2464
|
+
* @memberof CustomersApiExportCustomers
|
|
2465
|
+
*/
|
|
2466
|
+
readonly productTypes?: Array<string>
|
|
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
|
|
2170
2477
|
* @type {number}
|
|
2171
2478
|
* @memberof CustomersApiExportCustomers
|
|
2172
2479
|
*/
|
|
2173
|
-
readonly
|
|
2480
|
+
readonly minimumTotalOrderCount?: number
|
|
2174
2481
|
|
|
2175
2482
|
/**
|
|
2176
|
-
* Filter customers by
|
|
2483
|
+
* Filter customers by total order count less than or equal to the value provided
|
|
2177
2484
|
* @type {number}
|
|
2178
2485
|
* @memberof CustomersApiExportCustomers
|
|
2179
2486
|
*/
|
|
2180
|
-
readonly
|
|
2487
|
+
readonly maximumTotalOrderCount?: number
|
|
2181
2488
|
|
|
2182
2489
|
/**
|
|
2183
|
-
* Filter customers by
|
|
2490
|
+
* Filter customers by refunded order count greater than or equal to the value provided
|
|
2184
2491
|
* @type {number}
|
|
2185
2492
|
* @memberof CustomersApiExportCustomers
|
|
2186
2493
|
*/
|
|
2187
|
-
readonly
|
|
2494
|
+
readonly minimumRefundedOrderCount?: number
|
|
2188
2495
|
|
|
2189
2496
|
/**
|
|
2190
|
-
*
|
|
2191
|
-
* @type {
|
|
2497
|
+
* Filter customers by refunded order count less than or equal to the value provided
|
|
2498
|
+
* @type {number}
|
|
2192
2499
|
* @memberof CustomersApiExportCustomers
|
|
2193
2500
|
*/
|
|
2194
|
-
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
|
|
2195
2516
|
|
|
2196
2517
|
/**
|
|
2197
2518
|
* Start of date range to filter customers by last purchase date
|
|
@@ -2279,7 +2600,7 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2279
2600
|
|
|
2280
2601
|
/**
|
|
2281
2602
|
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2282
|
-
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2603
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
|
|
2283
2604
|
* @memberof CustomersApiListCustomers
|
|
2284
2605
|
*/
|
|
2285
2606
|
readonly sortBy?: Array<ListCustomersSortByEnum>
|
|
@@ -2291,6 +2612,13 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2291
2612
|
*/
|
|
2292
2613
|
readonly countries?: Array<string>
|
|
2293
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
|
+
|
|
2294
2622
|
/**
|
|
2295
2623
|
* Filter customers by gender equal to the value provided
|
|
2296
2624
|
* @type {'male' | 'female'}
|
|
@@ -2299,25 +2627,60 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2299
2627
|
readonly gender?: ListCustomersGenderEnum
|
|
2300
2628
|
|
|
2301
2629
|
/**
|
|
2302
|
-
* 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<string>}
|
|
2632
|
+
* @memberof CustomersApiListCustomers
|
|
2633
|
+
*/
|
|
2634
|
+
readonly productTypes?: Array<string>
|
|
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
|
|
2303
2659
|
* @type {number}
|
|
2304
2660
|
* @memberof CustomersApiListCustomers
|
|
2305
2661
|
*/
|
|
2306
|
-
readonly
|
|
2662
|
+
readonly minimumRefundedOrderCount?: number
|
|
2307
2663
|
|
|
2308
2664
|
/**
|
|
2309
|
-
* 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
|
|
2310
2666
|
* @type {number}
|
|
2311
2667
|
* @memberof CustomersApiListCustomers
|
|
2312
2668
|
*/
|
|
2313
|
-
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
|
|
2314
2677
|
|
|
2315
2678
|
/**
|
|
2316
2679
|
* Filter customers by lifetime value less than or equal to the value provided
|
|
2317
2680
|
* @type {number}
|
|
2318
2681
|
* @memberof CustomersApiListCustomers
|
|
2319
2682
|
*/
|
|
2320
|
-
readonly
|
|
2683
|
+
readonly maximumLifetimeValue?: number
|
|
2321
2684
|
|
|
2322
2685
|
/**
|
|
2323
2686
|
* Start of date range to filter customers by last purchase date
|
|
@@ -2350,7 +2713,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
2350
2713
|
* @memberof CustomersApi
|
|
2351
2714
|
*/
|
|
2352
2715
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2353
|
-
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));
|
|
2354
2717
|
}
|
|
2355
2718
|
|
|
2356
2719
|
/**
|
|
@@ -2374,18 +2737,10 @@ export class CustomersApi extends BaseAPI {
|
|
|
2374
2737
|
* @memberof CustomersApi
|
|
2375
2738
|
*/
|
|
2376
2739
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2377
|
-
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));
|
|
2378
2741
|
}
|
|
2379
2742
|
}
|
|
2380
2743
|
|
|
2381
|
-
/**
|
|
2382
|
-
* @export
|
|
2383
|
-
*/
|
|
2384
|
-
export const ExportCustomersGenderEnum = {
|
|
2385
|
-
Male: 'male',
|
|
2386
|
-
Female: 'female'
|
|
2387
|
-
} as const;
|
|
2388
|
-
export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
|
|
2389
2744
|
/**
|
|
2390
2745
|
* @export
|
|
2391
2746
|
*/
|
|
@@ -2397,9 +2752,19 @@ export const ExportCustomersSortByEnum = {
|
|
|
2397
2752
|
RefundedOrderCount: '+refundedOrderCount',
|
|
2398
2753
|
RefundedOrderCount2: '-refundedOrderCount',
|
|
2399
2754
|
LastPurchased: '+lastPurchased',
|
|
2400
|
-
LastPurchased2: '-lastPurchased'
|
|
2755
|
+
LastPurchased2: '-lastPurchased',
|
|
2756
|
+
UsedDiscount: '+usedDiscount',
|
|
2757
|
+
UsedDiscount2: '-usedDiscount'
|
|
2401
2758
|
} as const;
|
|
2402
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];
|
|
2403
2768
|
/**
|
|
2404
2769
|
* @export
|
|
2405
2770
|
*/
|
|
@@ -2411,7 +2776,9 @@ export const ListCustomersSortByEnum = {
|
|
|
2411
2776
|
RefundedOrderCount: '+refundedOrderCount',
|
|
2412
2777
|
RefundedOrderCount2: '-refundedOrderCount',
|
|
2413
2778
|
LastPurchased: '+lastPurchased',
|
|
2414
|
-
LastPurchased2: '-lastPurchased'
|
|
2779
|
+
LastPurchased2: '-lastPurchased',
|
|
2780
|
+
UsedDiscount: '+usedDiscount',
|
|
2781
|
+
UsedDiscount2: '-usedDiscount'
|
|
2415
2782
|
} as const;
|
|
2416
2783
|
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2417
2784
|
/**
|
|
@@ -3125,6 +3492,118 @@ export class EnquiriesApi extends BaseAPI {
|
|
|
3125
3492
|
*/
|
|
3126
3493
|
export const OrdersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3127
3494
|
return {
|
|
3495
|
+
/**
|
|
3496
|
+
*
|
|
3497
|
+
* @summary Confirm order
|
|
3498
|
+
* @param {string} project Project unique identifier
|
|
3499
|
+
* @param {string} platformId The platform identifier
|
|
3500
|
+
* @param {string} orderId The order identifier
|
|
3501
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
3502
|
+
* @param {*} [options] Override http request option.
|
|
3503
|
+
* @throws {RequiredError}
|
|
3504
|
+
*/
|
|
3505
|
+
confirmOrder: async (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3506
|
+
// verify required parameter 'project' is not null or undefined
|
|
3507
|
+
assertParamExists('confirmOrder', 'project', project)
|
|
3508
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3509
|
+
assertParamExists('confirmOrder', 'platformId', platformId)
|
|
3510
|
+
// verify required parameter 'orderId' is not null or undefined
|
|
3511
|
+
assertParamExists('confirmOrder', 'orderId', orderId)
|
|
3512
|
+
// verify required parameter 'confirmOrderRequest' is not null or undefined
|
|
3513
|
+
assertParamExists('confirmOrder', 'confirmOrderRequest', confirmOrderRequest)
|
|
3514
|
+
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}/confirm`
|
|
3515
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3516
|
+
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
3517
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3518
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3519
|
+
let baseOptions;
|
|
3520
|
+
if (configuration) {
|
|
3521
|
+
baseOptions = configuration.baseOptions;
|
|
3522
|
+
}
|
|
3523
|
+
|
|
3524
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3525
|
+
const localVarHeaderParameter = {} as any;
|
|
3526
|
+
const localVarQueryParameter = {} as any;
|
|
3527
|
+
|
|
3528
|
+
// authentication session-oauth required
|
|
3529
|
+
// oauth required
|
|
3530
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3531
|
+
|
|
3532
|
+
// authentication api-key required
|
|
3533
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3534
|
+
|
|
3535
|
+
if (project !== undefined) {
|
|
3536
|
+
localVarQueryParameter['project'] = project;
|
|
3537
|
+
}
|
|
3538
|
+
|
|
3539
|
+
|
|
3540
|
+
|
|
3541
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3542
|
+
|
|
3543
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3544
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3545
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3546
|
+
localVarRequestOptions.data = serializeDataIfNeeded(confirmOrderRequest, localVarRequestOptions, configuration)
|
|
3547
|
+
|
|
3548
|
+
return {
|
|
3549
|
+
url: toPathString(localVarUrlObj),
|
|
3550
|
+
options: localVarRequestOptions,
|
|
3551
|
+
};
|
|
3552
|
+
},
|
|
3553
|
+
/**
|
|
3554
|
+
*
|
|
3555
|
+
* @summary Create order
|
|
3556
|
+
* @param {string} project Project unique identifier
|
|
3557
|
+
* @param {string} platformId The platform identifier
|
|
3558
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
3559
|
+
* @param {*} [options] Override http request option.
|
|
3560
|
+
* @throws {RequiredError}
|
|
3561
|
+
*/
|
|
3562
|
+
createOrder: async (project: string, platformId: string, createOrder: CreateOrder, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3563
|
+
// verify required parameter 'project' is not null or undefined
|
|
3564
|
+
assertParamExists('createOrder', 'project', project)
|
|
3565
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3566
|
+
assertParamExists('createOrder', 'platformId', platformId)
|
|
3567
|
+
// verify required parameter 'createOrder' is not null or undefined
|
|
3568
|
+
assertParamExists('createOrder', 'createOrder', createOrder)
|
|
3569
|
+
const localVarPath = `/v1/platform/{platformId}/orders`
|
|
3570
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3571
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3572
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3573
|
+
let baseOptions;
|
|
3574
|
+
if (configuration) {
|
|
3575
|
+
baseOptions = configuration.baseOptions;
|
|
3576
|
+
}
|
|
3577
|
+
|
|
3578
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
3579
|
+
const localVarHeaderParameter = {} as any;
|
|
3580
|
+
const localVarQueryParameter = {} as any;
|
|
3581
|
+
|
|
3582
|
+
// authentication session-oauth required
|
|
3583
|
+
// oauth required
|
|
3584
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3585
|
+
|
|
3586
|
+
// authentication api-key required
|
|
3587
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3588
|
+
|
|
3589
|
+
if (project !== undefined) {
|
|
3590
|
+
localVarQueryParameter['project'] = project;
|
|
3591
|
+
}
|
|
3592
|
+
|
|
3593
|
+
|
|
3594
|
+
|
|
3595
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3596
|
+
|
|
3597
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3598
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3599
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3600
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createOrder, localVarRequestOptions, configuration)
|
|
3601
|
+
|
|
3602
|
+
return {
|
|
3603
|
+
url: toPathString(localVarUrlObj),
|
|
3604
|
+
options: localVarRequestOptions,
|
|
3605
|
+
};
|
|
3606
|
+
},
|
|
3128
3607
|
/**
|
|
3129
3608
|
* Export orders as a CSV file
|
|
3130
3609
|
* @summary Export orders
|
|
@@ -3666,6 +4145,37 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3666
4145
|
export const OrdersApiFp = function(configuration?: Configuration) {
|
|
3667
4146
|
const localVarAxiosParamCreator = OrdersApiAxiosParamCreator(configuration)
|
|
3668
4147
|
return {
|
|
4148
|
+
/**
|
|
4149
|
+
*
|
|
4150
|
+
* @summary Confirm order
|
|
4151
|
+
* @param {string} project Project unique identifier
|
|
4152
|
+
* @param {string} platformId The platform identifier
|
|
4153
|
+
* @param {string} orderId The order identifier
|
|
4154
|
+
* @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
|
|
4155
|
+
* @param {*} [options] Override http request option.
|
|
4156
|
+
* @throws {RequiredError}
|
|
4157
|
+
*/
|
|
4158
|
+
async confirmOrder(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
4159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.confirmOrder(project, platformId, orderId, confirmOrderRequest, options);
|
|
4160
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4161
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.confirmOrder']?.[localVarOperationServerIndex]?.url;
|
|
4162
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4163
|
+
},
|
|
4164
|
+
/**
|
|
4165
|
+
*
|
|
4166
|
+
* @summary Create order
|
|
4167
|
+
* @param {string} project Project unique identifier
|
|
4168
|
+
* @param {string} platformId The platform identifier
|
|
4169
|
+
* @param {CreateOrder} createOrder Create Order schema
|
|
4170
|
+
* @param {*} [options] Override http request option.
|
|
4171
|
+
* @throws {RequiredError}
|
|
4172
|
+
*/
|
|
4173
|
+
async createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
4174
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createOrder(project, platformId, createOrder, options);
|
|
4175
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
4176
|
+
const localVarOperationServerBasePath = operationServerMap['OrdersApi.createOrder']?.[localVarOperationServerIndex]?.url;
|
|
4177
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4178
|
+
},
|
|
3669
4179
|
/**
|
|
3670
4180
|
* Export orders as a CSV file
|
|
3671
4181
|
* @summary Export orders
|
|
@@ -3821,6 +4331,26 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
3821
4331
|
export const OrdersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3822
4332
|
const localVarFp = OrdersApiFp(configuration)
|
|
3823
4333
|
return {
|
|
4334
|
+
/**
|
|
4335
|
+
*
|
|
4336
|
+
* @summary Confirm order
|
|
4337
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4338
|
+
* @param {*} [options] Override http request option.
|
|
4339
|
+
* @throws {RequiredError}
|
|
4340
|
+
*/
|
|
4341
|
+
confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
4342
|
+
return localVarFp.confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(axios, basePath));
|
|
4343
|
+
},
|
|
4344
|
+
/**
|
|
4345
|
+
*
|
|
4346
|
+
* @summary Create order
|
|
4347
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4348
|
+
* @param {*} [options] Override http request option.
|
|
4349
|
+
* @throws {RequiredError}
|
|
4350
|
+
*/
|
|
4351
|
+
createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
4352
|
+
return localVarFp.createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(axios, basePath));
|
|
4353
|
+
},
|
|
3824
4354
|
/**
|
|
3825
4355
|
* Export orders as a CSV file
|
|
3826
4356
|
* @summary Export orders
|
|
@@ -3914,6 +4444,69 @@ export const OrdersApiFactory = function (configuration?: Configuration, basePat
|
|
|
3914
4444
|
};
|
|
3915
4445
|
};
|
|
3916
4446
|
|
|
4447
|
+
/**
|
|
4448
|
+
* Request parameters for confirmOrder operation in OrdersApi.
|
|
4449
|
+
* @export
|
|
4450
|
+
* @interface OrdersApiConfirmOrderRequest
|
|
4451
|
+
*/
|
|
4452
|
+
export interface OrdersApiConfirmOrderRequest {
|
|
4453
|
+
/**
|
|
4454
|
+
* Project unique identifier
|
|
4455
|
+
* @type {string}
|
|
4456
|
+
* @memberof OrdersApiConfirmOrder
|
|
4457
|
+
*/
|
|
4458
|
+
readonly project: string
|
|
4459
|
+
|
|
4460
|
+
/**
|
|
4461
|
+
* The platform identifier
|
|
4462
|
+
* @type {string}
|
|
4463
|
+
* @memberof OrdersApiConfirmOrder
|
|
4464
|
+
*/
|
|
4465
|
+
readonly platformId: string
|
|
4466
|
+
|
|
4467
|
+
/**
|
|
4468
|
+
* The order identifier
|
|
4469
|
+
* @type {string}
|
|
4470
|
+
* @memberof OrdersApiConfirmOrder
|
|
4471
|
+
*/
|
|
4472
|
+
readonly orderId: string
|
|
4473
|
+
|
|
4474
|
+
/**
|
|
4475
|
+
* ConfirmFulfillment schema
|
|
4476
|
+
* @type {ConfirmOrderRequest}
|
|
4477
|
+
* @memberof OrdersApiConfirmOrder
|
|
4478
|
+
*/
|
|
4479
|
+
readonly confirmOrderRequest: ConfirmOrderRequest
|
|
4480
|
+
}
|
|
4481
|
+
|
|
4482
|
+
/**
|
|
4483
|
+
* Request parameters for createOrder operation in OrdersApi.
|
|
4484
|
+
* @export
|
|
4485
|
+
* @interface OrdersApiCreateOrderRequest
|
|
4486
|
+
*/
|
|
4487
|
+
export interface OrdersApiCreateOrderRequest {
|
|
4488
|
+
/**
|
|
4489
|
+
* Project unique identifier
|
|
4490
|
+
* @type {string}
|
|
4491
|
+
* @memberof OrdersApiCreateOrder
|
|
4492
|
+
*/
|
|
4493
|
+
readonly project: string
|
|
4494
|
+
|
|
4495
|
+
/**
|
|
4496
|
+
* The platform identifier
|
|
4497
|
+
* @type {string}
|
|
4498
|
+
* @memberof OrdersApiCreateOrder
|
|
4499
|
+
*/
|
|
4500
|
+
readonly platformId: string
|
|
4501
|
+
|
|
4502
|
+
/**
|
|
4503
|
+
* Create Order schema
|
|
4504
|
+
* @type {CreateOrder}
|
|
4505
|
+
* @memberof OrdersApiCreateOrder
|
|
4506
|
+
*/
|
|
4507
|
+
readonly createOrder: CreateOrder
|
|
4508
|
+
}
|
|
4509
|
+
|
|
3917
4510
|
/**
|
|
3918
4511
|
* Request parameters for exportOrders operation in OrdersApi.
|
|
3919
4512
|
* @export
|
|
@@ -4243,6 +4836,30 @@ export interface OrdersApiUpdateFulfillmentRequest {
|
|
|
4243
4836
|
* @extends {BaseAPI}
|
|
4244
4837
|
*/
|
|
4245
4838
|
export class OrdersApi extends BaseAPI {
|
|
4839
|
+
/**
|
|
4840
|
+
*
|
|
4841
|
+
* @summary Confirm order
|
|
4842
|
+
* @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
|
|
4843
|
+
* @param {*} [options] Override http request option.
|
|
4844
|
+
* @throws {RequiredError}
|
|
4845
|
+
* @memberof OrdersApi
|
|
4846
|
+
*/
|
|
4847
|
+
public confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig) {
|
|
4848
|
+
return OrdersApiFp(this.configuration).confirmOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, requestParameters.confirmOrderRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4849
|
+
}
|
|
4850
|
+
|
|
4851
|
+
/**
|
|
4852
|
+
*
|
|
4853
|
+
* @summary Create order
|
|
4854
|
+
* @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
|
|
4855
|
+
* @param {*} [options] Override http request option.
|
|
4856
|
+
* @throws {RequiredError}
|
|
4857
|
+
* @memberof OrdersApi
|
|
4858
|
+
*/
|
|
4859
|
+
public createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig) {
|
|
4860
|
+
return OrdersApiFp(this.configuration).createOrder(requestParameters.project, requestParameters.platformId, requestParameters.createOrder, options).then((request) => request(this.axios, this.basePath));
|
|
4861
|
+
}
|
|
4862
|
+
|
|
4246
4863
|
/**
|
|
4247
4864
|
* Export orders as a CSV file
|
|
4248
4865
|
* @summary Export orders
|