@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/dist/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.27.0
5
+ * The version of the OpenAPI document: 0.29.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -112,6 +112,57 @@ export interface Client {
112
112
  */
113
113
  'name'?: string;
114
114
  }
115
+ /**
116
+ *
117
+ * @export
118
+ * @interface ConfirmOrderFulfillment
119
+ */
120
+ export interface ConfirmOrderFulfillment {
121
+ /**
122
+ * Unique object identifier
123
+ * @type {string}
124
+ * @memberof ConfirmOrderFulfillment
125
+ */
126
+ 'fulfillmentId': string;
127
+ /**
128
+ * Unique object identifier
129
+ * @type {string}
130
+ * @memberof ConfirmOrderFulfillment
131
+ */
132
+ 'shippingMethodId'?: string;
133
+ /**
134
+ *
135
+ * @type {ConfirmOrderFulfillmentShipment}
136
+ * @memberof ConfirmOrderFulfillment
137
+ */
138
+ 'shipment'?: ConfirmOrderFulfillmentShipment;
139
+ }
140
+ /**
141
+ * This field is only required if you are using your own shipping label.
142
+ * @export
143
+ * @interface ConfirmOrderFulfillmentShipment
144
+ */
145
+ export interface ConfirmOrderFulfillmentShipment {
146
+ /**
147
+ * Only required if you are generating shipping labels outside of PodOS
148
+ * @type {string}
149
+ * @memberof ConfirmOrderFulfillmentShipment
150
+ */
151
+ 'image': string;
152
+ }
153
+ /**
154
+ *
155
+ * @export
156
+ * @interface ConfirmOrderRequest
157
+ */
158
+ export interface ConfirmOrderRequest {
159
+ /**
160
+ *
161
+ * @type {Array<ConfirmOrderFulfillment>}
162
+ * @memberof ConfirmOrderRequest
163
+ */
164
+ 'fulfillments': Array<ConfirmOrderFulfillment>;
165
+ }
115
166
  /**
116
167
  * Order recipient contact information, used only for courier tracking/updates.
117
168
  * @export
@@ -176,6 +227,74 @@ export interface CreateDomainRequest {
176
227
  */
177
228
  'domain'?: string;
178
229
  }
230
+ /**
231
+ * Create an order
232
+ * @export
233
+ * @interface CreateOrder
234
+ */
235
+ export interface CreateOrder {
236
+ /**
237
+ * A custom reference to the merchant\'s order.
238
+ * @type {string}
239
+ * @memberof CreateOrder
240
+ */
241
+ 'merchantReference'?: string | null;
242
+ /**
243
+ *
244
+ * @type {CreateOrderContactInformation}
245
+ * @memberof CreateOrder
246
+ */
247
+ 'contactInformation': CreateOrderContactInformation;
248
+ /**
249
+ *
250
+ * @type {Address}
251
+ * @memberof CreateOrder
252
+ */
253
+ 'shippingAddress': Address;
254
+ /**
255
+ *
256
+ * @type {CustomsInformation}
257
+ * @memberof CreateOrder
258
+ */
259
+ 'customsInformation'?: CustomsInformation;
260
+ /**
261
+ * Items to be ordered
262
+ * @type {Array<OrderItem1>}
263
+ * @memberof CreateOrder
264
+ */
265
+ 'items': Array<OrderItem1>;
266
+ /**
267
+ *
268
+ * @type {Array<string>}
269
+ * @memberof CreateOrder
270
+ */
271
+ 'preferredFulfillers'?: Array<string>;
272
+ /**
273
+ * A reference to the resource location
274
+ * @type {string}
275
+ * @memberof CreateOrder
276
+ */
277
+ 'originalOrderRef'?: string;
278
+ }
279
+ /**
280
+ * Contact information for the order
281
+ * @export
282
+ * @interface CreateOrderContactInformation
283
+ */
284
+ export interface CreateOrderContactInformation {
285
+ /**
286
+ *
287
+ * @type {string}
288
+ * @memberof CreateOrderContactInformation
289
+ */
290
+ 'email': string;
291
+ /**
292
+ *
293
+ * @type {string}
294
+ * @memberof CreateOrderContactInformation
295
+ */
296
+ 'phone'?: string | null;
297
+ }
179
298
  /**
180
299
  * The customer that has placed an order on your platform
181
300
  * @export
@@ -244,6 +363,41 @@ export interface CustomersResponse {
244
363
  */
245
364
  'nextPageToken'?: number | null;
246
365
  }
366
+ /**
367
+ * Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
368
+ * @export
369
+ * @interface CustomsInformation
370
+ */
371
+ export interface CustomsInformation {
372
+ /**
373
+ * Pre-registration type
374
+ * @type {string}
375
+ * @memberof CustomsInformation
376
+ */
377
+ 'preRegistrationType'?: CustomsInformationPreRegistrationTypeEnum;
378
+ /**
379
+ * Pre-registration number
380
+ * @type {string}
381
+ * @memberof CustomsInformation
382
+ */
383
+ 'preRegistrationNumber'?: string;
384
+ /**
385
+ * VAT number
386
+ * @type {string}
387
+ * @memberof CustomsInformation
388
+ */
389
+ 'vatNumber'?: string;
390
+ /**
391
+ * EORI number
392
+ * @type {string}
393
+ * @memberof CustomsInformation
394
+ */
395
+ 'eoriNumber'?: string;
396
+ }
397
+ export declare const CustomsInformationPreRegistrationTypeEnum: {
398
+ readonly Ioss: "IOSS";
399
+ };
400
+ export type CustomsInformationPreRegistrationTypeEnum = typeof CustomsInformationPreRegistrationTypeEnum[keyof typeof CustomsInformationPreRegistrationTypeEnum];
247
401
  /**
248
402
  *
249
403
  * @export
@@ -967,6 +1121,50 @@ export interface OrderItem {
967
1121
  */
968
1122
  'recipientCost'?: Price;
969
1123
  }
1124
+ /**
1125
+ *
1126
+ * @export
1127
+ * @interface OrderItem1
1128
+ */
1129
+ export interface OrderItem1 {
1130
+ /**
1131
+ * A reference to the variant being ordered
1132
+ * @type {string}
1133
+ * @memberof OrderItem1
1134
+ */
1135
+ 'variantRef': string;
1136
+ /**
1137
+ *
1138
+ * @type {number}
1139
+ * @memberof OrderItem1
1140
+ */
1141
+ 'quantity': number;
1142
+ /**
1143
+ *
1144
+ * @type {OrderItem1RecipientCost}
1145
+ * @memberof OrderItem1
1146
+ */
1147
+ 'recipientCost'?: OrderItem1RecipientCost;
1148
+ }
1149
+ /**
1150
+ *
1151
+ * @export
1152
+ * @interface OrderItem1RecipientCost
1153
+ */
1154
+ export interface OrderItem1RecipientCost {
1155
+ /**
1156
+ *
1157
+ * @type {string}
1158
+ * @memberof OrderItem1RecipientCost
1159
+ */
1160
+ 'amount': string;
1161
+ /**
1162
+ *
1163
+ * @type {string}
1164
+ * @memberof OrderItem1RecipientCost
1165
+ */
1166
+ 'currencyCode': string;
1167
+ }
970
1168
  /**
971
1169
  *
972
1170
  * @export
@@ -1553,6 +1751,12 @@ export interface Statistics {
1553
1751
  * @memberof Statistics
1554
1752
  */
1555
1753
  'lastPurchased': string | null;
1754
+ /**
1755
+ *
1756
+ * @type {boolean}
1757
+ * @memberof Statistics
1758
+ */
1759
+ 'usedDiscount': boolean;
1556
1760
  }
1557
1761
  /**
1558
1762
  *
@@ -1745,18 +1949,24 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1745
1949
  * @summary Export customers
1746
1950
  * @param {string} project Project unique identifier
1747
1951
  * @param {string} platformId The platform identifier
1952
+ * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1748
1953
  * @param {Array<string>} [countries] Filter customers by country code
1954
+ * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
1749
1955
  * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
1750
- * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1751
- * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
1752
- * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1753
- * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1956
+ * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
1957
+ * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
1958
+ * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
1959
+ * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
1960
+ * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
1961
+ * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
1962
+ * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
1963
+ * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1754
1964
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1755
1965
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1756
1966
  * @param {*} [options] Override http request option.
1757
1967
  * @throws {RequiredError}
1758
1968
  */
1759
- exportCustomers: (project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1969
+ 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<RequestArgs>;
1760
1970
  /**
1761
1971
  * Get a customer for a platform by a given customer ID.
1762
1972
  * @summary Get customer
@@ -1777,16 +1987,22 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1777
1987
  * @param {string} [search] Search term to filter results
1778
1988
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1779
1989
  * @param {Array<string>} [countries] Filter customers by country code
1990
+ * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
1780
1991
  * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
1781
- * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1782
- * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
1783
- * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1992
+ * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
1993
+ * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
1994
+ * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
1995
+ * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
1996
+ * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
1997
+ * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
1998
+ * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
1999
+ * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1784
2000
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1785
2001
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1786
2002
  * @param {*} [options] Override http request option.
1787
2003
  * @throws {RequiredError}
1788
2004
  */
1789
- listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2005
+ 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<RequestArgs>;
1790
2006
  };
1791
2007
  /**
1792
2008
  * CustomersApi - functional programming interface
@@ -1798,18 +2014,24 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1798
2014
  * @summary Export customers
1799
2015
  * @param {string} project Project unique identifier
1800
2016
  * @param {string} platformId The platform identifier
2017
+ * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1801
2018
  * @param {Array<string>} [countries] Filter customers by country code
2019
+ * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
1802
2020
  * @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
1803
- * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1804
- * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
1805
- * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1806
- * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2021
+ * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
2022
+ * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
2023
+ * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
2024
+ * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
2025
+ * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
2026
+ * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
2027
+ * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
2028
+ * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1807
2029
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1808
2030
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1809
2031
  * @param {*} [options] Override http request option.
1810
2032
  * @throws {RequiredError}
1811
2033
  */
1812
- exportCustomers(project: string, platformId: string, countries?: Array<string>, gender?: ExportCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2034
+ 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>>;
1813
2035
  /**
1814
2036
  * Get a customer for a platform by a given customer ID.
1815
2037
  * @summary Get customer
@@ -1830,16 +2052,22 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1830
2052
  * @param {string} [search] Search term to filter results
1831
2053
  * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1832
2054
  * @param {Array<string>} [countries] Filter customers by country code
2055
+ * @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
1833
2056
  * @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
1834
- * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1835
- * @param {number} [refundedOrderCount] Filter customers by refunded order count equal to the value provided
1836
- * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
2057
+ * @param {Array<string>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
2058
+ * @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
2059
+ * @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
2060
+ * @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
2061
+ * @param {number} [minimumRefundedOrderCount] Filter customers by refunded order count greater than or equal to the value provided
2062
+ * @param {number} [maximumRefundedOrderCount] Filter customers by refunded order count less than or equal to the value provided
2063
+ * @param {number} [minimumLifetimeValue] Filter customers by lifetime value greater than or equal to the value provided
2064
+ * @param {number} [maximumLifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1837
2065
  * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1838
2066
  * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1839
2067
  * @param {*} [options] Override http request option.
1840
2068
  * @throws {RequiredError}
1841
2069
  */
1842
- listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, gender?: ListCustomersGenderEnum, totalOrderCount?: number, refundedOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
2070
+ 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>>;
1843
2071
  };
1844
2072
  /**
1845
2073
  * CustomersApi - factory interface
@@ -1889,12 +2117,24 @@ export interface CustomersApiExportCustomersRequest {
1889
2117
  * @memberof CustomersApiExportCustomers
1890
2118
  */
1891
2119
  readonly platformId: string;
2120
+ /**
2121
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2122
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
2123
+ * @memberof CustomersApiExportCustomers
2124
+ */
2125
+ readonly sortBy?: Array<ExportCustomersSortByEnum>;
1892
2126
  /**
1893
2127
  * Filter customers by country code
1894
2128
  * @type {Array<string>}
1895
2129
  * @memberof CustomersApiExportCustomers
1896
2130
  */
1897
2131
  readonly countries?: Array<string>;
2132
+ /**
2133
+ * Filter customers by project. In the absence of this field, all projects will be included in the export.
2134
+ * @type {Array<string>}
2135
+ * @memberof CustomersApiExportCustomers
2136
+ */
2137
+ readonly projects?: Array<string>;
1898
2138
  /**
1899
2139
  * Filter customers by gender equal to the value provided
1900
2140
  * @type {'male' | 'female'}
@@ -1902,29 +2142,53 @@ export interface CustomersApiExportCustomersRequest {
1902
2142
  */
1903
2143
  readonly gender?: ExportCustomersGenderEnum;
1904
2144
  /**
1905
- * Filter customers by total order count equal to the value provided
2145
+ * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
2146
+ * @type {Array<string>}
2147
+ * @memberof CustomersApiExportCustomers
2148
+ */
2149
+ readonly productTypes?: Array<string>;
2150
+ /**
2151
+ * Filter customers by whether they have used a discount
2152
+ * @type {boolean}
2153
+ * @memberof CustomersApiExportCustomers
2154
+ */
2155
+ readonly usedDiscount?: boolean;
2156
+ /**
2157
+ * Filter customers by total order count greater than or equal to the value provided
1906
2158
  * @type {number}
1907
2159
  * @memberof CustomersApiExportCustomers
1908
2160
  */
1909
- readonly totalOrderCount?: number;
2161
+ readonly minimumTotalOrderCount?: number;
1910
2162
  /**
1911
- * Filter customers by refunded order count equal to the value provided
2163
+ * Filter customers by total order count less than or equal to the value provided
1912
2164
  * @type {number}
1913
2165
  * @memberof CustomersApiExportCustomers
1914
2166
  */
1915
- readonly refundedOrderCount?: number;
2167
+ readonly maximumTotalOrderCount?: number;
1916
2168
  /**
1917
- * Filter customers by lifetime value less than or equal to the value provided
2169
+ * Filter customers by refunded order count greater than or equal to the value provided
1918
2170
  * @type {number}
1919
2171
  * @memberof CustomersApiExportCustomers
1920
2172
  */
1921
- readonly lifetimeValue?: number;
2173
+ readonly minimumRefundedOrderCount?: number;
1922
2174
  /**
1923
- * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1924
- * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
2175
+ * Filter customers by refunded order count less than or equal to the value provided
2176
+ * @type {number}
1925
2177
  * @memberof CustomersApiExportCustomers
1926
2178
  */
1927
- readonly sortBy?: Array<ExportCustomersSortByEnum>;
2179
+ readonly maximumRefundedOrderCount?: number;
2180
+ /**
2181
+ * Filter customers by lifetime value greater than or equal to the value provided
2182
+ * @type {number}
2183
+ * @memberof CustomersApiExportCustomers
2184
+ */
2185
+ readonly minimumLifetimeValue?: number;
2186
+ /**
2187
+ * Filter customers by lifetime value less than or equal to the value provided
2188
+ * @type {number}
2189
+ * @memberof CustomersApiExportCustomers
2190
+ */
2191
+ readonly maximumLifetimeValue?: number;
1928
2192
  /**
1929
2193
  * Start of date range to filter customers by last purchase date
1930
2194
  * @type {string}
@@ -2001,7 +2265,7 @@ export interface CustomersApiListCustomersRequest {
2001
2265
  readonly search?: string;
2002
2266
  /**
2003
2267
  * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2004
- * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased'>}
2268
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+refundedOrderCount' | '-refundedOrderCount' | '+lastPurchased' | '-lastPurchased' | '+usedDiscount' | '-usedDiscount'>}
2005
2269
  * @memberof CustomersApiListCustomers
2006
2270
  */
2007
2271
  readonly sortBy?: Array<ListCustomersSortByEnum>;
@@ -2011,6 +2275,12 @@ export interface CustomersApiListCustomersRequest {
2011
2275
  * @memberof CustomersApiListCustomers
2012
2276
  */
2013
2277
  readonly countries?: Array<string>;
2278
+ /**
2279
+ * Filter customers by project. In the absence of this field, all projects will be included in the export.
2280
+ * @type {Array<string>}
2281
+ * @memberof CustomersApiListCustomers
2282
+ */
2283
+ readonly projects?: Array<string>;
2014
2284
  /**
2015
2285
  * Filter customers by gender equal to the value provided
2016
2286
  * @type {'male' | 'female'}
@@ -2018,23 +2288,53 @@ export interface CustomersApiListCustomersRequest {
2018
2288
  */
2019
2289
  readonly gender?: ListCustomersGenderEnum;
2020
2290
  /**
2021
- * Filter customers by total order count equal to the value provided
2291
+ * Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
2292
+ * @type {Array<string>}
2293
+ * @memberof CustomersApiListCustomers
2294
+ */
2295
+ readonly productTypes?: Array<string>;
2296
+ /**
2297
+ * Filter customers by whether they have used a discount
2298
+ * @type {boolean}
2299
+ * @memberof CustomersApiListCustomers
2300
+ */
2301
+ readonly usedDiscount?: boolean;
2302
+ /**
2303
+ * Filter customers by total order count greater than or equal to the value provided
2304
+ * @type {number}
2305
+ * @memberof CustomersApiListCustomers
2306
+ */
2307
+ readonly minimumTotalOrderCount?: number;
2308
+ /**
2309
+ * Filter customers by total order count less than or equal to the value provided
2310
+ * @type {number}
2311
+ * @memberof CustomersApiListCustomers
2312
+ */
2313
+ readonly maximumTotalOrderCount?: number;
2314
+ /**
2315
+ * Filter customers by refunded order count greater than or equal to the value provided
2316
+ * @type {number}
2317
+ * @memberof CustomersApiListCustomers
2318
+ */
2319
+ readonly minimumRefundedOrderCount?: number;
2320
+ /**
2321
+ * Filter customers by refunded order count less than or equal to the value provided
2022
2322
  * @type {number}
2023
2323
  * @memberof CustomersApiListCustomers
2024
2324
  */
2025
- readonly totalOrderCount?: number;
2325
+ readonly maximumRefundedOrderCount?: number;
2026
2326
  /**
2027
- * Filter customers by refunded order count equal to the value provided
2327
+ * Filter customers by lifetime value greater than or equal to the value provided
2028
2328
  * @type {number}
2029
2329
  * @memberof CustomersApiListCustomers
2030
2330
  */
2031
- readonly refundedOrderCount?: number;
2331
+ readonly minimumLifetimeValue?: number;
2032
2332
  /**
2033
2333
  * Filter customers by lifetime value less than or equal to the value provided
2034
2334
  * @type {number}
2035
2335
  * @memberof CustomersApiListCustomers
2036
2336
  */
2037
- readonly lifetimeValue?: number;
2337
+ readonly maximumLifetimeValue?: number;
2038
2338
  /**
2039
2339
  * Start of date range to filter customers by last purchase date
2040
2340
  * @type {string}
@@ -2083,14 +2383,6 @@ export declare class CustomersApi extends BaseAPI {
2083
2383
  */
2084
2384
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
2085
2385
  }
2086
- /**
2087
- * @export
2088
- */
2089
- export declare const ExportCustomersGenderEnum: {
2090
- readonly Male: "male";
2091
- readonly Female: "female";
2092
- };
2093
- export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
2094
2386
  /**
2095
2387
  * @export
2096
2388
  */
@@ -2103,8 +2395,18 @@ export declare const ExportCustomersSortByEnum: {
2103
2395
  readonly RefundedOrderCount2: "-refundedOrderCount";
2104
2396
  readonly LastPurchased: "+lastPurchased";
2105
2397
  readonly LastPurchased2: "-lastPurchased";
2398
+ readonly UsedDiscount: "+usedDiscount";
2399
+ readonly UsedDiscount2: "-usedDiscount";
2106
2400
  };
2107
2401
  export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
2402
+ /**
2403
+ * @export
2404
+ */
2405
+ export declare const ExportCustomersGenderEnum: {
2406
+ readonly Male: "male";
2407
+ readonly Female: "female";
2408
+ };
2409
+ export type ExportCustomersGenderEnum = typeof ExportCustomersGenderEnum[keyof typeof ExportCustomersGenderEnum];
2108
2410
  /**
2109
2411
  * @export
2110
2412
  */
@@ -2117,6 +2419,8 @@ export declare const ListCustomersSortByEnum: {
2117
2419
  readonly RefundedOrderCount2: "-refundedOrderCount";
2118
2420
  readonly LastPurchased: "+lastPurchased";
2119
2421
  readonly LastPurchased2: "-lastPurchased";
2422
+ readonly UsedDiscount: "+usedDiscount";
2423
+ readonly UsedDiscount2: "-usedDiscount";
2120
2424
  };
2121
2425
  export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
2122
2426
  /**
@@ -2508,6 +2812,27 @@ export declare class EnquiriesApi extends BaseAPI {
2508
2812
  * @export
2509
2813
  */
2510
2814
  export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
2815
+ /**
2816
+ *
2817
+ * @summary Confirm order
2818
+ * @param {string} project Project unique identifier
2819
+ * @param {string} platformId The platform identifier
2820
+ * @param {string} orderId The order identifier
2821
+ * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
2822
+ * @param {*} [options] Override http request option.
2823
+ * @throws {RequiredError}
2824
+ */
2825
+ confirmOrder: (project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2826
+ /**
2827
+ *
2828
+ * @summary Create order
2829
+ * @param {string} project Project unique identifier
2830
+ * @param {string} platformId The platform identifier
2831
+ * @param {CreateOrder} createOrder Create Order schema
2832
+ * @param {*} [options] Override http request option.
2833
+ * @throws {RequiredError}
2834
+ */
2835
+ createOrder: (project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2511
2836
  /**
2512
2837
  * Export orders as a CSV file
2513
2838
  * @summary Export orders
@@ -2614,6 +2939,27 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
2614
2939
  * @export
2615
2940
  */
2616
2941
  export declare const OrdersApiFp: (configuration?: Configuration) => {
2942
+ /**
2943
+ *
2944
+ * @summary Confirm order
2945
+ * @param {string} project Project unique identifier
2946
+ * @param {string} platformId The platform identifier
2947
+ * @param {string} orderId The order identifier
2948
+ * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
2949
+ * @param {*} [options] Override http request option.
2950
+ * @throws {RequiredError}
2951
+ */
2952
+ confirmOrder(project: string, platformId: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
2953
+ /**
2954
+ *
2955
+ * @summary Create order
2956
+ * @param {string} project Project unique identifier
2957
+ * @param {string} platformId The platform identifier
2958
+ * @param {CreateOrder} createOrder Create Order schema
2959
+ * @param {*} [options] Override http request option.
2960
+ * @throws {RequiredError}
2961
+ */
2962
+ createOrder(project: string, platformId: string, createOrder: CreateOrder, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
2617
2963
  /**
2618
2964
  * Export orders as a CSV file
2619
2965
  * @summary Export orders
@@ -2720,6 +3066,22 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2720
3066
  * @export
2721
3067
  */
2722
3068
  export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
3069
+ /**
3070
+ *
3071
+ * @summary Confirm order
3072
+ * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
3073
+ * @param {*} [options] Override http request option.
3074
+ * @throws {RequiredError}
3075
+ */
3076
+ confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
3077
+ /**
3078
+ *
3079
+ * @summary Create order
3080
+ * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
3081
+ * @param {*} [options] Override http request option.
3082
+ * @throws {RequiredError}
3083
+ */
3084
+ createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
2723
3085
  /**
2724
3086
  * Export orders as a CSV file
2725
3087
  * @summary Export orders
@@ -2793,6 +3155,62 @@ export declare const OrdersApiFactory: (configuration?: Configuration, basePath?
2793
3155
  */
2794
3156
  updateFulfillment(requestParameters: OrdersApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
2795
3157
  };
3158
+ /**
3159
+ * Request parameters for confirmOrder operation in OrdersApi.
3160
+ * @export
3161
+ * @interface OrdersApiConfirmOrderRequest
3162
+ */
3163
+ export interface OrdersApiConfirmOrderRequest {
3164
+ /**
3165
+ * Project unique identifier
3166
+ * @type {string}
3167
+ * @memberof OrdersApiConfirmOrder
3168
+ */
3169
+ readonly project: string;
3170
+ /**
3171
+ * The platform identifier
3172
+ * @type {string}
3173
+ * @memberof OrdersApiConfirmOrder
3174
+ */
3175
+ readonly platformId: string;
3176
+ /**
3177
+ * The order identifier
3178
+ * @type {string}
3179
+ * @memberof OrdersApiConfirmOrder
3180
+ */
3181
+ readonly orderId: string;
3182
+ /**
3183
+ * ConfirmFulfillment schema
3184
+ * @type {ConfirmOrderRequest}
3185
+ * @memberof OrdersApiConfirmOrder
3186
+ */
3187
+ readonly confirmOrderRequest: ConfirmOrderRequest;
3188
+ }
3189
+ /**
3190
+ * Request parameters for createOrder operation in OrdersApi.
3191
+ * @export
3192
+ * @interface OrdersApiCreateOrderRequest
3193
+ */
3194
+ export interface OrdersApiCreateOrderRequest {
3195
+ /**
3196
+ * Project unique identifier
3197
+ * @type {string}
3198
+ * @memberof OrdersApiCreateOrder
3199
+ */
3200
+ readonly project: string;
3201
+ /**
3202
+ * The platform identifier
3203
+ * @type {string}
3204
+ * @memberof OrdersApiCreateOrder
3205
+ */
3206
+ readonly platformId: string;
3207
+ /**
3208
+ * Create Order schema
3209
+ * @type {CreateOrder}
3210
+ * @memberof OrdersApiCreateOrder
3211
+ */
3212
+ readonly createOrder: CreateOrder;
3213
+ }
2796
3214
  /**
2797
3215
  * Request parameters for exportOrders operation in OrdersApi.
2798
3216
  * @export
@@ -3085,6 +3503,24 @@ export interface OrdersApiUpdateFulfillmentRequest {
3085
3503
  * @extends {BaseAPI}
3086
3504
  */
3087
3505
  export declare class OrdersApi extends BaseAPI {
3506
+ /**
3507
+ *
3508
+ * @summary Confirm order
3509
+ * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
3510
+ * @param {*} [options] Override http request option.
3511
+ * @throws {RequiredError}
3512
+ * @memberof OrdersApi
3513
+ */
3514
+ confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
3515
+ /**
3516
+ *
3517
+ * @summary Create order
3518
+ * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
3519
+ * @param {*} [options] Override http request option.
3520
+ * @throws {RequiredError}
3521
+ * @memberof OrdersApi
3522
+ */
3523
+ createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
3088
3524
  /**
3089
3525
  * Export orders as a CSV file
3090
3526
  * @summary Export orders