@teemill/platform 0.11.1 → 0.12.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +308 -1537
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +257 -860
- package/dist/api.js +151 -1061
- 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 +2 -2
- package/dist/esm/api.d.ts +257 -860
- package/dist/esm/api.js +148 -1058
- 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 +2 -2
- 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/index.ts +1 -1
- package/package.json +1 -1
- package/.openapi-generator/FILES +0 -12
- package/.openapi-generator/VERSION +0 -1
- package/.openapi-generator-ignore +0 -23
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.
|
|
5
|
+
* The version of the OpenAPI document: 0.12.3
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -185,13 +185,31 @@ export interface Customer {
|
|
|
185
185
|
* @type {string}
|
|
186
186
|
* @memberof Customer
|
|
187
187
|
*/
|
|
188
|
-
'firstName'
|
|
188
|
+
'firstName': string;
|
|
189
189
|
/**
|
|
190
190
|
*
|
|
191
191
|
* @type {string}
|
|
192
192
|
* @memberof Customer
|
|
193
193
|
*/
|
|
194
|
-
'lastName'
|
|
194
|
+
'lastName': string;
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @type {string}
|
|
198
|
+
* @memberof Customer
|
|
199
|
+
*/
|
|
200
|
+
'gender': string | null;
|
|
201
|
+
/**
|
|
202
|
+
*
|
|
203
|
+
* @type {string}
|
|
204
|
+
* @memberof Customer
|
|
205
|
+
*/
|
|
206
|
+
'country': string | null;
|
|
207
|
+
/**
|
|
208
|
+
*
|
|
209
|
+
* @type {Statistics}
|
|
210
|
+
* @memberof Customer
|
|
211
|
+
*/
|
|
212
|
+
'statistics': Statistics;
|
|
195
213
|
}
|
|
196
214
|
/**
|
|
197
215
|
*
|
|
@@ -980,6 +998,24 @@ export interface Platform {
|
|
|
980
998
|
* @memberof Platform
|
|
981
999
|
*/
|
|
982
1000
|
'clientGiftWrapAvailable': boolean;
|
|
1001
|
+
/**
|
|
1002
|
+
* The subscription fee for the platform
|
|
1003
|
+
* @type {number}
|
|
1004
|
+
* @memberof Platform
|
|
1005
|
+
*/
|
|
1006
|
+
'storeSubscriptionFee': number;
|
|
1007
|
+
/**
|
|
1008
|
+
* The order handling fee for the platform
|
|
1009
|
+
* @type {number}
|
|
1010
|
+
* @memberof Platform
|
|
1011
|
+
*/
|
|
1012
|
+
'orderHandlingFee': number;
|
|
1013
|
+
/**
|
|
1014
|
+
* The item handling fee for the platform
|
|
1015
|
+
* @type {number}
|
|
1016
|
+
* @memberof Platform
|
|
1017
|
+
*/
|
|
1018
|
+
'itemHandlingFee': number;
|
|
983
1019
|
}
|
|
984
1020
|
/**
|
|
985
1021
|
*
|
|
@@ -1310,6 +1346,31 @@ export interface ShippingMethod {
|
|
|
1310
1346
|
*/
|
|
1311
1347
|
'discountPrice'?: Price;
|
|
1312
1348
|
}
|
|
1349
|
+
/**
|
|
1350
|
+
*
|
|
1351
|
+
* @export
|
|
1352
|
+
* @interface Statistics
|
|
1353
|
+
*/
|
|
1354
|
+
export interface Statistics {
|
|
1355
|
+
/**
|
|
1356
|
+
*
|
|
1357
|
+
* @type {number}
|
|
1358
|
+
* @memberof Statistics
|
|
1359
|
+
*/
|
|
1360
|
+
'lifetimeValue': number;
|
|
1361
|
+
/**
|
|
1362
|
+
*
|
|
1363
|
+
* @type {number}
|
|
1364
|
+
* @memberof Statistics
|
|
1365
|
+
*/
|
|
1366
|
+
'totalOrderCount': number;
|
|
1367
|
+
/**
|
|
1368
|
+
*
|
|
1369
|
+
* @type {string}
|
|
1370
|
+
* @memberof Statistics
|
|
1371
|
+
*/
|
|
1372
|
+
'lastPurchased': string | null;
|
|
1373
|
+
}
|
|
1313
1374
|
/**
|
|
1314
1375
|
*
|
|
1315
1376
|
* @export
|
|
@@ -1366,6 +1427,24 @@ export interface UpdatePlatformRequest {
|
|
|
1366
1427
|
* @memberof UpdatePlatformRequest
|
|
1367
1428
|
*/
|
|
1368
1429
|
'clientGiftWrapAvailable'?: boolean;
|
|
1430
|
+
/**
|
|
1431
|
+
*
|
|
1432
|
+
* @type {number}
|
|
1433
|
+
* @memberof UpdatePlatformRequest
|
|
1434
|
+
*/
|
|
1435
|
+
'storeSubscriptionFee'?: number;
|
|
1436
|
+
/**
|
|
1437
|
+
*
|
|
1438
|
+
* @type {number}
|
|
1439
|
+
* @memberof UpdatePlatformRequest
|
|
1440
|
+
*/
|
|
1441
|
+
'orderHandlingFee'?: number;
|
|
1442
|
+
/**
|
|
1443
|
+
*
|
|
1444
|
+
* @type {number}
|
|
1445
|
+
* @memberof UpdatePlatformRequest
|
|
1446
|
+
*/
|
|
1447
|
+
'itemHandlingFee'?: number;
|
|
1369
1448
|
}
|
|
1370
1449
|
/**
|
|
1371
1450
|
*
|
|
@@ -1430,14 +1509,6 @@ export interface ValidationError {
|
|
|
1430
1509
|
* @memberof ValidationError
|
|
1431
1510
|
*/
|
|
1432
1511
|
'message': string;
|
|
1433
|
-
/**
|
|
1434
|
-
*
|
|
1435
|
-
* @type {{ [key: string]: Array<string>; }}
|
|
1436
|
-
* @memberof ValidationError
|
|
1437
|
-
*/
|
|
1438
|
-
'errors': {
|
|
1439
|
-
[key: string]: Array<string>;
|
|
1440
|
-
};
|
|
1441
1512
|
}
|
|
1442
1513
|
/**
|
|
1443
1514
|
*
|
|
@@ -1646,10 +1717,14 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1646
1717
|
* @summary Export customers
|
|
1647
1718
|
* @param {string} project Project unique identifier
|
|
1648
1719
|
* @param {string} platformId The platform identifier
|
|
1720
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1721
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1722
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1723
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1649
1724
|
* @param {*} [options] Override http request option.
|
|
1650
1725
|
* @throws {RequiredError}
|
|
1651
1726
|
*/
|
|
1652
|
-
exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1727
|
+
exportCustomers: (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1653
1728
|
/**
|
|
1654
1729
|
* Get a customer for a platform by a given customer ID.
|
|
1655
1730
|
* @summary Get customer
|
|
@@ -1668,10 +1743,14 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
|
|
|
1668
1743
|
* @param {number} [pageToken] Page reference token
|
|
1669
1744
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1670
1745
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1746
|
+
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1747
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1748
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1749
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1671
1750
|
* @param {*} [options] Override http request option.
|
|
1672
1751
|
* @throws {RequiredError}
|
|
1673
1752
|
*/
|
|
1674
|
-
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1753
|
+
listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1675
1754
|
};
|
|
1676
1755
|
/**
|
|
1677
1756
|
* CustomersApi - functional programming interface
|
|
@@ -1683,10 +1762,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1683
1762
|
* @summary Export customers
|
|
1684
1763
|
* @param {string} project Project unique identifier
|
|
1685
1764
|
* @param {string} platformId The platform identifier
|
|
1765
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1766
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1767
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1768
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1686
1769
|
* @param {*} [options] Override http request option.
|
|
1687
1770
|
* @throws {RequiredError}
|
|
1688
1771
|
*/
|
|
1689
|
-
exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1772
|
+
exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
1690
1773
|
/**
|
|
1691
1774
|
* Get a customer for a platform by a given customer ID.
|
|
1692
1775
|
* @summary Get customer
|
|
@@ -1705,10 +1788,14 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
|
|
|
1705
1788
|
* @param {number} [pageToken] Page reference token
|
|
1706
1789
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1707
1790
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1791
|
+
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1792
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1793
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1794
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1708
1795
|
* @param {*} [options] Override http request option.
|
|
1709
1796
|
* @throws {RequiredError}
|
|
1710
1797
|
*/
|
|
1711
|
-
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1798
|
+
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
1712
1799
|
};
|
|
1713
1800
|
/**
|
|
1714
1801
|
* CustomersApi - factory interface
|
|
@@ -1758,6 +1845,30 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
1758
1845
|
* @memberof CustomersApiExportCustomers
|
|
1759
1846
|
*/
|
|
1760
1847
|
readonly platformId: string;
|
|
1848
|
+
/**
|
|
1849
|
+
* Filter customers by total order count equal to the value provided
|
|
1850
|
+
* @type {number}
|
|
1851
|
+
* @memberof CustomersApiExportCustomers
|
|
1852
|
+
*/
|
|
1853
|
+
readonly totalOrderCount?: number;
|
|
1854
|
+
/**
|
|
1855
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1856
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
1857
|
+
* @memberof CustomersApiExportCustomers
|
|
1858
|
+
*/
|
|
1859
|
+
readonly sortBy?: Array<ExportCustomersSortByEnum>;
|
|
1860
|
+
/**
|
|
1861
|
+
* Start of date range to filter customers by last purchase date
|
|
1862
|
+
* @type {string}
|
|
1863
|
+
* @memberof CustomersApiExportCustomers
|
|
1864
|
+
*/
|
|
1865
|
+
readonly lastPurchasedStart?: string;
|
|
1866
|
+
/**
|
|
1867
|
+
* End of date range to filter customers by last purchase date
|
|
1868
|
+
* @type {string}
|
|
1869
|
+
* @memberof CustomersApiExportCustomers
|
|
1870
|
+
*/
|
|
1871
|
+
readonly lastPurchasedEnd?: string;
|
|
1761
1872
|
}
|
|
1762
1873
|
/**
|
|
1763
1874
|
* Request parameters for getCustomer operation in CustomersApi.
|
|
@@ -1820,6 +1931,30 @@ export interface CustomersApiListCustomersRequest {
|
|
|
1820
1931
|
* @memberof CustomersApiListCustomers
|
|
1821
1932
|
*/
|
|
1822
1933
|
readonly search?: string;
|
|
1934
|
+
/**
|
|
1935
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1936
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
1937
|
+
* @memberof CustomersApiListCustomers
|
|
1938
|
+
*/
|
|
1939
|
+
readonly sortBy?: Array<ListCustomersSortByEnum>;
|
|
1940
|
+
/**
|
|
1941
|
+
* Filter customers by total order count equal to the value provided
|
|
1942
|
+
* @type {number}
|
|
1943
|
+
* @memberof CustomersApiListCustomers
|
|
1944
|
+
*/
|
|
1945
|
+
readonly totalOrderCount?: number;
|
|
1946
|
+
/**
|
|
1947
|
+
* Start of date range to filter customers by last purchase date
|
|
1948
|
+
* @type {string}
|
|
1949
|
+
* @memberof CustomersApiListCustomers
|
|
1950
|
+
*/
|
|
1951
|
+
readonly lastPurchasedStart?: string;
|
|
1952
|
+
/**
|
|
1953
|
+
* End of date range to filter customers by last purchase date
|
|
1954
|
+
* @type {string}
|
|
1955
|
+
* @memberof CustomersApiListCustomers
|
|
1956
|
+
*/
|
|
1957
|
+
readonly lastPurchasedEnd?: string;
|
|
1823
1958
|
}
|
|
1824
1959
|
/**
|
|
1825
1960
|
* CustomersApi - object-oriented interface
|
|
@@ -1856,6 +1991,30 @@ export declare class CustomersApi extends BaseAPI {
|
|
|
1856
1991
|
*/
|
|
1857
1992
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
1858
1993
|
}
|
|
1994
|
+
/**
|
|
1995
|
+
* @export
|
|
1996
|
+
*/
|
|
1997
|
+
export declare const ExportCustomersSortByEnum: {
|
|
1998
|
+
readonly LifetimeValue: "+lifetimeValue";
|
|
1999
|
+
readonly LifetimeValue2: "-lifetimeValue";
|
|
2000
|
+
readonly TotalOrderCount: "+totalOrderCount";
|
|
2001
|
+
readonly TotalOrderCount2: "-totalOrderCount";
|
|
2002
|
+
readonly LastPurchased: "+lastPurchased";
|
|
2003
|
+
readonly LastPurchased2: "-lastPurchased";
|
|
2004
|
+
};
|
|
2005
|
+
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
2006
|
+
/**
|
|
2007
|
+
* @export
|
|
2008
|
+
*/
|
|
2009
|
+
export declare const ListCustomersSortByEnum: {
|
|
2010
|
+
readonly LifetimeValue: "+lifetimeValue";
|
|
2011
|
+
readonly LifetimeValue2: "-lifetimeValue";
|
|
2012
|
+
readonly TotalOrderCount: "+totalOrderCount";
|
|
2013
|
+
readonly TotalOrderCount2: "-totalOrderCount";
|
|
2014
|
+
readonly LastPurchased: "+lastPurchased";
|
|
2015
|
+
readonly LastPurchased2: "-lastPurchased";
|
|
2016
|
+
};
|
|
2017
|
+
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
1859
2018
|
/**
|
|
1860
2019
|
* OrdersApi - axios parameter creator
|
|
1861
2020
|
* @export
|
|
@@ -1867,7 +2026,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1867
2026
|
* @param {string} project Project unique identifier
|
|
1868
2027
|
* @param {string} platformId The platform identifier
|
|
1869
2028
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1870
|
-
* @param {string} [end] End of date range to filter
|
|
2029
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
1871
2030
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1872
2031
|
* @param {*} [options] Override http request option.
|
|
1873
2032
|
* @throws {RequiredError}
|
|
@@ -1911,8 +2070,8 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
1911
2070
|
* @param {number} [pageToken] Page reference token
|
|
1912
2071
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1913
2072
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1914
|
-
* @param {string} [start] Start of date range to filter
|
|
1915
|
-
* @param {string} [end] End of date range to filter
|
|
2073
|
+
* @param {string} [start] Start of date range to filter when orders were placed
|
|
2074
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
1916
2075
|
* @param {*} [options] Override http request option.
|
|
1917
2076
|
* @throws {RequiredError}
|
|
1918
2077
|
*/
|
|
@@ -1940,7 +2099,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1940
2099
|
* @param {string} project Project unique identifier
|
|
1941
2100
|
* @param {string} platformId The platform identifier
|
|
1942
2101
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
1943
|
-
* @param {string} [end] End of date range to filter
|
|
2102
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
1944
2103
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1945
2104
|
* @param {*} [options] Override http request option.
|
|
1946
2105
|
* @throws {RequiredError}
|
|
@@ -1984,8 +2143,8 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
|
|
|
1984
2143
|
* @param {number} [pageToken] Page reference token
|
|
1985
2144
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1986
2145
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1987
|
-
* @param {string} [start] Start of date range to filter
|
|
1988
|
-
* @param {string} [end] End of date range to filter
|
|
2146
|
+
* @param {string} [start] Start of date range to filter when orders were placed
|
|
2147
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
1989
2148
|
* @param {*} [options] Override http request option.
|
|
1990
2149
|
* @throws {RequiredError}
|
|
1991
2150
|
*/
|
|
@@ -2081,7 +2240,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2081
2240
|
*/
|
|
2082
2241
|
readonly start: string;
|
|
2083
2242
|
/**
|
|
2084
|
-
* End of date range to filter
|
|
2243
|
+
* End of date range to filter when orders were placed
|
|
2085
2244
|
* @type {string}
|
|
2086
2245
|
* @memberof OrdersApiExportOrders
|
|
2087
2246
|
*/
|
|
@@ -2205,13 +2364,13 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2205
2364
|
*/
|
|
2206
2365
|
readonly search?: string;
|
|
2207
2366
|
/**
|
|
2208
|
-
* Start of date range to filter
|
|
2367
|
+
* Start of date range to filter when orders were placed
|
|
2209
2368
|
* @type {string}
|
|
2210
2369
|
* @memberof OrdersApiListOrders
|
|
2211
2370
|
*/
|
|
2212
2371
|
readonly start?: string;
|
|
2213
2372
|
/**
|
|
2214
|
-
* End of date range to filter
|
|
2373
|
+
* End of date range to filter when orders were placed
|
|
2215
2374
|
* @type {string}
|
|
2216
2375
|
* @memberof OrdersApiListOrders
|
|
2217
2376
|
*/
|
|
@@ -2316,887 +2475,125 @@ export declare class OrdersApi extends BaseAPI {
|
|
|
2316
2475
|
*/
|
|
2317
2476
|
export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2318
2477
|
/**
|
|
2319
|
-
*
|
|
2320
|
-
* @summary
|
|
2321
|
-
* @param {string} project Project unique identifier
|
|
2322
|
-
* @param {string} platformId The platform identifier
|
|
2323
|
-
* @param {*} [options] Override http request option.
|
|
2324
|
-
* @throws {RequiredError}
|
|
2325
|
-
*/
|
|
2326
|
-
exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2327
|
-
/**
|
|
2328
|
-
* Export orders as a CSV file
|
|
2329
|
-
* @summary Export orders
|
|
2478
|
+
*
|
|
2479
|
+
* @summary Get platform details
|
|
2330
2480
|
* @param {string} project Project unique identifier
|
|
2331
|
-
* @param {string} platformId The platform identifier
|
|
2332
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
2333
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
2334
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2335
2481
|
* @param {*} [options] Override http request option.
|
|
2336
2482
|
* @throws {RequiredError}
|
|
2337
2483
|
*/
|
|
2338
|
-
|
|
2484
|
+
getPlatform: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2339
2485
|
/**
|
|
2340
|
-
*
|
|
2341
|
-
* @summary
|
|
2486
|
+
*
|
|
2487
|
+
* @summary Update platform
|
|
2342
2488
|
* @param {string} project Project unique identifier
|
|
2343
|
-
* @param {
|
|
2344
|
-
* @param {string} customerId The customer identifier
|
|
2489
|
+
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
2345
2490
|
* @param {*} [options] Override http request option.
|
|
2346
2491
|
* @throws {RequiredError}
|
|
2347
2492
|
*/
|
|
2348
|
-
|
|
2493
|
+
updatePlatform: (project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2494
|
+
};
|
|
2495
|
+
/**
|
|
2496
|
+
* PlatformApi - functional programming interface
|
|
2497
|
+
* @export
|
|
2498
|
+
*/
|
|
2499
|
+
export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
2349
2500
|
/**
|
|
2350
|
-
*
|
|
2351
|
-
* @summary Get
|
|
2501
|
+
*
|
|
2502
|
+
* @summary Get platform details
|
|
2352
2503
|
* @param {string} project Project unique identifier
|
|
2353
|
-
* @param {string} platformId The platform identifier
|
|
2354
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2355
2504
|
* @param {*} [options] Override http request option.
|
|
2356
2505
|
* @throws {RequiredError}
|
|
2357
2506
|
*/
|
|
2358
|
-
|
|
2507
|
+
getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
2359
2508
|
/**
|
|
2360
|
-
*
|
|
2361
|
-
* @summary
|
|
2509
|
+
*
|
|
2510
|
+
* @summary Update platform
|
|
2362
2511
|
* @param {string} project Project unique identifier
|
|
2363
|
-
* @param {
|
|
2364
|
-
* @param {string} orderId The order identifier
|
|
2512
|
+
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
2365
2513
|
* @param {*} [options] Override http request option.
|
|
2366
2514
|
* @throws {RequiredError}
|
|
2367
2515
|
*/
|
|
2368
|
-
|
|
2516
|
+
updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
2517
|
+
};
|
|
2518
|
+
/**
|
|
2519
|
+
* PlatformApi - factory interface
|
|
2520
|
+
* @export
|
|
2521
|
+
*/
|
|
2522
|
+
export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2369
2523
|
/**
|
|
2370
2524
|
*
|
|
2371
2525
|
* @summary Get platform details
|
|
2372
|
-
* @param {
|
|
2526
|
+
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
2373
2527
|
* @param {*} [options] Override http request option.
|
|
2374
2528
|
* @throws {RequiredError}
|
|
2375
2529
|
*/
|
|
2376
|
-
getPlatform
|
|
2530
|
+
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
2377
2531
|
/**
|
|
2378
|
-
*
|
|
2379
|
-
* @summary
|
|
2380
|
-
* @param {
|
|
2381
|
-
* @param {string} platformId The platform identifier
|
|
2382
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2532
|
+
*
|
|
2533
|
+
* @summary Update platform
|
|
2534
|
+
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
2383
2535
|
* @param {*} [options] Override http request option.
|
|
2384
2536
|
* @throws {RequiredError}
|
|
2385
2537
|
*/
|
|
2386
|
-
|
|
2538
|
+
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
2539
|
+
};
|
|
2540
|
+
/**
|
|
2541
|
+
* Request parameters for getPlatform operation in PlatformApi.
|
|
2542
|
+
* @export
|
|
2543
|
+
* @interface PlatformApiGetPlatformRequest
|
|
2544
|
+
*/
|
|
2545
|
+
export interface PlatformApiGetPlatformRequest {
|
|
2387
2546
|
/**
|
|
2388
|
-
*
|
|
2389
|
-
* @
|
|
2390
|
-
* @
|
|
2391
|
-
* @param {string} platformId The platform identifier
|
|
2392
|
-
* @param {number} [pageToken] Page reference token
|
|
2393
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2394
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2395
|
-
* @param {*} [options] Override http request option.
|
|
2396
|
-
* @throws {RequiredError}
|
|
2547
|
+
* Project unique identifier
|
|
2548
|
+
* @type {string}
|
|
2549
|
+
* @memberof PlatformApiGetPlatform
|
|
2397
2550
|
*/
|
|
2398
|
-
|
|
2551
|
+
readonly project: string;
|
|
2552
|
+
}
|
|
2553
|
+
/**
|
|
2554
|
+
* Request parameters for updatePlatform operation in PlatformApi.
|
|
2555
|
+
* @export
|
|
2556
|
+
* @interface PlatformApiUpdatePlatformRequest
|
|
2557
|
+
*/
|
|
2558
|
+
export interface PlatformApiUpdatePlatformRequest {
|
|
2399
2559
|
/**
|
|
2400
|
-
*
|
|
2401
|
-
* @
|
|
2402
|
-
* @
|
|
2403
|
-
* @param {string} platformId The platform identifier
|
|
2404
|
-
* @param {number} [pageToken] Page reference token
|
|
2405
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2406
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2407
|
-
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
2408
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
2409
|
-
* @param {*} [options] Override http request option.
|
|
2410
|
-
* @throws {RequiredError}
|
|
2560
|
+
* Project unique identifier
|
|
2561
|
+
* @type {string}
|
|
2562
|
+
* @memberof PlatformApiUpdatePlatform
|
|
2411
2563
|
*/
|
|
2412
|
-
|
|
2564
|
+
readonly project: string;
|
|
2413
2565
|
/**
|
|
2414
|
-
*
|
|
2415
|
-
* @
|
|
2416
|
-
* @
|
|
2417
|
-
* @param {string} platformId The platform identifier
|
|
2418
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2419
|
-
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
2420
|
-
* @param {*} [options] Override http request option.
|
|
2421
|
-
* @throws {RequiredError}
|
|
2566
|
+
*
|
|
2567
|
+
* @type {UpdatePlatformRequest}
|
|
2568
|
+
* @memberof PlatformApiUpdatePlatform
|
|
2422
2569
|
*/
|
|
2423
|
-
|
|
2570
|
+
readonly updatePlatformRequest: UpdatePlatformRequest;
|
|
2571
|
+
}
|
|
2572
|
+
/**
|
|
2573
|
+
* PlatformApi - object-oriented interface
|
|
2574
|
+
* @export
|
|
2575
|
+
* @class PlatformApi
|
|
2576
|
+
* @extends {BaseAPI}
|
|
2577
|
+
*/
|
|
2578
|
+
export declare class PlatformApi extends BaseAPI {
|
|
2424
2579
|
/**
|
|
2425
2580
|
*
|
|
2426
|
-
* @summary
|
|
2427
|
-
* @param {
|
|
2428
|
-
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
2581
|
+
* @summary Get platform details
|
|
2582
|
+
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
2429
2583
|
* @param {*} [options] Override http request option.
|
|
2430
2584
|
* @throws {RequiredError}
|
|
2585
|
+
* @memberof PlatformApi
|
|
2431
2586
|
*/
|
|
2432
|
-
|
|
2587
|
+
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
2433
2588
|
/**
|
|
2434
|
-
*
|
|
2435
|
-
* @summary Update
|
|
2436
|
-
* @param {
|
|
2437
|
-
* @param {string} platformId The platform identifier
|
|
2438
|
-
* @param {string} productId Products unique identifier
|
|
2439
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
2589
|
+
*
|
|
2590
|
+
* @summary Update platform
|
|
2591
|
+
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
2440
2592
|
* @param {*} [options] Override http request option.
|
|
2441
2593
|
* @throws {RequiredError}
|
|
2442
|
-
|
|
2443
|
-
updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2444
|
-
/**
|
|
2445
|
-
* Updates the warehouse variant
|
|
2446
|
-
* @summary Update warehouse variant
|
|
2447
|
-
* @param {string} project Project unique identifier
|
|
2448
|
-
* @param {string} platformId The platform identifier
|
|
2449
|
-
* @param {string} variantId Variants unique identifier
|
|
2450
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
2451
|
-
* @param {*} [options] Override http request option.
|
|
2452
|
-
* @throws {RequiredError}
|
|
2453
|
-
*/
|
|
2454
|
-
updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2455
|
-
};
|
|
2456
|
-
/**
|
|
2457
|
-
* PlatformApi - functional programming interface
|
|
2458
|
-
* @export
|
|
2459
|
-
*/
|
|
2460
|
-
export declare const PlatformApiFp: (configuration?: Configuration) => {
|
|
2461
|
-
/**
|
|
2462
|
-
* Export customers as a CSV file
|
|
2463
|
-
* @summary Export customers
|
|
2464
|
-
* @param {string} project Project unique identifier
|
|
2465
|
-
* @param {string} platformId The platform identifier
|
|
2466
|
-
* @param {*} [options] Override http request option.
|
|
2467
|
-
* @throws {RequiredError}
|
|
2468
|
-
*/
|
|
2469
|
-
exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2470
|
-
/**
|
|
2471
|
-
* Export orders as a CSV file
|
|
2472
|
-
* @summary Export orders
|
|
2473
|
-
* @param {string} project Project unique identifier
|
|
2474
|
-
* @param {string} platformId The platform identifier
|
|
2475
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
2476
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
2477
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2478
|
-
* @param {*} [options] Override http request option.
|
|
2479
|
-
* @throws {RequiredError}
|
|
2480
|
-
*/
|
|
2481
|
-
exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
2482
|
-
/**
|
|
2483
|
-
* Get a customer for a platform by a given customer ID.
|
|
2484
|
-
* @summary Get customer
|
|
2485
|
-
* @param {string} project Project unique identifier
|
|
2486
|
-
* @param {string} platformId The platform identifier
|
|
2487
|
-
* @param {string} customerId The customer identifier
|
|
2488
|
-
* @param {*} [options] Override http request option.
|
|
2489
|
-
* @throws {RequiredError}
|
|
2490
|
-
*/
|
|
2491
|
-
getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
|
|
2492
|
-
/**
|
|
2493
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2494
|
-
* @summary Get fulfillment
|
|
2495
|
-
* @param {string} project Project unique identifier
|
|
2496
|
-
* @param {string} platformId The platform identifier
|
|
2497
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2498
|
-
* @param {*} [options] Override http request option.
|
|
2499
|
-
* @throws {RequiredError}
|
|
2500
|
-
*/
|
|
2501
|
-
getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
2502
|
-
/**
|
|
2503
|
-
* Get an order for a platform by a given order ID.
|
|
2504
|
-
* @summary Get order
|
|
2505
|
-
* @param {string} project Project unique identifier
|
|
2506
|
-
* @param {string} platformId The platform identifier
|
|
2507
|
-
* @param {string} orderId The order identifier
|
|
2508
|
-
* @param {*} [options] Override http request option.
|
|
2509
|
-
* @throws {RequiredError}
|
|
2510
|
-
*/
|
|
2511
|
-
getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
|
|
2512
|
-
/**
|
|
2513
|
-
*
|
|
2514
|
-
* @summary Get platform details
|
|
2515
|
-
* @param {string} project Project unique identifier
|
|
2516
|
-
* @param {*} [options] Override http request option.
|
|
2517
|
-
* @throws {RequiredError}
|
|
2518
|
-
*/
|
|
2519
|
-
getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
2520
|
-
/**
|
|
2521
|
-
* List available fulfillers for a given fulfillment
|
|
2522
|
-
* @summary List available fulfillers
|
|
2523
|
-
* @param {string} project Project unique identifier
|
|
2524
|
-
* @param {string} platformId The platform identifier
|
|
2525
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2526
|
-
* @param {*} [options] Override http request option.
|
|
2527
|
-
* @throws {RequiredError}
|
|
2528
|
-
*/
|
|
2529
|
-
listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
|
|
2530
|
-
/**
|
|
2531
|
-
* List customers for a platform
|
|
2532
|
-
* @summary List customers
|
|
2533
|
-
* @param {string} project Project unique identifier
|
|
2534
|
-
* @param {string} platformId The platform identifier
|
|
2535
|
-
* @param {number} [pageToken] Page reference token
|
|
2536
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2537
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2538
|
-
* @param {*} [options] Override http request option.
|
|
2539
|
-
* @throws {RequiredError}
|
|
2540
|
-
*/
|
|
2541
|
-
listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
|
|
2542
|
-
/**
|
|
2543
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
2544
|
-
* @summary List orders
|
|
2545
|
-
* @param {string} project Project unique identifier
|
|
2546
|
-
* @param {string} platformId The platform identifier
|
|
2547
|
-
* @param {number} [pageToken] Page reference token
|
|
2548
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2549
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2550
|
-
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
2551
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
2552
|
-
* @param {*} [options] Override http request option.
|
|
2553
|
-
* @throws {RequiredError}
|
|
2554
|
-
*/
|
|
2555
|
-
listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
|
|
2556
|
-
/**
|
|
2557
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
2558
|
-
* @summary Update fulfillment
|
|
2559
|
-
* @param {string} project Project unique identifier
|
|
2560
|
-
* @param {string} platformId The platform identifier
|
|
2561
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
2562
|
-
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
2563
|
-
* @param {*} [options] Override http request option.
|
|
2564
|
-
* @throws {RequiredError}
|
|
2565
|
-
*/
|
|
2566
|
-
updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
|
|
2567
|
-
/**
|
|
2568
|
-
*
|
|
2569
|
-
* @summary Update platform
|
|
2570
|
-
* @param {string} project Project unique identifier
|
|
2571
|
-
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
2572
|
-
* @param {*} [options] Override http request option.
|
|
2573
|
-
* @throws {RequiredError}
|
|
2574
|
-
*/
|
|
2575
|
-
updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
|
|
2576
|
-
/**
|
|
2577
|
-
* Updates the warehouse product and its variants
|
|
2578
|
-
* @summary Update warehouse product
|
|
2579
|
-
* @param {string} project Project unique identifier
|
|
2580
|
-
* @param {string} platformId The platform identifier
|
|
2581
|
-
* @param {string} productId Products unique identifier
|
|
2582
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
2583
|
-
* @param {*} [options] Override http request option.
|
|
2584
|
-
* @throws {RequiredError}
|
|
2585
|
-
*/
|
|
2586
|
-
updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
|
|
2587
|
-
/**
|
|
2588
|
-
* Updates the warehouse variant
|
|
2589
|
-
* @summary Update warehouse variant
|
|
2590
|
-
* @param {string} project Project unique identifier
|
|
2591
|
-
* @param {string} platformId The platform identifier
|
|
2592
|
-
* @param {string} variantId Variants unique identifier
|
|
2593
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
2594
|
-
* @param {*} [options] Override http request option.
|
|
2595
|
-
* @throws {RequiredError}
|
|
2596
|
-
*/
|
|
2597
|
-
updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
|
|
2598
|
-
};
|
|
2599
|
-
/**
|
|
2600
|
-
* PlatformApi - factory interface
|
|
2601
|
-
* @export
|
|
2602
|
-
*/
|
|
2603
|
-
export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2604
|
-
/**
|
|
2605
|
-
* Export customers as a CSV file
|
|
2606
|
-
* @summary Export customers
|
|
2607
|
-
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
2608
|
-
* @param {*} [options] Override http request option.
|
|
2609
|
-
* @throws {RequiredError}
|
|
2610
|
-
*/
|
|
2611
|
-
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2612
|
-
/**
|
|
2613
|
-
* Export orders as a CSV file
|
|
2614
|
-
* @summary Export orders
|
|
2615
|
-
* @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
|
|
2616
|
-
* @param {*} [options] Override http request option.
|
|
2617
|
-
* @throws {RequiredError}
|
|
2618
|
-
*/
|
|
2619
|
-
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
|
|
2620
|
-
/**
|
|
2621
|
-
* Get a customer for a platform by a given customer ID.
|
|
2622
|
-
* @summary Get customer
|
|
2623
|
-
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
2624
|
-
* @param {*} [options] Override http request option.
|
|
2625
|
-
* @throws {RequiredError}
|
|
2626
|
-
*/
|
|
2627
|
-
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
|
|
2628
|
-
/**
|
|
2629
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
2630
|
-
* @summary Get fulfillment
|
|
2631
|
-
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
2632
|
-
* @param {*} [options] Override http request option.
|
|
2633
|
-
* @throws {RequiredError}
|
|
2634
|
-
*/
|
|
2635
|
-
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
2636
|
-
/**
|
|
2637
|
-
* Get an order for a platform by a given order ID.
|
|
2638
|
-
* @summary Get order
|
|
2639
|
-
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
2640
|
-
* @param {*} [options] Override http request option.
|
|
2641
|
-
* @throws {RequiredError}
|
|
2642
|
-
*/
|
|
2643
|
-
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
|
|
2644
|
-
/**
|
|
2645
|
-
*
|
|
2646
|
-
* @summary Get platform details
|
|
2647
|
-
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
2648
|
-
* @param {*} [options] Override http request option.
|
|
2649
|
-
* @throws {RequiredError}
|
|
2650
|
-
*/
|
|
2651
|
-
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
2652
|
-
/**
|
|
2653
|
-
* List available fulfillers for a given fulfillment
|
|
2654
|
-
* @summary List available fulfillers
|
|
2655
|
-
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
2656
|
-
* @param {*} [options] Override http request option.
|
|
2657
|
-
* @throws {RequiredError}
|
|
2658
|
-
*/
|
|
2659
|
-
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
|
|
2660
|
-
/**
|
|
2661
|
-
* List customers for a platform
|
|
2662
|
-
* @summary List customers
|
|
2663
|
-
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
2664
|
-
* @param {*} [options] Override http request option.
|
|
2665
|
-
* @throws {RequiredError}
|
|
2666
|
-
*/
|
|
2667
|
-
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
|
|
2668
|
-
/**
|
|
2669
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
2670
|
-
* @summary List orders
|
|
2671
|
-
* @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
|
|
2672
|
-
* @param {*} [options] Override http request option.
|
|
2673
|
-
* @throws {RequiredError}
|
|
2674
|
-
*/
|
|
2675
|
-
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
|
|
2676
|
-
/**
|
|
2677
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
2678
|
-
* @summary Update fulfillment
|
|
2679
|
-
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
2680
|
-
* @param {*} [options] Override http request option.
|
|
2681
|
-
* @throws {RequiredError}
|
|
2682
|
-
*/
|
|
2683
|
-
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
|
|
2684
|
-
/**
|
|
2685
|
-
*
|
|
2686
|
-
* @summary Update platform
|
|
2687
|
-
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
2688
|
-
* @param {*} [options] Override http request option.
|
|
2689
|
-
* @throws {RequiredError}
|
|
2690
|
-
*/
|
|
2691
|
-
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
|
|
2692
|
-
/**
|
|
2693
|
-
* Updates the warehouse product and its variants
|
|
2694
|
-
* @summary Update warehouse product
|
|
2695
|
-
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
2696
|
-
* @param {*} [options] Override http request option.
|
|
2697
|
-
* @throws {RequiredError}
|
|
2698
|
-
*/
|
|
2699
|
-
updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
|
|
2700
|
-
/**
|
|
2701
|
-
* Updates the warehouse variant
|
|
2702
|
-
* @summary Update warehouse variant
|
|
2703
|
-
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
2704
|
-
* @param {*} [options] Override http request option.
|
|
2705
|
-
* @throws {RequiredError}
|
|
2706
|
-
*/
|
|
2707
|
-
updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
|
|
2708
|
-
};
|
|
2709
|
-
/**
|
|
2710
|
-
* Request parameters for exportCustomers operation in PlatformApi.
|
|
2711
|
-
* @export
|
|
2712
|
-
* @interface PlatformApiExportCustomersRequest
|
|
2713
|
-
*/
|
|
2714
|
-
export interface PlatformApiExportCustomersRequest {
|
|
2715
|
-
/**
|
|
2716
|
-
* Project unique identifier
|
|
2717
|
-
* @type {string}
|
|
2718
|
-
* @memberof PlatformApiExportCustomers
|
|
2719
|
-
*/
|
|
2720
|
-
readonly project: string;
|
|
2721
|
-
/**
|
|
2722
|
-
* The platform identifier
|
|
2723
|
-
* @type {string}
|
|
2724
|
-
* @memberof PlatformApiExportCustomers
|
|
2725
|
-
*/
|
|
2726
|
-
readonly platformId: string;
|
|
2727
|
-
}
|
|
2728
|
-
/**
|
|
2729
|
-
* Request parameters for exportOrders operation in PlatformApi.
|
|
2730
|
-
* @export
|
|
2731
|
-
* @interface PlatformApiExportOrdersRequest
|
|
2732
|
-
*/
|
|
2733
|
-
export interface PlatformApiExportOrdersRequest {
|
|
2734
|
-
/**
|
|
2735
|
-
* Project unique identifier
|
|
2736
|
-
* @type {string}
|
|
2737
|
-
* @memberof PlatformApiExportOrders
|
|
2738
|
-
*/
|
|
2739
|
-
readonly project: string;
|
|
2740
|
-
/**
|
|
2741
|
-
* The platform identifier
|
|
2742
|
-
* @type {string}
|
|
2743
|
-
* @memberof PlatformApiExportOrders
|
|
2744
|
-
*/
|
|
2745
|
-
readonly platformId: string;
|
|
2746
|
-
/**
|
|
2747
|
-
* Start of date range to filter by when orders were placed
|
|
2748
|
-
* @type {string}
|
|
2749
|
-
* @memberof PlatformApiExportOrders
|
|
2750
|
-
*/
|
|
2751
|
-
readonly start: string;
|
|
2752
|
-
/**
|
|
2753
|
-
* End of date range to filter by when orders were placed
|
|
2754
|
-
* @type {string}
|
|
2755
|
-
* @memberof PlatformApiExportOrders
|
|
2756
|
-
*/
|
|
2757
|
-
readonly end?: string;
|
|
2758
|
-
/**
|
|
2759
|
-
* Search term to filter based on order reference, customer name and email
|
|
2760
|
-
* @type {string}
|
|
2761
|
-
* @memberof PlatformApiExportOrders
|
|
2762
|
-
*/
|
|
2763
|
-
readonly search?: string;
|
|
2764
|
-
}
|
|
2765
|
-
/**
|
|
2766
|
-
* Request parameters for getCustomer operation in PlatformApi.
|
|
2767
|
-
* @export
|
|
2768
|
-
* @interface PlatformApiGetCustomerRequest
|
|
2769
|
-
*/
|
|
2770
|
-
export interface PlatformApiGetCustomerRequest {
|
|
2771
|
-
/**
|
|
2772
|
-
* Project unique identifier
|
|
2773
|
-
* @type {string}
|
|
2774
|
-
* @memberof PlatformApiGetCustomer
|
|
2775
|
-
*/
|
|
2776
|
-
readonly project: string;
|
|
2777
|
-
/**
|
|
2778
|
-
* The platform identifier
|
|
2779
|
-
* @type {string}
|
|
2780
|
-
* @memberof PlatformApiGetCustomer
|
|
2781
|
-
*/
|
|
2782
|
-
readonly platformId: string;
|
|
2783
|
-
/**
|
|
2784
|
-
* The customer identifier
|
|
2785
|
-
* @type {string}
|
|
2786
|
-
* @memberof PlatformApiGetCustomer
|
|
2787
|
-
*/
|
|
2788
|
-
readonly customerId: string;
|
|
2789
|
-
}
|
|
2790
|
-
/**
|
|
2791
|
-
* Request parameters for getFulfillment operation in PlatformApi.
|
|
2792
|
-
* @export
|
|
2793
|
-
* @interface PlatformApiGetFulfillmentRequest
|
|
2794
|
-
*/
|
|
2795
|
-
export interface PlatformApiGetFulfillmentRequest {
|
|
2796
|
-
/**
|
|
2797
|
-
* Project unique identifier
|
|
2798
|
-
* @type {string}
|
|
2799
|
-
* @memberof PlatformApiGetFulfillment
|
|
2800
|
-
*/
|
|
2801
|
-
readonly project: string;
|
|
2802
|
-
/**
|
|
2803
|
-
* The platform identifier
|
|
2804
|
-
* @type {string}
|
|
2805
|
-
* @memberof PlatformApiGetFulfillment
|
|
2806
|
-
*/
|
|
2807
|
-
readonly platformId: string;
|
|
2808
|
-
/**
|
|
2809
|
-
* The fulfillment identifier
|
|
2810
|
-
* @type {string}
|
|
2811
|
-
* @memberof PlatformApiGetFulfillment
|
|
2812
|
-
*/
|
|
2813
|
-
readonly fulfillmentId: string;
|
|
2814
|
-
}
|
|
2815
|
-
/**
|
|
2816
|
-
* Request parameters for getOrder operation in PlatformApi.
|
|
2817
|
-
* @export
|
|
2818
|
-
* @interface PlatformApiGetOrderRequest
|
|
2819
|
-
*/
|
|
2820
|
-
export interface PlatformApiGetOrderRequest {
|
|
2821
|
-
/**
|
|
2822
|
-
* Project unique identifier
|
|
2823
|
-
* @type {string}
|
|
2824
|
-
* @memberof PlatformApiGetOrder
|
|
2825
|
-
*/
|
|
2826
|
-
readonly project: string;
|
|
2827
|
-
/**
|
|
2828
|
-
* The platform identifier
|
|
2829
|
-
* @type {string}
|
|
2830
|
-
* @memberof PlatformApiGetOrder
|
|
2831
|
-
*/
|
|
2832
|
-
readonly platformId: string;
|
|
2833
|
-
/**
|
|
2834
|
-
* The order identifier
|
|
2835
|
-
* @type {string}
|
|
2836
|
-
* @memberof PlatformApiGetOrder
|
|
2837
|
-
*/
|
|
2838
|
-
readonly orderId: string;
|
|
2839
|
-
}
|
|
2840
|
-
/**
|
|
2841
|
-
* Request parameters for getPlatform operation in PlatformApi.
|
|
2842
|
-
* @export
|
|
2843
|
-
* @interface PlatformApiGetPlatformRequest
|
|
2844
|
-
*/
|
|
2845
|
-
export interface PlatformApiGetPlatformRequest {
|
|
2846
|
-
/**
|
|
2847
|
-
* Project unique identifier
|
|
2848
|
-
* @type {string}
|
|
2849
|
-
* @memberof PlatformApiGetPlatform
|
|
2850
|
-
*/
|
|
2851
|
-
readonly project: string;
|
|
2852
|
-
}
|
|
2853
|
-
/**
|
|
2854
|
-
* Request parameters for listAvailableFulfillers operation in PlatformApi.
|
|
2855
|
-
* @export
|
|
2856
|
-
* @interface PlatformApiListAvailableFulfillersRequest
|
|
2857
|
-
*/
|
|
2858
|
-
export interface PlatformApiListAvailableFulfillersRequest {
|
|
2859
|
-
/**
|
|
2860
|
-
* Project unique identifier
|
|
2861
|
-
* @type {string}
|
|
2862
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
2863
|
-
*/
|
|
2864
|
-
readonly project: string;
|
|
2865
|
-
/**
|
|
2866
|
-
* The platform identifier
|
|
2867
|
-
* @type {string}
|
|
2868
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
2869
|
-
*/
|
|
2870
|
-
readonly platformId: string;
|
|
2871
|
-
/**
|
|
2872
|
-
* The fulfillment identifier
|
|
2873
|
-
* @type {string}
|
|
2874
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
2875
|
-
*/
|
|
2876
|
-
readonly fulfillmentId: string;
|
|
2877
|
-
}
|
|
2878
|
-
/**
|
|
2879
|
-
* Request parameters for listCustomers operation in PlatformApi.
|
|
2880
|
-
* @export
|
|
2881
|
-
* @interface PlatformApiListCustomersRequest
|
|
2882
|
-
*/
|
|
2883
|
-
export interface PlatformApiListCustomersRequest {
|
|
2884
|
-
/**
|
|
2885
|
-
* Project unique identifier
|
|
2886
|
-
* @type {string}
|
|
2887
|
-
* @memberof PlatformApiListCustomers
|
|
2888
|
-
*/
|
|
2889
|
-
readonly project: string;
|
|
2890
|
-
/**
|
|
2891
|
-
* The platform identifier
|
|
2892
|
-
* @type {string}
|
|
2893
|
-
* @memberof PlatformApiListCustomers
|
|
2894
|
-
*/
|
|
2895
|
-
readonly platformId: string;
|
|
2896
|
-
/**
|
|
2897
|
-
* Page reference token
|
|
2898
|
-
* @type {number}
|
|
2899
|
-
* @memberof PlatformApiListCustomers
|
|
2900
|
-
*/
|
|
2901
|
-
readonly pageToken?: number;
|
|
2902
|
-
/**
|
|
2903
|
-
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2904
|
-
* @type {number}
|
|
2905
|
-
* @memberof PlatformApiListCustomers
|
|
2906
|
-
*/
|
|
2907
|
-
readonly pageSize?: number;
|
|
2908
|
-
/**
|
|
2909
|
-
* Search term to filter based on order reference, customer name and email
|
|
2910
|
-
* @type {string}
|
|
2911
|
-
* @memberof PlatformApiListCustomers
|
|
2912
|
-
*/
|
|
2913
|
-
readonly search?: string;
|
|
2914
|
-
}
|
|
2915
|
-
/**
|
|
2916
|
-
* Request parameters for listOrders operation in PlatformApi.
|
|
2917
|
-
* @export
|
|
2918
|
-
* @interface PlatformApiListOrdersRequest
|
|
2919
|
-
*/
|
|
2920
|
-
export interface PlatformApiListOrdersRequest {
|
|
2921
|
-
/**
|
|
2922
|
-
* Project unique identifier
|
|
2923
|
-
* @type {string}
|
|
2924
|
-
* @memberof PlatformApiListOrders
|
|
2925
|
-
*/
|
|
2926
|
-
readonly project: string;
|
|
2927
|
-
/**
|
|
2928
|
-
* The platform identifier
|
|
2929
|
-
* @type {string}
|
|
2930
|
-
* @memberof PlatformApiListOrders
|
|
2931
|
-
*/
|
|
2932
|
-
readonly platformId: string;
|
|
2933
|
-
/**
|
|
2934
|
-
* Page reference token
|
|
2935
|
-
* @type {number}
|
|
2936
|
-
* @memberof PlatformApiListOrders
|
|
2937
|
-
*/
|
|
2938
|
-
readonly pageToken?: number;
|
|
2939
|
-
/**
|
|
2940
|
-
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2941
|
-
* @type {number}
|
|
2942
|
-
* @memberof PlatformApiListOrders
|
|
2943
|
-
*/
|
|
2944
|
-
readonly pageSize?: number;
|
|
2945
|
-
/**
|
|
2946
|
-
* Search term to filter based on order reference, customer name and email
|
|
2947
|
-
* @type {string}
|
|
2948
|
-
* @memberof PlatformApiListOrders
|
|
2949
|
-
*/
|
|
2950
|
-
readonly search?: string;
|
|
2951
|
-
/**
|
|
2952
|
-
* Start of date range to filter by when orders were placed
|
|
2953
|
-
* @type {string}
|
|
2954
|
-
* @memberof PlatformApiListOrders
|
|
2955
|
-
*/
|
|
2956
|
-
readonly start?: string;
|
|
2957
|
-
/**
|
|
2958
|
-
* End of date range to filter by when orders were placed
|
|
2959
|
-
* @type {string}
|
|
2960
|
-
* @memberof PlatformApiListOrders
|
|
2961
|
-
*/
|
|
2962
|
-
readonly end?: string;
|
|
2963
|
-
}
|
|
2964
|
-
/**
|
|
2965
|
-
* Request parameters for updateFulfillment operation in PlatformApi.
|
|
2966
|
-
* @export
|
|
2967
|
-
* @interface PlatformApiUpdateFulfillmentRequest
|
|
2968
|
-
*/
|
|
2969
|
-
export interface PlatformApiUpdateFulfillmentRequest {
|
|
2970
|
-
/**
|
|
2971
|
-
* Project unique identifier
|
|
2972
|
-
* @type {string}
|
|
2973
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
2974
|
-
*/
|
|
2975
|
-
readonly project: string;
|
|
2976
|
-
/**
|
|
2977
|
-
* The platform identifier
|
|
2978
|
-
* @type {string}
|
|
2979
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
2980
|
-
*/
|
|
2981
|
-
readonly platformId: string;
|
|
2982
|
-
/**
|
|
2983
|
-
* The fulfillment identifier
|
|
2984
|
-
* @type {string}
|
|
2985
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
2986
|
-
*/
|
|
2987
|
-
readonly fulfillmentId: string;
|
|
2988
|
-
/**
|
|
2989
|
-
*
|
|
2990
|
-
* @type {UpdateFulfillmentRequest}
|
|
2991
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
2992
|
-
*/
|
|
2993
|
-
readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
|
|
2994
|
-
}
|
|
2995
|
-
/**
|
|
2996
|
-
* Request parameters for updatePlatform operation in PlatformApi.
|
|
2997
|
-
* @export
|
|
2998
|
-
* @interface PlatformApiUpdatePlatformRequest
|
|
2999
|
-
*/
|
|
3000
|
-
export interface PlatformApiUpdatePlatformRequest {
|
|
3001
|
-
/**
|
|
3002
|
-
* Project unique identifier
|
|
3003
|
-
* @type {string}
|
|
3004
|
-
* @memberof PlatformApiUpdatePlatform
|
|
3005
|
-
*/
|
|
3006
|
-
readonly project: string;
|
|
3007
|
-
/**
|
|
3008
|
-
*
|
|
3009
|
-
* @type {UpdatePlatformRequest}
|
|
3010
|
-
* @memberof PlatformApiUpdatePlatform
|
|
3011
|
-
*/
|
|
3012
|
-
readonly updatePlatformRequest: UpdatePlatformRequest;
|
|
3013
|
-
}
|
|
3014
|
-
/**
|
|
3015
|
-
* Request parameters for updateProduct operation in PlatformApi.
|
|
3016
|
-
* @export
|
|
3017
|
-
* @interface PlatformApiUpdateProductRequest
|
|
3018
|
-
*/
|
|
3019
|
-
export interface PlatformApiUpdateProductRequest {
|
|
3020
|
-
/**
|
|
3021
|
-
* Project unique identifier
|
|
3022
|
-
* @type {string}
|
|
3023
|
-
* @memberof PlatformApiUpdateProduct
|
|
3024
|
-
*/
|
|
3025
|
-
readonly project: string;
|
|
3026
|
-
/**
|
|
3027
|
-
* The platform identifier
|
|
3028
|
-
* @type {string}
|
|
3029
|
-
* @memberof PlatformApiUpdateProduct
|
|
3030
|
-
*/
|
|
3031
|
-
readonly platformId: string;
|
|
3032
|
-
/**
|
|
3033
|
-
* Products unique identifier
|
|
3034
|
-
* @type {string}
|
|
3035
|
-
* @memberof PlatformApiUpdateProduct
|
|
3036
|
-
*/
|
|
3037
|
-
readonly productId: string;
|
|
3038
|
-
/**
|
|
3039
|
-
* Update a platform warehouse product
|
|
3040
|
-
* @type {UpdateProductRequest}
|
|
3041
|
-
* @memberof PlatformApiUpdateProduct
|
|
3042
|
-
*/
|
|
3043
|
-
readonly updateProductRequest: UpdateProductRequest;
|
|
3044
|
-
}
|
|
3045
|
-
/**
|
|
3046
|
-
* Request parameters for updateVariant operation in PlatformApi.
|
|
3047
|
-
* @export
|
|
3048
|
-
* @interface PlatformApiUpdateVariantRequest
|
|
3049
|
-
*/
|
|
3050
|
-
export interface PlatformApiUpdateVariantRequest {
|
|
3051
|
-
/**
|
|
3052
|
-
* Project unique identifier
|
|
3053
|
-
* @type {string}
|
|
3054
|
-
* @memberof PlatformApiUpdateVariant
|
|
3055
|
-
*/
|
|
3056
|
-
readonly project: string;
|
|
3057
|
-
/**
|
|
3058
|
-
* The platform identifier
|
|
3059
|
-
* @type {string}
|
|
3060
|
-
* @memberof PlatformApiUpdateVariant
|
|
3061
|
-
*/
|
|
3062
|
-
readonly platformId: string;
|
|
3063
|
-
/**
|
|
3064
|
-
* Variants unique identifier
|
|
3065
|
-
* @type {string}
|
|
3066
|
-
* @memberof PlatformApiUpdateVariant
|
|
3067
|
-
*/
|
|
3068
|
-
readonly variantId: string;
|
|
3069
|
-
/**
|
|
3070
|
-
* Update a platform warehouse variant
|
|
3071
|
-
* @type {UpdateVariantRequest}
|
|
3072
|
-
* @memberof PlatformApiUpdateVariant
|
|
3073
|
-
*/
|
|
3074
|
-
readonly updateVariantRequest: UpdateVariantRequest;
|
|
3075
|
-
}
|
|
3076
|
-
/**
|
|
3077
|
-
* PlatformApi - object-oriented interface
|
|
3078
|
-
* @export
|
|
3079
|
-
* @class PlatformApi
|
|
3080
|
-
* @extends {BaseAPI}
|
|
3081
|
-
*/
|
|
3082
|
-
export declare class PlatformApi extends BaseAPI {
|
|
3083
|
-
/**
|
|
3084
|
-
* Export customers as a CSV file
|
|
3085
|
-
* @summary Export customers
|
|
3086
|
-
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
3087
|
-
* @param {*} [options] Override http request option.
|
|
3088
|
-
* @throws {RequiredError}
|
|
3089
|
-
* @memberof PlatformApi
|
|
3090
|
-
*/
|
|
3091
|
-
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
3092
|
-
/**
|
|
3093
|
-
* Export orders as a CSV file
|
|
3094
|
-
* @summary Export orders
|
|
3095
|
-
* @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
|
|
3096
|
-
* @param {*} [options] Override http request option.
|
|
3097
|
-
* @throws {RequiredError}
|
|
3098
|
-
* @memberof PlatformApi
|
|
3099
|
-
*/
|
|
3100
|
-
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
|
|
3101
|
-
/**
|
|
3102
|
-
* Get a customer for a platform by a given customer ID.
|
|
3103
|
-
* @summary Get customer
|
|
3104
|
-
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
3105
|
-
* @param {*} [options] Override http request option.
|
|
3106
|
-
* @throws {RequiredError}
|
|
3107
|
-
* @memberof PlatformApi
|
|
3108
|
-
*/
|
|
3109
|
-
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
|
|
3110
|
-
/**
|
|
3111
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3112
|
-
* @summary Get fulfillment
|
|
3113
|
-
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
3114
|
-
* @param {*} [options] Override http request option.
|
|
3115
|
-
* @throws {RequiredError}
|
|
3116
|
-
* @memberof PlatformApi
|
|
3117
|
-
*/
|
|
3118
|
-
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
3119
|
-
/**
|
|
3120
|
-
* Get an order for a platform by a given order ID.
|
|
3121
|
-
* @summary Get order
|
|
3122
|
-
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
3123
|
-
* @param {*} [options] Override http request option.
|
|
3124
|
-
* @throws {RequiredError}
|
|
3125
|
-
* @memberof PlatformApi
|
|
3126
|
-
*/
|
|
3127
|
-
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
|
|
3128
|
-
/**
|
|
3129
|
-
*
|
|
3130
|
-
* @summary Get platform details
|
|
3131
|
-
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
3132
|
-
* @param {*} [options] Override http request option.
|
|
3133
|
-
* @throws {RequiredError}
|
|
3134
|
-
* @memberof PlatformApi
|
|
3135
|
-
*/
|
|
3136
|
-
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
3137
|
-
/**
|
|
3138
|
-
* List available fulfillers for a given fulfillment
|
|
3139
|
-
* @summary List available fulfillers
|
|
3140
|
-
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
3141
|
-
* @param {*} [options] Override http request option.
|
|
3142
|
-
* @throws {RequiredError}
|
|
3143
|
-
* @memberof PlatformApi
|
|
3144
|
-
*/
|
|
3145
|
-
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
|
|
3146
|
-
/**
|
|
3147
|
-
* List customers for a platform
|
|
3148
|
-
* @summary List customers
|
|
3149
|
-
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
3150
|
-
* @param {*} [options] Override http request option.
|
|
3151
|
-
* @throws {RequiredError}
|
|
3152
|
-
* @memberof PlatformApi
|
|
3153
|
-
*/
|
|
3154
|
-
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
|
|
3155
|
-
/**
|
|
3156
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3157
|
-
* @summary List orders
|
|
3158
|
-
* @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
|
|
3159
|
-
* @param {*} [options] Override http request option.
|
|
3160
|
-
* @throws {RequiredError}
|
|
3161
|
-
* @memberof PlatformApi
|
|
3162
|
-
*/
|
|
3163
|
-
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
|
|
3164
|
-
/**
|
|
3165
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
3166
|
-
* @summary Update fulfillment
|
|
3167
|
-
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
3168
|
-
* @param {*} [options] Override http request option.
|
|
3169
|
-
* @throws {RequiredError}
|
|
3170
|
-
* @memberof PlatformApi
|
|
3171
|
-
*/
|
|
3172
|
-
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
|
|
3173
|
-
/**
|
|
3174
|
-
*
|
|
3175
|
-
* @summary Update platform
|
|
3176
|
-
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
3177
|
-
* @param {*} [options] Override http request option.
|
|
3178
|
-
* @throws {RequiredError}
|
|
3179
|
-
* @memberof PlatformApi
|
|
2594
|
+
* @memberof PlatformApi
|
|
3180
2595
|
*/
|
|
3181
2596
|
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
|
|
3182
|
-
/**
|
|
3183
|
-
* Updates the warehouse product and its variants
|
|
3184
|
-
* @summary Update warehouse product
|
|
3185
|
-
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
3186
|
-
* @param {*} [options] Override http request option.
|
|
3187
|
-
* @throws {RequiredError}
|
|
3188
|
-
* @memberof PlatformApi
|
|
3189
|
-
*/
|
|
3190
|
-
updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
|
|
3191
|
-
/**
|
|
3192
|
-
* Updates the warehouse variant
|
|
3193
|
-
* @summary Update warehouse variant
|
|
3194
|
-
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
3195
|
-
* @param {*} [options] Override http request option.
|
|
3196
|
-
* @throws {RequiredError}
|
|
3197
|
-
* @memberof PlatformApi
|
|
3198
|
-
*/
|
|
3199
|
-
updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
|
|
3200
2597
|
}
|
|
3201
2598
|
/**
|
|
3202
2599
|
* ProductsApi - axios parameter creator
|