@teemill/platform 0.12.1 → 0.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/api.ts +298 -1537
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +230 -853
- package/dist/api.js +161 -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 +230 -853
- package/dist/esm/api.js +158 -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/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.13.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -195,13 +195,31 @@ export interface Customer {
|
|
|
195
195
|
* @type {string}
|
|
196
196
|
* @memberof Customer
|
|
197
197
|
*/
|
|
198
|
-
'firstName'
|
|
198
|
+
'firstName': string;
|
|
199
199
|
/**
|
|
200
200
|
*
|
|
201
201
|
* @type {string}
|
|
202
202
|
* @memberof Customer
|
|
203
203
|
*/
|
|
204
|
-
'lastName'
|
|
204
|
+
'lastName': string;
|
|
205
|
+
/**
|
|
206
|
+
*
|
|
207
|
+
* @type {string}
|
|
208
|
+
* @memberof Customer
|
|
209
|
+
*/
|
|
210
|
+
'gender': string | null;
|
|
211
|
+
/**
|
|
212
|
+
*
|
|
213
|
+
* @type {string}
|
|
214
|
+
* @memberof Customer
|
|
215
|
+
*/
|
|
216
|
+
'country': string | null;
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
* @type {Statistics}
|
|
220
|
+
* @memberof Customer
|
|
221
|
+
*/
|
|
222
|
+
'statistics': Statistics;
|
|
205
223
|
}
|
|
206
224
|
/**
|
|
207
225
|
*
|
|
@@ -1351,6 +1369,31 @@ export interface ShippingMethod {
|
|
|
1351
1369
|
*/
|
|
1352
1370
|
'discountPrice'?: Price;
|
|
1353
1371
|
}
|
|
1372
|
+
/**
|
|
1373
|
+
*
|
|
1374
|
+
* @export
|
|
1375
|
+
* @interface Statistics
|
|
1376
|
+
*/
|
|
1377
|
+
export interface Statistics {
|
|
1378
|
+
/**
|
|
1379
|
+
*
|
|
1380
|
+
* @type {number}
|
|
1381
|
+
* @memberof Statistics
|
|
1382
|
+
*/
|
|
1383
|
+
'lifetimeValue': number;
|
|
1384
|
+
/**
|
|
1385
|
+
*
|
|
1386
|
+
* @type {number}
|
|
1387
|
+
* @memberof Statistics
|
|
1388
|
+
*/
|
|
1389
|
+
'totalOrderCount': number;
|
|
1390
|
+
/**
|
|
1391
|
+
*
|
|
1392
|
+
* @type {string}
|
|
1393
|
+
* @memberof Statistics
|
|
1394
|
+
*/
|
|
1395
|
+
'lastPurchased': string | null;
|
|
1396
|
+
}
|
|
1354
1397
|
/**
|
|
1355
1398
|
*
|
|
1356
1399
|
* @export
|
|
@@ -1491,12 +1534,6 @@ export interface ValidationError {
|
|
|
1491
1534
|
* @memberof ValidationError
|
|
1492
1535
|
*/
|
|
1493
1536
|
'message': string;
|
|
1494
|
-
/**
|
|
1495
|
-
*
|
|
1496
|
-
* @type {{ [key: string]: Array<string>; }}
|
|
1497
|
-
* @memberof ValidationError
|
|
1498
|
-
*/
|
|
1499
|
-
'errors': { [key: string]: Array<string>; };
|
|
1500
1537
|
}
|
|
1501
1538
|
/**
|
|
1502
1539
|
*
|
|
@@ -1710,10 +1747,15 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1710
1747
|
* @summary Export customers
|
|
1711
1748
|
* @param {string} project Project unique identifier
|
|
1712
1749
|
* @param {string} platformId The platform identifier
|
|
1750
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1751
|
+
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1752
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1753
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1754
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1713
1755
|
* @param {*} [options] Override http request option.
|
|
1714
1756
|
* @throws {RequiredError}
|
|
1715
1757
|
*/
|
|
1716
|
-
exportCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1758
|
+
exportCustomers: async (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1717
1759
|
// verify required parameter 'project' is not null or undefined
|
|
1718
1760
|
assertParamExists('exportCustomers', 'project', project)
|
|
1719
1761
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1742,6 +1784,28 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1742
1784
|
localVarQueryParameter['project'] = project;
|
|
1743
1785
|
}
|
|
1744
1786
|
|
|
1787
|
+
if (totalOrderCount !== undefined) {
|
|
1788
|
+
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1789
|
+
}
|
|
1790
|
+
|
|
1791
|
+
if (lifetimeValue !== undefined) {
|
|
1792
|
+
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1793
|
+
}
|
|
1794
|
+
|
|
1795
|
+
if (sortBy) {
|
|
1796
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
if (lastPurchasedStart !== undefined) {
|
|
1800
|
+
localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart as any instanceof Date) ?
|
|
1801
|
+
(lastPurchasedStart as any).toISOString() :
|
|
1802
|
+
lastPurchasedStart;
|
|
1803
|
+
}
|
|
1804
|
+
|
|
1805
|
+
if (lastPurchasedEnd !== undefined) {
|
|
1806
|
+
localVarQueryParameter['lastPurchasedEnd'] = lastPurchasedEnd;
|
|
1807
|
+
}
|
|
1808
|
+
|
|
1745
1809
|
|
|
1746
1810
|
|
|
1747
1811
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1813,10 +1877,15 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1813
1877
|
* @param {number} [pageToken] Page reference token
|
|
1814
1878
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1815
1879
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
1880
|
+
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1881
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1882
|
+
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1883
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1884
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1816
1885
|
* @param {*} [options] Override http request option.
|
|
1817
1886
|
* @throws {RequiredError}
|
|
1818
1887
|
*/
|
|
1819
|
-
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1888
|
+
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1820
1889
|
// verify required parameter 'project' is not null or undefined
|
|
1821
1890
|
assertParamExists('listCustomers', 'project', project)
|
|
1822
1891
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -1857,6 +1926,28 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
1857
1926
|
localVarQueryParameter['search'] = search;
|
|
1858
1927
|
}
|
|
1859
1928
|
|
|
1929
|
+
if (sortBy) {
|
|
1930
|
+
localVarQueryParameter['sortBy'] = sortBy;
|
|
1931
|
+
}
|
|
1932
|
+
|
|
1933
|
+
if (totalOrderCount !== undefined) {
|
|
1934
|
+
localVarQueryParameter['totalOrderCount'] = totalOrderCount;
|
|
1935
|
+
}
|
|
1936
|
+
|
|
1937
|
+
if (lifetimeValue !== undefined) {
|
|
1938
|
+
localVarQueryParameter['lifetimeValue'] = lifetimeValue;
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
if (lastPurchasedStart !== undefined) {
|
|
1942
|
+
localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart as any instanceof Date) ?
|
|
1943
|
+
(lastPurchasedStart as any).toISOString() :
|
|
1944
|
+
lastPurchasedStart;
|
|
1945
|
+
}
|
|
1946
|
+
|
|
1947
|
+
if (lastPurchasedEnd !== undefined) {
|
|
1948
|
+
localVarQueryParameter['lastPurchasedEnd'] = lastPurchasedEnd;
|
|
1949
|
+
}
|
|
1950
|
+
|
|
1860
1951
|
|
|
1861
1952
|
|
|
1862
1953
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -1883,11 +1974,16 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1883
1974
|
* @summary Export customers
|
|
1884
1975
|
* @param {string} project Project unique identifier
|
|
1885
1976
|
* @param {string} platformId The platform identifier
|
|
1977
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
1978
|
+
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
1979
|
+
* @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
1980
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
1981
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1886
1982
|
* @param {*} [options] Override http request option.
|
|
1887
1983
|
* @throws {RequiredError}
|
|
1888
1984
|
*/
|
|
1889
|
-
async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1890
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
1985
|
+
async exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1986
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, lifetimeValue, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
|
|
1891
1987
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1892
1988
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1893
1989
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1915,11 +2011,16 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
1915
2011
|
* @param {number} [pageToken] Page reference token
|
|
1916
2012
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
1917
2013
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2014
|
+
* @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2015
|
+
* @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
|
|
2016
|
+
* @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
|
|
2017
|
+
* @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
|
|
2018
|
+
* @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
|
|
1918
2019
|
* @param {*} [options] Override http request option.
|
|
1919
2020
|
* @throws {RequiredError}
|
|
1920
2021
|
*/
|
|
1921
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
1922
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
|
|
2022
|
+
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2023
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
1923
2024
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1924
2025
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1925
2026
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1942,7 +2043,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1942
2043
|
* @throws {RequiredError}
|
|
1943
2044
|
*/
|
|
1944
2045
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1945
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
2046
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
1946
2047
|
},
|
|
1947
2048
|
/**
|
|
1948
2049
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -1962,7 +2063,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
1962
2063
|
* @throws {RequiredError}
|
|
1963
2064
|
*/
|
|
1964
2065
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
1965
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
2066
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
1966
2067
|
},
|
|
1967
2068
|
};
|
|
1968
2069
|
};
|
|
@@ -1986,6 +2087,41 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
1986
2087
|
* @memberof CustomersApiExportCustomers
|
|
1987
2088
|
*/
|
|
1988
2089
|
readonly platformId: string
|
|
2090
|
+
|
|
2091
|
+
/**
|
|
2092
|
+
* Filter customers by total order count equal to the value provided
|
|
2093
|
+
* @type {number}
|
|
2094
|
+
* @memberof CustomersApiExportCustomers
|
|
2095
|
+
*/
|
|
2096
|
+
readonly totalOrderCount?: number
|
|
2097
|
+
|
|
2098
|
+
/**
|
|
2099
|
+
* Filter customers by lifetime value less than or equal to the value provided
|
|
2100
|
+
* @type {number}
|
|
2101
|
+
* @memberof CustomersApiExportCustomers
|
|
2102
|
+
*/
|
|
2103
|
+
readonly lifetimeValue?: number
|
|
2104
|
+
|
|
2105
|
+
/**
|
|
2106
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2107
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2108
|
+
* @memberof CustomersApiExportCustomers
|
|
2109
|
+
*/
|
|
2110
|
+
readonly sortBy?: Array<ExportCustomersSortByEnum>
|
|
2111
|
+
|
|
2112
|
+
/**
|
|
2113
|
+
* Start of date range to filter customers by last purchase date
|
|
2114
|
+
* @type {string}
|
|
2115
|
+
* @memberof CustomersApiExportCustomers
|
|
2116
|
+
*/
|
|
2117
|
+
readonly lastPurchasedStart?: string
|
|
2118
|
+
|
|
2119
|
+
/**
|
|
2120
|
+
* End of date range to filter customers by last purchase date
|
|
2121
|
+
* @type {string}
|
|
2122
|
+
* @memberof CustomersApiExportCustomers
|
|
2123
|
+
*/
|
|
2124
|
+
readonly lastPurchasedEnd?: string
|
|
1989
2125
|
}
|
|
1990
2126
|
|
|
1991
2127
|
/**
|
|
@@ -2056,6 +2192,41 @@ export interface CustomersApiListCustomersRequest {
|
|
|
2056
2192
|
* @memberof CustomersApiListCustomers
|
|
2057
2193
|
*/
|
|
2058
2194
|
readonly search?: string
|
|
2195
|
+
|
|
2196
|
+
/**
|
|
2197
|
+
* An array of fields to sort by, prefixed with a \'-\' for descending order or \'+\' for ascending. Default is ascending.
|
|
2198
|
+
* @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
|
|
2199
|
+
* @memberof CustomersApiListCustomers
|
|
2200
|
+
*/
|
|
2201
|
+
readonly sortBy?: Array<ListCustomersSortByEnum>
|
|
2202
|
+
|
|
2203
|
+
/**
|
|
2204
|
+
* Filter customers by total order count equal to the value provided
|
|
2205
|
+
* @type {number}
|
|
2206
|
+
* @memberof CustomersApiListCustomers
|
|
2207
|
+
*/
|
|
2208
|
+
readonly totalOrderCount?: number
|
|
2209
|
+
|
|
2210
|
+
/**
|
|
2211
|
+
* Filter customers by lifetime value less than or equal to the value provided
|
|
2212
|
+
* @type {number}
|
|
2213
|
+
* @memberof CustomersApiListCustomers
|
|
2214
|
+
*/
|
|
2215
|
+
readonly lifetimeValue?: number
|
|
2216
|
+
|
|
2217
|
+
/**
|
|
2218
|
+
* Start of date range to filter customers by last purchase date
|
|
2219
|
+
* @type {string}
|
|
2220
|
+
* @memberof CustomersApiListCustomers
|
|
2221
|
+
*/
|
|
2222
|
+
readonly lastPurchasedStart?: string
|
|
2223
|
+
|
|
2224
|
+
/**
|
|
2225
|
+
* End of date range to filter customers by last purchase date
|
|
2226
|
+
* @type {string}
|
|
2227
|
+
* @memberof CustomersApiListCustomers
|
|
2228
|
+
*/
|
|
2229
|
+
readonly lastPurchasedEnd?: string
|
|
2059
2230
|
}
|
|
2060
2231
|
|
|
2061
2232
|
/**
|
|
@@ -2074,7 +2245,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
2074
2245
|
* @memberof CustomersApi
|
|
2075
2246
|
*/
|
|
2076
2247
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2077
|
-
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
2248
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2078
2249
|
}
|
|
2079
2250
|
|
|
2080
2251
|
/**
|
|
@@ -2098,10 +2269,34 @@ export class CustomersApi extends BaseAPI {
|
|
|
2098
2269
|
* @memberof CustomersApi
|
|
2099
2270
|
*/
|
|
2100
2271
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2101
|
-
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
2272
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
2102
2273
|
}
|
|
2103
2274
|
}
|
|
2104
2275
|
|
|
2276
|
+
/**
|
|
2277
|
+
* @export
|
|
2278
|
+
*/
|
|
2279
|
+
export const ExportCustomersSortByEnum = {
|
|
2280
|
+
LifetimeValue: '+lifetimeValue',
|
|
2281
|
+
LifetimeValue2: '-lifetimeValue',
|
|
2282
|
+
TotalOrderCount: '+totalOrderCount',
|
|
2283
|
+
TotalOrderCount2: '-totalOrderCount',
|
|
2284
|
+
LastPurchased: '+lastPurchased',
|
|
2285
|
+
LastPurchased2: '-lastPurchased'
|
|
2286
|
+
} as const;
|
|
2287
|
+
export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
|
|
2288
|
+
/**
|
|
2289
|
+
* @export
|
|
2290
|
+
*/
|
|
2291
|
+
export const ListCustomersSortByEnum = {
|
|
2292
|
+
LifetimeValue: '+lifetimeValue',
|
|
2293
|
+
LifetimeValue2: '-lifetimeValue',
|
|
2294
|
+
TotalOrderCount: '+totalOrderCount',
|
|
2295
|
+
TotalOrderCount2: '-totalOrderCount',
|
|
2296
|
+
LastPurchased: '+lastPurchased',
|
|
2297
|
+
LastPurchased2: '-lastPurchased'
|
|
2298
|
+
} as const;
|
|
2299
|
+
export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
|
|
2105
2300
|
|
|
2106
2301
|
|
|
2107
2302
|
/**
|
|
@@ -2116,7 +2311,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2116
2311
|
* @param {string} project Project unique identifier
|
|
2117
2312
|
* @param {string} platformId The platform identifier
|
|
2118
2313
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2119
|
-
* @param {string} [end] End of date range to filter
|
|
2314
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
2120
2315
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2121
2316
|
* @param {*} [options] Override http request option.
|
|
2122
2317
|
* @throws {RequiredError}
|
|
@@ -2343,8 +2538,8 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2343
2538
|
* @param {number} [pageToken] Page reference token
|
|
2344
2539
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2345
2540
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2346
|
-
* @param {string} [start] Start of date range to filter
|
|
2347
|
-
* @param {string} [end] End of date range to filter
|
|
2541
|
+
* @param {string} [start] Start of date range to filter when orders were placed
|
|
2542
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
2348
2543
|
* @param {*} [options] Override http request option.
|
|
2349
2544
|
* @throws {RequiredError}
|
|
2350
2545
|
*/
|
|
@@ -2486,7 +2681,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
2486
2681
|
* @param {string} project Project unique identifier
|
|
2487
2682
|
* @param {string} platformId The platform identifier
|
|
2488
2683
|
* @param {string} start Start of date range to filter by when orders were placed
|
|
2489
|
-
* @param {string} [end] End of date range to filter
|
|
2684
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
2490
2685
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2491
2686
|
* @param {*} [options] Override http request option.
|
|
2492
2687
|
* @throws {RequiredError}
|
|
@@ -2550,8 +2745,8 @@ export const OrdersApiFp = function(configuration?: Configuration) {
|
|
|
2550
2745
|
* @param {number} [pageToken] Page reference token
|
|
2551
2746
|
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2552
2747
|
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
2553
|
-
* @param {string} [start] Start of date range to filter
|
|
2554
|
-
* @param {string} [end] End of date range to filter
|
|
2748
|
+
* @param {string} [start] Start of date range to filter when orders were placed
|
|
2749
|
+
* @param {string} [end] End of date range to filter when orders were placed
|
|
2555
2750
|
* @param {*} [options] Override http request option.
|
|
2556
2751
|
* @throws {RequiredError}
|
|
2557
2752
|
*/
|
|
@@ -2678,7 +2873,7 @@ export interface OrdersApiExportOrdersRequest {
|
|
|
2678
2873
|
readonly start: string
|
|
2679
2874
|
|
|
2680
2875
|
/**
|
|
2681
|
-
* End of date range to filter
|
|
2876
|
+
* End of date range to filter when orders were placed
|
|
2682
2877
|
* @type {string}
|
|
2683
2878
|
* @memberof OrdersApiExportOrders
|
|
2684
2879
|
*/
|
|
@@ -2818,14 +3013,14 @@ export interface OrdersApiListOrdersRequest {
|
|
|
2818
3013
|
readonly search?: string
|
|
2819
3014
|
|
|
2820
3015
|
/**
|
|
2821
|
-
* Start of date range to filter
|
|
3016
|
+
* Start of date range to filter when orders were placed
|
|
2822
3017
|
* @type {string}
|
|
2823
3018
|
* @memberof OrdersApiListOrders
|
|
2824
3019
|
*/
|
|
2825
3020
|
readonly start?: string
|
|
2826
3021
|
|
|
2827
3022
|
/**
|
|
2828
|
-
* End of date range to filter
|
|
3023
|
+
* End of date range to filter when orders were placed
|
|
2829
3024
|
* @type {string}
|
|
2830
3025
|
* @memberof OrdersApiListOrders
|
|
2831
3026
|
*/
|
|
@@ -2956,20 +3151,16 @@ export class OrdersApi extends BaseAPI {
|
|
|
2956
3151
|
export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2957
3152
|
return {
|
|
2958
3153
|
/**
|
|
2959
|
-
*
|
|
2960
|
-
* @summary
|
|
3154
|
+
*
|
|
3155
|
+
* @summary Get platform details
|
|
2961
3156
|
* @param {string} project Project unique identifier
|
|
2962
|
-
* @param {string} platformId The platform identifier
|
|
2963
3157
|
* @param {*} [options] Override http request option.
|
|
2964
3158
|
* @throws {RequiredError}
|
|
2965
3159
|
*/
|
|
2966
|
-
|
|
3160
|
+
getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2967
3161
|
// verify required parameter 'project' is not null or undefined
|
|
2968
|
-
assertParamExists('
|
|
2969
|
-
|
|
2970
|
-
assertParamExists('exportCustomers', 'platformId', platformId)
|
|
2971
|
-
const localVarPath = `/v1/platform/{platformId}/customers/export`
|
|
2972
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3162
|
+
assertParamExists('getPlatform', 'project', project)
|
|
3163
|
+
const localVarPath = `/v1/platform`;
|
|
2973
3164
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2974
3165
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2975
3166
|
let baseOptions;
|
|
@@ -3004,25 +3195,19 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3004
3195
|
};
|
|
3005
3196
|
},
|
|
3006
3197
|
/**
|
|
3007
|
-
*
|
|
3008
|
-
* @summary
|
|
3198
|
+
*
|
|
3199
|
+
* @summary Update platform
|
|
3009
3200
|
* @param {string} project Project unique identifier
|
|
3010
|
-
* @param {
|
|
3011
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
3012
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
3013
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3201
|
+
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
3014
3202
|
* @param {*} [options] Override http request option.
|
|
3015
3203
|
* @throws {RequiredError}
|
|
3016
3204
|
*/
|
|
3017
|
-
|
|
3205
|
+
updatePlatform: async (project: string, updatePlatformRequest: UpdatePlatformRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3018
3206
|
// verify required parameter 'project' is not null or undefined
|
|
3019
|
-
assertParamExists('
|
|
3020
|
-
// verify required parameter '
|
|
3021
|
-
assertParamExists('
|
|
3022
|
-
|
|
3023
|
-
assertParamExists('exportOrders', 'start', start)
|
|
3024
|
-
const localVarPath = `/v1/platform/{platformId}/orders/export`
|
|
3025
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3207
|
+
assertParamExists('updatePlatform', 'project', project)
|
|
3208
|
+
// verify required parameter 'updatePlatformRequest' is not null or undefined
|
|
3209
|
+
assertParamExists('updatePlatform', 'updatePlatformRequest', updatePlatformRequest)
|
|
3210
|
+
const localVarPath = `/v1/platform`;
|
|
3026
3211
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3027
3212
|
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3028
3213
|
let baseOptions;
|
|
@@ -3030,7 +3215,7 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3030
3215
|
baseOptions = configuration.baseOptions;
|
|
3031
3216
|
}
|
|
3032
3217
|
|
|
3033
|
-
const localVarRequestOptions = { method: '
|
|
3218
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3034
3219
|
const localVarHeaderParameter = {} as any;
|
|
3035
3220
|
const localVarQueryParameter = {} as any;
|
|
3036
3221
|
|
|
@@ -3045,1324 +3230,102 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3045
3230
|
localVarQueryParameter['project'] = project;
|
|
3046
3231
|
}
|
|
3047
3232
|
|
|
3048
|
-
if (start !== undefined) {
|
|
3049
|
-
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3050
|
-
(start as any).toISOString() :
|
|
3051
|
-
start;
|
|
3052
|
-
}
|
|
3053
|
-
|
|
3054
|
-
if (end !== undefined) {
|
|
3055
|
-
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3056
|
-
(end as any).toISOString() :
|
|
3057
|
-
end;
|
|
3058
|
-
}
|
|
3059
|
-
|
|
3060
|
-
if (search !== undefined) {
|
|
3061
|
-
localVarQueryParameter['search'] = search;
|
|
3062
|
-
}
|
|
3063
|
-
|
|
3064
3233
|
|
|
3065
3234
|
|
|
3235
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3236
|
+
|
|
3066
3237
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3067
3238
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3068
3239
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3240
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformRequest, localVarRequestOptions, configuration)
|
|
3069
3241
|
|
|
3070
3242
|
return {
|
|
3071
3243
|
url: toPathString(localVarUrlObj),
|
|
3072
3244
|
options: localVarRequestOptions,
|
|
3073
3245
|
};
|
|
3074
3246
|
},
|
|
3247
|
+
}
|
|
3248
|
+
};
|
|
3249
|
+
|
|
3250
|
+
/**
|
|
3251
|
+
* PlatformApi - functional programming interface
|
|
3252
|
+
* @export
|
|
3253
|
+
*/
|
|
3254
|
+
export const PlatformApiFp = function(configuration?: Configuration) {
|
|
3255
|
+
const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
|
|
3256
|
+
return {
|
|
3075
3257
|
/**
|
|
3076
|
-
*
|
|
3077
|
-
* @summary Get
|
|
3258
|
+
*
|
|
3259
|
+
* @summary Get platform details
|
|
3078
3260
|
* @param {string} project Project unique identifier
|
|
3079
|
-
* @param {string} platformId The platform identifier
|
|
3080
|
-
* @param {string} customerId The customer identifier
|
|
3081
3261
|
* @param {*} [options] Override http request option.
|
|
3082
3262
|
* @throws {RequiredError}
|
|
3083
3263
|
*/
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3088
|
-
|
|
3089
|
-
// verify required parameter 'customerId' is not null or undefined
|
|
3090
|
-
assertParamExists('getCustomer', 'customerId', customerId)
|
|
3091
|
-
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
3092
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3093
|
-
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
3094
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3095
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3096
|
-
let baseOptions;
|
|
3097
|
-
if (configuration) {
|
|
3098
|
-
baseOptions = configuration.baseOptions;
|
|
3099
|
-
}
|
|
3100
|
-
|
|
3101
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3102
|
-
const localVarHeaderParameter = {} as any;
|
|
3103
|
-
const localVarQueryParameter = {} as any;
|
|
3104
|
-
|
|
3105
|
-
// authentication session-oauth required
|
|
3106
|
-
// oauth required
|
|
3107
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3108
|
-
|
|
3109
|
-
// authentication api-key required
|
|
3110
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3111
|
-
|
|
3112
|
-
if (project !== undefined) {
|
|
3113
|
-
localVarQueryParameter['project'] = project;
|
|
3114
|
-
}
|
|
3115
|
-
|
|
3116
|
-
|
|
3117
|
-
|
|
3118
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3119
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3120
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3121
|
-
|
|
3122
|
-
return {
|
|
3123
|
-
url: toPathString(localVarUrlObj),
|
|
3124
|
-
options: localVarRequestOptions,
|
|
3125
|
-
};
|
|
3264
|
+
async getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
|
|
3265
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlatform(project, options);
|
|
3266
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3267
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
|
|
3268
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3126
3269
|
},
|
|
3127
3270
|
/**
|
|
3128
|
-
*
|
|
3129
|
-
* @summary
|
|
3271
|
+
*
|
|
3272
|
+
* @summary Update platform
|
|
3130
3273
|
* @param {string} project Project unique identifier
|
|
3131
|
-
* @param {
|
|
3132
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3274
|
+
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
3133
3275
|
* @param {*} [options] Override http request option.
|
|
3134
3276
|
* @throws {RequiredError}
|
|
3135
3277
|
*/
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3145
|
-
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
3146
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3147
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3148
|
-
let baseOptions;
|
|
3149
|
-
if (configuration) {
|
|
3150
|
-
baseOptions = configuration.baseOptions;
|
|
3151
|
-
}
|
|
3152
|
-
|
|
3153
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3154
|
-
const localVarHeaderParameter = {} as any;
|
|
3155
|
-
const localVarQueryParameter = {} as any;
|
|
3156
|
-
|
|
3157
|
-
// authentication session-oauth required
|
|
3158
|
-
// oauth required
|
|
3159
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3160
|
-
|
|
3161
|
-
// authentication api-key required
|
|
3162
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3163
|
-
|
|
3164
|
-
if (project !== undefined) {
|
|
3165
|
-
localVarQueryParameter['project'] = project;
|
|
3166
|
-
}
|
|
3167
|
-
|
|
3168
|
-
|
|
3169
|
-
|
|
3170
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3171
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3172
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3173
|
-
|
|
3174
|
-
return {
|
|
3175
|
-
url: toPathString(localVarUrlObj),
|
|
3176
|
-
options: localVarRequestOptions,
|
|
3177
|
-
};
|
|
3178
|
-
},
|
|
3179
|
-
/**
|
|
3180
|
-
* Get an order for a platform by a given order ID.
|
|
3181
|
-
* @summary Get order
|
|
3182
|
-
* @param {string} project Project unique identifier
|
|
3183
|
-
* @param {string} platformId The platform identifier
|
|
3184
|
-
* @param {string} orderId The order identifier
|
|
3185
|
-
* @param {*} [options] Override http request option.
|
|
3186
|
-
* @throws {RequiredError}
|
|
3187
|
-
*/
|
|
3188
|
-
getOrder: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3189
|
-
// verify required parameter 'project' is not null or undefined
|
|
3190
|
-
assertParamExists('getOrder', 'project', project)
|
|
3191
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3192
|
-
assertParamExists('getOrder', 'platformId', platformId)
|
|
3193
|
-
// verify required parameter 'orderId' is not null or undefined
|
|
3194
|
-
assertParamExists('getOrder', 'orderId', orderId)
|
|
3195
|
-
const localVarPath = `/v1/platform/{platformId}/orders/{orderId}`
|
|
3196
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3197
|
-
.replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
|
|
3198
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3199
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3200
|
-
let baseOptions;
|
|
3201
|
-
if (configuration) {
|
|
3202
|
-
baseOptions = configuration.baseOptions;
|
|
3203
|
-
}
|
|
3204
|
-
|
|
3205
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3206
|
-
const localVarHeaderParameter = {} as any;
|
|
3207
|
-
const localVarQueryParameter = {} as any;
|
|
3208
|
-
|
|
3209
|
-
// authentication session-oauth required
|
|
3210
|
-
// oauth required
|
|
3211
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3212
|
-
|
|
3213
|
-
// authentication api-key required
|
|
3214
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3215
|
-
|
|
3216
|
-
if (project !== undefined) {
|
|
3217
|
-
localVarQueryParameter['project'] = project;
|
|
3218
|
-
}
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3223
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3224
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3225
|
-
|
|
3226
|
-
return {
|
|
3227
|
-
url: toPathString(localVarUrlObj),
|
|
3228
|
-
options: localVarRequestOptions,
|
|
3229
|
-
};
|
|
3230
|
-
},
|
|
3231
|
-
/**
|
|
3232
|
-
*
|
|
3233
|
-
* @summary Get platform details
|
|
3234
|
-
* @param {string} project Project unique identifier
|
|
3235
|
-
* @param {*} [options] Override http request option.
|
|
3236
|
-
* @throws {RequiredError}
|
|
3237
|
-
*/
|
|
3238
|
-
getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3239
|
-
// verify required parameter 'project' is not null or undefined
|
|
3240
|
-
assertParamExists('getPlatform', 'project', project)
|
|
3241
|
-
const localVarPath = `/v1/platform`;
|
|
3242
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3243
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3244
|
-
let baseOptions;
|
|
3245
|
-
if (configuration) {
|
|
3246
|
-
baseOptions = configuration.baseOptions;
|
|
3247
|
-
}
|
|
3248
|
-
|
|
3249
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3250
|
-
const localVarHeaderParameter = {} as any;
|
|
3251
|
-
const localVarQueryParameter = {} as any;
|
|
3252
|
-
|
|
3253
|
-
// authentication session-oauth required
|
|
3254
|
-
// oauth required
|
|
3255
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3256
|
-
|
|
3257
|
-
// authentication api-key required
|
|
3258
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3259
|
-
|
|
3260
|
-
if (project !== undefined) {
|
|
3261
|
-
localVarQueryParameter['project'] = project;
|
|
3262
|
-
}
|
|
3263
|
-
|
|
3264
|
-
|
|
3265
|
-
|
|
3266
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3267
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3268
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3269
|
-
|
|
3270
|
-
return {
|
|
3271
|
-
url: toPathString(localVarUrlObj),
|
|
3272
|
-
options: localVarRequestOptions,
|
|
3273
|
-
};
|
|
3274
|
-
},
|
|
3275
|
-
/**
|
|
3276
|
-
* List available fulfillers for a given fulfillment
|
|
3277
|
-
* @summary List available fulfillers
|
|
3278
|
-
* @param {string} project Project unique identifier
|
|
3279
|
-
* @param {string} platformId The platform identifier
|
|
3280
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3281
|
-
* @param {*} [options] Override http request option.
|
|
3282
|
-
* @throws {RequiredError}
|
|
3283
|
-
*/
|
|
3284
|
-
listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3285
|
-
// verify required parameter 'project' is not null or undefined
|
|
3286
|
-
assertParamExists('listAvailableFulfillers', 'project', project)
|
|
3287
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3288
|
-
assertParamExists('listAvailableFulfillers', 'platformId', platformId)
|
|
3289
|
-
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
3290
|
-
assertParamExists('listAvailableFulfillers', 'fulfillmentId', fulfillmentId)
|
|
3291
|
-
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers`
|
|
3292
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3293
|
-
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
3294
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3295
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3296
|
-
let baseOptions;
|
|
3297
|
-
if (configuration) {
|
|
3298
|
-
baseOptions = configuration.baseOptions;
|
|
3299
|
-
}
|
|
3300
|
-
|
|
3301
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3302
|
-
const localVarHeaderParameter = {} as any;
|
|
3303
|
-
const localVarQueryParameter = {} as any;
|
|
3304
|
-
|
|
3305
|
-
// authentication session-oauth required
|
|
3306
|
-
// oauth required
|
|
3307
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3308
|
-
|
|
3309
|
-
// authentication api-key required
|
|
3310
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3311
|
-
|
|
3312
|
-
if (project !== undefined) {
|
|
3313
|
-
localVarQueryParameter['project'] = project;
|
|
3314
|
-
}
|
|
3315
|
-
|
|
3316
|
-
|
|
3317
|
-
|
|
3318
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3319
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3320
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3321
|
-
|
|
3322
|
-
return {
|
|
3323
|
-
url: toPathString(localVarUrlObj),
|
|
3324
|
-
options: localVarRequestOptions,
|
|
3325
|
-
};
|
|
3326
|
-
},
|
|
3327
|
-
/**
|
|
3328
|
-
* List customers for a platform
|
|
3329
|
-
* @summary List customers
|
|
3330
|
-
* @param {string} project Project unique identifier
|
|
3331
|
-
* @param {string} platformId The platform identifier
|
|
3332
|
-
* @param {number} [pageToken] Page reference token
|
|
3333
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3334
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3335
|
-
* @param {*} [options] Override http request option.
|
|
3336
|
-
* @throws {RequiredError}
|
|
3337
|
-
*/
|
|
3338
|
-
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3339
|
-
// verify required parameter 'project' is not null or undefined
|
|
3340
|
-
assertParamExists('listCustomers', 'project', project)
|
|
3341
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3342
|
-
assertParamExists('listCustomers', 'platformId', platformId)
|
|
3343
|
-
const localVarPath = `/v1/platform/{platformId}/customers`
|
|
3344
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3345
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3346
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3347
|
-
let baseOptions;
|
|
3348
|
-
if (configuration) {
|
|
3349
|
-
baseOptions = configuration.baseOptions;
|
|
3350
|
-
}
|
|
3351
|
-
|
|
3352
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3353
|
-
const localVarHeaderParameter = {} as any;
|
|
3354
|
-
const localVarQueryParameter = {} as any;
|
|
3355
|
-
|
|
3356
|
-
// authentication session-oauth required
|
|
3357
|
-
// oauth required
|
|
3358
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3359
|
-
|
|
3360
|
-
// authentication api-key required
|
|
3361
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3362
|
-
|
|
3363
|
-
if (project !== undefined) {
|
|
3364
|
-
localVarQueryParameter['project'] = project;
|
|
3365
|
-
}
|
|
3366
|
-
|
|
3367
|
-
if (pageToken !== undefined) {
|
|
3368
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
3369
|
-
}
|
|
3370
|
-
|
|
3371
|
-
if (pageSize !== undefined) {
|
|
3372
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
3373
|
-
}
|
|
3374
|
-
|
|
3375
|
-
if (search !== undefined) {
|
|
3376
|
-
localVarQueryParameter['search'] = search;
|
|
3377
|
-
}
|
|
3378
|
-
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3382
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3383
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3384
|
-
|
|
3385
|
-
return {
|
|
3386
|
-
url: toPathString(localVarUrlObj),
|
|
3387
|
-
options: localVarRequestOptions,
|
|
3388
|
-
};
|
|
3389
|
-
},
|
|
3390
|
-
/**
|
|
3391
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3392
|
-
* @summary List orders
|
|
3393
|
-
* @param {string} project Project unique identifier
|
|
3394
|
-
* @param {string} platformId The platform identifier
|
|
3395
|
-
* @param {number} [pageToken] Page reference token
|
|
3396
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3397
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3398
|
-
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
3399
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
3400
|
-
* @param {*} [options] Override http request option.
|
|
3401
|
-
* @throws {RequiredError}
|
|
3402
|
-
*/
|
|
3403
|
-
listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3404
|
-
// verify required parameter 'project' is not null or undefined
|
|
3405
|
-
assertParamExists('listOrders', 'project', project)
|
|
3406
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3407
|
-
assertParamExists('listOrders', 'platformId', platformId)
|
|
3408
|
-
const localVarPath = `/v1/platform/{platformId}/orders`
|
|
3409
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3410
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3411
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3412
|
-
let baseOptions;
|
|
3413
|
-
if (configuration) {
|
|
3414
|
-
baseOptions = configuration.baseOptions;
|
|
3415
|
-
}
|
|
3416
|
-
|
|
3417
|
-
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3418
|
-
const localVarHeaderParameter = {} as any;
|
|
3419
|
-
const localVarQueryParameter = {} as any;
|
|
3420
|
-
|
|
3421
|
-
// authentication session-oauth required
|
|
3422
|
-
// oauth required
|
|
3423
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3424
|
-
|
|
3425
|
-
// authentication api-key required
|
|
3426
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3427
|
-
|
|
3428
|
-
if (project !== undefined) {
|
|
3429
|
-
localVarQueryParameter['project'] = project;
|
|
3430
|
-
}
|
|
3431
|
-
|
|
3432
|
-
if (pageToken !== undefined) {
|
|
3433
|
-
localVarQueryParameter['pageToken'] = pageToken;
|
|
3434
|
-
}
|
|
3435
|
-
|
|
3436
|
-
if (pageSize !== undefined) {
|
|
3437
|
-
localVarQueryParameter['pageSize'] = pageSize;
|
|
3438
|
-
}
|
|
3439
|
-
|
|
3440
|
-
if (search !== undefined) {
|
|
3441
|
-
localVarQueryParameter['search'] = search;
|
|
3442
|
-
}
|
|
3443
|
-
|
|
3444
|
-
if (start !== undefined) {
|
|
3445
|
-
localVarQueryParameter['start'] = (start as any instanceof Date) ?
|
|
3446
|
-
(start as any).toISOString() :
|
|
3447
|
-
start;
|
|
3448
|
-
}
|
|
3449
|
-
|
|
3450
|
-
if (end !== undefined) {
|
|
3451
|
-
localVarQueryParameter['end'] = (end as any instanceof Date) ?
|
|
3452
|
-
(end as any).toISOString() :
|
|
3453
|
-
end;
|
|
3454
|
-
}
|
|
3455
|
-
|
|
3456
|
-
|
|
3457
|
-
|
|
3458
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3459
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3460
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3461
|
-
|
|
3462
|
-
return {
|
|
3463
|
-
url: toPathString(localVarUrlObj),
|
|
3464
|
-
options: localVarRequestOptions,
|
|
3465
|
-
};
|
|
3466
|
-
},
|
|
3467
|
-
/**
|
|
3468
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
3469
|
-
* @summary Update fulfillment
|
|
3470
|
-
* @param {string} project Project unique identifier
|
|
3471
|
-
* @param {string} platformId The platform identifier
|
|
3472
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3473
|
-
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
3474
|
-
* @param {*} [options] Override http request option.
|
|
3475
|
-
* @throws {RequiredError}
|
|
3476
|
-
*/
|
|
3477
|
-
updateFulfillment: async (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3478
|
-
// verify required parameter 'project' is not null or undefined
|
|
3479
|
-
assertParamExists('updateFulfillment', 'project', project)
|
|
3480
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3481
|
-
assertParamExists('updateFulfillment', 'platformId', platformId)
|
|
3482
|
-
// verify required parameter 'fulfillmentId' is not null or undefined
|
|
3483
|
-
assertParamExists('updateFulfillment', 'fulfillmentId', fulfillmentId)
|
|
3484
|
-
// verify required parameter 'updateFulfillmentRequest' is not null or undefined
|
|
3485
|
-
assertParamExists('updateFulfillment', 'updateFulfillmentRequest', updateFulfillmentRequest)
|
|
3486
|
-
const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
|
|
3487
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3488
|
-
.replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
|
|
3489
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3490
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3491
|
-
let baseOptions;
|
|
3492
|
-
if (configuration) {
|
|
3493
|
-
baseOptions = configuration.baseOptions;
|
|
3494
|
-
}
|
|
3495
|
-
|
|
3496
|
-
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3497
|
-
const localVarHeaderParameter = {} as any;
|
|
3498
|
-
const localVarQueryParameter = {} as any;
|
|
3499
|
-
|
|
3500
|
-
// authentication session-oauth required
|
|
3501
|
-
// oauth required
|
|
3502
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3503
|
-
|
|
3504
|
-
// authentication api-key required
|
|
3505
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3506
|
-
|
|
3507
|
-
if (project !== undefined) {
|
|
3508
|
-
localVarQueryParameter['project'] = project;
|
|
3509
|
-
}
|
|
3510
|
-
|
|
3511
|
-
|
|
3512
|
-
|
|
3513
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3514
|
-
|
|
3515
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3516
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3517
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3518
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateFulfillmentRequest, localVarRequestOptions, configuration)
|
|
3519
|
-
|
|
3520
|
-
return {
|
|
3521
|
-
url: toPathString(localVarUrlObj),
|
|
3522
|
-
options: localVarRequestOptions,
|
|
3523
|
-
};
|
|
3524
|
-
},
|
|
3525
|
-
/**
|
|
3526
|
-
*
|
|
3527
|
-
* @summary Update platform
|
|
3528
|
-
* @param {string} project Project unique identifier
|
|
3529
|
-
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
3530
|
-
* @param {*} [options] Override http request option.
|
|
3531
|
-
* @throws {RequiredError}
|
|
3532
|
-
*/
|
|
3533
|
-
updatePlatform: async (project: string, updatePlatformRequest: UpdatePlatformRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3534
|
-
// verify required parameter 'project' is not null or undefined
|
|
3535
|
-
assertParamExists('updatePlatform', 'project', project)
|
|
3536
|
-
// verify required parameter 'updatePlatformRequest' is not null or undefined
|
|
3537
|
-
assertParamExists('updatePlatform', 'updatePlatformRequest', updatePlatformRequest)
|
|
3538
|
-
const localVarPath = `/v1/platform`;
|
|
3539
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3540
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3541
|
-
let baseOptions;
|
|
3542
|
-
if (configuration) {
|
|
3543
|
-
baseOptions = configuration.baseOptions;
|
|
3544
|
-
}
|
|
3545
|
-
|
|
3546
|
-
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3547
|
-
const localVarHeaderParameter = {} as any;
|
|
3548
|
-
const localVarQueryParameter = {} as any;
|
|
3549
|
-
|
|
3550
|
-
// authentication session-oauth required
|
|
3551
|
-
// oauth required
|
|
3552
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3553
|
-
|
|
3554
|
-
// authentication api-key required
|
|
3555
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3556
|
-
|
|
3557
|
-
if (project !== undefined) {
|
|
3558
|
-
localVarQueryParameter['project'] = project;
|
|
3559
|
-
}
|
|
3560
|
-
|
|
3561
|
-
|
|
3562
|
-
|
|
3563
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3564
|
-
|
|
3565
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3566
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3567
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3568
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformRequest, localVarRequestOptions, configuration)
|
|
3569
|
-
|
|
3570
|
-
return {
|
|
3571
|
-
url: toPathString(localVarUrlObj),
|
|
3572
|
-
options: localVarRequestOptions,
|
|
3573
|
-
};
|
|
3574
|
-
},
|
|
3575
|
-
/**
|
|
3576
|
-
* Updates the warehouse product and its variants
|
|
3577
|
-
* @summary Update warehouse product
|
|
3578
|
-
* @param {string} project Project unique identifier
|
|
3579
|
-
* @param {string} platformId The platform identifier
|
|
3580
|
-
* @param {string} productId Products unique identifier
|
|
3581
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
3582
|
-
* @param {*} [options] Override http request option.
|
|
3583
|
-
* @throws {RequiredError}
|
|
3584
|
-
*/
|
|
3585
|
-
updateProduct: async (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3586
|
-
// verify required parameter 'project' is not null or undefined
|
|
3587
|
-
assertParamExists('updateProduct', 'project', project)
|
|
3588
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3589
|
-
assertParamExists('updateProduct', 'platformId', platformId)
|
|
3590
|
-
// verify required parameter 'productId' is not null or undefined
|
|
3591
|
-
assertParamExists('updateProduct', 'productId', productId)
|
|
3592
|
-
// verify required parameter 'updateProductRequest' is not null or undefined
|
|
3593
|
-
assertParamExists('updateProduct', 'updateProductRequest', updateProductRequest)
|
|
3594
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
|
|
3595
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3596
|
-
.replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
|
|
3597
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3598
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3599
|
-
let baseOptions;
|
|
3600
|
-
if (configuration) {
|
|
3601
|
-
baseOptions = configuration.baseOptions;
|
|
3602
|
-
}
|
|
3603
|
-
|
|
3604
|
-
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3605
|
-
const localVarHeaderParameter = {} as any;
|
|
3606
|
-
const localVarQueryParameter = {} as any;
|
|
3607
|
-
|
|
3608
|
-
// authentication session-oauth required
|
|
3609
|
-
// oauth required
|
|
3610
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3611
|
-
|
|
3612
|
-
// authentication api-key required
|
|
3613
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3614
|
-
|
|
3615
|
-
if (project !== undefined) {
|
|
3616
|
-
localVarQueryParameter['project'] = project;
|
|
3617
|
-
}
|
|
3618
|
-
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3622
|
-
|
|
3623
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3624
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3625
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3626
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
|
|
3627
|
-
|
|
3628
|
-
return {
|
|
3629
|
-
url: toPathString(localVarUrlObj),
|
|
3630
|
-
options: localVarRequestOptions,
|
|
3631
|
-
};
|
|
3632
|
-
},
|
|
3633
|
-
/**
|
|
3634
|
-
* Updates the warehouse variant
|
|
3635
|
-
* @summary Update warehouse variant
|
|
3636
|
-
* @param {string} project Project unique identifier
|
|
3637
|
-
* @param {string} platformId The platform identifier
|
|
3638
|
-
* @param {string} variantId Variants unique identifier
|
|
3639
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
3640
|
-
* @param {*} [options] Override http request option.
|
|
3641
|
-
* @throws {RequiredError}
|
|
3642
|
-
*/
|
|
3643
|
-
updateVariant: async (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3644
|
-
// verify required parameter 'project' is not null or undefined
|
|
3645
|
-
assertParamExists('updateVariant', 'project', project)
|
|
3646
|
-
// verify required parameter 'platformId' is not null or undefined
|
|
3647
|
-
assertParamExists('updateVariant', 'platformId', platformId)
|
|
3648
|
-
// verify required parameter 'variantId' is not null or undefined
|
|
3649
|
-
assertParamExists('updateVariant', 'variantId', variantId)
|
|
3650
|
-
// verify required parameter 'updateVariantRequest' is not null or undefined
|
|
3651
|
-
assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest)
|
|
3652
|
-
const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
|
|
3653
|
-
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3654
|
-
.replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
|
|
3655
|
-
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3656
|
-
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3657
|
-
let baseOptions;
|
|
3658
|
-
if (configuration) {
|
|
3659
|
-
baseOptions = configuration.baseOptions;
|
|
3660
|
-
}
|
|
3661
|
-
|
|
3662
|
-
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
3663
|
-
const localVarHeaderParameter = {} as any;
|
|
3664
|
-
const localVarQueryParameter = {} as any;
|
|
3665
|
-
|
|
3666
|
-
// authentication session-oauth required
|
|
3667
|
-
// oauth required
|
|
3668
|
-
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3669
|
-
|
|
3670
|
-
// authentication api-key required
|
|
3671
|
-
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3672
|
-
|
|
3673
|
-
if (project !== undefined) {
|
|
3674
|
-
localVarQueryParameter['project'] = project;
|
|
3675
|
-
}
|
|
3676
|
-
|
|
3677
|
-
|
|
3678
|
-
|
|
3679
|
-
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
3680
|
-
|
|
3681
|
-
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3682
|
-
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3683
|
-
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3684
|
-
localVarRequestOptions.data = serializeDataIfNeeded(updateVariantRequest, localVarRequestOptions, configuration)
|
|
3685
|
-
|
|
3686
|
-
return {
|
|
3687
|
-
url: toPathString(localVarUrlObj),
|
|
3688
|
-
options: localVarRequestOptions,
|
|
3689
|
-
};
|
|
3690
|
-
},
|
|
3691
|
-
}
|
|
3692
|
-
};
|
|
3693
|
-
|
|
3694
|
-
/**
|
|
3695
|
-
* PlatformApi - functional programming interface
|
|
3696
|
-
* @export
|
|
3697
|
-
*/
|
|
3698
|
-
export const PlatformApiFp = function(configuration?: Configuration) {
|
|
3699
|
-
const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
|
|
3700
|
-
return {
|
|
3701
|
-
/**
|
|
3702
|
-
* Export customers as a CSV file
|
|
3703
|
-
* @summary Export customers
|
|
3704
|
-
* @param {string} project Project unique identifier
|
|
3705
|
-
* @param {string} platformId The platform identifier
|
|
3706
|
-
* @param {*} [options] Override http request option.
|
|
3707
|
-
* @throws {RequiredError}
|
|
3708
|
-
*/
|
|
3709
|
-
async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3710
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
3711
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3712
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
3713
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3714
|
-
},
|
|
3715
|
-
/**
|
|
3716
|
-
* Export orders as a CSV file
|
|
3717
|
-
* @summary Export orders
|
|
3718
|
-
* @param {string} project Project unique identifier
|
|
3719
|
-
* @param {string} platformId The platform identifier
|
|
3720
|
-
* @param {string} start Start of date range to filter by when orders were placed
|
|
3721
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
3722
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3723
|
-
* @param {*} [options] Override http request option.
|
|
3724
|
-
* @throws {RequiredError}
|
|
3725
|
-
*/
|
|
3726
|
-
async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3727
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
|
|
3728
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3729
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
3730
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3731
|
-
},
|
|
3732
|
-
/**
|
|
3733
|
-
* Get a customer for a platform by a given customer ID.
|
|
3734
|
-
* @summary Get customer
|
|
3735
|
-
* @param {string} project Project unique identifier
|
|
3736
|
-
* @param {string} platformId The platform identifier
|
|
3737
|
-
* @param {string} customerId The customer identifier
|
|
3738
|
-
* @param {*} [options] Override http request option.
|
|
3739
|
-
* @throws {RequiredError}
|
|
3740
|
-
*/
|
|
3741
|
-
async getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
|
|
3742
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
|
|
3743
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3744
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
3745
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3746
|
-
},
|
|
3747
|
-
/**
|
|
3748
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3749
|
-
* @summary Get fulfillment
|
|
3750
|
-
* @param {string} project Project unique identifier
|
|
3751
|
-
* @param {string} platformId The platform identifier
|
|
3752
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3753
|
-
* @param {*} [options] Override http request option.
|
|
3754
|
-
* @throws {RequiredError}
|
|
3755
|
-
*/
|
|
3756
|
-
async getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
3757
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getFulfillment(project, platformId, fulfillmentId, options);
|
|
3758
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3759
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
3760
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3761
|
-
},
|
|
3762
|
-
/**
|
|
3763
|
-
* Get an order for a platform by a given order ID.
|
|
3764
|
-
* @summary Get order
|
|
3765
|
-
* @param {string} project Project unique identifier
|
|
3766
|
-
* @param {string} platformId The platform identifier
|
|
3767
|
-
* @param {string} orderId The order identifier
|
|
3768
|
-
* @param {*} [options] Override http request option.
|
|
3769
|
-
* @throws {RequiredError}
|
|
3770
|
-
*/
|
|
3771
|
-
async getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
|
|
3772
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(project, platformId, orderId, options);
|
|
3773
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3774
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getOrder']?.[localVarOperationServerIndex]?.url;
|
|
3775
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3776
|
-
},
|
|
3777
|
-
/**
|
|
3778
|
-
*
|
|
3779
|
-
* @summary Get platform details
|
|
3780
|
-
* @param {string} project Project unique identifier
|
|
3781
|
-
* @param {*} [options] Override http request option.
|
|
3782
|
-
* @throws {RequiredError}
|
|
3783
|
-
*/
|
|
3784
|
-
async getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
|
|
3785
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getPlatform(project, options);
|
|
3786
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3787
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
|
|
3788
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3789
|
-
},
|
|
3790
|
-
/**
|
|
3791
|
-
* List available fulfillers for a given fulfillment
|
|
3792
|
-
* @summary List available fulfillers
|
|
3793
|
-
* @param {string} project Project unique identifier
|
|
3794
|
-
* @param {string} platformId The platform identifier
|
|
3795
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3796
|
-
* @param {*} [options] Override http request option.
|
|
3797
|
-
* @throws {RequiredError}
|
|
3798
|
-
*/
|
|
3799
|
-
async listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>> {
|
|
3800
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableFulfillers(project, platformId, fulfillmentId, options);
|
|
3801
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3802
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listAvailableFulfillers']?.[localVarOperationServerIndex]?.url;
|
|
3803
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3804
|
-
},
|
|
3805
|
-
/**
|
|
3806
|
-
* List customers for a platform
|
|
3807
|
-
* @summary List customers
|
|
3808
|
-
* @param {string} project Project unique identifier
|
|
3809
|
-
* @param {string} platformId The platform identifier
|
|
3810
|
-
* @param {number} [pageToken] Page reference token
|
|
3811
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3812
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3813
|
-
* @param {*} [options] Override http request option.
|
|
3814
|
-
* @throws {RequiredError}
|
|
3815
|
-
*/
|
|
3816
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
3817
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
|
|
3818
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3819
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
3820
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3821
|
-
},
|
|
3822
|
-
/**
|
|
3823
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3824
|
-
* @summary List orders
|
|
3825
|
-
* @param {string} project Project unique identifier
|
|
3826
|
-
* @param {string} platformId The platform identifier
|
|
3827
|
-
* @param {number} [pageToken] Page reference token
|
|
3828
|
-
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3829
|
-
* @param {string} [search] Search term to filter based on order reference, customer name and email
|
|
3830
|
-
* @param {string} [start] Start of date range to filter by when orders were placed
|
|
3831
|
-
* @param {string} [end] End of date range to filter by when orders were placed
|
|
3832
|
-
* @param {*} [options] Override http request option.
|
|
3833
|
-
* @throws {RequiredError}
|
|
3834
|
-
*/
|
|
3835
|
-
async listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>> {
|
|
3836
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
|
|
3837
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3838
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listOrders']?.[localVarOperationServerIndex]?.url;
|
|
3839
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3840
|
-
},
|
|
3841
|
-
/**
|
|
3842
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
3843
|
-
* @summary Update fulfillment
|
|
3844
|
-
* @param {string} project Project unique identifier
|
|
3845
|
-
* @param {string} platformId The platform identifier
|
|
3846
|
-
* @param {string} fulfillmentId The fulfillment identifier
|
|
3847
|
-
* @param {UpdateFulfillmentRequest} updateFulfillmentRequest
|
|
3848
|
-
* @param {*} [options] Override http request option.
|
|
3849
|
-
* @throws {RequiredError}
|
|
3850
|
-
*/
|
|
3851
|
-
async updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
|
|
3852
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateFulfillment(project, platformId, fulfillmentId, updateFulfillmentRequest, options);
|
|
3853
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3854
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateFulfillment']?.[localVarOperationServerIndex]?.url;
|
|
3855
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3856
|
-
},
|
|
3857
|
-
/**
|
|
3858
|
-
*
|
|
3859
|
-
* @summary Update platform
|
|
3860
|
-
* @param {string} project Project unique identifier
|
|
3861
|
-
* @param {UpdatePlatformRequest} updatePlatformRequest
|
|
3862
|
-
* @param {*} [options] Override http request option.
|
|
3863
|
-
* @throws {RequiredError}
|
|
3864
|
-
*/
|
|
3865
|
-
async updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
|
|
3866
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlatform(project, updatePlatformRequest, options);
|
|
3867
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3868
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updatePlatform']?.[localVarOperationServerIndex]?.url;
|
|
3869
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3870
|
-
},
|
|
3871
|
-
/**
|
|
3872
|
-
* Updates the warehouse product and its variants
|
|
3873
|
-
* @summary Update warehouse product
|
|
3874
|
-
* @param {string} project Project unique identifier
|
|
3875
|
-
* @param {string} platformId The platform identifier
|
|
3876
|
-
* @param {string} productId Products unique identifier
|
|
3877
|
-
* @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
|
|
3878
|
-
* @param {*} [options] Override http request option.
|
|
3879
|
-
* @throws {RequiredError}
|
|
3880
|
-
*/
|
|
3881
|
-
async updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
|
|
3882
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateProduct(project, platformId, productId, updateProductRequest, options);
|
|
3883
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3884
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateProduct']?.[localVarOperationServerIndex]?.url;
|
|
3885
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3886
|
-
},
|
|
3887
|
-
/**
|
|
3888
|
-
* Updates the warehouse variant
|
|
3889
|
-
* @summary Update warehouse variant
|
|
3890
|
-
* @param {string} project Project unique identifier
|
|
3891
|
-
* @param {string} platformId The platform identifier
|
|
3892
|
-
* @param {string} variantId Variants unique identifier
|
|
3893
|
-
* @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
|
|
3894
|
-
* @param {*} [options] Override http request option.
|
|
3895
|
-
* @throws {RequiredError}
|
|
3896
|
-
*/
|
|
3897
|
-
async updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>> {
|
|
3898
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVariant(project, platformId, variantId, updateVariantRequest, options);
|
|
3899
|
-
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3900
|
-
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateVariant']?.[localVarOperationServerIndex]?.url;
|
|
3901
|
-
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3902
|
-
},
|
|
3903
|
-
}
|
|
3904
|
-
};
|
|
3905
|
-
|
|
3906
|
-
/**
|
|
3907
|
-
* PlatformApi - factory interface
|
|
3908
|
-
* @export
|
|
3909
|
-
*/
|
|
3910
|
-
export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3911
|
-
const localVarFp = PlatformApiFp(configuration)
|
|
3912
|
-
return {
|
|
3913
|
-
/**
|
|
3914
|
-
* Export customers as a CSV file
|
|
3915
|
-
* @summary Export customers
|
|
3916
|
-
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
3917
|
-
* @param {*} [options] Override http request option.
|
|
3918
|
-
* @throws {RequiredError}
|
|
3919
|
-
*/
|
|
3920
|
-
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3921
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
3922
|
-
},
|
|
3923
|
-
/**
|
|
3924
|
-
* Export orders as a CSV file
|
|
3925
|
-
* @summary Export orders
|
|
3926
|
-
* @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
|
|
3927
|
-
* @param {*} [options] Override http request option.
|
|
3928
|
-
* @throws {RequiredError}
|
|
3929
|
-
*/
|
|
3930
|
-
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3931
|
-
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3932
|
-
},
|
|
3933
|
-
/**
|
|
3934
|
-
* Get a customer for a platform by a given customer ID.
|
|
3935
|
-
* @summary Get customer
|
|
3936
|
-
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
3937
|
-
* @param {*} [options] Override http request option.
|
|
3938
|
-
* @throws {RequiredError}
|
|
3939
|
-
*/
|
|
3940
|
-
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
3941
|
-
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
3942
|
-
},
|
|
3943
|
-
/**
|
|
3944
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3945
|
-
* @summary Get fulfillment
|
|
3946
|
-
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
3947
|
-
* @param {*} [options] Override http request option.
|
|
3948
|
-
* @throws {RequiredError}
|
|
3949
|
-
*/
|
|
3950
|
-
getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
3951
|
-
return localVarFp.getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
3952
|
-
},
|
|
3953
|
-
/**
|
|
3954
|
-
* Get an order for a platform by a given order ID.
|
|
3955
|
-
* @summary Get order
|
|
3956
|
-
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
3957
|
-
* @param {*} [options] Override http request option.
|
|
3958
|
-
* @throws {RequiredError}
|
|
3959
|
-
*/
|
|
3960
|
-
getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
|
|
3961
|
-
return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
|
|
3962
|
-
},
|
|
3963
|
-
/**
|
|
3964
|
-
*
|
|
3965
|
-
* @summary Get platform details
|
|
3966
|
-
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
3967
|
-
* @param {*} [options] Override http request option.
|
|
3968
|
-
* @throws {RequiredError}
|
|
3969
|
-
*/
|
|
3970
|
-
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
|
|
3971
|
-
return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3972
|
-
},
|
|
3973
|
-
/**
|
|
3974
|
-
* List available fulfillers for a given fulfillment
|
|
3975
|
-
* @summary List available fulfillers
|
|
3976
|
-
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
3977
|
-
* @param {*} [options] Override http request option.
|
|
3978
|
-
* @throws {RequiredError}
|
|
3979
|
-
*/
|
|
3980
|
-
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse> {
|
|
3981
|
-
return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
3982
|
-
},
|
|
3983
|
-
/**
|
|
3984
|
-
* List customers for a platform
|
|
3985
|
-
* @summary List customers
|
|
3986
|
-
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
3987
|
-
* @param {*} [options] Override http request option.
|
|
3988
|
-
* @throws {RequiredError}
|
|
3989
|
-
*/
|
|
3990
|
-
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
3991
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3992
|
-
},
|
|
3993
|
-
/**
|
|
3994
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3995
|
-
* @summary List orders
|
|
3996
|
-
* @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
|
|
3997
|
-
* @param {*} [options] Override http request option.
|
|
3998
|
-
* @throws {RequiredError}
|
|
3999
|
-
*/
|
|
4000
|
-
listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
|
|
4001
|
-
return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
|
|
4002
|
-
},
|
|
4003
|
-
/**
|
|
4004
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
4005
|
-
* @summary Update fulfillment
|
|
4006
|
-
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
4007
|
-
* @param {*} [options] Override http request option.
|
|
4008
|
-
* @throws {RequiredError}
|
|
4009
|
-
*/
|
|
4010
|
-
updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
|
|
4011
|
-
return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
|
|
4012
|
-
},
|
|
4013
|
-
/**
|
|
4014
|
-
*
|
|
4015
|
-
* @summary Update platform
|
|
4016
|
-
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
4017
|
-
* @param {*} [options] Override http request option.
|
|
4018
|
-
* @throws {RequiredError}
|
|
4019
|
-
*/
|
|
4020
|
-
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
|
|
4021
|
-
return localVarFp.updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(axios, basePath));
|
|
4022
|
-
},
|
|
4023
|
-
/**
|
|
4024
|
-
* Updates the warehouse product and its variants
|
|
4025
|
-
* @summary Update warehouse product
|
|
4026
|
-
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
4027
|
-
* @param {*} [options] Override http request option.
|
|
4028
|
-
* @throws {RequiredError}
|
|
4029
|
-
*/
|
|
4030
|
-
updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
|
|
4031
|
-
return localVarFp.updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
|
|
4032
|
-
},
|
|
4033
|
-
/**
|
|
4034
|
-
* Updates the warehouse variant
|
|
4035
|
-
* @summary Update warehouse variant
|
|
4036
|
-
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
4037
|
-
* @param {*} [options] Override http request option.
|
|
4038
|
-
* @throws {RequiredError}
|
|
4039
|
-
*/
|
|
4040
|
-
updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
|
|
4041
|
-
return localVarFp.updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(axios, basePath));
|
|
4042
|
-
},
|
|
4043
|
-
};
|
|
4044
|
-
};
|
|
4045
|
-
|
|
4046
|
-
/**
|
|
4047
|
-
* Request parameters for exportCustomers operation in PlatformApi.
|
|
4048
|
-
* @export
|
|
4049
|
-
* @interface PlatformApiExportCustomersRequest
|
|
4050
|
-
*/
|
|
4051
|
-
export interface PlatformApiExportCustomersRequest {
|
|
4052
|
-
/**
|
|
4053
|
-
* Project unique identifier
|
|
4054
|
-
* @type {string}
|
|
4055
|
-
* @memberof PlatformApiExportCustomers
|
|
4056
|
-
*/
|
|
4057
|
-
readonly project: string
|
|
4058
|
-
|
|
4059
|
-
/**
|
|
4060
|
-
* The platform identifier
|
|
4061
|
-
* @type {string}
|
|
4062
|
-
* @memberof PlatformApiExportCustomers
|
|
4063
|
-
*/
|
|
4064
|
-
readonly platformId: string
|
|
4065
|
-
}
|
|
4066
|
-
|
|
4067
|
-
/**
|
|
4068
|
-
* Request parameters for exportOrders operation in PlatformApi.
|
|
4069
|
-
* @export
|
|
4070
|
-
* @interface PlatformApiExportOrdersRequest
|
|
4071
|
-
*/
|
|
4072
|
-
export interface PlatformApiExportOrdersRequest {
|
|
4073
|
-
/**
|
|
4074
|
-
* Project unique identifier
|
|
4075
|
-
* @type {string}
|
|
4076
|
-
* @memberof PlatformApiExportOrders
|
|
4077
|
-
*/
|
|
4078
|
-
readonly project: string
|
|
4079
|
-
|
|
4080
|
-
/**
|
|
4081
|
-
* The platform identifier
|
|
4082
|
-
* @type {string}
|
|
4083
|
-
* @memberof PlatformApiExportOrders
|
|
4084
|
-
*/
|
|
4085
|
-
readonly platformId: string
|
|
4086
|
-
|
|
4087
|
-
/**
|
|
4088
|
-
* Start of date range to filter by when orders were placed
|
|
4089
|
-
* @type {string}
|
|
4090
|
-
* @memberof PlatformApiExportOrders
|
|
4091
|
-
*/
|
|
4092
|
-
readonly start: string
|
|
4093
|
-
|
|
4094
|
-
/**
|
|
4095
|
-
* End of date range to filter by when orders were placed
|
|
4096
|
-
* @type {string}
|
|
4097
|
-
* @memberof PlatformApiExportOrders
|
|
4098
|
-
*/
|
|
4099
|
-
readonly end?: string
|
|
4100
|
-
|
|
4101
|
-
/**
|
|
4102
|
-
* Search term to filter based on order reference, customer name and email
|
|
4103
|
-
* @type {string}
|
|
4104
|
-
* @memberof PlatformApiExportOrders
|
|
4105
|
-
*/
|
|
4106
|
-
readonly search?: string
|
|
4107
|
-
}
|
|
4108
|
-
|
|
4109
|
-
/**
|
|
4110
|
-
* Request parameters for getCustomer operation in PlatformApi.
|
|
4111
|
-
* @export
|
|
4112
|
-
* @interface PlatformApiGetCustomerRequest
|
|
4113
|
-
*/
|
|
4114
|
-
export interface PlatformApiGetCustomerRequest {
|
|
4115
|
-
/**
|
|
4116
|
-
* Project unique identifier
|
|
4117
|
-
* @type {string}
|
|
4118
|
-
* @memberof PlatformApiGetCustomer
|
|
4119
|
-
*/
|
|
4120
|
-
readonly project: string
|
|
4121
|
-
|
|
4122
|
-
/**
|
|
4123
|
-
* The platform identifier
|
|
4124
|
-
* @type {string}
|
|
4125
|
-
* @memberof PlatformApiGetCustomer
|
|
4126
|
-
*/
|
|
4127
|
-
readonly platformId: string
|
|
4128
|
-
|
|
4129
|
-
/**
|
|
4130
|
-
* The customer identifier
|
|
4131
|
-
* @type {string}
|
|
4132
|
-
* @memberof PlatformApiGetCustomer
|
|
4133
|
-
*/
|
|
4134
|
-
readonly customerId: string
|
|
4135
|
-
}
|
|
4136
|
-
|
|
4137
|
-
/**
|
|
4138
|
-
* Request parameters for getFulfillment operation in PlatformApi.
|
|
4139
|
-
* @export
|
|
4140
|
-
* @interface PlatformApiGetFulfillmentRequest
|
|
4141
|
-
*/
|
|
4142
|
-
export interface PlatformApiGetFulfillmentRequest {
|
|
4143
|
-
/**
|
|
4144
|
-
* Project unique identifier
|
|
4145
|
-
* @type {string}
|
|
4146
|
-
* @memberof PlatformApiGetFulfillment
|
|
4147
|
-
*/
|
|
4148
|
-
readonly project: string
|
|
4149
|
-
|
|
4150
|
-
/**
|
|
4151
|
-
* The platform identifier
|
|
4152
|
-
* @type {string}
|
|
4153
|
-
* @memberof PlatformApiGetFulfillment
|
|
4154
|
-
*/
|
|
4155
|
-
readonly platformId: string
|
|
4156
|
-
|
|
4157
|
-
/**
|
|
4158
|
-
* The fulfillment identifier
|
|
4159
|
-
* @type {string}
|
|
4160
|
-
* @memberof PlatformApiGetFulfillment
|
|
4161
|
-
*/
|
|
4162
|
-
readonly fulfillmentId: string
|
|
4163
|
-
}
|
|
4164
|
-
|
|
4165
|
-
/**
|
|
4166
|
-
* Request parameters for getOrder operation in PlatformApi.
|
|
4167
|
-
* @export
|
|
4168
|
-
* @interface PlatformApiGetOrderRequest
|
|
4169
|
-
*/
|
|
4170
|
-
export interface PlatformApiGetOrderRequest {
|
|
4171
|
-
/**
|
|
4172
|
-
* Project unique identifier
|
|
4173
|
-
* @type {string}
|
|
4174
|
-
* @memberof PlatformApiGetOrder
|
|
4175
|
-
*/
|
|
4176
|
-
readonly project: string
|
|
4177
|
-
|
|
4178
|
-
/**
|
|
4179
|
-
* The platform identifier
|
|
4180
|
-
* @type {string}
|
|
4181
|
-
* @memberof PlatformApiGetOrder
|
|
4182
|
-
*/
|
|
4183
|
-
readonly platformId: string
|
|
4184
|
-
|
|
4185
|
-
/**
|
|
4186
|
-
* The order identifier
|
|
4187
|
-
* @type {string}
|
|
4188
|
-
* @memberof PlatformApiGetOrder
|
|
4189
|
-
*/
|
|
4190
|
-
readonly orderId: string
|
|
4191
|
-
}
|
|
4192
|
-
|
|
4193
|
-
/**
|
|
4194
|
-
* Request parameters for getPlatform operation in PlatformApi.
|
|
4195
|
-
* @export
|
|
4196
|
-
* @interface PlatformApiGetPlatformRequest
|
|
4197
|
-
*/
|
|
4198
|
-
export interface PlatformApiGetPlatformRequest {
|
|
4199
|
-
/**
|
|
4200
|
-
* Project unique identifier
|
|
4201
|
-
* @type {string}
|
|
4202
|
-
* @memberof PlatformApiGetPlatform
|
|
4203
|
-
*/
|
|
4204
|
-
readonly project: string
|
|
4205
|
-
}
|
|
4206
|
-
|
|
4207
|
-
/**
|
|
4208
|
-
* Request parameters for listAvailableFulfillers operation in PlatformApi.
|
|
4209
|
-
* @export
|
|
4210
|
-
* @interface PlatformApiListAvailableFulfillersRequest
|
|
4211
|
-
*/
|
|
4212
|
-
export interface PlatformApiListAvailableFulfillersRequest {
|
|
4213
|
-
/**
|
|
4214
|
-
* Project unique identifier
|
|
4215
|
-
* @type {string}
|
|
4216
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
4217
|
-
*/
|
|
4218
|
-
readonly project: string
|
|
4219
|
-
|
|
4220
|
-
/**
|
|
4221
|
-
* The platform identifier
|
|
4222
|
-
* @type {string}
|
|
4223
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
4224
|
-
*/
|
|
4225
|
-
readonly platformId: string
|
|
4226
|
-
|
|
4227
|
-
/**
|
|
4228
|
-
* The fulfillment identifier
|
|
4229
|
-
* @type {string}
|
|
4230
|
-
* @memberof PlatformApiListAvailableFulfillers
|
|
4231
|
-
*/
|
|
4232
|
-
readonly fulfillmentId: string
|
|
4233
|
-
}
|
|
4234
|
-
|
|
4235
|
-
/**
|
|
4236
|
-
* Request parameters for listCustomers operation in PlatformApi.
|
|
4237
|
-
* @export
|
|
4238
|
-
* @interface PlatformApiListCustomersRequest
|
|
4239
|
-
*/
|
|
4240
|
-
export interface PlatformApiListCustomersRequest {
|
|
4241
|
-
/**
|
|
4242
|
-
* Project unique identifier
|
|
4243
|
-
* @type {string}
|
|
4244
|
-
* @memberof PlatformApiListCustomers
|
|
4245
|
-
*/
|
|
4246
|
-
readonly project: string
|
|
4247
|
-
|
|
4248
|
-
/**
|
|
4249
|
-
* The platform identifier
|
|
4250
|
-
* @type {string}
|
|
4251
|
-
* @memberof PlatformApiListCustomers
|
|
4252
|
-
*/
|
|
4253
|
-
readonly platformId: string
|
|
4254
|
-
|
|
4255
|
-
/**
|
|
4256
|
-
* Page reference token
|
|
4257
|
-
* @type {number}
|
|
4258
|
-
* @memberof PlatformApiListCustomers
|
|
4259
|
-
*/
|
|
4260
|
-
readonly pageToken?: number
|
|
4261
|
-
|
|
4262
|
-
/**
|
|
4263
|
-
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
4264
|
-
* @type {number}
|
|
4265
|
-
* @memberof PlatformApiListCustomers
|
|
4266
|
-
*/
|
|
4267
|
-
readonly pageSize?: number
|
|
4268
|
-
|
|
4269
|
-
/**
|
|
4270
|
-
* Search term to filter based on order reference, customer name and email
|
|
4271
|
-
* @type {string}
|
|
4272
|
-
* @memberof PlatformApiListCustomers
|
|
4273
|
-
*/
|
|
4274
|
-
readonly search?: string
|
|
4275
|
-
}
|
|
3278
|
+
async updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
|
|
3279
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlatform(project, updatePlatformRequest, options);
|
|
3280
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3281
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.updatePlatform']?.[localVarOperationServerIndex]?.url;
|
|
3282
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3283
|
+
},
|
|
3284
|
+
}
|
|
3285
|
+
};
|
|
4276
3286
|
|
|
4277
3287
|
/**
|
|
4278
|
-
*
|
|
3288
|
+
* PlatformApi - factory interface
|
|
4279
3289
|
* @export
|
|
4280
|
-
* @interface PlatformApiListOrdersRequest
|
|
4281
3290
|
*/
|
|
4282
|
-
export
|
|
4283
|
-
|
|
4284
|
-
|
|
4285
|
-
|
|
4286
|
-
|
|
4287
|
-
|
|
4288
|
-
|
|
4289
|
-
|
|
4290
|
-
|
|
4291
|
-
|
|
4292
|
-
|
|
4293
|
-
|
|
4294
|
-
|
|
4295
|
-
|
|
4296
|
-
|
|
4297
|
-
|
|
4298
|
-
|
|
4299
|
-
|
|
4300
|
-
|
|
4301
|
-
|
|
4302
|
-
|
|
4303
|
-
|
|
4304
|
-
|
|
4305
|
-
|
|
4306
|
-
|
|
4307
|
-
* @memberof PlatformApiListOrders
|
|
4308
|
-
*/
|
|
4309
|
-
readonly pageSize?: number
|
|
4310
|
-
|
|
4311
|
-
/**
|
|
4312
|
-
* Search term to filter based on order reference, customer name and email
|
|
4313
|
-
* @type {string}
|
|
4314
|
-
* @memberof PlatformApiListOrders
|
|
4315
|
-
*/
|
|
4316
|
-
readonly search?: string
|
|
4317
|
-
|
|
4318
|
-
/**
|
|
4319
|
-
* Start of date range to filter by when orders were placed
|
|
4320
|
-
* @type {string}
|
|
4321
|
-
* @memberof PlatformApiListOrders
|
|
4322
|
-
*/
|
|
4323
|
-
readonly start?: string
|
|
4324
|
-
|
|
4325
|
-
/**
|
|
4326
|
-
* End of date range to filter by when orders were placed
|
|
4327
|
-
* @type {string}
|
|
4328
|
-
* @memberof PlatformApiListOrders
|
|
4329
|
-
*/
|
|
4330
|
-
readonly end?: string
|
|
4331
|
-
}
|
|
3291
|
+
export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3292
|
+
const localVarFp = PlatformApiFp(configuration)
|
|
3293
|
+
return {
|
|
3294
|
+
/**
|
|
3295
|
+
*
|
|
3296
|
+
* @summary Get platform details
|
|
3297
|
+
* @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
|
|
3298
|
+
* @param {*} [options] Override http request option.
|
|
3299
|
+
* @throws {RequiredError}
|
|
3300
|
+
*/
|
|
3301
|
+
getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
|
|
3302
|
+
return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
3303
|
+
},
|
|
3304
|
+
/**
|
|
3305
|
+
*
|
|
3306
|
+
* @summary Update platform
|
|
3307
|
+
* @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
|
|
3308
|
+
* @param {*} [options] Override http request option.
|
|
3309
|
+
* @throws {RequiredError}
|
|
3310
|
+
*/
|
|
3311
|
+
updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
|
|
3312
|
+
return localVarFp.updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(axios, basePath));
|
|
3313
|
+
},
|
|
3314
|
+
};
|
|
3315
|
+
};
|
|
4332
3316
|
|
|
4333
3317
|
/**
|
|
4334
|
-
* Request parameters for
|
|
3318
|
+
* Request parameters for getPlatform operation in PlatformApi.
|
|
4335
3319
|
* @export
|
|
4336
|
-
* @interface
|
|
3320
|
+
* @interface PlatformApiGetPlatformRequest
|
|
4337
3321
|
*/
|
|
4338
|
-
export interface
|
|
3322
|
+
export interface PlatformApiGetPlatformRequest {
|
|
4339
3323
|
/**
|
|
4340
3324
|
* Project unique identifier
|
|
4341
3325
|
* @type {string}
|
|
4342
|
-
* @memberof
|
|
3326
|
+
* @memberof PlatformApiGetPlatform
|
|
4343
3327
|
*/
|
|
4344
3328
|
readonly project: string
|
|
4345
|
-
|
|
4346
|
-
/**
|
|
4347
|
-
* The platform identifier
|
|
4348
|
-
* @type {string}
|
|
4349
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
4350
|
-
*/
|
|
4351
|
-
readonly platformId: string
|
|
4352
|
-
|
|
4353
|
-
/**
|
|
4354
|
-
* The fulfillment identifier
|
|
4355
|
-
* @type {string}
|
|
4356
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
4357
|
-
*/
|
|
4358
|
-
readonly fulfillmentId: string
|
|
4359
|
-
|
|
4360
|
-
/**
|
|
4361
|
-
*
|
|
4362
|
-
* @type {UpdateFulfillmentRequest}
|
|
4363
|
-
* @memberof PlatformApiUpdateFulfillment
|
|
4364
|
-
*/
|
|
4365
|
-
readonly updateFulfillmentRequest: UpdateFulfillmentRequest
|
|
4366
3329
|
}
|
|
4367
3330
|
|
|
4368
3331
|
/**
|
|
@@ -4386,76 +3349,6 @@ export interface PlatformApiUpdatePlatformRequest {
|
|
|
4386
3349
|
readonly updatePlatformRequest: UpdatePlatformRequest
|
|
4387
3350
|
}
|
|
4388
3351
|
|
|
4389
|
-
/**
|
|
4390
|
-
* Request parameters for updateProduct operation in PlatformApi.
|
|
4391
|
-
* @export
|
|
4392
|
-
* @interface PlatformApiUpdateProductRequest
|
|
4393
|
-
*/
|
|
4394
|
-
export interface PlatformApiUpdateProductRequest {
|
|
4395
|
-
/**
|
|
4396
|
-
* Project unique identifier
|
|
4397
|
-
* @type {string}
|
|
4398
|
-
* @memberof PlatformApiUpdateProduct
|
|
4399
|
-
*/
|
|
4400
|
-
readonly project: string
|
|
4401
|
-
|
|
4402
|
-
/**
|
|
4403
|
-
* The platform identifier
|
|
4404
|
-
* @type {string}
|
|
4405
|
-
* @memberof PlatformApiUpdateProduct
|
|
4406
|
-
*/
|
|
4407
|
-
readonly platformId: string
|
|
4408
|
-
|
|
4409
|
-
/**
|
|
4410
|
-
* Products unique identifier
|
|
4411
|
-
* @type {string}
|
|
4412
|
-
* @memberof PlatformApiUpdateProduct
|
|
4413
|
-
*/
|
|
4414
|
-
readonly productId: string
|
|
4415
|
-
|
|
4416
|
-
/**
|
|
4417
|
-
* Update a platform warehouse product
|
|
4418
|
-
* @type {UpdateProductRequest}
|
|
4419
|
-
* @memberof PlatformApiUpdateProduct
|
|
4420
|
-
*/
|
|
4421
|
-
readonly updateProductRequest: UpdateProductRequest
|
|
4422
|
-
}
|
|
4423
|
-
|
|
4424
|
-
/**
|
|
4425
|
-
* Request parameters for updateVariant operation in PlatformApi.
|
|
4426
|
-
* @export
|
|
4427
|
-
* @interface PlatformApiUpdateVariantRequest
|
|
4428
|
-
*/
|
|
4429
|
-
export interface PlatformApiUpdateVariantRequest {
|
|
4430
|
-
/**
|
|
4431
|
-
* Project unique identifier
|
|
4432
|
-
* @type {string}
|
|
4433
|
-
* @memberof PlatformApiUpdateVariant
|
|
4434
|
-
*/
|
|
4435
|
-
readonly project: string
|
|
4436
|
-
|
|
4437
|
-
/**
|
|
4438
|
-
* The platform identifier
|
|
4439
|
-
* @type {string}
|
|
4440
|
-
* @memberof PlatformApiUpdateVariant
|
|
4441
|
-
*/
|
|
4442
|
-
readonly platformId: string
|
|
4443
|
-
|
|
4444
|
-
/**
|
|
4445
|
-
* Variants unique identifier
|
|
4446
|
-
* @type {string}
|
|
4447
|
-
* @memberof PlatformApiUpdateVariant
|
|
4448
|
-
*/
|
|
4449
|
-
readonly variantId: string
|
|
4450
|
-
|
|
4451
|
-
/**
|
|
4452
|
-
* Update a platform warehouse variant
|
|
4453
|
-
* @type {UpdateVariantRequest}
|
|
4454
|
-
* @memberof PlatformApiUpdateVariant
|
|
4455
|
-
*/
|
|
4456
|
-
readonly updateVariantRequest: UpdateVariantRequest
|
|
4457
|
-
}
|
|
4458
|
-
|
|
4459
3352
|
/**
|
|
4460
3353
|
* PlatformApi - object-oriented interface
|
|
4461
3354
|
* @export
|
|
@@ -4463,66 +3356,6 @@ export interface PlatformApiUpdateVariantRequest {
|
|
|
4463
3356
|
* @extends {BaseAPI}
|
|
4464
3357
|
*/
|
|
4465
3358
|
export class PlatformApi extends BaseAPI {
|
|
4466
|
-
/**
|
|
4467
|
-
* Export customers as a CSV file
|
|
4468
|
-
* @summary Export customers
|
|
4469
|
-
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
4470
|
-
* @param {*} [options] Override http request option.
|
|
4471
|
-
* @throws {RequiredError}
|
|
4472
|
-
* @memberof PlatformApi
|
|
4473
|
-
*/
|
|
4474
|
-
public exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
4475
|
-
return PlatformApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
4476
|
-
}
|
|
4477
|
-
|
|
4478
|
-
/**
|
|
4479
|
-
* Export orders as a CSV file
|
|
4480
|
-
* @summary Export orders
|
|
4481
|
-
* @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
|
|
4482
|
-
* @param {*} [options] Override http request option.
|
|
4483
|
-
* @throws {RequiredError}
|
|
4484
|
-
* @memberof PlatformApi
|
|
4485
|
-
*/
|
|
4486
|
-
public exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4487
|
-
return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
4488
|
-
}
|
|
4489
|
-
|
|
4490
|
-
/**
|
|
4491
|
-
* Get a customer for a platform by a given customer ID.
|
|
4492
|
-
* @summary Get customer
|
|
4493
|
-
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
4494
|
-
* @param {*} [options] Override http request option.
|
|
4495
|
-
* @throws {RequiredError}
|
|
4496
|
-
* @memberof PlatformApi
|
|
4497
|
-
*/
|
|
4498
|
-
public getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
4499
|
-
return PlatformApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
4500
|
-
}
|
|
4501
|
-
|
|
4502
|
-
/**
|
|
4503
|
-
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
4504
|
-
* @summary Get fulfillment
|
|
4505
|
-
* @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
|
|
4506
|
-
* @param {*} [options] Override http request option.
|
|
4507
|
-
* @throws {RequiredError}
|
|
4508
|
-
* @memberof PlatformApi
|
|
4509
|
-
*/
|
|
4510
|
-
public getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
4511
|
-
return PlatformApiFp(this.configuration).getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
4512
|
-
}
|
|
4513
|
-
|
|
4514
|
-
/**
|
|
4515
|
-
* Get an order for a platform by a given order ID.
|
|
4516
|
-
* @summary Get order
|
|
4517
|
-
* @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
|
|
4518
|
-
* @param {*} [options] Override http request option.
|
|
4519
|
-
* @throws {RequiredError}
|
|
4520
|
-
* @memberof PlatformApi
|
|
4521
|
-
*/
|
|
4522
|
-
public getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig) {
|
|
4523
|
-
return PlatformApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
|
|
4524
|
-
}
|
|
4525
|
-
|
|
4526
3359
|
/**
|
|
4527
3360
|
*
|
|
4528
3361
|
* @summary Get platform details
|
|
@@ -4535,54 +3368,6 @@ export class PlatformApi extends BaseAPI {
|
|
|
4535
3368
|
return PlatformApiFp(this.configuration).getPlatform(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
|
|
4536
3369
|
}
|
|
4537
3370
|
|
|
4538
|
-
/**
|
|
4539
|
-
* List available fulfillers for a given fulfillment
|
|
4540
|
-
* @summary List available fulfillers
|
|
4541
|
-
* @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
|
|
4542
|
-
* @param {*} [options] Override http request option.
|
|
4543
|
-
* @throws {RequiredError}
|
|
4544
|
-
* @memberof PlatformApi
|
|
4545
|
-
*/
|
|
4546
|
-
public listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig) {
|
|
4547
|
-
return PlatformApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
4548
|
-
}
|
|
4549
|
-
|
|
4550
|
-
/**
|
|
4551
|
-
* List customers for a platform
|
|
4552
|
-
* @summary List customers
|
|
4553
|
-
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
4554
|
-
* @param {*} [options] Override http request option.
|
|
4555
|
-
* @throws {RequiredError}
|
|
4556
|
-
* @memberof PlatformApi
|
|
4557
|
-
*/
|
|
4558
|
-
public listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
4559
|
-
return PlatformApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
4560
|
-
}
|
|
4561
|
-
|
|
4562
|
-
/**
|
|
4563
|
-
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
4564
|
-
* @summary List orders
|
|
4565
|
-
* @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
|
|
4566
|
-
* @param {*} [options] Override http request option.
|
|
4567
|
-
* @throws {RequiredError}
|
|
4568
|
-
* @memberof PlatformApi
|
|
4569
|
-
*/
|
|
4570
|
-
public listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig) {
|
|
4571
|
-
return PlatformApiFp(this.configuration).listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(this.axios, this.basePath));
|
|
4572
|
-
}
|
|
4573
|
-
|
|
4574
|
-
/**
|
|
4575
|
-
* Update a fulfillment that belongs to an order placed through the platform
|
|
4576
|
-
* @summary Update fulfillment
|
|
4577
|
-
* @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
|
|
4578
|
-
* @param {*} [options] Override http request option.
|
|
4579
|
-
* @throws {RequiredError}
|
|
4580
|
-
* @memberof PlatformApi
|
|
4581
|
-
*/
|
|
4582
|
-
public updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig) {
|
|
4583
|
-
return PlatformApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4584
|
-
}
|
|
4585
|
-
|
|
4586
3371
|
/**
|
|
4587
3372
|
*
|
|
4588
3373
|
* @summary Update platform
|
|
@@ -4594,30 +3379,6 @@ export class PlatformApi extends BaseAPI {
|
|
|
4594
3379
|
public updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig) {
|
|
4595
3380
|
return PlatformApiFp(this.configuration).updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4596
3381
|
}
|
|
4597
|
-
|
|
4598
|
-
/**
|
|
4599
|
-
* Updates the warehouse product and its variants
|
|
4600
|
-
* @summary Update warehouse product
|
|
4601
|
-
* @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
|
|
4602
|
-
* @param {*} [options] Override http request option.
|
|
4603
|
-
* @throws {RequiredError}
|
|
4604
|
-
* @memberof PlatformApi
|
|
4605
|
-
*/
|
|
4606
|
-
public updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
|
|
4607
|
-
return PlatformApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4608
|
-
}
|
|
4609
|
-
|
|
4610
|
-
/**
|
|
4611
|
-
* Updates the warehouse variant
|
|
4612
|
-
* @summary Update warehouse variant
|
|
4613
|
-
* @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
|
|
4614
|
-
* @param {*} [options] Override http request option.
|
|
4615
|
-
* @throws {RequiredError}
|
|
4616
|
-
* @memberof PlatformApi
|
|
4617
|
-
*/
|
|
4618
|
-
public updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig) {
|
|
4619
|
-
return PlatformApiFp(this.configuration).updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(this.axios, this.basePath));
|
|
4620
|
-
}
|
|
4621
3382
|
}
|
|
4622
3383
|
|
|
4623
3384
|
|