@teemill/platform 0.12.1 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/esm/api.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.12.1
5
+ * The version of the OpenAPI document: 0.13.0
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -185,13 +185,31 @@ export interface Customer {
185
185
  * @type {string}
186
186
  * @memberof Customer
187
187
  */
188
- 'firstName'?: string;
188
+ 'firstName': string;
189
189
  /**
190
190
  *
191
191
  * @type {string}
192
192
  * @memberof Customer
193
193
  */
194
- 'lastName'?: string;
194
+ 'lastName': string;
195
+ /**
196
+ *
197
+ * @type {string}
198
+ * @memberof Customer
199
+ */
200
+ 'gender': string | null;
201
+ /**
202
+ *
203
+ * @type {string}
204
+ * @memberof Customer
205
+ */
206
+ 'country': string | null;
207
+ /**
208
+ *
209
+ * @type {Statistics}
210
+ * @memberof Customer
211
+ */
212
+ 'statistics': Statistics;
195
213
  }
196
214
  /**
197
215
  *
@@ -1328,6 +1346,31 @@ export interface ShippingMethod {
1328
1346
  */
1329
1347
  'discountPrice'?: Price;
1330
1348
  }
1349
+ /**
1350
+ *
1351
+ * @export
1352
+ * @interface Statistics
1353
+ */
1354
+ export interface Statistics {
1355
+ /**
1356
+ *
1357
+ * @type {number}
1358
+ * @memberof Statistics
1359
+ */
1360
+ 'lifetimeValue': number;
1361
+ /**
1362
+ *
1363
+ * @type {number}
1364
+ * @memberof Statistics
1365
+ */
1366
+ 'totalOrderCount': number;
1367
+ /**
1368
+ *
1369
+ * @type {string}
1370
+ * @memberof Statistics
1371
+ */
1372
+ 'lastPurchased': string | null;
1373
+ }
1331
1374
  /**
1332
1375
  *
1333
1376
  * @export
@@ -1466,14 +1509,6 @@ export interface ValidationError {
1466
1509
  * @memberof ValidationError
1467
1510
  */
1468
1511
  'message': string;
1469
- /**
1470
- *
1471
- * @type {{ [key: string]: Array<string>; }}
1472
- * @memberof ValidationError
1473
- */
1474
- 'errors': {
1475
- [key: string]: Array<string>;
1476
- };
1477
1512
  }
1478
1513
  /**
1479
1514
  *
@@ -1682,10 +1717,15 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1682
1717
  * @summary Export customers
1683
1718
  * @param {string} project Project unique identifier
1684
1719
  * @param {string} platformId The platform identifier
1720
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1721
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1722
+ * @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.
1723
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1724
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1685
1725
  * @param {*} [options] Override http request option.
1686
1726
  * @throws {RequiredError}
1687
1727
  */
1688
- exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1728
+ exportCustomers: (project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1689
1729
  /**
1690
1730
  * Get a customer for a platform by a given customer ID.
1691
1731
  * @summary Get customer
@@ -1704,10 +1744,15 @@ export declare const CustomersApiAxiosParamCreator: (configuration?: Configurati
1704
1744
  * @param {number} [pageToken] Page reference token
1705
1745
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1706
1746
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1747
+ * @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.
1748
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1749
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1750
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1751
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1707
1752
  * @param {*} [options] Override http request option.
1708
1753
  * @throws {RequiredError}
1709
1754
  */
1710
- listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1755
+ listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1711
1756
  };
1712
1757
  /**
1713
1758
  * CustomersApi - functional programming interface
@@ -1719,10 +1764,15 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1719
1764
  * @summary Export customers
1720
1765
  * @param {string} project Project unique identifier
1721
1766
  * @param {string} platformId The platform identifier
1767
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1768
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1769
+ * @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.
1770
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1771
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1722
1772
  * @param {*} [options] Override http request option.
1723
1773
  * @throws {RequiredError}
1724
1774
  */
1725
- exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1775
+ exportCustomers(project: string, platformId: string, totalOrderCount?: number, lifetimeValue?: number, sortBy?: Array<ExportCustomersSortByEnum>, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1726
1776
  /**
1727
1777
  * Get a customer for a platform by a given customer ID.
1728
1778
  * @summary Get customer
@@ -1741,10 +1791,15 @@ export declare const CustomersApiFp: (configuration?: Configuration) => {
1741
1791
  * @param {number} [pageToken] Page reference token
1742
1792
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1743
1793
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1794
+ * @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.
1795
+ * @param {number} [totalOrderCount] Filter customers by total order count equal to the value provided
1796
+ * @param {number} [lifetimeValue] Filter customers by lifetime value less than or equal to the value provided
1797
+ * @param {string} [lastPurchasedStart] Start of date range to filter customers by last purchase date
1798
+ * @param {string} [lastPurchasedEnd] End of date range to filter customers by last purchase date
1744
1799
  * @param {*} [options] Override http request option.
1745
1800
  * @throws {RequiredError}
1746
1801
  */
1747
- listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1802
+ listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, totalOrderCount?: number, lifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1748
1803
  };
1749
1804
  /**
1750
1805
  * CustomersApi - factory interface
@@ -1794,6 +1849,36 @@ export interface CustomersApiExportCustomersRequest {
1794
1849
  * @memberof CustomersApiExportCustomers
1795
1850
  */
1796
1851
  readonly platformId: string;
1852
+ /**
1853
+ * Filter customers by total order count equal to the value provided
1854
+ * @type {number}
1855
+ * @memberof CustomersApiExportCustomers
1856
+ */
1857
+ readonly totalOrderCount?: number;
1858
+ /**
1859
+ * Filter customers by lifetime value less than or equal to the value provided
1860
+ * @type {number}
1861
+ * @memberof CustomersApiExportCustomers
1862
+ */
1863
+ readonly lifetimeValue?: number;
1864
+ /**
1865
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1866
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
1867
+ * @memberof CustomersApiExportCustomers
1868
+ */
1869
+ readonly sortBy?: Array<ExportCustomersSortByEnum>;
1870
+ /**
1871
+ * Start of date range to filter customers by last purchase date
1872
+ * @type {string}
1873
+ * @memberof CustomersApiExportCustomers
1874
+ */
1875
+ readonly lastPurchasedStart?: string;
1876
+ /**
1877
+ * End of date range to filter customers by last purchase date
1878
+ * @type {string}
1879
+ * @memberof CustomersApiExportCustomers
1880
+ */
1881
+ readonly lastPurchasedEnd?: string;
1797
1882
  }
1798
1883
  /**
1799
1884
  * Request parameters for getCustomer operation in CustomersApi.
@@ -1856,6 +1941,36 @@ export interface CustomersApiListCustomersRequest {
1856
1941
  * @memberof CustomersApiListCustomers
1857
1942
  */
1858
1943
  readonly search?: string;
1944
+ /**
1945
+ * An array of fields to sort by, prefixed with a \&#39;-\&#39; for descending order or \&#39;+\&#39; for ascending. Default is ascending.
1946
+ * @type {Array<'+lifetimeValue' | '-lifetimeValue' | '+totalOrderCount' | '-totalOrderCount' | '+lastPurchased' | '-lastPurchased'>}
1947
+ * @memberof CustomersApiListCustomers
1948
+ */
1949
+ readonly sortBy?: Array<ListCustomersSortByEnum>;
1950
+ /**
1951
+ * Filter customers by total order count equal to the value provided
1952
+ * @type {number}
1953
+ * @memberof CustomersApiListCustomers
1954
+ */
1955
+ readonly totalOrderCount?: number;
1956
+ /**
1957
+ * Filter customers by lifetime value less than or equal to the value provided
1958
+ * @type {number}
1959
+ * @memberof CustomersApiListCustomers
1960
+ */
1961
+ readonly lifetimeValue?: number;
1962
+ /**
1963
+ * Start of date range to filter customers by last purchase date
1964
+ * @type {string}
1965
+ * @memberof CustomersApiListCustomers
1966
+ */
1967
+ readonly lastPurchasedStart?: string;
1968
+ /**
1969
+ * End of date range to filter customers by last purchase date
1970
+ * @type {string}
1971
+ * @memberof CustomersApiListCustomers
1972
+ */
1973
+ readonly lastPurchasedEnd?: string;
1859
1974
  }
1860
1975
  /**
1861
1976
  * CustomersApi - object-oriented interface
@@ -1892,6 +2007,30 @@ export declare class CustomersApi extends BaseAPI {
1892
2007
  */
1893
2008
  listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
1894
2009
  }
2010
+ /**
2011
+ * @export
2012
+ */
2013
+ export declare const ExportCustomersSortByEnum: {
2014
+ readonly LifetimeValue: "+lifetimeValue";
2015
+ readonly LifetimeValue2: "-lifetimeValue";
2016
+ readonly TotalOrderCount: "+totalOrderCount";
2017
+ readonly TotalOrderCount2: "-totalOrderCount";
2018
+ readonly LastPurchased: "+lastPurchased";
2019
+ readonly LastPurchased2: "-lastPurchased";
2020
+ };
2021
+ export type ExportCustomersSortByEnum = typeof ExportCustomersSortByEnum[keyof typeof ExportCustomersSortByEnum];
2022
+ /**
2023
+ * @export
2024
+ */
2025
+ export declare const ListCustomersSortByEnum: {
2026
+ readonly LifetimeValue: "+lifetimeValue";
2027
+ readonly LifetimeValue2: "-lifetimeValue";
2028
+ readonly TotalOrderCount: "+totalOrderCount";
2029
+ readonly TotalOrderCount2: "-totalOrderCount";
2030
+ readonly LastPurchased: "+lastPurchased";
2031
+ readonly LastPurchased2: "-lastPurchased";
2032
+ };
2033
+ export type ListCustomersSortByEnum = typeof ListCustomersSortByEnum[keyof typeof ListCustomersSortByEnum];
1895
2034
  /**
1896
2035
  * OrdersApi - axios parameter creator
1897
2036
  * @export
@@ -1903,7 +2042,7 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
1903
2042
  * @param {string} project Project unique identifier
1904
2043
  * @param {string} platformId The platform identifier
1905
2044
  * @param {string} start Start of date range to filter by when orders were placed
1906
- * @param {string} [end] End of date range to filter by when orders were placed
2045
+ * @param {string} [end] End of date range to filter when orders were placed
1907
2046
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1908
2047
  * @param {*} [options] Override http request option.
1909
2048
  * @throws {RequiredError}
@@ -1947,8 +2086,8 @@ export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration)
1947
2086
  * @param {number} [pageToken] Page reference token
1948
2087
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1949
2088
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1950
- * @param {string} [start] Start of date range to filter by when orders were placed
1951
- * @param {string} [end] End of date range to filter by when orders were placed
2089
+ * @param {string} [start] Start of date range to filter when orders were placed
2090
+ * @param {string} [end] End of date range to filter when orders were placed
1952
2091
  * @param {*} [options] Override http request option.
1953
2092
  * @throws {RequiredError}
1954
2093
  */
@@ -1976,7 +2115,7 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
1976
2115
  * @param {string} project Project unique identifier
1977
2116
  * @param {string} platformId The platform identifier
1978
2117
  * @param {string} start Start of date range to filter by when orders were placed
1979
- * @param {string} [end] End of date range to filter by when orders were placed
2118
+ * @param {string} [end] End of date range to filter when orders were placed
1980
2119
  * @param {string} [search] Search term to filter based on order reference, customer name and email
1981
2120
  * @param {*} [options] Override http request option.
1982
2121
  * @throws {RequiredError}
@@ -2020,8 +2159,8 @@ export declare const OrdersApiFp: (configuration?: Configuration) => {
2020
2159
  * @param {number} [pageToken] Page reference token
2021
2160
  * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2022
2161
  * @param {string} [search] Search term to filter based on order reference, customer name and email
2023
- * @param {string} [start] Start of date range to filter by when orders were placed
2024
- * @param {string} [end] End of date range to filter by when orders were placed
2162
+ * @param {string} [start] Start of date range to filter when orders were placed
2163
+ * @param {string} [end] End of date range to filter when orders were placed
2025
2164
  * @param {*} [options] Override http request option.
2026
2165
  * @throws {RequiredError}
2027
2166
  */
@@ -2117,7 +2256,7 @@ export interface OrdersApiExportOrdersRequest {
2117
2256
  */
2118
2257
  readonly start: string;
2119
2258
  /**
2120
- * End of date range to filter by when orders were placed
2259
+ * End of date range to filter when orders were placed
2121
2260
  * @type {string}
2122
2261
  * @memberof OrdersApiExportOrders
2123
2262
  */
@@ -2241,13 +2380,13 @@ export interface OrdersApiListOrdersRequest {
2241
2380
  */
2242
2381
  readonly search?: string;
2243
2382
  /**
2244
- * Start of date range to filter by when orders were placed
2383
+ * Start of date range to filter when orders were placed
2245
2384
  * @type {string}
2246
2385
  * @memberof OrdersApiListOrders
2247
2386
  */
2248
2387
  readonly start?: string;
2249
2388
  /**
2250
- * End of date range to filter by when orders were placed
2389
+ * End of date range to filter when orders were placed
2251
2390
  * @type {string}
2252
2391
  * @memberof OrdersApiListOrders
2253
2392
  */
@@ -2351,57 +2490,6 @@ export declare class OrdersApi extends BaseAPI {
2351
2490
  * @export
2352
2491
  */
2353
2492
  export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
2354
- /**
2355
- * Export customers as a CSV file
2356
- * @summary Export customers
2357
- * @param {string} project Project unique identifier
2358
- * @param {string} platformId The platform identifier
2359
- * @param {*} [options] Override http request option.
2360
- * @throws {RequiredError}
2361
- */
2362
- exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2363
- /**
2364
- * Export orders as a CSV file
2365
- * @summary Export orders
2366
- * @param {string} project Project unique identifier
2367
- * @param {string} platformId The platform identifier
2368
- * @param {string} start Start of date range to filter by when orders were placed
2369
- * @param {string} [end] End of date range to filter by when orders were placed
2370
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2371
- * @param {*} [options] Override http request option.
2372
- * @throws {RequiredError}
2373
- */
2374
- exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2375
- /**
2376
- * Get a customer for a platform by a given customer ID.
2377
- * @summary Get customer
2378
- * @param {string} project Project unique identifier
2379
- * @param {string} platformId The platform identifier
2380
- * @param {string} customerId The customer identifier
2381
- * @param {*} [options] Override http request option.
2382
- * @throws {RequiredError}
2383
- */
2384
- getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2385
- /**
2386
- * Get a fulfillment for a platform by a given fulfillment ID.
2387
- * @summary Get fulfillment
2388
- * @param {string} project Project unique identifier
2389
- * @param {string} platformId The platform identifier
2390
- * @param {string} fulfillmentId The fulfillment identifier
2391
- * @param {*} [options] Override http request option.
2392
- * @throws {RequiredError}
2393
- */
2394
- getFulfillment: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2395
- /**
2396
- * Get an order for a platform by a given order ID.
2397
- * @summary Get order
2398
- * @param {string} project Project unique identifier
2399
- * @param {string} platformId The platform identifier
2400
- * @param {string} orderId The order identifier
2401
- * @param {*} [options] Override http request option.
2402
- * @throws {RequiredError}
2403
- */
2404
- getOrder: (project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2405
2493
  /**
2406
2494
  *
2407
2495
  * @summary Get platform details
@@ -2411,801 +2499,108 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
2411
2499
  */
2412
2500
  getPlatform: (project: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2413
2501
  /**
2414
- * List available fulfillers for a given fulfillment
2415
- * @summary List available fulfillers
2502
+ *
2503
+ * @summary Update platform
2416
2504
  * @param {string} project Project unique identifier
2417
- * @param {string} platformId The platform identifier
2418
- * @param {string} fulfillmentId The fulfillment identifier
2505
+ * @param {UpdatePlatformRequest} updatePlatformRequest
2419
2506
  * @param {*} [options] Override http request option.
2420
2507
  * @throws {RequiredError}
2421
2508
  */
2422
- listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2509
+ updatePlatform: (project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2510
+ };
2511
+ /**
2512
+ * PlatformApi - functional programming interface
2513
+ * @export
2514
+ */
2515
+ export declare const PlatformApiFp: (configuration?: Configuration) => {
2423
2516
  /**
2424
- * List customers for a platform
2425
- * @summary List customers
2517
+ *
2518
+ * @summary Get platform details
2426
2519
  * @param {string} project Project unique identifier
2427
- * @param {string} platformId The platform identifier
2428
- * @param {number} [pageToken] Page reference token
2429
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2430
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2431
2520
  * @param {*} [options] Override http request option.
2432
2521
  * @throws {RequiredError}
2433
2522
  */
2434
- listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2523
+ getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
2435
2524
  /**
2436
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2437
- * @summary List orders
2525
+ *
2526
+ * @summary Update platform
2438
2527
  * @param {string} project Project unique identifier
2439
- * @param {string} platformId The platform identifier
2440
- * @param {number} [pageToken] Page reference token
2441
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2442
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2443
- * @param {string} [start] Start of date range to filter by when orders were placed
2444
- * @param {string} [end] End of date range to filter by when orders were placed
2528
+ * @param {UpdatePlatformRequest} updatePlatformRequest
2445
2529
  * @param {*} [options] Override http request option.
2446
2530
  * @throws {RequiredError}
2447
2531
  */
2448
- listOrders: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2532
+ updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
2533
+ };
2534
+ /**
2535
+ * PlatformApi - factory interface
2536
+ * @export
2537
+ */
2538
+ export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2449
2539
  /**
2450
- * Update a fulfillment that belongs to an order placed through the platform
2451
- * @summary Update fulfillment
2452
- * @param {string} project Project unique identifier
2453
- * @param {string} platformId The platform identifier
2454
- * @param {string} fulfillmentId The fulfillment identifier
2455
- * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
2540
+ *
2541
+ * @summary Get platform details
2542
+ * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
2456
2543
  * @param {*} [options] Override http request option.
2457
2544
  * @throws {RequiredError}
2458
2545
  */
2459
- updateFulfillment: (project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2546
+ getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
2460
2547
  /**
2461
2548
  *
2462
2549
  * @summary Update platform
2463
- * @param {string} project Project unique identifier
2464
- * @param {UpdatePlatformRequest} updatePlatformRequest
2550
+ * @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
2465
2551
  * @param {*} [options] Override http request option.
2466
2552
  * @throws {RequiredError}
2467
2553
  */
2468
- updatePlatform: (project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2554
+ updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
2555
+ };
2556
+ /**
2557
+ * Request parameters for getPlatform operation in PlatformApi.
2558
+ * @export
2559
+ * @interface PlatformApiGetPlatformRequest
2560
+ */
2561
+ export interface PlatformApiGetPlatformRequest {
2469
2562
  /**
2470
- * Updates the warehouse product and its variants
2471
- * @summary Update warehouse product
2472
- * @param {string} project Project unique identifier
2473
- * @param {string} platformId The platform identifier
2474
- * @param {string} productId Products unique identifier
2475
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2476
- * @param {*} [options] Override http request option.
2477
- * @throws {RequiredError}
2563
+ * Project unique identifier
2564
+ * @type {string}
2565
+ * @memberof PlatformApiGetPlatform
2478
2566
  */
2479
- updateProduct: (project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2567
+ readonly project: string;
2568
+ }
2569
+ /**
2570
+ * Request parameters for updatePlatform operation in PlatformApi.
2571
+ * @export
2572
+ * @interface PlatformApiUpdatePlatformRequest
2573
+ */
2574
+ export interface PlatformApiUpdatePlatformRequest {
2480
2575
  /**
2481
- * Updates the warehouse variant
2482
- * @summary Update warehouse variant
2483
- * @param {string} project Project unique identifier
2484
- * @param {string} platformId The platform identifier
2485
- * @param {string} variantId Variants unique identifier
2486
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2487
- * @param {*} [options] Override http request option.
2488
- * @throws {RequiredError}
2576
+ * Project unique identifier
2577
+ * @type {string}
2578
+ * @memberof PlatformApiUpdatePlatform
2489
2579
  */
2490
- updateVariant: (project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2491
- };
2580
+ readonly project: string;
2581
+ /**
2582
+ *
2583
+ * @type {UpdatePlatformRequest}
2584
+ * @memberof PlatformApiUpdatePlatform
2585
+ */
2586
+ readonly updatePlatformRequest: UpdatePlatformRequest;
2587
+ }
2492
2588
  /**
2493
- * PlatformApi - functional programming interface
2589
+ * PlatformApi - object-oriented interface
2494
2590
  * @export
2591
+ * @class PlatformApi
2592
+ * @extends {BaseAPI}
2495
2593
  */
2496
- export declare const PlatformApiFp: (configuration?: Configuration) => {
2594
+ export declare class PlatformApi extends BaseAPI {
2497
2595
  /**
2498
- * Export customers as a CSV file
2499
- * @summary Export customers
2500
- * @param {string} project Project unique identifier
2501
- * @param {string} platformId The platform identifier
2596
+ *
2597
+ * @summary Get platform details
2598
+ * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
2502
2599
  * @param {*} [options] Override http request option.
2503
2600
  * @throws {RequiredError}
2601
+ * @memberof PlatformApi
2504
2602
  */
2505
- exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2506
- /**
2507
- * Export orders as a CSV file
2508
- * @summary Export orders
2509
- * @param {string} project Project unique identifier
2510
- * @param {string} platformId The platform identifier
2511
- * @param {string} start Start of date range to filter by when orders were placed
2512
- * @param {string} [end] End of date range to filter by when orders were placed
2513
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2514
- * @param {*} [options] Override http request option.
2515
- * @throws {RequiredError}
2516
- */
2517
- exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2518
- /**
2519
- * Get a customer for a platform by a given customer ID.
2520
- * @summary Get customer
2521
- * @param {string} project Project unique identifier
2522
- * @param {string} platformId The platform identifier
2523
- * @param {string} customerId The customer identifier
2524
- * @param {*} [options] Override http request option.
2525
- * @throws {RequiredError}
2526
- */
2527
- getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
2528
- /**
2529
- * Get a fulfillment for a platform by a given fulfillment ID.
2530
- * @summary Get fulfillment
2531
- * @param {string} project Project unique identifier
2532
- * @param {string} platformId The platform identifier
2533
- * @param {string} fulfillmentId The fulfillment identifier
2534
- * @param {*} [options] Override http request option.
2535
- * @throws {RequiredError}
2536
- */
2537
- getFulfillment(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
2538
- /**
2539
- * Get an order for a platform by a given order ID.
2540
- * @summary Get order
2541
- * @param {string} project Project unique identifier
2542
- * @param {string} platformId The platform identifier
2543
- * @param {string} orderId The order identifier
2544
- * @param {*} [options] Override http request option.
2545
- * @throws {RequiredError}
2546
- */
2547
- getOrder(project: string, platformId: string, orderId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
2548
- /**
2549
- *
2550
- * @summary Get platform details
2551
- * @param {string} project Project unique identifier
2552
- * @param {*} [options] Override http request option.
2553
- * @throws {RequiredError}
2554
- */
2555
- getPlatform(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
2556
- /**
2557
- * List available fulfillers for a given fulfillment
2558
- * @summary List available fulfillers
2559
- * @param {string} project Project unique identifier
2560
- * @param {string} platformId The platform identifier
2561
- * @param {string} fulfillmentId The fulfillment identifier
2562
- * @param {*} [options] Override http request option.
2563
- * @throws {RequiredError}
2564
- */
2565
- listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
2566
- /**
2567
- * List customers for a platform
2568
- * @summary List customers
2569
- * @param {string} project Project unique identifier
2570
- * @param {string} platformId The platform identifier
2571
- * @param {number} [pageToken] Page reference token
2572
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2573
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2574
- * @param {*} [options] Override http request option.
2575
- * @throws {RequiredError}
2576
- */
2577
- listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
2578
- /**
2579
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2580
- * @summary List orders
2581
- * @param {string} project Project unique identifier
2582
- * @param {string} platformId The platform identifier
2583
- * @param {number} [pageToken] Page reference token
2584
- * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2585
- * @param {string} [search] Search term to filter based on order reference, customer name and email
2586
- * @param {string} [start] Start of date range to filter by when orders were placed
2587
- * @param {string} [end] End of date range to filter by when orders were placed
2588
- * @param {*} [options] Override http request option.
2589
- * @throws {RequiredError}
2590
- */
2591
- listOrders(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
2592
- /**
2593
- * Update a fulfillment that belongs to an order placed through the platform
2594
- * @summary Update fulfillment
2595
- * @param {string} project Project unique identifier
2596
- * @param {string} platformId The platform identifier
2597
- * @param {string} fulfillmentId The fulfillment identifier
2598
- * @param {UpdateFulfillmentRequest} updateFulfillmentRequest
2599
- * @param {*} [options] Override http request option.
2600
- * @throws {RequiredError}
2601
- */
2602
- updateFulfillment(project: string, platformId: string, fulfillmentId: string, updateFulfillmentRequest: UpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Fulfillment>>;
2603
- /**
2604
- *
2605
- * @summary Update platform
2606
- * @param {string} project Project unique identifier
2607
- * @param {UpdatePlatformRequest} updatePlatformRequest
2608
- * @param {*} [options] Override http request option.
2609
- * @throws {RequiredError}
2610
- */
2611
- updatePlatform(project: string, updatePlatformRequest: UpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Platform>>;
2612
- /**
2613
- * Updates the warehouse product and its variants
2614
- * @summary Update warehouse product
2615
- * @param {string} project Project unique identifier
2616
- * @param {string} platformId The platform identifier
2617
- * @param {string} productId Products unique identifier
2618
- * @param {UpdateProductRequest} updateProductRequest Update a platform warehouse product
2619
- * @param {*} [options] Override http request option.
2620
- * @throws {RequiredError}
2621
- */
2622
- updateProduct(project: string, platformId: string, productId: string, updateProductRequest: UpdateProductRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Product>>;
2623
- /**
2624
- * Updates the warehouse variant
2625
- * @summary Update warehouse variant
2626
- * @param {string} project Project unique identifier
2627
- * @param {string} platformId The platform identifier
2628
- * @param {string} variantId Variants unique identifier
2629
- * @param {UpdateVariantRequest} updateVariantRequest Update a platform warehouse variant
2630
- * @param {*} [options] Override http request option.
2631
- * @throws {RequiredError}
2632
- */
2633
- updateVariant(project: string, platformId: string, variantId: string, updateVariantRequest: UpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Variant>>;
2634
- };
2635
- /**
2636
- * PlatformApi - factory interface
2637
- * @export
2638
- */
2639
- export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2640
- /**
2641
- * Export customers as a CSV file
2642
- * @summary Export customers
2643
- * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
2644
- * @param {*} [options] Override http request option.
2645
- * @throws {RequiredError}
2646
- */
2647
- exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2648
- /**
2649
- * Export orders as a CSV file
2650
- * @summary Export orders
2651
- * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
2652
- * @param {*} [options] Override http request option.
2653
- * @throws {RequiredError}
2654
- */
2655
- exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2656
- /**
2657
- * Get a customer for a platform by a given customer ID.
2658
- * @summary Get customer
2659
- * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
2660
- * @param {*} [options] Override http request option.
2661
- * @throws {RequiredError}
2662
- */
2663
- getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
2664
- /**
2665
- * Get a fulfillment for a platform by a given fulfillment ID.
2666
- * @summary Get fulfillment
2667
- * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
2668
- * @param {*} [options] Override http request option.
2669
- * @throws {RequiredError}
2670
- */
2671
- getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
2672
- /**
2673
- * Get an order for a platform by a given order ID.
2674
- * @summary Get order
2675
- * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
2676
- * @param {*} [options] Override http request option.
2677
- * @throws {RequiredError}
2678
- */
2679
- getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
2680
- /**
2681
- *
2682
- * @summary Get platform details
2683
- * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
2684
- * @param {*} [options] Override http request option.
2685
- * @throws {RequiredError}
2686
- */
2687
- getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
2688
- /**
2689
- * List available fulfillers for a given fulfillment
2690
- * @summary List available fulfillers
2691
- * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
2692
- * @param {*} [options] Override http request option.
2693
- * @throws {RequiredError}
2694
- */
2695
- listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
2696
- /**
2697
- * List customers for a platform
2698
- * @summary List customers
2699
- * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
2700
- * @param {*} [options] Override http request option.
2701
- * @throws {RequiredError}
2702
- */
2703
- listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
2704
- /**
2705
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2706
- * @summary List orders
2707
- * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
2708
- * @param {*} [options] Override http request option.
2709
- * @throws {RequiredError}
2710
- */
2711
- listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
2712
- /**
2713
- * Update a fulfillment that belongs to an order placed through the platform
2714
- * @summary Update fulfillment
2715
- * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
2716
- * @param {*} [options] Override http request option.
2717
- * @throws {RequiredError}
2718
- */
2719
- updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): AxiosPromise<Fulfillment>;
2720
- /**
2721
- *
2722
- * @summary Update platform
2723
- * @param {PlatformApiUpdatePlatformRequest} requestParameters Request parameters.
2724
- * @param {*} [options] Override http request option.
2725
- * @throws {RequiredError}
2726
- */
2727
- updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): AxiosPromise<Platform>;
2728
- /**
2729
- * Updates the warehouse product and its variants
2730
- * @summary Update warehouse product
2731
- * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
2732
- * @param {*} [options] Override http request option.
2733
- * @throws {RequiredError}
2734
- */
2735
- updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): AxiosPromise<Product>;
2736
- /**
2737
- * Updates the warehouse variant
2738
- * @summary Update warehouse variant
2739
- * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
2740
- * @param {*} [options] Override http request option.
2741
- * @throws {RequiredError}
2742
- */
2743
- updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
2744
- };
2745
- /**
2746
- * Request parameters for exportCustomers operation in PlatformApi.
2747
- * @export
2748
- * @interface PlatformApiExportCustomersRequest
2749
- */
2750
- export interface PlatformApiExportCustomersRequest {
2751
- /**
2752
- * Project unique identifier
2753
- * @type {string}
2754
- * @memberof PlatformApiExportCustomers
2755
- */
2756
- readonly project: string;
2757
- /**
2758
- * The platform identifier
2759
- * @type {string}
2760
- * @memberof PlatformApiExportCustomers
2761
- */
2762
- readonly platformId: string;
2763
- }
2764
- /**
2765
- * Request parameters for exportOrders operation in PlatformApi.
2766
- * @export
2767
- * @interface PlatformApiExportOrdersRequest
2768
- */
2769
- export interface PlatformApiExportOrdersRequest {
2770
- /**
2771
- * Project unique identifier
2772
- * @type {string}
2773
- * @memberof PlatformApiExportOrders
2774
- */
2775
- readonly project: string;
2776
- /**
2777
- * The platform identifier
2778
- * @type {string}
2779
- * @memberof PlatformApiExportOrders
2780
- */
2781
- readonly platformId: string;
2782
- /**
2783
- * Start of date range to filter by when orders were placed
2784
- * @type {string}
2785
- * @memberof PlatformApiExportOrders
2786
- */
2787
- readonly start: string;
2788
- /**
2789
- * End of date range to filter by when orders were placed
2790
- * @type {string}
2791
- * @memberof PlatformApiExportOrders
2792
- */
2793
- readonly end?: string;
2794
- /**
2795
- * Search term to filter based on order reference, customer name and email
2796
- * @type {string}
2797
- * @memberof PlatformApiExportOrders
2798
- */
2799
- readonly search?: string;
2800
- }
2801
- /**
2802
- * Request parameters for getCustomer operation in PlatformApi.
2803
- * @export
2804
- * @interface PlatformApiGetCustomerRequest
2805
- */
2806
- export interface PlatformApiGetCustomerRequest {
2807
- /**
2808
- * Project unique identifier
2809
- * @type {string}
2810
- * @memberof PlatformApiGetCustomer
2811
- */
2812
- readonly project: string;
2813
- /**
2814
- * The platform identifier
2815
- * @type {string}
2816
- * @memberof PlatformApiGetCustomer
2817
- */
2818
- readonly platformId: string;
2819
- /**
2820
- * The customer identifier
2821
- * @type {string}
2822
- * @memberof PlatformApiGetCustomer
2823
- */
2824
- readonly customerId: string;
2825
- }
2826
- /**
2827
- * Request parameters for getFulfillment operation in PlatformApi.
2828
- * @export
2829
- * @interface PlatformApiGetFulfillmentRequest
2830
- */
2831
- export interface PlatformApiGetFulfillmentRequest {
2832
- /**
2833
- * Project unique identifier
2834
- * @type {string}
2835
- * @memberof PlatformApiGetFulfillment
2836
- */
2837
- readonly project: string;
2838
- /**
2839
- * The platform identifier
2840
- * @type {string}
2841
- * @memberof PlatformApiGetFulfillment
2842
- */
2843
- readonly platformId: string;
2844
- /**
2845
- * The fulfillment identifier
2846
- * @type {string}
2847
- * @memberof PlatformApiGetFulfillment
2848
- */
2849
- readonly fulfillmentId: string;
2850
- }
2851
- /**
2852
- * Request parameters for getOrder operation in PlatformApi.
2853
- * @export
2854
- * @interface PlatformApiGetOrderRequest
2855
- */
2856
- export interface PlatformApiGetOrderRequest {
2857
- /**
2858
- * Project unique identifier
2859
- * @type {string}
2860
- * @memberof PlatformApiGetOrder
2861
- */
2862
- readonly project: string;
2863
- /**
2864
- * The platform identifier
2865
- * @type {string}
2866
- * @memberof PlatformApiGetOrder
2867
- */
2868
- readonly platformId: string;
2869
- /**
2870
- * The order identifier
2871
- * @type {string}
2872
- * @memberof PlatformApiGetOrder
2873
- */
2874
- readonly orderId: string;
2875
- }
2876
- /**
2877
- * Request parameters for getPlatform operation in PlatformApi.
2878
- * @export
2879
- * @interface PlatformApiGetPlatformRequest
2880
- */
2881
- export interface PlatformApiGetPlatformRequest {
2882
- /**
2883
- * Project unique identifier
2884
- * @type {string}
2885
- * @memberof PlatformApiGetPlatform
2886
- */
2887
- readonly project: string;
2888
- }
2889
- /**
2890
- * Request parameters for listAvailableFulfillers operation in PlatformApi.
2891
- * @export
2892
- * @interface PlatformApiListAvailableFulfillersRequest
2893
- */
2894
- export interface PlatformApiListAvailableFulfillersRequest {
2895
- /**
2896
- * Project unique identifier
2897
- * @type {string}
2898
- * @memberof PlatformApiListAvailableFulfillers
2899
- */
2900
- readonly project: string;
2901
- /**
2902
- * The platform identifier
2903
- * @type {string}
2904
- * @memberof PlatformApiListAvailableFulfillers
2905
- */
2906
- readonly platformId: string;
2907
- /**
2908
- * The fulfillment identifier
2909
- * @type {string}
2910
- * @memberof PlatformApiListAvailableFulfillers
2911
- */
2912
- readonly fulfillmentId: string;
2913
- }
2914
- /**
2915
- * Request parameters for listCustomers operation in PlatformApi.
2916
- * @export
2917
- * @interface PlatformApiListCustomersRequest
2918
- */
2919
- export interface PlatformApiListCustomersRequest {
2920
- /**
2921
- * Project unique identifier
2922
- * @type {string}
2923
- * @memberof PlatformApiListCustomers
2924
- */
2925
- readonly project: string;
2926
- /**
2927
- * The platform identifier
2928
- * @type {string}
2929
- * @memberof PlatformApiListCustomers
2930
- */
2931
- readonly platformId: string;
2932
- /**
2933
- * Page reference token
2934
- * @type {number}
2935
- * @memberof PlatformApiListCustomers
2936
- */
2937
- readonly pageToken?: number;
2938
- /**
2939
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2940
- * @type {number}
2941
- * @memberof PlatformApiListCustomers
2942
- */
2943
- readonly pageSize?: number;
2944
- /**
2945
- * Search term to filter based on order reference, customer name and email
2946
- * @type {string}
2947
- * @memberof PlatformApiListCustomers
2948
- */
2949
- readonly search?: string;
2950
- }
2951
- /**
2952
- * Request parameters for listOrders operation in PlatformApi.
2953
- * @export
2954
- * @interface PlatformApiListOrdersRequest
2955
- */
2956
- export interface PlatformApiListOrdersRequest {
2957
- /**
2958
- * Project unique identifier
2959
- * @type {string}
2960
- * @memberof PlatformApiListOrders
2961
- */
2962
- readonly project: string;
2963
- /**
2964
- * The platform identifier
2965
- * @type {string}
2966
- * @memberof PlatformApiListOrders
2967
- */
2968
- readonly platformId: string;
2969
- /**
2970
- * Page reference token
2971
- * @type {number}
2972
- * @memberof PlatformApiListOrders
2973
- */
2974
- readonly pageToken?: number;
2975
- /**
2976
- * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2977
- * @type {number}
2978
- * @memberof PlatformApiListOrders
2979
- */
2980
- readonly pageSize?: number;
2981
- /**
2982
- * Search term to filter based on order reference, customer name and email
2983
- * @type {string}
2984
- * @memberof PlatformApiListOrders
2985
- */
2986
- readonly search?: string;
2987
- /**
2988
- * Start of date range to filter by when orders were placed
2989
- * @type {string}
2990
- * @memberof PlatformApiListOrders
2991
- */
2992
- readonly start?: string;
2993
- /**
2994
- * End of date range to filter by when orders were placed
2995
- * @type {string}
2996
- * @memberof PlatformApiListOrders
2997
- */
2998
- readonly end?: string;
2999
- }
3000
- /**
3001
- * Request parameters for updateFulfillment operation in PlatformApi.
3002
- * @export
3003
- * @interface PlatformApiUpdateFulfillmentRequest
3004
- */
3005
- export interface PlatformApiUpdateFulfillmentRequest {
3006
- /**
3007
- * Project unique identifier
3008
- * @type {string}
3009
- * @memberof PlatformApiUpdateFulfillment
3010
- */
3011
- readonly project: string;
3012
- /**
3013
- * The platform identifier
3014
- * @type {string}
3015
- * @memberof PlatformApiUpdateFulfillment
3016
- */
3017
- readonly platformId: string;
3018
- /**
3019
- * The fulfillment identifier
3020
- * @type {string}
3021
- * @memberof PlatformApiUpdateFulfillment
3022
- */
3023
- readonly fulfillmentId: string;
3024
- /**
3025
- *
3026
- * @type {UpdateFulfillmentRequest}
3027
- * @memberof PlatformApiUpdateFulfillment
3028
- */
3029
- readonly updateFulfillmentRequest: UpdateFulfillmentRequest;
3030
- }
3031
- /**
3032
- * Request parameters for updatePlatform operation in PlatformApi.
3033
- * @export
3034
- * @interface PlatformApiUpdatePlatformRequest
3035
- */
3036
- export interface PlatformApiUpdatePlatformRequest {
3037
- /**
3038
- * Project unique identifier
3039
- * @type {string}
3040
- * @memberof PlatformApiUpdatePlatform
3041
- */
3042
- readonly project: string;
3043
- /**
3044
- *
3045
- * @type {UpdatePlatformRequest}
3046
- * @memberof PlatformApiUpdatePlatform
3047
- */
3048
- readonly updatePlatformRequest: UpdatePlatformRequest;
3049
- }
3050
- /**
3051
- * Request parameters for updateProduct operation in PlatformApi.
3052
- * @export
3053
- * @interface PlatformApiUpdateProductRequest
3054
- */
3055
- export interface PlatformApiUpdateProductRequest {
3056
- /**
3057
- * Project unique identifier
3058
- * @type {string}
3059
- * @memberof PlatformApiUpdateProduct
3060
- */
3061
- readonly project: string;
3062
- /**
3063
- * The platform identifier
3064
- * @type {string}
3065
- * @memberof PlatformApiUpdateProduct
3066
- */
3067
- readonly platformId: string;
3068
- /**
3069
- * Products unique identifier
3070
- * @type {string}
3071
- * @memberof PlatformApiUpdateProduct
3072
- */
3073
- readonly productId: string;
3074
- /**
3075
- * Update a platform warehouse product
3076
- * @type {UpdateProductRequest}
3077
- * @memberof PlatformApiUpdateProduct
3078
- */
3079
- readonly updateProductRequest: UpdateProductRequest;
3080
- }
3081
- /**
3082
- * Request parameters for updateVariant operation in PlatformApi.
3083
- * @export
3084
- * @interface PlatformApiUpdateVariantRequest
3085
- */
3086
- export interface PlatformApiUpdateVariantRequest {
3087
- /**
3088
- * Project unique identifier
3089
- * @type {string}
3090
- * @memberof PlatformApiUpdateVariant
3091
- */
3092
- readonly project: string;
3093
- /**
3094
- * The platform identifier
3095
- * @type {string}
3096
- * @memberof PlatformApiUpdateVariant
3097
- */
3098
- readonly platformId: string;
3099
- /**
3100
- * Variants unique identifier
3101
- * @type {string}
3102
- * @memberof PlatformApiUpdateVariant
3103
- */
3104
- readonly variantId: string;
3105
- /**
3106
- * Update a platform warehouse variant
3107
- * @type {UpdateVariantRequest}
3108
- * @memberof PlatformApiUpdateVariant
3109
- */
3110
- readonly updateVariantRequest: UpdateVariantRequest;
3111
- }
3112
- /**
3113
- * PlatformApi - object-oriented interface
3114
- * @export
3115
- * @class PlatformApi
3116
- * @extends {BaseAPI}
3117
- */
3118
- export declare class PlatformApi extends BaseAPI {
3119
- /**
3120
- * Export customers as a CSV file
3121
- * @summary Export customers
3122
- * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
3123
- * @param {*} [options] Override http request option.
3124
- * @throws {RequiredError}
3125
- * @memberof PlatformApi
3126
- */
3127
- exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
3128
- /**
3129
- * Export orders as a CSV file
3130
- * @summary Export orders
3131
- * @param {PlatformApiExportOrdersRequest} requestParameters Request parameters.
3132
- * @param {*} [options] Override http request option.
3133
- * @throws {RequiredError}
3134
- * @memberof PlatformApi
3135
- */
3136
- exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
3137
- /**
3138
- * Get a customer for a platform by a given customer ID.
3139
- * @summary Get customer
3140
- * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
3141
- * @param {*} [options] Override http request option.
3142
- * @throws {RequiredError}
3143
- * @memberof PlatformApi
3144
- */
3145
- getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
3146
- /**
3147
- * Get a fulfillment for a platform by a given fulfillment ID.
3148
- * @summary Get fulfillment
3149
- * @param {PlatformApiGetFulfillmentRequest} requestParameters Request parameters.
3150
- * @param {*} [options] Override http request option.
3151
- * @throws {RequiredError}
3152
- * @memberof PlatformApi
3153
- */
3154
- getFulfillment(requestParameters: PlatformApiGetFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
3155
- /**
3156
- * Get an order for a platform by a given order ID.
3157
- * @summary Get order
3158
- * @param {PlatformApiGetOrderRequest} requestParameters Request parameters.
3159
- * @param {*} [options] Override http request option.
3160
- * @throws {RequiredError}
3161
- * @memberof PlatformApi
3162
- */
3163
- getOrder(requestParameters: PlatformApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
3164
- /**
3165
- *
3166
- * @summary Get platform details
3167
- * @param {PlatformApiGetPlatformRequest} requestParameters Request parameters.
3168
- * @param {*} [options] Override http request option.
3169
- * @throws {RequiredError}
3170
- * @memberof PlatformApi
3171
- */
3172
- getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
3173
- /**
3174
- * List available fulfillers for a given fulfillment
3175
- * @summary List available fulfillers
3176
- * @param {PlatformApiListAvailableFulfillersRequest} requestParameters Request parameters.
3177
- * @param {*} [options] Override http request option.
3178
- * @throws {RequiredError}
3179
- * @memberof PlatformApi
3180
- */
3181
- listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
3182
- /**
3183
- * List customers for a platform
3184
- * @summary List customers
3185
- * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
3186
- * @param {*} [options] Override http request option.
3187
- * @throws {RequiredError}
3188
- * @memberof PlatformApi
3189
- */
3190
- listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
3191
- /**
3192
- * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
3193
- * @summary List orders
3194
- * @param {PlatformApiListOrdersRequest} requestParameters Request parameters.
3195
- * @param {*} [options] Override http request option.
3196
- * @throws {RequiredError}
3197
- * @memberof PlatformApi
3198
- */
3199
- listOrders(requestParameters: PlatformApiListOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
3200
- /**
3201
- * Update a fulfillment that belongs to an order placed through the platform
3202
- * @summary Update fulfillment
3203
- * @param {PlatformApiUpdateFulfillmentRequest} requestParameters Request parameters.
3204
- * @param {*} [options] Override http request option.
3205
- * @throws {RequiredError}
3206
- * @memberof PlatformApi
3207
- */
3208
- updateFulfillment(requestParameters: PlatformApiUpdateFulfillmentRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Fulfillment, any>>;
2603
+ getPlatform(requestParameters: PlatformApiGetPlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
3209
2604
  /**
3210
2605
  *
3211
2606
  * @summary Update platform
@@ -3215,24 +2610,6 @@ export declare class PlatformApi extends BaseAPI {
3215
2610
  * @memberof PlatformApi
3216
2611
  */
3217
2612
  updatePlatform(requestParameters: PlatformApiUpdatePlatformRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Platform, any>>;
3218
- /**
3219
- * Updates the warehouse product and its variants
3220
- * @summary Update warehouse product
3221
- * @param {PlatformApiUpdateProductRequest} requestParameters Request parameters.
3222
- * @param {*} [options] Override http request option.
3223
- * @throws {RequiredError}
3224
- * @memberof PlatformApi
3225
- */
3226
- updateProduct(requestParameters: PlatformApiUpdateProductRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Product, any>>;
3227
- /**
3228
- * Updates the warehouse variant
3229
- * @summary Update warehouse variant
3230
- * @param {PlatformApiUpdateVariantRequest} requestParameters Request parameters.
3231
- * @param {*} [options] Override http request option.
3232
- * @throws {RequiredError}
3233
- * @memberof PlatformApi
3234
- */
3235
- updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Variant, any>>;
3236
2613
  }
3237
2614
  /**
3238
2615
  * ProductsApi - axios parameter creator