@teemill/platform 0.10.0 → 0.11.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 +749 -6
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +8 -2
- package/dist/api.d.ts +417 -1
- package/dist/api.js +518 -2
- 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 +3 -2
- package/dist/esm/api.d.ts +417 -1
- package/dist/esm/api.js +513 -1
- 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 +3 -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/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.11.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -172,6 +172,56 @@ export interface ContactInformation {
|
|
|
172
172
|
*/
|
|
173
173
|
'phone'?: string | null;
|
|
174
174
|
}
|
|
175
|
+
/**
|
|
176
|
+
* The customer that has placed an order on your platform
|
|
177
|
+
* @export
|
|
178
|
+
* @interface Customer
|
|
179
|
+
*/
|
|
180
|
+
export interface Customer {
|
|
181
|
+
/**
|
|
182
|
+
* Unique object identifier
|
|
183
|
+
* @type {string}
|
|
184
|
+
* @memberof Customer
|
|
185
|
+
*/
|
|
186
|
+
'id': string;
|
|
187
|
+
/**
|
|
188
|
+
*
|
|
189
|
+
* @type {string}
|
|
190
|
+
* @memberof Customer
|
|
191
|
+
*/
|
|
192
|
+
'email': string;
|
|
193
|
+
/**
|
|
194
|
+
*
|
|
195
|
+
* @type {string}
|
|
196
|
+
* @memberof Customer
|
|
197
|
+
*/
|
|
198
|
+
'firstName'?: string;
|
|
199
|
+
/**
|
|
200
|
+
*
|
|
201
|
+
* @type {string}
|
|
202
|
+
* @memberof Customer
|
|
203
|
+
*/
|
|
204
|
+
'lastName'?: string;
|
|
205
|
+
}
|
|
206
|
+
/**
|
|
207
|
+
*
|
|
208
|
+
* @export
|
|
209
|
+
* @interface CustomersResponse
|
|
210
|
+
*/
|
|
211
|
+
export interface CustomersResponse {
|
|
212
|
+
/**
|
|
213
|
+
*
|
|
214
|
+
* @type {Array<Customer>}
|
|
215
|
+
* @memberof CustomersResponse
|
|
216
|
+
*/
|
|
217
|
+
'customers': Array<Customer>;
|
|
218
|
+
/**
|
|
219
|
+
*
|
|
220
|
+
* @type {number}
|
|
221
|
+
* @memberof CustomersResponse
|
|
222
|
+
*/
|
|
223
|
+
'nextPageToken'?: number | null;
|
|
224
|
+
}
|
|
175
225
|
/**
|
|
176
226
|
*
|
|
177
227
|
* @export
|
|
@@ -1604,15 +1654,381 @@ export interface VariantPackedDimensions {
|
|
|
1604
1654
|
* @type {number}
|
|
1605
1655
|
* @memberof VariantPackedDimensions
|
|
1606
1656
|
*/
|
|
1607
|
-
'width'?: number;
|
|
1657
|
+
'width'?: number;
|
|
1658
|
+
/**
|
|
1659
|
+
* Depth in mm
|
|
1660
|
+
* @type {number}
|
|
1661
|
+
* @memberof VariantPackedDimensions
|
|
1662
|
+
*/
|
|
1663
|
+
'depth'?: number;
|
|
1664
|
+
}
|
|
1665
|
+
|
|
1666
|
+
/**
|
|
1667
|
+
* CustomersApi - axios parameter creator
|
|
1668
|
+
* @export
|
|
1669
|
+
*/
|
|
1670
|
+
export const CustomersApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1671
|
+
return {
|
|
1672
|
+
/**
|
|
1673
|
+
* Export customers as a CSV file
|
|
1674
|
+
* @summary Export customers
|
|
1675
|
+
* @param {string} project Project unique identifier
|
|
1676
|
+
* @param {string} platformId The platform identifier
|
|
1677
|
+
* @param {*} [options] Override http request option.
|
|
1678
|
+
* @throws {RequiredError}
|
|
1679
|
+
*/
|
|
1680
|
+
exportCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1681
|
+
// verify required parameter 'project' is not null or undefined
|
|
1682
|
+
assertParamExists('exportCustomers', 'project', project)
|
|
1683
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1684
|
+
assertParamExists('exportCustomers', 'platformId', platformId)
|
|
1685
|
+
const localVarPath = `/v1/platform/{platformId}/customers/export`
|
|
1686
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1687
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1688
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1689
|
+
let baseOptions;
|
|
1690
|
+
if (configuration) {
|
|
1691
|
+
baseOptions = configuration.baseOptions;
|
|
1692
|
+
}
|
|
1693
|
+
|
|
1694
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1695
|
+
const localVarHeaderParameter = {} as any;
|
|
1696
|
+
const localVarQueryParameter = {} as any;
|
|
1697
|
+
|
|
1698
|
+
// authentication session-oauth required
|
|
1699
|
+
// oauth required
|
|
1700
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1701
|
+
|
|
1702
|
+
// authentication api-key required
|
|
1703
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1704
|
+
|
|
1705
|
+
if (project !== undefined) {
|
|
1706
|
+
localVarQueryParameter['project'] = project;
|
|
1707
|
+
}
|
|
1708
|
+
|
|
1709
|
+
|
|
1710
|
+
|
|
1711
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1712
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1713
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1714
|
+
|
|
1715
|
+
return {
|
|
1716
|
+
url: toPathString(localVarUrlObj),
|
|
1717
|
+
options: localVarRequestOptions,
|
|
1718
|
+
};
|
|
1719
|
+
},
|
|
1720
|
+
/**
|
|
1721
|
+
* Get a customer for a platform by a given customer ID.
|
|
1722
|
+
* @summary Get customer
|
|
1723
|
+
* @param {string} project Project unique identifier
|
|
1724
|
+
* @param {string} platformId The platform identifier
|
|
1725
|
+
* @param {string} customerId The customer identifier
|
|
1726
|
+
* @param {*} [options] Override http request option.
|
|
1727
|
+
* @throws {RequiredError}
|
|
1728
|
+
*/
|
|
1729
|
+
getCustomer: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1730
|
+
// verify required parameter 'project' is not null or undefined
|
|
1731
|
+
assertParamExists('getCustomer', 'project', project)
|
|
1732
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1733
|
+
assertParamExists('getCustomer', 'platformId', platformId)
|
|
1734
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
1735
|
+
assertParamExists('getCustomer', 'customerId', customerId)
|
|
1736
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
1737
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
1738
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
1739
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1740
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1741
|
+
let baseOptions;
|
|
1742
|
+
if (configuration) {
|
|
1743
|
+
baseOptions = configuration.baseOptions;
|
|
1744
|
+
}
|
|
1745
|
+
|
|
1746
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1747
|
+
const localVarHeaderParameter = {} as any;
|
|
1748
|
+
const localVarQueryParameter = {} as any;
|
|
1749
|
+
|
|
1750
|
+
// authentication session-oauth required
|
|
1751
|
+
// oauth required
|
|
1752
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1753
|
+
|
|
1754
|
+
// authentication api-key required
|
|
1755
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1756
|
+
|
|
1757
|
+
if (project !== undefined) {
|
|
1758
|
+
localVarQueryParameter['project'] = project;
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1764
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1765
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1766
|
+
|
|
1767
|
+
return {
|
|
1768
|
+
url: toPathString(localVarUrlObj),
|
|
1769
|
+
options: localVarRequestOptions,
|
|
1770
|
+
};
|
|
1771
|
+
},
|
|
1772
|
+
/**
|
|
1773
|
+
* List customers for a platform
|
|
1774
|
+
* @summary List customers
|
|
1775
|
+
* @param {string} project Project unique identifier
|
|
1776
|
+
* @param {string} platformId The platform identifier
|
|
1777
|
+
* @param {*} [options] Override http request option.
|
|
1778
|
+
* @throws {RequiredError}
|
|
1779
|
+
*/
|
|
1780
|
+
listCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
1781
|
+
// verify required parameter 'project' is not null or undefined
|
|
1782
|
+
assertParamExists('listCustomers', 'project', project)
|
|
1783
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
1784
|
+
assertParamExists('listCustomers', 'platformId', platformId)
|
|
1785
|
+
const localVarPath = `/v1/platform/{platformId}/customers`
|
|
1786
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
1787
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
1788
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
1789
|
+
let baseOptions;
|
|
1790
|
+
if (configuration) {
|
|
1791
|
+
baseOptions = configuration.baseOptions;
|
|
1792
|
+
}
|
|
1793
|
+
|
|
1794
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
1795
|
+
const localVarHeaderParameter = {} as any;
|
|
1796
|
+
const localVarQueryParameter = {} as any;
|
|
1797
|
+
|
|
1798
|
+
// authentication session-oauth required
|
|
1799
|
+
// oauth required
|
|
1800
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
1801
|
+
|
|
1802
|
+
// authentication api-key required
|
|
1803
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
1804
|
+
|
|
1805
|
+
if (project !== undefined) {
|
|
1806
|
+
localVarQueryParameter['project'] = project;
|
|
1807
|
+
}
|
|
1808
|
+
|
|
1809
|
+
|
|
1810
|
+
|
|
1811
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
1812
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
1813
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
1814
|
+
|
|
1815
|
+
return {
|
|
1816
|
+
url: toPathString(localVarUrlObj),
|
|
1817
|
+
options: localVarRequestOptions,
|
|
1818
|
+
};
|
|
1819
|
+
},
|
|
1820
|
+
}
|
|
1821
|
+
};
|
|
1822
|
+
|
|
1823
|
+
/**
|
|
1824
|
+
* CustomersApi - functional programming interface
|
|
1825
|
+
* @export
|
|
1826
|
+
*/
|
|
1827
|
+
export const CustomersApiFp = function(configuration?: Configuration) {
|
|
1828
|
+
const localVarAxiosParamCreator = CustomersApiAxiosParamCreator(configuration)
|
|
1829
|
+
return {
|
|
1830
|
+
/**
|
|
1831
|
+
* Export customers as a CSV file
|
|
1832
|
+
* @summary Export customers
|
|
1833
|
+
* @param {string} project Project unique identifier
|
|
1834
|
+
* @param {string} platformId The platform identifier
|
|
1835
|
+
* @param {*} [options] Override http request option.
|
|
1836
|
+
* @throws {RequiredError}
|
|
1837
|
+
*/
|
|
1838
|
+
async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
1839
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
1840
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1841
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1842
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1843
|
+
},
|
|
1844
|
+
/**
|
|
1845
|
+
* Get a customer for a platform by a given customer ID.
|
|
1846
|
+
* @summary Get customer
|
|
1847
|
+
* @param {string} project Project unique identifier
|
|
1848
|
+
* @param {string} platformId The platform identifier
|
|
1849
|
+
* @param {string} customerId The customer identifier
|
|
1850
|
+
* @param {*} [options] Override http request option.
|
|
1851
|
+
* @throws {RequiredError}
|
|
1852
|
+
*/
|
|
1853
|
+
async getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
|
|
1854
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
|
|
1855
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1856
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
1857
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1858
|
+
},
|
|
1859
|
+
/**
|
|
1860
|
+
* List customers for a platform
|
|
1861
|
+
* @summary List customers
|
|
1862
|
+
* @param {string} project Project unique identifier
|
|
1863
|
+
* @param {string} platformId The platform identifier
|
|
1864
|
+
* @param {*} [options] Override http request option.
|
|
1865
|
+
* @throws {RequiredError}
|
|
1866
|
+
*/
|
|
1867
|
+
async listCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
1868
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, options);
|
|
1869
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
1870
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
1871
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1872
|
+
},
|
|
1873
|
+
}
|
|
1874
|
+
};
|
|
1875
|
+
|
|
1876
|
+
/**
|
|
1877
|
+
* CustomersApi - factory interface
|
|
1878
|
+
* @export
|
|
1879
|
+
*/
|
|
1880
|
+
export const CustomersApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
1881
|
+
const localVarFp = CustomersApiFp(configuration)
|
|
1882
|
+
return {
|
|
1883
|
+
/**
|
|
1884
|
+
* Export customers as a CSV file
|
|
1885
|
+
* @summary Export customers
|
|
1886
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
1887
|
+
* @param {*} [options] Override http request option.
|
|
1888
|
+
* @throws {RequiredError}
|
|
1889
|
+
*/
|
|
1890
|
+
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
1891
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
1892
|
+
},
|
|
1893
|
+
/**
|
|
1894
|
+
* Get a customer for a platform by a given customer ID.
|
|
1895
|
+
* @summary Get customer
|
|
1896
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
1897
|
+
* @param {*} [options] Override http request option.
|
|
1898
|
+
* @throws {RequiredError}
|
|
1899
|
+
*/
|
|
1900
|
+
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
1901
|
+
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
1902
|
+
},
|
|
1903
|
+
/**
|
|
1904
|
+
* List customers for a platform
|
|
1905
|
+
* @summary List customers
|
|
1906
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
1907
|
+
* @param {*} [options] Override http request option.
|
|
1908
|
+
* @throws {RequiredError}
|
|
1909
|
+
*/
|
|
1910
|
+
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
1911
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
1912
|
+
},
|
|
1913
|
+
};
|
|
1914
|
+
};
|
|
1915
|
+
|
|
1916
|
+
/**
|
|
1917
|
+
* Request parameters for exportCustomers operation in CustomersApi.
|
|
1918
|
+
* @export
|
|
1919
|
+
* @interface CustomersApiExportCustomersRequest
|
|
1920
|
+
*/
|
|
1921
|
+
export interface CustomersApiExportCustomersRequest {
|
|
1922
|
+
/**
|
|
1923
|
+
* Project unique identifier
|
|
1924
|
+
* @type {string}
|
|
1925
|
+
* @memberof CustomersApiExportCustomers
|
|
1926
|
+
*/
|
|
1927
|
+
readonly project: string
|
|
1928
|
+
|
|
1929
|
+
/**
|
|
1930
|
+
* The platform identifier
|
|
1931
|
+
* @type {string}
|
|
1932
|
+
* @memberof CustomersApiExportCustomers
|
|
1933
|
+
*/
|
|
1934
|
+
readonly platformId: string
|
|
1935
|
+
}
|
|
1936
|
+
|
|
1937
|
+
/**
|
|
1938
|
+
* Request parameters for getCustomer operation in CustomersApi.
|
|
1939
|
+
* @export
|
|
1940
|
+
* @interface CustomersApiGetCustomerRequest
|
|
1941
|
+
*/
|
|
1942
|
+
export interface CustomersApiGetCustomerRequest {
|
|
1943
|
+
/**
|
|
1944
|
+
* Project unique identifier
|
|
1945
|
+
* @type {string}
|
|
1946
|
+
* @memberof CustomersApiGetCustomer
|
|
1947
|
+
*/
|
|
1948
|
+
readonly project: string
|
|
1949
|
+
|
|
1950
|
+
/**
|
|
1951
|
+
* The platform identifier
|
|
1952
|
+
* @type {string}
|
|
1953
|
+
* @memberof CustomersApiGetCustomer
|
|
1954
|
+
*/
|
|
1955
|
+
readonly platformId: string
|
|
1956
|
+
|
|
1957
|
+
/**
|
|
1958
|
+
* The customer identifier
|
|
1959
|
+
* @type {string}
|
|
1960
|
+
* @memberof CustomersApiGetCustomer
|
|
1961
|
+
*/
|
|
1962
|
+
readonly customerId: string
|
|
1963
|
+
}
|
|
1964
|
+
|
|
1965
|
+
/**
|
|
1966
|
+
* Request parameters for listCustomers operation in CustomersApi.
|
|
1967
|
+
* @export
|
|
1968
|
+
* @interface CustomersApiListCustomersRequest
|
|
1969
|
+
*/
|
|
1970
|
+
export interface CustomersApiListCustomersRequest {
|
|
1971
|
+
/**
|
|
1972
|
+
* Project unique identifier
|
|
1973
|
+
* @type {string}
|
|
1974
|
+
* @memberof CustomersApiListCustomers
|
|
1975
|
+
*/
|
|
1976
|
+
readonly project: string
|
|
1977
|
+
|
|
1978
|
+
/**
|
|
1979
|
+
* The platform identifier
|
|
1980
|
+
* @type {string}
|
|
1981
|
+
* @memberof CustomersApiListCustomers
|
|
1982
|
+
*/
|
|
1983
|
+
readonly platformId: string
|
|
1984
|
+
}
|
|
1985
|
+
|
|
1986
|
+
/**
|
|
1987
|
+
* CustomersApi - object-oriented interface
|
|
1988
|
+
* @export
|
|
1989
|
+
* @class CustomersApi
|
|
1990
|
+
* @extends {BaseAPI}
|
|
1991
|
+
*/
|
|
1992
|
+
export class CustomersApi extends BaseAPI {
|
|
1993
|
+
/**
|
|
1994
|
+
* Export customers as a CSV file
|
|
1995
|
+
* @summary Export customers
|
|
1996
|
+
* @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
|
|
1997
|
+
* @param {*} [options] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
* @memberof CustomersApi
|
|
2000
|
+
*/
|
|
2001
|
+
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2002
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
2003
|
+
}
|
|
2004
|
+
|
|
2005
|
+
/**
|
|
2006
|
+
* Get a customer for a platform by a given customer ID.
|
|
2007
|
+
* @summary Get customer
|
|
2008
|
+
* @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
|
|
2009
|
+
* @param {*} [options] Override http request option.
|
|
2010
|
+
* @throws {RequiredError}
|
|
2011
|
+
* @memberof CustomersApi
|
|
2012
|
+
*/
|
|
2013
|
+
public getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
2014
|
+
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
2015
|
+
}
|
|
2016
|
+
|
|
1608
2017
|
/**
|
|
1609
|
-
*
|
|
1610
|
-
* @
|
|
1611
|
-
* @
|
|
2018
|
+
* List customers for a platform
|
|
2019
|
+
* @summary List customers
|
|
2020
|
+
* @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
|
|
2021
|
+
* @param {*} [options] Override http request option.
|
|
2022
|
+
* @throws {RequiredError}
|
|
2023
|
+
* @memberof CustomersApi
|
|
1612
2024
|
*/
|
|
1613
|
-
|
|
2025
|
+
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
2026
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
2027
|
+
}
|
|
1614
2028
|
}
|
|
1615
2029
|
|
|
2030
|
+
|
|
2031
|
+
|
|
1616
2032
|
/**
|
|
1617
2033
|
* OrdersApi - axios parameter creator
|
|
1618
2034
|
* @export
|
|
@@ -2464,6 +2880,54 @@ export class OrdersApi extends BaseAPI {
|
|
|
2464
2880
|
*/
|
|
2465
2881
|
export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2466
2882
|
return {
|
|
2883
|
+
/**
|
|
2884
|
+
* Export customers as a CSV file
|
|
2885
|
+
* @summary Export customers
|
|
2886
|
+
* @param {string} project Project unique identifier
|
|
2887
|
+
* @param {string} platformId The platform identifier
|
|
2888
|
+
* @param {*} [options] Override http request option.
|
|
2889
|
+
* @throws {RequiredError}
|
|
2890
|
+
*/
|
|
2891
|
+
exportCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2892
|
+
// verify required parameter 'project' is not null or undefined
|
|
2893
|
+
assertParamExists('exportCustomers', 'project', project)
|
|
2894
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2895
|
+
assertParamExists('exportCustomers', 'platformId', platformId)
|
|
2896
|
+
const localVarPath = `/v1/platform/{platformId}/customers/export`
|
|
2897
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2898
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2899
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2900
|
+
let baseOptions;
|
|
2901
|
+
if (configuration) {
|
|
2902
|
+
baseOptions = configuration.baseOptions;
|
|
2903
|
+
}
|
|
2904
|
+
|
|
2905
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2906
|
+
const localVarHeaderParameter = {} as any;
|
|
2907
|
+
const localVarQueryParameter = {} as any;
|
|
2908
|
+
|
|
2909
|
+
// authentication session-oauth required
|
|
2910
|
+
// oauth required
|
|
2911
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2912
|
+
|
|
2913
|
+
// authentication api-key required
|
|
2914
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2915
|
+
|
|
2916
|
+
if (project !== undefined) {
|
|
2917
|
+
localVarQueryParameter['project'] = project;
|
|
2918
|
+
}
|
|
2919
|
+
|
|
2920
|
+
|
|
2921
|
+
|
|
2922
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2923
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2924
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2925
|
+
|
|
2926
|
+
return {
|
|
2927
|
+
url: toPathString(localVarUrlObj),
|
|
2928
|
+
options: localVarRequestOptions,
|
|
2929
|
+
};
|
|
2930
|
+
},
|
|
2467
2931
|
/**
|
|
2468
2932
|
* Export orders as a CSV file
|
|
2469
2933
|
* @summary Export orders
|
|
@@ -2524,6 +2988,58 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2524
2988
|
|
|
2525
2989
|
|
|
2526
2990
|
|
|
2991
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2992
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2993
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2994
|
+
|
|
2995
|
+
return {
|
|
2996
|
+
url: toPathString(localVarUrlObj),
|
|
2997
|
+
options: localVarRequestOptions,
|
|
2998
|
+
};
|
|
2999
|
+
},
|
|
3000
|
+
/**
|
|
3001
|
+
* Get a customer for a platform by a given customer ID.
|
|
3002
|
+
* @summary Get customer
|
|
3003
|
+
* @param {string} project Project unique identifier
|
|
3004
|
+
* @param {string} platformId The platform identifier
|
|
3005
|
+
* @param {string} customerId The customer identifier
|
|
3006
|
+
* @param {*} [options] Override http request option.
|
|
3007
|
+
* @throws {RequiredError}
|
|
3008
|
+
*/
|
|
3009
|
+
getCustomer: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3010
|
+
// verify required parameter 'project' is not null or undefined
|
|
3011
|
+
assertParamExists('getCustomer', 'project', project)
|
|
3012
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3013
|
+
assertParamExists('getCustomer', 'platformId', platformId)
|
|
3014
|
+
// verify required parameter 'customerId' is not null or undefined
|
|
3015
|
+
assertParamExists('getCustomer', 'customerId', customerId)
|
|
3016
|
+
const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
|
|
3017
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
|
|
3018
|
+
.replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
|
|
3019
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3020
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3021
|
+
let baseOptions;
|
|
3022
|
+
if (configuration) {
|
|
3023
|
+
baseOptions = configuration.baseOptions;
|
|
3024
|
+
}
|
|
3025
|
+
|
|
3026
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3027
|
+
const localVarHeaderParameter = {} as any;
|
|
3028
|
+
const localVarQueryParameter = {} as any;
|
|
3029
|
+
|
|
3030
|
+
// authentication session-oauth required
|
|
3031
|
+
// oauth required
|
|
3032
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3033
|
+
|
|
3034
|
+
// authentication api-key required
|
|
3035
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3036
|
+
|
|
3037
|
+
if (project !== undefined) {
|
|
3038
|
+
localVarQueryParameter['project'] = project;
|
|
3039
|
+
}
|
|
3040
|
+
|
|
3041
|
+
|
|
3042
|
+
|
|
2527
3043
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2528
3044
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2529
3045
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2724,6 +3240,54 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
2724
3240
|
|
|
2725
3241
|
|
|
2726
3242
|
|
|
3243
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
3244
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
3245
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
3246
|
+
|
|
3247
|
+
return {
|
|
3248
|
+
url: toPathString(localVarUrlObj),
|
|
3249
|
+
options: localVarRequestOptions,
|
|
3250
|
+
};
|
|
3251
|
+
},
|
|
3252
|
+
/**
|
|
3253
|
+
* List customers for a platform
|
|
3254
|
+
* @summary List customers
|
|
3255
|
+
* @param {string} project Project unique identifier
|
|
3256
|
+
* @param {string} platformId The platform identifier
|
|
3257
|
+
* @param {*} [options] Override http request option.
|
|
3258
|
+
* @throws {RequiredError}
|
|
3259
|
+
*/
|
|
3260
|
+
listCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
3261
|
+
// verify required parameter 'project' is not null or undefined
|
|
3262
|
+
assertParamExists('listCustomers', 'project', project)
|
|
3263
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
3264
|
+
assertParamExists('listCustomers', 'platformId', platformId)
|
|
3265
|
+
const localVarPath = `/v1/platform/{platformId}/customers`
|
|
3266
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
3267
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
3268
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
3269
|
+
let baseOptions;
|
|
3270
|
+
if (configuration) {
|
|
3271
|
+
baseOptions = configuration.baseOptions;
|
|
3272
|
+
}
|
|
3273
|
+
|
|
3274
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
3275
|
+
const localVarHeaderParameter = {} as any;
|
|
3276
|
+
const localVarQueryParameter = {} as any;
|
|
3277
|
+
|
|
3278
|
+
// authentication session-oauth required
|
|
3279
|
+
// oauth required
|
|
3280
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
3281
|
+
|
|
3282
|
+
// authentication api-key required
|
|
3283
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
3284
|
+
|
|
3285
|
+
if (project !== undefined) {
|
|
3286
|
+
localVarQueryParameter['project'] = project;
|
|
3287
|
+
}
|
|
3288
|
+
|
|
3289
|
+
|
|
3290
|
+
|
|
2727
3291
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2728
3292
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2729
3293
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -3044,6 +3608,20 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
3044
3608
|
export const PlatformApiFp = function(configuration?: Configuration) {
|
|
3045
3609
|
const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
|
|
3046
3610
|
return {
|
|
3611
|
+
/**
|
|
3612
|
+
* Export customers as a CSV file
|
|
3613
|
+
* @summary Export customers
|
|
3614
|
+
* @param {string} project Project unique identifier
|
|
3615
|
+
* @param {string} platformId The platform identifier
|
|
3616
|
+
* @param {*} [options] Override http request option.
|
|
3617
|
+
* @throws {RequiredError}
|
|
3618
|
+
*/
|
|
3619
|
+
async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
3620
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
|
|
3621
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3622
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
3623
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3624
|
+
},
|
|
3047
3625
|
/**
|
|
3048
3626
|
* Export orders as a CSV file
|
|
3049
3627
|
* @summary Export orders
|
|
@@ -3061,6 +3639,21 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
3061
3639
|
const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
|
|
3062
3640
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3063
3641
|
},
|
|
3642
|
+
/**
|
|
3643
|
+
* Get a customer for a platform by a given customer ID.
|
|
3644
|
+
* @summary Get customer
|
|
3645
|
+
* @param {string} project Project unique identifier
|
|
3646
|
+
* @param {string} platformId The platform identifier
|
|
3647
|
+
* @param {string} customerId The customer identifier
|
|
3648
|
+
* @param {*} [options] Override http request option.
|
|
3649
|
+
* @throws {RequiredError}
|
|
3650
|
+
*/
|
|
3651
|
+
async getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
|
|
3652
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
|
|
3653
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3654
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
3655
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3656
|
+
},
|
|
3064
3657
|
/**
|
|
3065
3658
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3066
3659
|
* @summary Get fulfillment
|
|
@@ -3119,6 +3712,20 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
3119
3712
|
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listAvailableFulfillers']?.[localVarOperationServerIndex]?.url;
|
|
3120
3713
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3121
3714
|
},
|
|
3715
|
+
/**
|
|
3716
|
+
* List customers for a platform
|
|
3717
|
+
* @summary List customers
|
|
3718
|
+
* @param {string} project Project unique identifier
|
|
3719
|
+
* @param {string} platformId The platform identifier
|
|
3720
|
+
* @param {*} [options] Override http request option.
|
|
3721
|
+
* @throws {RequiredError}
|
|
3722
|
+
*/
|
|
3723
|
+
async listCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
3724
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, options);
|
|
3725
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3726
|
+
const localVarOperationServerBasePath = operationServerMap['PlatformApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
3727
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3728
|
+
},
|
|
3122
3729
|
/**
|
|
3123
3730
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3124
3731
|
* @summary List orders
|
|
@@ -3210,6 +3817,16 @@ export const PlatformApiFp = function(configuration?: Configuration) {
|
|
|
3210
3817
|
export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
3211
3818
|
const localVarFp = PlatformApiFp(configuration)
|
|
3212
3819
|
return {
|
|
3820
|
+
/**
|
|
3821
|
+
* Export customers as a CSV file
|
|
3822
|
+
* @summary Export customers
|
|
3823
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
3824
|
+
* @param {*} [options] Override http request option.
|
|
3825
|
+
* @throws {RequiredError}
|
|
3826
|
+
*/
|
|
3827
|
+
exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3828
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
3829
|
+
},
|
|
3213
3830
|
/**
|
|
3214
3831
|
* Export orders as a CSV file
|
|
3215
3832
|
* @summary Export orders
|
|
@@ -3220,6 +3837,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
3220
3837
|
exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
3221
3838
|
return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3222
3839
|
},
|
|
3840
|
+
/**
|
|
3841
|
+
* Get a customer for a platform by a given customer ID.
|
|
3842
|
+
* @summary Get customer
|
|
3843
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
3844
|
+
* @param {*} [options] Override http request option.
|
|
3845
|
+
* @throws {RequiredError}
|
|
3846
|
+
*/
|
|
3847
|
+
getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
3848
|
+
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
3849
|
+
},
|
|
3223
3850
|
/**
|
|
3224
3851
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3225
3852
|
* @summary Get fulfillment
|
|
@@ -3260,6 +3887,16 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
3260
3887
|
listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse> {
|
|
3261
3888
|
return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
|
|
3262
3889
|
},
|
|
3890
|
+
/**
|
|
3891
|
+
* List customers for a platform
|
|
3892
|
+
* @summary List customers
|
|
3893
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
3894
|
+
* @param {*} [options] Override http request option.
|
|
3895
|
+
* @throws {RequiredError}
|
|
3896
|
+
*/
|
|
3897
|
+
listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
3898
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
|
|
3899
|
+
},
|
|
3263
3900
|
/**
|
|
3264
3901
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3265
3902
|
* @summary List orders
|
|
@@ -3313,6 +3950,27 @@ export const PlatformApiFactory = function (configuration?: Configuration, baseP
|
|
|
3313
3950
|
};
|
|
3314
3951
|
};
|
|
3315
3952
|
|
|
3953
|
+
/**
|
|
3954
|
+
* Request parameters for exportCustomers operation in PlatformApi.
|
|
3955
|
+
* @export
|
|
3956
|
+
* @interface PlatformApiExportCustomersRequest
|
|
3957
|
+
*/
|
|
3958
|
+
export interface PlatformApiExportCustomersRequest {
|
|
3959
|
+
/**
|
|
3960
|
+
* Project unique identifier
|
|
3961
|
+
* @type {string}
|
|
3962
|
+
* @memberof PlatformApiExportCustomers
|
|
3963
|
+
*/
|
|
3964
|
+
readonly project: string
|
|
3965
|
+
|
|
3966
|
+
/**
|
|
3967
|
+
* The platform identifier
|
|
3968
|
+
* @type {string}
|
|
3969
|
+
* @memberof PlatformApiExportCustomers
|
|
3970
|
+
*/
|
|
3971
|
+
readonly platformId: string
|
|
3972
|
+
}
|
|
3973
|
+
|
|
3316
3974
|
/**
|
|
3317
3975
|
* Request parameters for exportOrders operation in PlatformApi.
|
|
3318
3976
|
* @export
|
|
@@ -3355,6 +4013,34 @@ export interface PlatformApiExportOrdersRequest {
|
|
|
3355
4013
|
readonly search?: string
|
|
3356
4014
|
}
|
|
3357
4015
|
|
|
4016
|
+
/**
|
|
4017
|
+
* Request parameters for getCustomer operation in PlatformApi.
|
|
4018
|
+
* @export
|
|
4019
|
+
* @interface PlatformApiGetCustomerRequest
|
|
4020
|
+
*/
|
|
4021
|
+
export interface PlatformApiGetCustomerRequest {
|
|
4022
|
+
/**
|
|
4023
|
+
* Project unique identifier
|
|
4024
|
+
* @type {string}
|
|
4025
|
+
* @memberof PlatformApiGetCustomer
|
|
4026
|
+
*/
|
|
4027
|
+
readonly project: string
|
|
4028
|
+
|
|
4029
|
+
/**
|
|
4030
|
+
* The platform identifier
|
|
4031
|
+
* @type {string}
|
|
4032
|
+
* @memberof PlatformApiGetCustomer
|
|
4033
|
+
*/
|
|
4034
|
+
readonly platformId: string
|
|
4035
|
+
|
|
4036
|
+
/**
|
|
4037
|
+
* The customer identifier
|
|
4038
|
+
* @type {string}
|
|
4039
|
+
* @memberof PlatformApiGetCustomer
|
|
4040
|
+
*/
|
|
4041
|
+
readonly customerId: string
|
|
4042
|
+
}
|
|
4043
|
+
|
|
3358
4044
|
/**
|
|
3359
4045
|
* Request parameters for getFulfillment operation in PlatformApi.
|
|
3360
4046
|
* @export
|
|
@@ -3453,6 +4139,27 @@ export interface PlatformApiListAvailableFulfillersRequest {
|
|
|
3453
4139
|
readonly fulfillmentId: string
|
|
3454
4140
|
}
|
|
3455
4141
|
|
|
4142
|
+
/**
|
|
4143
|
+
* Request parameters for listCustomers operation in PlatformApi.
|
|
4144
|
+
* @export
|
|
4145
|
+
* @interface PlatformApiListCustomersRequest
|
|
4146
|
+
*/
|
|
4147
|
+
export interface PlatformApiListCustomersRequest {
|
|
4148
|
+
/**
|
|
4149
|
+
* Project unique identifier
|
|
4150
|
+
* @type {string}
|
|
4151
|
+
* @memberof PlatformApiListCustomers
|
|
4152
|
+
*/
|
|
4153
|
+
readonly project: string
|
|
4154
|
+
|
|
4155
|
+
/**
|
|
4156
|
+
* The platform identifier
|
|
4157
|
+
* @type {string}
|
|
4158
|
+
* @memberof PlatformApiListCustomers
|
|
4159
|
+
*/
|
|
4160
|
+
readonly platformId: string
|
|
4161
|
+
}
|
|
4162
|
+
|
|
3456
4163
|
/**
|
|
3457
4164
|
* Request parameters for listOrders operation in PlatformApi.
|
|
3458
4165
|
* @export
|
|
@@ -3642,6 +4349,18 @@ export interface PlatformApiUpdateVariantRequest {
|
|
|
3642
4349
|
* @extends {BaseAPI}
|
|
3643
4350
|
*/
|
|
3644
4351
|
export class PlatformApi extends BaseAPI {
|
|
4352
|
+
/**
|
|
4353
|
+
* Export customers as a CSV file
|
|
4354
|
+
* @summary Export customers
|
|
4355
|
+
* @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
|
|
4356
|
+
* @param {*} [options] Override http request option.
|
|
4357
|
+
* @throws {RequiredError}
|
|
4358
|
+
* @memberof PlatformApi
|
|
4359
|
+
*/
|
|
4360
|
+
public exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
4361
|
+
return PlatformApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
4362
|
+
}
|
|
4363
|
+
|
|
3645
4364
|
/**
|
|
3646
4365
|
* Export orders as a CSV file
|
|
3647
4366
|
* @summary Export orders
|
|
@@ -3654,6 +4373,18 @@ export class PlatformApi extends BaseAPI {
|
|
|
3654
4373
|
return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
3655
4374
|
}
|
|
3656
4375
|
|
|
4376
|
+
/**
|
|
4377
|
+
* Get a customer for a platform by a given customer ID.
|
|
4378
|
+
* @summary Get customer
|
|
4379
|
+
* @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
|
|
4380
|
+
* @param {*} [options] Override http request option.
|
|
4381
|
+
* @throws {RequiredError}
|
|
4382
|
+
* @memberof PlatformApi
|
|
4383
|
+
*/
|
|
4384
|
+
public getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig) {
|
|
4385
|
+
return PlatformApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
4386
|
+
}
|
|
4387
|
+
|
|
3657
4388
|
/**
|
|
3658
4389
|
* Get a fulfillment for a platform by a given fulfillment ID.
|
|
3659
4390
|
* @summary Get fulfillment
|
|
@@ -3702,6 +4433,18 @@ export class PlatformApi extends BaseAPI {
|
|
|
3702
4433
|
return PlatformApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
|
|
3703
4434
|
}
|
|
3704
4435
|
|
|
4436
|
+
/**
|
|
4437
|
+
* List customers for a platform
|
|
4438
|
+
* @summary List customers
|
|
4439
|
+
* @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
|
|
4440
|
+
* @param {*} [options] Override http request option.
|
|
4441
|
+
* @throws {RequiredError}
|
|
4442
|
+
* @memberof PlatformApi
|
|
4443
|
+
*/
|
|
4444
|
+
public listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
4445
|
+
return PlatformApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
|
|
4446
|
+
}
|
|
4447
|
+
|
|
3705
4448
|
/**
|
|
3706
4449
|
* Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
|
|
3707
4450
|
* @summary List orders
|