@teemill/platform 0.11.1 → 0.12.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/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.11.1
7
+ * The version of the OpenAPI document: 0.12.3
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'?: string;
198
+ 'firstName': string;
199
199
  /**
200
200
  *
201
201
  * @type {string}
202
202
  * @memberof Customer
203
203
  */
204
- 'lastName'?: string;
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
  *
@@ -1002,6 +1020,24 @@ export interface Platform {
1002
1020
  * @memberof Platform
1003
1021
  */
1004
1022
  'clientGiftWrapAvailable': boolean;
1023
+ /**
1024
+ * The subscription fee for the platform
1025
+ * @type {number}
1026
+ * @memberof Platform
1027
+ */
1028
+ 'storeSubscriptionFee': number;
1029
+ /**
1030
+ * The order handling fee for the platform
1031
+ * @type {number}
1032
+ * @memberof Platform
1033
+ */
1034
+ 'orderHandlingFee': number;
1035
+ /**
1036
+ * The item handling fee for the platform
1037
+ * @type {number}
1038
+ * @memberof Platform
1039
+ */
1040
+ 'itemHandlingFee': number;
1005
1041
  }
1006
1042
  /**
1007
1043
  *
@@ -1333,6 +1369,31 @@ export interface ShippingMethod {
1333
1369
  */
1334
1370
  'discountPrice'?: Price;
1335
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
+ }
1336
1397
  /**
1337
1398
  *
1338
1399
  * @export
@@ -1391,6 +1452,24 @@ export interface UpdatePlatformRequest {
1391
1452
  * @memberof UpdatePlatformRequest
1392
1453
  */
1393
1454
  'clientGiftWrapAvailable'?: boolean;
1455
+ /**
1456
+ *
1457
+ * @type {number}
1458
+ * @memberof UpdatePlatformRequest
1459
+ */
1460
+ 'storeSubscriptionFee'?: number;
1461
+ /**
1462
+ *
1463
+ * @type {number}
1464
+ * @memberof UpdatePlatformRequest
1465
+ */
1466
+ 'orderHandlingFee'?: number;
1467
+ /**
1468
+ *
1469
+ * @type {number}
1470
+ * @memberof UpdatePlatformRequest
1471
+ */
1472
+ 'itemHandlingFee'?: number;
1394
1473
  }
1395
1474
  /**
1396
1475
  *
@@ -1455,12 +1534,6 @@ export interface ValidationError {
1455
1534
  * @memberof ValidationError
1456
1535
  */
1457
1536
  'message': string;
1458
- /**
1459
- *
1460
- * @type {{ [key: string]: Array<string>; }}
1461
- * @memberof ValidationError
1462
- */
1463
- 'errors': { [key: string]: Array<string>; };
1464
1537
  }
1465
1538
  /**
1466
1539
  *
@@ -1674,10 +1747,14 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1674
1747
  * @summary Export customers
1675
1748
  * @param {string} project Project unique identifier
1676
1749
  * @param {string} platformId The platform identifier
1750
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1751
+ * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1752
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1753
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1677
1754
  * @param {*} [options] Override http request option.
1678
1755
  * @throws {RequiredError}
1679
1756
  */
1680
- exportCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1757
+ exportCustomers: async (project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1681
1758
  // verify required parameter 'project' is not null or undefined
1682
1759
  assertParamExists('exportCustomers', 'project', project)
1683
1760
  // verify required parameter 'platformId' is not null or undefined
@@ -1706,6 +1783,24 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1706
1783
  localVarQueryParameter['project'] = project;
1707
1784
  }
1708
1785
 
1786
+ if (totalOrderCount !== undefined) {
1787
+ localVarQueryParameter['totalOrderCount'] = totalOrderCount;
1788
+ }
1789
+
1790
+ if (sortBy) {
1791
+ localVarQueryParameter['sortBy'] = sortBy;
1792
+ }
1793
+
1794
+ if (lastPurchasedStart !== undefined) {
1795
+ localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart as any instanceof Date) ?
1796
+ (lastPurchasedStart as any).toISOString() :
1797
+ lastPurchasedStart;
1798
+ }
1799
+
1800
+ if (lastPurchasedEnd !== undefined) {
1801
+ localVarQueryParameter['lastPurchasedEnd'] = lastPurchasedEnd;
1802
+ }
1803
+
1709
1804
 
1710
1805
 
1711
1806
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1777,10 +1872,14 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1777
1872
  * @param {number} [pageToken] Page reference token
1778
1873
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1779
1874
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1875
+ * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1876
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1877
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1878
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1780
1879
  * @param {*} [options] Override http request option.
1781
1880
  * @throws {RequiredError}
1782
1881
  */
1783
- listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1882
+ listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
1784
1883
  // verify required parameter 'project' is not null or undefined
1785
1884
  assertParamExists('listCustomers', 'project', project)
1786
1885
  // verify required parameter 'platformId' is not null or undefined
@@ -1821,6 +1920,24 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
1821
1920
  localVarQueryParameter['search'] = search;
1822
1921
  }
1823
1922
 
1923
+ if (sortBy) {
1924
+ localVarQueryParameter['sortBy'] = sortBy;
1925
+ }
1926
+
1927
+ if (totalOrderCount !== undefined) {
1928
+ localVarQueryParameter['totalOrderCount'] = totalOrderCount;
1929
+ }
1930
+
1931
+ if (lastPurchasedStart !== undefined) {
1932
+ localVarQueryParameter['lastPurchasedStart'] = (lastPurchasedStart as any instanceof Date) ?
1933
+ (lastPurchasedStart as any).toISOString() :
1934
+ lastPurchasedStart;
1935
+ }
1936
+
1937
+ if (lastPurchasedEnd !== undefined) {
1938
+ localVarQueryParameter['lastPurchasedEnd'] = lastPurchasedEnd;
1939
+ }
1940
+
1824
1941
 
1825
1942
 
1826
1943
  setSearchParams(localVarUrlObj, localVarQueryParameter);
@@ -1847,11 +1964,15 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1847
1964
  * @summary Export customers
1848
1965
  * @param {string} project Project unique identifier
1849
1966
  * @param {string} platformId The platform identifier
1967
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1968
+ * @param {Array<ExportCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1969
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1970
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1850
1971
  * @param {*} [options] Override http request option.
1851
1972
  * @throws {RequiredError}
1852
1973
  */
1853
- async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
1854
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
1974
+ async exportCustomers(project: string, platformId: string, totalOrderCount?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
1975
+ const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, totalOrderCount, sortBy, lastPurchasedStart, lastPurchasedEnd, options);
1855
1976
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1856
1977
  const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
1857
1978
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1879,11 +2000,15 @@ export const CustomersApiFp = function(configuration?: Configuration) {
1879
2000
  * @param {number} [pageToken] Page reference token
1880
2001
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1881
2002
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2003
+ * @param {Array<ListCustomersSortByEnum>} [sortBy] An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2004
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
2005
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
2006
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1882
2007
  * @param {*} [options] Override http request option.
1883
2008
  * @throws {RequiredError}
1884
2009
  */
1885
- async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
1886
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
2010
+ async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
2011
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, totalOrderCount, lastPurchasedStart, lastPurchasedEnd, options);
1887
2012
  const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
1888
2013
  const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
1889
2014
  return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -1906,7 +2031,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
1906
2031
  * @throws {RequiredError}
1907
2032
  */
1908
2033
  exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
1909
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
2034
+ return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
1910
2035
  },
1911
2036
  /**
1912
2037
  * Get a customer for a platform by a given customer ID.
@@ -1926,7 +2051,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
1926
2051
  * @throws {RequiredError}
1927
2052
  */
1928
2053
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
1929
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
2054
+ return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
1930
2055
  },
1931
2056
  };
1932
2057
  };
@@ -1950,6 +2075,34 @@ export interface CustomersApiExportCustomersRequest {
1950
2075
  * @memberof CustomersApiExportCustomers
1951
2076
  */
1952
2077
  readonly platformId: string
2078
+
2079
+ /**
2080
+ * Filter customers by total order count equal to the value provided
2081
+ * @type {number}
2082
+ * @memberof CustomersApiExportCustomers
2083
+ */
2084
+ readonly totalOrderCount?: number
2085
+
2086
+ /**
2087
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2088
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
2089
+ * @memberof CustomersApiExportCustomers
2090
+ */
2091
+ readonly sortBy?: Array<ExportCustomersSortByEnum>
2092
+
2093
+ /**
2094
+ * Start of date range to filter customers by last purchase date
2095
+ * @type {string}
2096
+ * @memberof CustomersApiExportCustomers
2097
+ */
2098
+ readonly lastPurchasedStart?: string
2099
+
2100
+ /**
2101
+ * End of date range to filter customers by last purchase date
2102
+ * @type {string}
2103
+ * @memberof CustomersApiExportCustomers
2104
+ */
2105
+ readonly lastPurchasedEnd?: string
1953
2106
  }
1954
2107
 
1955
2108
  /**
@@ -2020,6 +2173,34 @@ export interface CustomersApiListCustomersRequest {
2020
2173
  * @memberof CustomersApiListCustomers
2021
2174
  */
2022
2175
  readonly search?: string
2176
+
2177
+ /**
2178
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
2179
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
2180
+ * @memberof CustomersApiListCustomers
2181
+ */
2182
+ readonly sortBy?: Array<ListCustomersSortByEnum>
2183
+
2184
+ /**
2185
+ * Filter customers by total order count equal to the value provided
2186
+ * @type {number}
2187
+ * @memberof CustomersApiListCustomers
2188
+ */
2189
+ readonly totalOrderCount?: number
2190
+
2191
+ /**
2192
+ * Start of date range to filter customers by last purchase date
2193
+ * @type {string}
2194
+ * @memberof CustomersApiListCustomers
2195
+ */
2196
+ readonly lastPurchasedStart?: string
2197
+
2198
+ /**
2199
+ * End of date range to filter customers by last purchase date
2200
+ * @type {string}
2201
+ * @memberof CustomersApiListCustomers
2202
+ */
2203
+ readonly lastPurchasedEnd?: string
2023
2204
  }
2024
2205
 
2025
2206
  /**
@@ -2038,7 +2219,7 @@ export class CustomersApi extends BaseAPI {
2038
2219
  * @memberof CustomersApi
2039
2220
  */
2040
2221
  public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
2041
- return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
2222
+ return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.totalOrderCount, requestParameters.sortBy, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2042
2223
  }
2043
2224
 
2044
2225
  /**
@@ -2062,10 +2243,34 @@ export class CustomersApi extends BaseAPI {
2062
2243
  * @memberof CustomersApi
2063
2244
  */
2064
2245
  public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
2065
- return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
2246
+ return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.totalOrderCount, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
2066
2247
  }
2067
2248
  }
2068
2249
 
2250
+ /**
2251
+ * @export
2252
+ */
2253
+ export const ExportCustomersSortByEnum = {
2254
+ LifetimeValue: '+lifetimeValue',
2255
+ LifetimeValue2: '-lifetimeValue',
2256
+ TotalOrderCount: '+totalOrderCount',
2257
+ TotalOrderCount2: '-totalOrderCount',
2258
+ LastPurchased: '+lastPurchased',
2259
+ LastPurchased2: '-lastPurchased'
2260
+ } as const;
2261
+ export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
2262
+ /**
2263
+ * @export
2264
+ */
2265
+ export const ListCustomersSortByEnum = {
2266
+ LifetimeValue: '+lifetimeValue',
2267
+ LifetimeValue2: '-lifetimeValue',
2268
+ TotalOrderCount: '+totalOrderCount',
2269
+ TotalOrderCount2: '-totalOrderCount',
2270
+ LastPurchased: '+lastPurchased',
2271
+ LastPurchased2: '-lastPurchased'
2272
+ } as const;
2273
+ export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
2069
2274
 
2070
2275
 
2071
2276
  /**
@@ -2080,7 +2285,7 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
2080
2285
  * @param {string} project Project unique identifier
2081
2286
  * @param {string} platformId The platform identifier
2082
2287
  * @param {string} start Start of date range to filter by when orders were placed
2083
- * @param {string} [end] End of date range to filter by when orders were placed
2288
+ * @param {string} [end] End of date range to filter when orders were placed
2084
2289
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2085
2290
  * @param {*} [options] Override http request option.
2086
2291
  * @throws {RequiredError}
@@ -2307,8 +2512,8 @@ export const OrdersApiAxiosParamCreator = function (configuration?: Configuratio
2307
2512
  * @param {number} [pageToken] Page reference token
2308
2513
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2309
2514
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2310
- * @param {string} [start] Start of date range to filter by when orders were placed
2311
- * @param {string} [end] End of date range to filter by when orders were placed
2515
+ * @param {string} [start] Start of date range to filter when orders were placed
2516
+ * @param {string} [end] End of date range to filter when orders were placed
2312
2517
  * @param {*} [options] Override http request option.
2313
2518
  * @throws {RequiredError}
2314
2519
  */
@@ -2450,7 +2655,7 @@ export const OrdersApiFp = function(configuration?: Configuration) {
2450
2655
  * @param {string} project Project unique identifier
2451
2656
  * @param {string} platformId The platform identifier
2452
2657
  * @param {string} start Start of date range to filter by when orders were placed
2453
- * @param {string} [end] End of date range to filter by when orders were placed
2658
+ * @param {string} [end] End of date range to filter when orders were placed
2454
2659
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2455
2660
  * @param {*} [options] Override http request option.
2456
2661
  * @throws {RequiredError}
@@ -2514,8 +2719,8 @@ export const OrdersApiFp = function(configuration?: Configuration) {
2514
2719
  * @param {number} [pageToken] Page reference token
2515
2720
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2516
2721
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2517
- * @param {string} [start] Start of date range to filter by when orders were placed
2518
- * @param {string} [end] End of date range to filter by when orders were placed
2722
+ * @param {string} [start] Start of date range to filter when orders were placed
2723
+ * @param {string} [end] End of date range to filter when orders were placed
2519
2724
  * @param {*} [options] Override http request option.
2520
2725
  * @throws {RequiredError}
2521
2726
  */
@@ -2642,7 +2847,7 @@ export interface OrdersApiExportOrdersRequest {
2642
2847
  readonly start: string
2643
2848
 
2644
2849
  /**
2645
- * End of date range to filter by when orders were placed
2850
+ * End of date range to filter when orders were placed
2646
2851
  * @type {string}
2647
2852
  * @memberof OrdersApiExportOrders
2648
2853
  */
@@ -2782,14 +2987,14 @@ export interface OrdersApiListOrdersRequest {
2782
2987
  readonly search?: string
2783
2988
 
2784
2989
  /**
2785
- * Start of date range to filter by when orders were placed
2990
+ * Start of date range to filter when orders were placed
2786
2991
  * @type {string}
2787
2992
  * @memberof OrdersApiListOrders
2788
2993
  */
2789
2994
  readonly start?: string
2790
2995
 
2791
2996
  /**
2792
- * End of date range to filter by when orders were placed
2997
+ * End of date range to filter when orders were placed
2793
2998
  * @type {string}
2794
2999
  * @memberof OrdersApiListOrders
2795
3000
  */
@@ -2920,20 +3125,16 @@ export class OrdersApi extends BaseAPI {
2920
3125
  export const PlatformApiAxiosParamCreator = function (configuration?: Configuration) {
2921
3126
  return {
2922
3127
  /**
2923
- * Export customers as a CSV file
2924
- * @summary Export customers
3128
+ *
3129
+ * @summary Get platform details
2925
3130
  * @param {string} project Project unique identifier
2926
- * @param {string} platformId The platform identifier
2927
3131
  * @param {*} [options] Override http request option.
2928
3132
  * @throws {RequiredError}
2929
3133
  */
2930
- exportCustomers: async (project: string, platformId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3134
+ getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2931
3135
  // verify required parameter 'project' is not null or undefined
2932
- assertParamExists('exportCustomers', 'project', project)
2933
- // verify required parameter 'platformId' is not null or undefined
2934
- assertParamExists('exportCustomers', 'platformId', platformId)
2935
- const localVarPath = `/v1/platform/{platformId}/customers/export`
2936
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3136
+ assertParamExists('getPlatform', 'project', project)
3137
+ const localVarPath = `/v1/platform`;
2937
3138
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2938
3139
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2939
3140
  let baseOptions;
@@ -2968,25 +3169,19 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
2968
3169
  };
2969
3170
  },
2970
3171
  /**
2971
- * Export orders as a CSV file
2972
- * @summary Export orders
3172
+ *
3173
+ * @summary Update platform
2973
3174
  * @param {string} project Project unique identifier
2974
- * @param {string} platformId The platform identifier
2975
- * @param {string} start Start of date range to filter by when orders were placed
2976
- * @param {string} [end] End of date range to filter by when orders were placed
2977
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3175
+ * @param {UpdatePlatformRequest} updatePlatformRequest
2978
3176
  * @param {*} [options] Override http request option.
2979
3177
  * @throws {RequiredError}
2980
3178
  */
2981
- exportOrders: async (project: string, platformId: string, start: string, end?: string, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3179
+ updatePlatform: async (project: string, updatePlatformRequest: UpdatePlatformRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
2982
3180
  // verify required parameter 'project' is not null or undefined
2983
- assertParamExists('exportOrders', 'project', project)
2984
- // verify required parameter 'platformId' is not null or undefined
2985
- assertParamExists('exportOrders', 'platformId', platformId)
2986
- // verify required parameter 'start' is not null or undefined
2987
- assertParamExists('exportOrders', 'start', start)
2988
- const localVarPath = `/v1/platform/{platformId}/orders/export`
2989
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3181
+ assertParamExists('updatePlatform', 'project', project)
3182
+ // verify required parameter 'updatePlatformRequest' is not null or undefined
3183
+ assertParamExists('updatePlatform', 'updatePlatformRequest', updatePlatformRequest)
3184
+ const localVarPath = `/v1/platform`;
2990
3185
  // use dummy base URL string because the URL constructor only accepts absolute URLs.
2991
3186
  const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
2992
3187
  let baseOptions;
@@ -2994,7 +3189,7 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
2994
3189
  baseOptions = configuration.baseOptions;
2995
3190
  }
2996
3191
 
2997
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3192
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
2998
3193
  const localVarHeaderParameter = {} as any;
2999
3194
  const localVarQueryParameter = {} as any;
3000
3195
 
@@ -3009,1324 +3204,102 @@ export const PlatformApiAxiosParamCreator = function (configuration?: Configurat
3009
3204
  localVarQueryParameter['project'] = project;
3010
3205
  }
3011
3206
 
3012
- if (start !== undefined) {
3013
- localVarQueryParameter['start'] = (start as any instanceof Date) ?
3014
- (start as any).toISOString() :
3015
- start;
3016
- }
3017
-
3018
- if (end !== undefined) {
3019
- localVarQueryParameter['end'] = (end as any instanceof Date) ?
3020
- (end as any).toISOString() :
3021
- end;
3022
- }
3023
-
3024
- if (search !== undefined) {
3025
- localVarQueryParameter['search'] = search;
3026
- }
3027
-
3028
3207
 
3029
3208
 
3209
+ localVarHeaderParameter['Content-Type'] = 'application/json';
3210
+
3030
3211
  setSearchParams(localVarUrlObj, localVarQueryParameter);
3031
3212
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3032
3213
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3214
+ localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformRequest, localVarRequestOptions, configuration)
3033
3215
 
3034
3216
  return {
3035
3217
  url: toPathString(localVarUrlObj),
3036
3218
  options: localVarRequestOptions,
3037
3219
  };
3038
3220
  },
3221
+ }
3222
+ };
3223
+
3224
+ /**
3225
+ * PlatformApi - functional programming interface
3226
+ * @export
3227
+ */
3228
+ export const PlatformApiFp = function(configuration?: Configuration) {
3229
+ const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
3230
+ return {
3039
3231
  /**
3040
- * Get a customer for a platform by a given customer ID.
3041
- * @summary Get customer
3232
+ *
3233
+ * @summary Get platform details
3042
3234
  * @param {string} project Project unique identifier
3043
- * @param {string} platformId The platform identifier
3044
- * @param {string} customerId The customer identifier
3045
3235
  * @param {*} [options] Override http request option.
3046
3236
  * @throws {RequiredError}
3047
3237
  */
3048
- getCustomer: async (project: string, platformId: string, customerId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3049
- // verify required parameter 'project' is not null or undefined
3050
- assertParamExists('getCustomer', 'project', project)
3051
- // verify required parameter 'platformId' is not null or undefined
3052
- assertParamExists('getCustomer', 'platformId', platformId)
3053
- // verify required parameter 'customerId' is not null or undefined
3054
- assertParamExists('getCustomer', 'customerId', customerId)
3055
- const localVarPath = `/v1/platform/{platformId}/customers/{customerId}`
3056
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3057
- .replace(`{${"customerId"}}`, encodeURIComponent(String(customerId)));
3058
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3059
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3060
- let baseOptions;
3061
- if (configuration) {
3062
- baseOptions = configuration.baseOptions;
3063
- }
3064
-
3065
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3066
- const localVarHeaderParameter = {} as any;
3067
- const localVarQueryParameter = {} as any;
3068
-
3069
- // authentication session-oauth required
3070
- // oauth required
3071
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3072
-
3073
- // authentication api-key required
3074
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3075
-
3076
- if (project !== undefined) {
3077
- localVarQueryParameter['project'] = project;
3078
- }
3079
-
3080
-
3081
-
3082
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3083
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3084
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3085
-
3086
- return {
3087
- url: toPathString(localVarUrlObj),
3088
- options: localVarRequestOptions,
3089
- };
3238
+ async getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
3239
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getPlatform(project, options);
3240
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3241
+ const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
3242
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3090
3243
  },
3091
3244
  /**
3092
- * Get a fulfillment for a platform by a given fulfillment ID.
3093
- * @summary Get fulfillment
3245
+ *
3246
+ * @summary Update platform
3094
3247
  * @param {string} project Project unique identifier
3095
- * @param {string} platformId The platform identifier
3096
- * @param {string} fulfillmentId The fulfillment identifier
3248
+ * @param {UpdatePlatformRequest} updatePlatformRequest
3097
3249
  * @param {*} [options] Override http request option.
3098
3250
  * @throws {RequiredError}
3099
3251
  */
3100
- getFulfillment: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3101
- // verify required parameter 'project' is not null or undefined
3102
- assertParamExists('getFulfillment', 'project', project)
3103
- // verify required parameter 'platformId' is not null or undefined
3104
- assertParamExists('getFulfillment', 'platformId', platformId)
3105
- // verify required parameter 'fulfillmentId' is not null or undefined
3106
- assertParamExists('getFulfillment', 'fulfillmentId', fulfillmentId)
3107
- const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
3108
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3109
- .replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
3110
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3111
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3112
- let baseOptions;
3113
- if (configuration) {
3114
- baseOptions = configuration.baseOptions;
3115
- }
3116
-
3117
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3118
- const localVarHeaderParameter = {} as any;
3119
- const localVarQueryParameter = {} as any;
3120
-
3121
- // authentication session-oauth required
3122
- // oauth required
3123
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3124
-
3125
- // authentication api-key required
3126
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3127
-
3128
- if (project !== undefined) {
3129
- localVarQueryParameter['project'] = project;
3130
- }
3131
-
3132
-
3133
-
3134
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3135
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3136
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3137
-
3138
- return {
3139
- url: toPathString(localVarUrlObj),
3140
- options: localVarRequestOptions,
3141
- };
3142
- },
3143
- /**
3144
- * Get an order for a platform by a given order ID.
3145
- * @summary Get order
3146
- * @param {string} project Project unique identifier
3147
- * @param {string} platformId The platform identifier
3148
- * @param {string} orderId The order identifier
3149
- * @param {*} [options] Override http request option.
3150
- * @throws {RequiredError}
3151
- */
3152
- getOrder: async (project: string, platformId: string, orderId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3153
- // verify required parameter 'project' is not null or undefined
3154
- assertParamExists('getOrder', 'project', project)
3155
- // verify required parameter 'platformId' is not null or undefined
3156
- assertParamExists('getOrder', 'platformId', platformId)
3157
- // verify required parameter 'orderId' is not null or undefined
3158
- assertParamExists('getOrder', 'orderId', orderId)
3159
- const localVarPath = `/v1/platform/{platformId}/orders/{orderId}`
3160
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3161
- .replace(`{${"orderId"}}`, encodeURIComponent(String(orderId)));
3162
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3163
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3164
- let baseOptions;
3165
- if (configuration) {
3166
- baseOptions = configuration.baseOptions;
3167
- }
3168
-
3169
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3170
- const localVarHeaderParameter = {} as any;
3171
- const localVarQueryParameter = {} as any;
3172
-
3173
- // authentication session-oauth required
3174
- // oauth required
3175
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3176
-
3177
- // authentication api-key required
3178
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3179
-
3180
- if (project !== undefined) {
3181
- localVarQueryParameter['project'] = project;
3182
- }
3183
-
3184
-
3185
-
3186
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3187
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3188
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3189
-
3190
- return {
3191
- url: toPathString(localVarUrlObj),
3192
- options: localVarRequestOptions,
3193
- };
3194
- },
3195
- /**
3196
- *
3197
- * @summary Get platform details
3198
- * @param {string} project Project unique identifier
3199
- * @param {*} [options] Override http request option.
3200
- * @throws {RequiredError}
3201
- */
3202
- getPlatform: async (project: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3203
- // verify required parameter 'project' is not null or undefined
3204
- assertParamExists('getPlatform', 'project', project)
3205
- const localVarPath = `/v1/platform`;
3206
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3207
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3208
- let baseOptions;
3209
- if (configuration) {
3210
- baseOptions = configuration.baseOptions;
3211
- }
3212
-
3213
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3214
- const localVarHeaderParameter = {} as any;
3215
- const localVarQueryParameter = {} as any;
3216
-
3217
- // authentication session-oauth required
3218
- // oauth required
3219
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3220
-
3221
- // authentication api-key required
3222
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3223
-
3224
- if (project !== undefined) {
3225
- localVarQueryParameter['project'] = project;
3226
- }
3227
-
3228
-
3229
-
3230
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3231
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3232
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3233
-
3234
- return {
3235
- url: toPathString(localVarUrlObj),
3236
- options: localVarRequestOptions,
3237
- };
3238
- },
3239
- /**
3240
- * List available fulfillers for a given fulfillment
3241
- * @summary List available fulfillers
3242
- * @param {string} project Project unique identifier
3243
- * @param {string} platformId The platform identifier
3244
- * @param {string} fulfillmentId The fulfillment identifier
3245
- * @param {*} [options] Override http request option.
3246
- * @throws {RequiredError}
3247
- */
3248
- listAvailableFulfillers: async (project: string, platformId: string, fulfillmentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3249
- // verify required parameter 'project' is not null or undefined
3250
- assertParamExists('listAvailableFulfillers', 'project', project)
3251
- // verify required parameter 'platformId' is not null or undefined
3252
- assertParamExists('listAvailableFulfillers', 'platformId', platformId)
3253
- // verify required parameter 'fulfillmentId' is not null or undefined
3254
- assertParamExists('listAvailableFulfillers', 'fulfillmentId', fulfillmentId)
3255
- const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}/available-fulfillers`
3256
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3257
- .replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
3258
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3259
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3260
- let baseOptions;
3261
- if (configuration) {
3262
- baseOptions = configuration.baseOptions;
3263
- }
3264
-
3265
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3266
- const localVarHeaderParameter = {} as any;
3267
- const localVarQueryParameter = {} as any;
3268
-
3269
- // authentication session-oauth required
3270
- // oauth required
3271
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3272
-
3273
- // authentication api-key required
3274
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3275
-
3276
- if (project !== undefined) {
3277
- localVarQueryParameter['project'] = project;
3278
- }
3279
-
3280
-
3281
-
3282
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3283
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3284
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3285
-
3286
- return {
3287
- url: toPathString(localVarUrlObj),
3288
- options: localVarRequestOptions,
3289
- };
3290
- },
3291
- /**
3292
- * List customers for a platform
3293
- * @summary List customers
3294
- * @param {string} project Project unique identifier
3295
- * @param {string} platformId The platform identifier
3296
- * @param {number} [pageToken] Page reference token
3297
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3298
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3299
- * @param {*} [options] Override http request option.
3300
- * @throws {RequiredError}
3301
- */
3302
- listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3303
- // verify required parameter 'project' is not null or undefined
3304
- assertParamExists('listCustomers', 'project', project)
3305
- // verify required parameter 'platformId' is not null or undefined
3306
- assertParamExists('listCustomers', 'platformId', platformId)
3307
- const localVarPath = `/v1/platform/{platformId}/customers`
3308
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3309
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3310
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3311
- let baseOptions;
3312
- if (configuration) {
3313
- baseOptions = configuration.baseOptions;
3314
- }
3315
-
3316
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3317
- const localVarHeaderParameter = {} as any;
3318
- const localVarQueryParameter = {} as any;
3319
-
3320
- // authentication session-oauth required
3321
- // oauth required
3322
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3323
-
3324
- // authentication api-key required
3325
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3326
-
3327
- if (project !== undefined) {
3328
- localVarQueryParameter['project'] = project;
3329
- }
3330
-
3331
- if (pageToken !== undefined) {
3332
- localVarQueryParameter['pageToken'] = pageToken;
3333
- }
3334
-
3335
- if (pageSize !== undefined) {
3336
- localVarQueryParameter['pageSize'] = pageSize;
3337
- }
3338
-
3339
- if (search !== undefined) {
3340
- localVarQueryParameter['search'] = search;
3341
- }
3342
-
3343
-
3344
-
3345
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3346
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3347
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3348
-
3349
- return {
3350
- url: toPathString(localVarUrlObj),
3351
- options: localVarRequestOptions,
3352
- };
3353
- },
3354
- /**
3355
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
3356
- * @summary List orders
3357
- * @param {string} project Project unique identifier
3358
- * @param {string} platformId The platform identifier
3359
- * @param {number} [pageToken] Page reference token
3360
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3361
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3362
- * @param {string} [start] Start of date range to filter by when orders were placed
3363
- * @param {string} [end] End of date range to filter by when orders were placed
3364
- * @param {*} [options] Override http request option.
3365
- * @throws {RequiredError}
3366
- */
3367
- listOrders: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3368
- // verify required parameter 'project' is not null or undefined
3369
- assertParamExists('listOrders', 'project', project)
3370
- // verify required parameter 'platformId' is not null or undefined
3371
- assertParamExists('listOrders', 'platformId', platformId)
3372
- const localVarPath = `/v1/platform/{platformId}/orders`
3373
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
3374
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3375
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3376
- let baseOptions;
3377
- if (configuration) {
3378
- baseOptions = configuration.baseOptions;
3379
- }
3380
-
3381
- const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
3382
- const localVarHeaderParameter = {} as any;
3383
- const localVarQueryParameter = {} as any;
3384
-
3385
- // authentication session-oauth required
3386
- // oauth required
3387
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3388
-
3389
- // authentication api-key required
3390
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3391
-
3392
- if (project !== undefined) {
3393
- localVarQueryParameter['project'] = project;
3394
- }
3395
-
3396
- if (pageToken !== undefined) {
3397
- localVarQueryParameter['pageToken'] = pageToken;
3398
- }
3399
-
3400
- if (pageSize !== undefined) {
3401
- localVarQueryParameter['pageSize'] = pageSize;
3402
- }
3403
-
3404
- if (search !== undefined) {
3405
- localVarQueryParameter['search'] = search;
3406
- }
3407
-
3408
- if (start !== undefined) {
3409
- localVarQueryParameter['start'] = (start as any instanceof Date) ?
3410
- (start as any).toISOString() :
3411
- start;
3412
- }
3413
-
3414
- if (end !== undefined) {
3415
- localVarQueryParameter['end'] = (end as any instanceof Date) ?
3416
- (end as any).toISOString() :
3417
- end;
3418
- }
3419
-
3420
-
3421
-
3422
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3423
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3424
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3425
-
3426
- return {
3427
- url: toPathString(localVarUrlObj),
3428
- options: localVarRequestOptions,
3429
- };
3430
- },
3431
- /**
3432
- * Update a fulfillment that belongs to an order placed through the platform
3433
- * @summary Update fulfillment
3434
- * @param {string} project Project unique identifier
3435
- * @param {string} platformId The platform identifier
3436
- * @param {string} fulfillmentId The fulfillment identifier
3437
- * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
3438
- * @param {*} [options] Override http request option.
3439
- * @throws {RequiredError}
3440
- */
3441
- updateFulfillment: async (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3442
- // verify required parameter 'project' is not null or undefined
3443
- assertParamExists('updateFulfillment', 'project', project)
3444
- // verify required parameter 'platformId' is not null or undefined
3445
- assertParamExists('updateFulfillment', 'platformId', platformId)
3446
- // verify required parameter 'fulfillmentId' is not null or undefined
3447
- assertParamExists('updateFulfillment', 'fulfillmentId', fulfillmentId)
3448
- // verify required parameter 'updateFulfillmentRequest' is not null or undefined
3449
- assertParamExists('updateFulfillment', 'updateFulfillmentRequest', updateFulfillmentRequest)
3450
- const localVarPath = `/v1/platform/{platformId}/fulfillments/{fulfillmentId}`
3451
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3452
- .replace(`{${"fulfillmentId"}}`, encodeURIComponent(String(fulfillmentId)));
3453
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3454
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3455
- let baseOptions;
3456
- if (configuration) {
3457
- baseOptions = configuration.baseOptions;
3458
- }
3459
-
3460
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3461
- const localVarHeaderParameter = {} as any;
3462
- const localVarQueryParameter = {} as any;
3463
-
3464
- // authentication session-oauth required
3465
- // oauth required
3466
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3467
-
3468
- // authentication api-key required
3469
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3470
-
3471
- if (project !== undefined) {
3472
- localVarQueryParameter['project'] = project;
3473
- }
3474
-
3475
-
3476
-
3477
- localVarHeaderParameter['Content-Type'] = 'application/json';
3478
-
3479
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3480
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3481
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3482
- localVarRequestOptions.data = serializeDataIfNeeded(updateFulfillmentRequest, localVarRequestOptions, configuration)
3483
-
3484
- return {
3485
- url: toPathString(localVarUrlObj),
3486
- options: localVarRequestOptions,
3487
- };
3488
- },
3489
- /**
3490
- *
3491
- * @summary Update platform
3492
- * @param {string} project Project unique identifier
3493
- * @param {UpdatePlatformRequest} updatePlatformRequest
3494
- * @param {*} [options] Override http request option.
3495
- * @throws {RequiredError}
3496
- */
3497
- updatePlatform: async (project: string, updatePlatformRequest: UpdatePlatformRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3498
- // verify required parameter 'project' is not null or undefined
3499
- assertParamExists('updatePlatform', 'project', project)
3500
- // verify required parameter 'updatePlatformRequest' is not null or undefined
3501
- assertParamExists('updatePlatform', 'updatePlatformRequest', updatePlatformRequest)
3502
- const localVarPath = `/v1/platform`;
3503
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3504
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3505
- let baseOptions;
3506
- if (configuration) {
3507
- baseOptions = configuration.baseOptions;
3508
- }
3509
-
3510
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3511
- const localVarHeaderParameter = {} as any;
3512
- const localVarQueryParameter = {} as any;
3513
-
3514
- // authentication session-oauth required
3515
- // oauth required
3516
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3517
-
3518
- // authentication api-key required
3519
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3520
-
3521
- if (project !== undefined) {
3522
- localVarQueryParameter['project'] = project;
3523
- }
3524
-
3525
-
3526
-
3527
- localVarHeaderParameter['Content-Type'] = 'application/json';
3528
-
3529
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3530
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3531
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3532
- localVarRequestOptions.data = serializeDataIfNeeded(updatePlatformRequest, localVarRequestOptions, configuration)
3533
-
3534
- return {
3535
- url: toPathString(localVarUrlObj),
3536
- options: localVarRequestOptions,
3537
- };
3538
- },
3539
- /**
3540
- * Updates the warehouse product and its variants
3541
- * @summary Update warehouse product
3542
- * @param {string} project Project unique identifier
3543
- * @param {string} platformId The platform identifier
3544
- * @param {string} productId Products unique identifier
3545
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3546
- * @param {*} [options] Override http request option.
3547
- * @throws {RequiredError}
3548
- */
3549
- updateProduct: async (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3550
- // verify required parameter 'project' is not null or undefined
3551
- assertParamExists('updateProduct', 'project', project)
3552
- // verify required parameter 'platformId' is not null or undefined
3553
- assertParamExists('updateProduct', 'platformId', platformId)
3554
- // verify required parameter 'productId' is not null or undefined
3555
- assertParamExists('updateProduct', 'productId', productId)
3556
- // verify required parameter 'updateProductRequest' is not null or undefined
3557
- assertParamExists('updateProduct', 'updateProductRequest', updateProductRequest)
3558
- const localVarPath = `/v1/platform/{platformId}/warehouse/products/{productId}`
3559
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3560
- .replace(`{${"productId"}}`, encodeURIComponent(String(productId)));
3561
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3562
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3563
- let baseOptions;
3564
- if (configuration) {
3565
- baseOptions = configuration.baseOptions;
3566
- }
3567
-
3568
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3569
- const localVarHeaderParameter = {} as any;
3570
- const localVarQueryParameter = {} as any;
3571
-
3572
- // authentication session-oauth required
3573
- // oauth required
3574
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3575
-
3576
- // authentication api-key required
3577
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3578
-
3579
- if (project !== undefined) {
3580
- localVarQueryParameter['project'] = project;
3581
- }
3582
-
3583
-
3584
-
3585
- localVarHeaderParameter['Content-Type'] = 'application/json';
3586
-
3587
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3588
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3589
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3590
- localVarRequestOptions.data = serializeDataIfNeeded(updateProductRequest, localVarRequestOptions, configuration)
3591
-
3592
- return {
3593
- url: toPathString(localVarUrlObj),
3594
- options: localVarRequestOptions,
3595
- };
3596
- },
3597
- /**
3598
- * Updates the warehouse variant
3599
- * @summary Update warehouse variant
3600
- * @param {string} project Project unique identifier
3601
- * @param {string} platformId The platform identifier
3602
- * @param {string} variantId Variants unique identifier
3603
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3604
- * @param {*} [options] Override http request option.
3605
- * @throws {RequiredError}
3606
- */
3607
- updateVariant: async (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
3608
- // verify required parameter 'project' is not null or undefined
3609
- assertParamExists('updateVariant', 'project', project)
3610
- // verify required parameter 'platformId' is not null or undefined
3611
- assertParamExists('updateVariant', 'platformId', platformId)
3612
- // verify required parameter 'variantId' is not null or undefined
3613
- assertParamExists('updateVariant', 'variantId', variantId)
3614
- // verify required parameter 'updateVariantRequest' is not null or undefined
3615
- assertParamExists('updateVariant', 'updateVariantRequest', updateVariantRequest)
3616
- const localVarPath = `/v1/platform/{platformId}/warehouse/variants/{variantId}`
3617
- .replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)))
3618
- .replace(`{${"variantId"}}`, encodeURIComponent(String(variantId)));
3619
- // use dummy base URL string because the URL constructor only accepts absolute URLs.
3620
- const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
3621
- let baseOptions;
3622
- if (configuration) {
3623
- baseOptions = configuration.baseOptions;
3624
- }
3625
-
3626
- const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
3627
- const localVarHeaderParameter = {} as any;
3628
- const localVarQueryParameter = {} as any;
3629
-
3630
- // authentication session-oauth required
3631
- // oauth required
3632
- await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
3633
-
3634
- // authentication api-key required
3635
- await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
3636
-
3637
- if (project !== undefined) {
3638
- localVarQueryParameter['project'] = project;
3639
- }
3640
-
3641
-
3642
-
3643
- localVarHeaderParameter['Content-Type'] = 'application/json';
3644
-
3645
- setSearchParams(localVarUrlObj, localVarQueryParameter);
3646
- let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
3647
- localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
3648
- localVarRequestOptions.data = serializeDataIfNeeded(updateVariantRequest, localVarRequestOptions, configuration)
3649
-
3650
- return {
3651
- url: toPathString(localVarUrlObj),
3652
- options: localVarRequestOptions,
3653
- };
3654
- },
3655
- }
3656
- };
3657
-
3658
- /**
3659
- * PlatformApi - functional programming interface
3660
- * @export
3661
- */
3662
- export const PlatformApiFp = function(configuration?: Configuration) {
3663
- const localVarAxiosParamCreator = PlatformApiAxiosParamCreator(configuration)
3664
- return {
3665
- /**
3666
- * Export customers as a CSV file
3667
- * @summary Export customers
3668
- * @param {string} project Project unique identifier
3669
- * @param {string} platformId The platform identifier
3670
- * @param {*} [options] Override http request option.
3671
- * @throws {RequiredError}
3672
- */
3673
- async exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3674
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, options);
3675
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3676
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
3677
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3678
- },
3679
- /**
3680
- * Export orders as a CSV file
3681
- * @summary Export orders
3682
- * @param {string} project Project unique identifier
3683
- * @param {string} platformId The platform identifier
3684
- * @param {string} start Start of date range to filter by when orders were placed
3685
- * @param {string} [end] End of date range to filter by when orders were placed
3686
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3687
- * @param {*} [options] Override http request option.
3688
- * @throws {RequiredError}
3689
- */
3690
- async exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
3691
- const localVarAxiosArgs = await localVarAxiosParamCreator.exportOrders(project, platformId, start, end, search, options);
3692
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3693
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.exportOrders']?.[localVarOperationServerIndex]?.url;
3694
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3695
- },
3696
- /**
3697
- * Get a customer for a platform by a given customer ID.
3698
- * @summary Get customer
3699
- * @param {string} project Project unique identifier
3700
- * @param {string} platformId The platform identifier
3701
- * @param {string} customerId The customer identifier
3702
- * @param {*} [options] Override http request option.
3703
- * @throws {RequiredError}
3704
- */
3705
- async getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>> {
3706
- const localVarAxiosArgs = await localVarAxiosParamCreator.getCustomer(project, platformId, customerId, options);
3707
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3708
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.getCustomer']?.[localVarOperationServerIndex]?.url;
3709
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3710
- },
3711
- /**
3712
- * Get a fulfillment for a platform by a given fulfillment ID.
3713
- * @summary Get fulfillment
3714
- * @param {string} project Project unique identifier
3715
- * @param {string} platformId The platform identifier
3716
- * @param {string} fulfillmentId The fulfillment identifier
3717
- * @param {*} [options] Override http request option.
3718
- * @throws {RequiredError}
3719
- */
3720
- async getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
3721
- const localVarAxiosArgs = await localVarAxiosParamCreator.getFulfillment(project, platformId, fulfillmentId, options);
3722
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3723
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.getFulfillment']?.[localVarOperationServerIndex]?.url;
3724
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3725
- },
3726
- /**
3727
- * Get an order for a platform by a given order ID.
3728
- * @summary Get order
3729
- * @param {string} project Project unique identifier
3730
- * @param {string} platformId The platform identifier
3731
- * @param {string} orderId The order identifier
3732
- * @param {*} [options] Override http request option.
3733
- * @throws {RequiredError}
3734
- */
3735
- async getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>> {
3736
- const localVarAxiosArgs = await localVarAxiosParamCreator.getOrder(project, platformId, orderId, options);
3737
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3738
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.getOrder']?.[localVarOperationServerIndex]?.url;
3739
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3740
- },
3741
- /**
3742
- *
3743
- * @summary Get platform details
3744
- * @param {string} project Project unique identifier
3745
- * @param {*} [options] Override http request option.
3746
- * @throws {RequiredError}
3747
- */
3748
- async getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
3749
- const localVarAxiosArgs = await localVarAxiosParamCreator.getPlatform(project, options);
3750
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3751
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.getPlatform']?.[localVarOperationServerIndex]?.url;
3752
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3753
- },
3754
- /**
3755
- * List available fulfillers for a given fulfillment
3756
- * @summary List available fulfillers
3757
- * @param {string} project Project unique identifier
3758
- * @param {string} platformId The platform identifier
3759
- * @param {string} fulfillmentId The fulfillment identifier
3760
- * @param {*} [options] Override http request option.
3761
- * @throws {RequiredError}
3762
- */
3763
- async listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>> {
3764
- const localVarAxiosArgs = await localVarAxiosParamCreator.listAvailableFulfillers(project, platformId, fulfillmentId, options);
3765
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3766
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.listAvailableFulfillers']?.[localVarOperationServerIndex]?.url;
3767
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3768
- },
3769
- /**
3770
- * List customers for a platform
3771
- * @summary List customers
3772
- * @param {string} project Project unique identifier
3773
- * @param {string} platformId The platform identifier
3774
- * @param {number} [pageToken] Page reference token
3775
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3776
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3777
- * @param {*} [options] Override http request option.
3778
- * @throws {RequiredError}
3779
- */
3780
- async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
3781
- const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, options);
3782
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3783
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.listCustomers']?.[localVarOperationServerIndex]?.url;
3784
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3785
- },
3786
- /**
3787
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
3788
- * @summary List orders
3789
- * @param {string} project Project unique identifier
3790
- * @param {string} platformId The platform identifier
3791
- * @param {number} [pageToken] Page reference token
3792
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
3793
- * @param {string} [search] Search term to filter based on order reference, customer name and email
3794
- * @param {string} [start] Start of date range to filter by when orders were placed
3795
- * @param {string} [end] End of date range to filter by when orders were placed
3796
- * @param {*} [options] Override http request option.
3797
- * @throws {RequiredError}
3798
- */
3799
- 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>> {
3800
- const localVarAxiosArgs = await localVarAxiosParamCreator.listOrders(project, platformId, pageToken, pageSize, search, start, end, options);
3801
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3802
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.listOrders']?.[localVarOperationServerIndex]?.url;
3803
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3804
- },
3805
- /**
3806
- * Update a fulfillment that belongs to an order placed through the platform
3807
- * @summary Update fulfillment
3808
- * @param {string} project Project unique identifier
3809
- * @param {string} platformId The platform identifier
3810
- * @param {string} fulfillmentId The fulfillment identifier
3811
- * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
3812
- * @param {*} [options] Override http request option.
3813
- * @throws {RequiredError}
3814
- */
3815
- async updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>> {
3816
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateFulfillment(project, platformId, fulfillmentId, updateFulfillmentRequest, options);
3817
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3818
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateFulfillment']?.[localVarOperationServerIndex]?.url;
3819
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3820
- },
3821
- /**
3822
- *
3823
- * @summary Update platform
3824
- * @param {string} project Project unique identifier
3825
- * @param {UpdatePlatformRequest} updatePlatformRequest
3826
- * @param {*} [options] Override http request option.
3827
- * @throws {RequiredError}
3828
- */
3829
- async updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
3830
- const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlatform(project, updatePlatformRequest, options);
3831
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3832
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.updatePlatform']?.[localVarOperationServerIndex]?.url;
3833
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3834
- },
3835
- /**
3836
- * Updates the warehouse product and its variants
3837
- * @summary Update warehouse product
3838
- * @param {string} project Project unique identifier
3839
- * @param {string} platformId The platform identifier
3840
- * @param {string} productId Products unique identifier
3841
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
3842
- * @param {*} [options] Override http request option.
3843
- * @throws {RequiredError}
3844
- */
3845
- async updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>> {
3846
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateProduct(project, platformId, productId, updateProductRequest, options);
3847
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3848
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateProduct']?.[localVarOperationServerIndex]?.url;
3849
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3850
- },
3851
- /**
3852
- * Updates the warehouse variant
3853
- * @summary Update warehouse variant
3854
- * @param {string} project Project unique identifier
3855
- * @param {string} platformId The platform identifier
3856
- * @param {string} variantId Variants unique identifier
3857
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
3858
- * @param {*} [options] Override http request option.
3859
- * @throws {RequiredError}
3860
- */
3861
- async updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>> {
3862
- const localVarAxiosArgs = await localVarAxiosParamCreator.updateVariant(project, platformId, variantId, updateVariantRequest, options);
3863
- const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3864
- const localVarOperationServerBasePath = operationServerMap['PlatformApi.updateVariant']?.[localVarOperationServerIndex]?.url;
3865
- return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3866
- },
3867
- }
3868
- };
3869
-
3870
- /**
3871
- * PlatformApi - factory interface
3872
- * @export
3873
- */
3874
- export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3875
- const localVarFp = PlatformApiFp(configuration)
3876
- return {
3877
- /**
3878
- * Export customers as a CSV file
3879
- * @summary Export customers
3880
- * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
3881
- * @param {*} [options] Override http request option.
3882
- * @throws {RequiredError}
3883
- */
3884
- exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3885
- return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(axios, basePath));
3886
- },
3887
- /**
3888
- * Export orders as a CSV file
3889
- * @summary Export orders
3890
- * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
3891
- * @param {*} [options] Override http request option.
3892
- * @throws {RequiredError}
3893
- */
3894
- exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
3895
- return localVarFp.exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(axios, basePath));
3896
- },
3897
- /**
3898
- * Get a customer for a platform by a given customer ID.
3899
- * @summary Get customer
3900
- * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
3901
- * @param {*} [options] Override http request option.
3902
- * @throws {RequiredError}
3903
- */
3904
- getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
3905
- return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
3906
- },
3907
- /**
3908
- * Get a fulfillment for a platform by a given fulfillment ID.
3909
- * @summary Get fulfillment
3910
- * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
3911
- * @param {*} [options] Override http request option.
3912
- * @throws {RequiredError}
3913
- */
3914
- getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
3915
- return localVarFp.getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
3916
- },
3917
- /**
3918
- * Get an order for a platform by a given order ID.
3919
- * @summary Get order
3920
- * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
3921
- * @param {*} [options] Override http request option.
3922
- * @throws {RequiredError}
3923
- */
3924
- getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order> {
3925
- return localVarFp.getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(axios, basePath));
3926
- },
3927
- /**
3928
- *
3929
- * @summary Get platform details
3930
- * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
3931
- * @param {*} [options] Override http request option.
3932
- * @throws {RequiredError}
3933
- */
3934
- getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
3935
- return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
3936
- },
3937
- /**
3938
- * List available fulfillers for a given fulfillment
3939
- * @summary List available fulfillers
3940
- * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
3941
- * @param {*} [options] Override http request option.
3942
- * @throws {RequiredError}
3943
- */
3944
- listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse> {
3945
- return localVarFp.listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(axios, basePath));
3946
- },
3947
- /**
3948
- * List customers for a platform
3949
- * @summary List customers
3950
- * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
3951
- * @param {*} [options] Override http request option.
3952
- * @throws {RequiredError}
3953
- */
3954
- listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
3955
- return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
3956
- },
3957
- /**
3958
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
3959
- * @summary List orders
3960
- * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
3961
- * @param {*} [options] Override http request option.
3962
- * @throws {RequiredError}
3963
- */
3964
- listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse> {
3965
- return localVarFp.listOrders(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.start, requestParameters.end, options).then((request) => request(axios, basePath));
3966
- },
3967
- /**
3968
- * Update a fulfillment that belongs to an order placed through the platform
3969
- * @summary Update fulfillment
3970
- * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
3971
- * @param {*} [options] Override http request option.
3972
- * @throws {RequiredError}
3973
- */
3974
- updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment> {
3975
- return localVarFp.updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(axios, basePath));
3976
- },
3977
- /**
3978
- *
3979
- * @summary Update platform
3980
- * @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
3981
- * @param {*} [options] Override http request option.
3982
- * @throws {RequiredError}
3983
- */
3984
- updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
3985
- return localVarFp.updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(axios, basePath));
3986
- },
3987
- /**
3988
- * Updates the warehouse product and its variants
3989
- * @summary Update warehouse product
3990
- * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
3991
- * @param {*} [options] Override http request option.
3992
- * @throws {RequiredError}
3993
- */
3994
- updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product> {
3995
- return localVarFp.updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(axios, basePath));
3996
- },
3997
- /**
3998
- * Updates the warehouse variant
3999
- * @summary Update warehouse variant
4000
- * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
4001
- * @param {*} [options] Override http request option.
4002
- * @throws {RequiredError}
4003
- */
4004
- updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant> {
4005
- return localVarFp.updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(axios, basePath));
4006
- },
4007
- };
4008
- };
4009
-
4010
- /**
4011
- * Request parameters for exportCustomers operation in PlatformApi.
4012
- * @export
4013
- * @interface PlatformApiExportCustomersRequest
4014
- */
4015
- export interface PlatformApiExportCustomersRequest {
4016
- /**
4017
- * Project unique identifier
4018
- * @type {string}
4019
- * @memberof PlatformApiExportCustomers
4020
- */
4021
- readonly project: string
4022
-
4023
- /**
4024
- * The platform identifier
4025
- * @type {string}
4026
- * @memberof PlatformApiExportCustomers
4027
- */
4028
- readonly platformId: string
4029
- }
4030
-
4031
- /**
4032
- * Request parameters for exportOrders operation in PlatformApi.
4033
- * @export
4034
- * @interface PlatformApiExportOrdersRequest
4035
- */
4036
- export interface PlatformApiExportOrdersRequest {
4037
- /**
4038
- * Project unique identifier
4039
- * @type {string}
4040
- * @memberof PlatformApiExportOrders
4041
- */
4042
- readonly project: string
4043
-
4044
- /**
4045
- * The platform identifier
4046
- * @type {string}
4047
- * @memberof PlatformApiExportOrders
4048
- */
4049
- readonly platformId: string
4050
-
4051
- /**
4052
- * Start of date range to filter by when orders were placed
4053
- * @type {string}
4054
- * @memberof PlatformApiExportOrders
4055
- */
4056
- readonly start: string
4057
-
4058
- /**
4059
- * End of date range to filter by when orders were placed
4060
- * @type {string}
4061
- * @memberof PlatformApiExportOrders
4062
- */
4063
- readonly end?: string
4064
-
4065
- /**
4066
- * Search term to filter based on order reference, customer name and email
4067
- * @type {string}
4068
- * @memberof PlatformApiExportOrders
4069
- */
4070
- readonly search?: string
4071
- }
4072
-
4073
- /**
4074
- * Request parameters for getCustomer operation in PlatformApi.
4075
- * @export
4076
- * @interface PlatformApiGetCustomerRequest
4077
- */
4078
- export interface PlatformApiGetCustomerRequest {
4079
- /**
4080
- * Project unique identifier
4081
- * @type {string}
4082
- * @memberof PlatformApiGetCustomer
4083
- */
4084
- readonly project: string
4085
-
4086
- /**
4087
- * The platform identifier
4088
- * @type {string}
4089
- * @memberof PlatformApiGetCustomer
4090
- */
4091
- readonly platformId: string
4092
-
4093
- /**
4094
- * The customer identifier
4095
- * @type {string}
4096
- * @memberof PlatformApiGetCustomer
4097
- */
4098
- readonly customerId: string
4099
- }
4100
-
4101
- /**
4102
- * Request parameters for getFulfillment operation in PlatformApi.
4103
- * @export
4104
- * @interface PlatformApiGetFulfillmentRequest
4105
- */
4106
- export interface PlatformApiGetFulfillmentRequest {
4107
- /**
4108
- * Project unique identifier
4109
- * @type {string}
4110
- * @memberof PlatformApiGetFulfillment
4111
- */
4112
- readonly project: string
4113
-
4114
- /**
4115
- * The platform identifier
4116
- * @type {string}
4117
- * @memberof PlatformApiGetFulfillment
4118
- */
4119
- readonly platformId: string
4120
-
4121
- /**
4122
- * The fulfillment identifier
4123
- * @type {string}
4124
- * @memberof PlatformApiGetFulfillment
4125
- */
4126
- readonly fulfillmentId: string
4127
- }
4128
-
4129
- /**
4130
- * Request parameters for getOrder operation in PlatformApi.
4131
- * @export
4132
- * @interface PlatformApiGetOrderRequest
4133
- */
4134
- export interface PlatformApiGetOrderRequest {
4135
- /**
4136
- * Project unique identifier
4137
- * @type {string}
4138
- * @memberof PlatformApiGetOrder
4139
- */
4140
- readonly project: string
4141
-
4142
- /**
4143
- * The platform identifier
4144
- * @type {string}
4145
- * @memberof PlatformApiGetOrder
4146
- */
4147
- readonly platformId: string
4148
-
4149
- /**
4150
- * The order identifier
4151
- * @type {string}
4152
- * @memberof PlatformApiGetOrder
4153
- */
4154
- readonly orderId: string
4155
- }
4156
-
4157
- /**
4158
- * Request parameters for getPlatform operation in PlatformApi.
4159
- * @export
4160
- * @interface PlatformApiGetPlatformRequest
4161
- */
4162
- export interface PlatformApiGetPlatformRequest {
4163
- /**
4164
- * Project unique identifier
4165
- * @type {string}
4166
- * @memberof PlatformApiGetPlatform
4167
- */
4168
- readonly project: string
4169
- }
4170
-
4171
- /**
4172
- * Request parameters for listAvailableFulfillers operation in PlatformApi.
4173
- * @export
4174
- * @interface PlatformApiListAvailableFulfillersRequest
4175
- */
4176
- export interface PlatformApiListAvailableFulfillersRequest {
4177
- /**
4178
- * Project unique identifier
4179
- * @type {string}
4180
- * @memberof PlatformApiListAvailableFulfillers
4181
- */
4182
- readonly project: string
4183
-
4184
- /**
4185
- * The platform identifier
4186
- * @type {string}
4187
- * @memberof PlatformApiListAvailableFulfillers
4188
- */
4189
- readonly platformId: string
4190
-
4191
- /**
4192
- * The fulfillment identifier
4193
- * @type {string}
4194
- * @memberof PlatformApiListAvailableFulfillers
4195
- */
4196
- readonly fulfillmentId: string
4197
- }
4198
-
4199
- /**
4200
- * Request parameters for listCustomers operation in PlatformApi.
4201
- * @export
4202
- * @interface PlatformApiListCustomersRequest
4203
- */
4204
- export interface PlatformApiListCustomersRequest {
4205
- /**
4206
- * Project unique identifier
4207
- * @type {string}
4208
- * @memberof PlatformApiListCustomers
4209
- */
4210
- readonly project: string
4211
-
4212
- /**
4213
- * The platform identifier
4214
- * @type {string}
4215
- * @memberof PlatformApiListCustomers
4216
- */
4217
- readonly platformId: string
4218
-
4219
- /**
4220
- * Page reference token
4221
- * @type {number}
4222
- * @memberof PlatformApiListCustomers
4223
- */
4224
- readonly pageToken?: number
4225
-
4226
- /**
4227
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
4228
- * @type {number}
4229
- * @memberof PlatformApiListCustomers
4230
- */
4231
- readonly pageSize?: number
4232
-
4233
- /**
4234
- * Search term to filter based on order reference, customer name and email
4235
- * @type {string}
4236
- * @memberof PlatformApiListCustomers
4237
- */
4238
- readonly search?: string
4239
- }
3252
+ async updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>> {
3253
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updatePlatform(project, updatePlatformRequest, options);
3254
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
3255
+ const localVarOperationServerBasePath = operationServerMap['PlatformApi.updatePlatform']?.[localVarOperationServerIndex]?.url;
3256
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
3257
+ },
3258
+ }
3259
+ };
4240
3260
 
4241
3261
  /**
4242
- * Request parameters for listOrders operation in PlatformApi.
3262
+ * PlatformApi - factory interface
4243
3263
  * @export
4244
- * @interface PlatformApiListOrdersRequest
4245
3264
  */
4246
- export interface PlatformApiListOrdersRequest {
4247
- /**
4248
- * Project unique identifier
4249
- * @type {string}
4250
- * @memberof PlatformApiListOrders
4251
- */
4252
- readonly project: string
4253
-
4254
- /**
4255
- * The platform identifier
4256
- * @type {string}
4257
- * @memberof PlatformApiListOrders
4258
- */
4259
- readonly platformId: string
4260
-
4261
- /**
4262
- * Page reference token
4263
- * @type {number}
4264
- * @memberof PlatformApiListOrders
4265
- */
4266
- readonly pageToken?: number
4267
-
4268
- /**
4269
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
4270
- * @type {number}
4271
- * @memberof PlatformApiListOrders
4272
- */
4273
- readonly pageSize?: number
4274
-
4275
- /**
4276
- * Search term to filter based on order reference, customer name and email
4277
- * @type {string}
4278
- * @memberof PlatformApiListOrders
4279
- */
4280
- readonly search?: string
4281
-
4282
- /**
4283
- * Start of date range to filter by when orders were placed
4284
- * @type {string}
4285
- * @memberof PlatformApiListOrders
4286
- */
4287
- readonly start?: string
4288
-
4289
- /**
4290
- * End of date range to filter by when orders were placed
4291
- * @type {string}
4292
- * @memberof PlatformApiListOrders
4293
- */
4294
- readonly end?: string
4295
- }
3265
+ export const PlatformApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
3266
+ const localVarFp = PlatformApiFp(configuration)
3267
+ return {
3268
+ /**
3269
+ *
3270
+ * @summary Get platform details
3271
+ * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
3272
+ * @param {*} [options] Override http request option.
3273
+ * @throws {RequiredError}
3274
+ */
3275
+ getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
3276
+ return localVarFp.getPlatform(requestParameters.project, options).then((request) => request(axios, basePath));
3277
+ },
3278
+ /**
3279
+ *
3280
+ * @summary Update platform
3281
+ * @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
3282
+ * @param {*} [options] Override http request option.
3283
+ * @throws {RequiredError}
3284
+ */
3285
+ updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform> {
3286
+ return localVarFp.updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(axios, basePath));
3287
+ },
3288
+ };
3289
+ };
4296
3290
 
4297
3291
  /**
4298
- * Request parameters for updateFulfillment operation in PlatformApi.
3292
+ * Request parameters for getPlatform operation in PlatformApi.
4299
3293
  * @export
4300
- * @interface PlatformApiUpdateFulfillmentRequest
3294
+ * @interface PlatformApiGetPlatformRequest
4301
3295
  */
4302
- export interface PlatformApiUpdateFulfillmentRequest {
3296
+ export interface PlatformApiGetPlatformRequest {
4303
3297
  /**
4304
3298
  * Project unique identifier
4305
3299
  * @type {string}
4306
- * @memberof PlatformApiUpdateFulfillment
3300
+ * @memberof PlatformApiGetPlatform
4307
3301
  */
4308
3302
  readonly project: string
4309
-
4310
- /**
4311
- * The platform identifier
4312
- * @type {string}
4313
- * @memberof PlatformApiUpdateFulfillment
4314
- */
4315
- readonly platformId: string
4316
-
4317
- /**
4318
- * The fulfillment identifier
4319
- * @type {string}
4320
- * @memberof PlatformApiUpdateFulfillment
4321
- */
4322
- readonly fulfillmentId: string
4323
-
4324
- /**
4325
- *
4326
- * @type {UpdateFulfillmentRequest}
4327
- * @memberof PlatformApiUpdateFulfillment
4328
- */
4329
- readonly updateFulfillmentRequest: UpdateFulfillmentRequest
4330
3303
  }
4331
3304
 
4332
3305
  /**
@@ -4350,76 +3323,6 @@ export interface PlatformApiUpdatePlatformRequest {
4350
3323
  readonly updatePlatformRequest: UpdatePlatformRequest
4351
3324
  }
4352
3325
 
4353
- /**
4354
- * Request parameters for updateProduct operation in PlatformApi.
4355
- * @export
4356
- * @interface PlatformApiUpdateProductRequest
4357
- */
4358
- export interface PlatformApiUpdateProductRequest {
4359
- /**
4360
- * Project unique identifier
4361
- * @type {string}
4362
- * @memberof PlatformApiUpdateProduct
4363
- */
4364
- readonly project: string
4365
-
4366
- /**
4367
- * The platform identifier
4368
- * @type {string}
4369
- * @memberof PlatformApiUpdateProduct
4370
- */
4371
- readonly platformId: string
4372
-
4373
- /**
4374
- * Products unique identifier
4375
- * @type {string}
4376
- * @memberof PlatformApiUpdateProduct
4377
- */
4378
- readonly productId: string
4379
-
4380
- /**
4381
- * Update a platform warehouse product
4382
- * @type {UpdateProductRequest}
4383
- * @memberof PlatformApiUpdateProduct
4384
- */
4385
- readonly updateProductRequest: UpdateProductRequest
4386
- }
4387
-
4388
- /**
4389
- * Request parameters for updateVariant operation in PlatformApi.
4390
- * @export
4391
- * @interface PlatformApiUpdateVariantRequest
4392
- */
4393
- export interface PlatformApiUpdateVariantRequest {
4394
- /**
4395
- * Project unique identifier
4396
- * @type {string}
4397
- * @memberof PlatformApiUpdateVariant
4398
- */
4399
- readonly project: string
4400
-
4401
- /**
4402
- * The platform identifier
4403
- * @type {string}
4404
- * @memberof PlatformApiUpdateVariant
4405
- */
4406
- readonly platformId: string
4407
-
4408
- /**
4409
- * Variants unique identifier
4410
- * @type {string}
4411
- * @memberof PlatformApiUpdateVariant
4412
- */
4413
- readonly variantId: string
4414
-
4415
- /**
4416
- * Update a platform warehouse variant
4417
- * @type {UpdateVariantRequest}
4418
- * @memberof PlatformApiUpdateVariant
4419
- */
4420
- readonly updateVariantRequest: UpdateVariantRequest
4421
- }
4422
-
4423
3326
  /**
4424
3327
  * PlatformApi - object-oriented interface
4425
3328
  * @export
@@ -4427,66 +3330,6 @@ export interface PlatformApiUpdateVariantRequest {
4427
3330
  * @extends {BaseAPI}
4428
3331
  */
4429
3332
  export class PlatformApi extends BaseAPI {
4430
- /**
4431
- * Export customers as a CSV file
4432
- * @summary Export customers
4433
- * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
4434
- * @param {*} [options] Override http request option.
4435
- * @throws {RequiredError}
4436
- * @memberof PlatformApi
4437
- */
4438
- public exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
4439
- return PlatformApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, options).then((request) => request(this.axios, this.basePath));
4440
- }
4441
-
4442
- /**
4443
- * Export orders as a CSV file
4444
- * @summary Export orders
4445
- * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
4446
- * @param {*} [options] Override http request option.
4447
- * @throws {RequiredError}
4448
- * @memberof PlatformApi
4449
- */
4450
- public exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig) {
4451
- return PlatformApiFp(this.configuration).exportOrders(requestParameters.project, requestParameters.platformId, requestParameters.start, requestParameters.end, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
4452
- }
4453
-
4454
- /**
4455
- * Get a customer for a platform by a given customer ID.
4456
- * @summary Get customer
4457
- * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
4458
- * @param {*} [options] Override http request option.
4459
- * @throws {RequiredError}
4460
- * @memberof PlatformApi
4461
- */
4462
- public getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig) {
4463
- return PlatformApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
4464
- }
4465
-
4466
- /**
4467
- * Get a fulfillment for a platform by a given fulfillment ID.
4468
- * @summary Get fulfillment
4469
- * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
4470
- * @param {*} [options] Override http request option.
4471
- * @throws {RequiredError}
4472
- * @memberof PlatformApi
4473
- */
4474
- public getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig) {
4475
- return PlatformApiFp(this.configuration).getFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
4476
- }
4477
-
4478
- /**
4479
- * Get an order for a platform by a given order ID.
4480
- * @summary Get order
4481
- * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
4482
- * @param {*} [options] Override http request option.
4483
- * @throws {RequiredError}
4484
- * @memberof PlatformApi
4485
- */
4486
- public getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig) {
4487
- return PlatformApiFp(this.configuration).getOrder(requestParameters.project, requestParameters.platformId, requestParameters.orderId, options).then((request) => request(this.axios, this.basePath));
4488
- }
4489
-
4490
3333
  /**
4491
3334
  *
4492
3335
  * @summary Get platform details
@@ -4499,54 +3342,6 @@ export class PlatformApi extends BaseAPI {
4499
3342
  return PlatformApiFp(this.configuration).getPlatform(requestParameters.project, options).then((request) => request(this.axios, this.basePath));
4500
3343
  }
4501
3344
 
4502
- /**
4503
- * List available fulfillers for a given fulfillment
4504
- * @summary List available fulfillers
4505
- * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
4506
- * @param {*} [options] Override http request option.
4507
- * @throws {RequiredError}
4508
- * @memberof PlatformApi
4509
- */
4510
- public listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig) {
4511
- return PlatformApiFp(this.configuration).listAvailableFulfillers(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, options).then((request) => request(this.axios, this.basePath));
4512
- }
4513
-
4514
- /**
4515
- * List customers for a platform
4516
- * @summary List customers
4517
- * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
4518
- * @param {*} [options] Override http request option.
4519
- * @throws {RequiredError}
4520
- * @memberof PlatformApi
4521
- */
4522
- public listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig) {
4523
- return PlatformApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
4524
- }
4525
-
4526
- /**
4527
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
4528
- * @summary List orders
4529
- * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
4530
- * @param {*} [options] Override http request option.
4531
- * @throws {RequiredError}
4532
- * @memberof PlatformApi
4533
- */
4534
- public listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig) {
4535
- 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));
4536
- }
4537
-
4538
- /**
4539
- * Update a fulfillment that belongs to an order placed through the platform
4540
- * @summary Update fulfillment
4541
- * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
4542
- * @param {*} [options] Override http request option.
4543
- * @throws {RequiredError}
4544
- * @memberof PlatformApi
4545
- */
4546
- public updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig) {
4547
- return PlatformApiFp(this.configuration).updateFulfillment(requestParameters.project, requestParameters.platformId, requestParameters.fulfillmentId, requestParameters.updateFulfillmentRequest, options).then((request) => request(this.axios, this.basePath));
4548
- }
4549
-
4550
3345
  /**
4551
3346
  *
4552
3347
  * @summary Update platform
@@ -4558,30 +3353,6 @@ export class PlatformApi extends BaseAPI {
4558
3353
  public updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig) {
4559
3354
  return PlatformApiFp(this.configuration).updatePlatform(requestParameters.project, requestParameters.updatePlatformRequest, options).then((request) => request(this.axios, this.basePath));
4560
3355
  }
4561
-
4562
- /**
4563
- * Updates the warehouse product and its variants
4564
- * @summary Update warehouse product
4565
- * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
4566
- * @param {*} [options] Override http request option.
4567
- * @throws {RequiredError}
4568
- * @memberof PlatformApi
4569
- */
4570
- public updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig) {
4571
- return PlatformApiFp(this.configuration).updateProduct(requestParameters.project, requestParameters.platformId, requestParameters.productId, requestParameters.updateProductRequest, options).then((request) => request(this.axios, this.basePath));
4572
- }
4573
-
4574
- /**
4575
- * Updates the warehouse variant
4576
- * @summary Update warehouse variant
4577
- * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
4578
- * @param {*} [options] Override http request option.
4579
- * @throws {RequiredError}
4580
- * @memberof PlatformApi
4581
- */
4582
- public updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig) {
4583
- return PlatformApiFp(this.configuration).updateVariant(requestParameters.project, requestParameters.platformId, requestParameters.variantId, requestParameters.updateVariantRequest, options).then((request) => request(this.axios, this.basePath));
4584
- }
4585
3356
  }
4586
3357
 
4587
3358