@teemill/platform 0.10.0 → 0.11.1

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/base.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.10.0
8
+ * The version of the OpenAPI document: 0.11.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.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.10.0
5
+ * The version of the OpenAPI document: 0.11.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/common.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.10.0
8
+ * The version of the OpenAPI document: 0.11.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -2,7 +2,7 @@
2
2
  * Platform API
3
3
  * Manage Your podOS platform
4
4
  *
5
- * The version of the OpenAPI document: 0.10.0
5
+ * The version of the OpenAPI document: 0.11.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -5,7 +5,7 @@
5
5
  * Platform API
6
6
  * Manage Your podOS platform
7
7
  *
8
- * The version of the OpenAPI document: 0.10.0
8
+ * The version of the OpenAPI document: 0.11.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,13 +16,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
16
16
  exports.Configuration = void 0;
17
17
  class Configuration {
18
18
  constructor(param = {}) {
19
+ var _a;
19
20
  this.apiKey = param.apiKey;
20
21
  this.username = param.username;
21
22
  this.password = param.password;
22
23
  this.accessToken = param.accessToken;
23
24
  this.basePath = param.basePath;
24
25
  this.serverIndex = param.serverIndex;
25
- this.baseOptions = param.baseOptions;
26
+ this.baseOptions = Object.assign({ headers: Object.assign(Object.assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers), { 'User-Agent': "OpenAPI-Generator/0.11.1/typescript-axios" }) }, param.baseOptions);
26
27
  this.formDataCtor = param.formDataCtor;
27
28
  }
28
29
  /**
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.10.0
5
+ * The version of the OpenAPI document: 0.11.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -162,6 +162,56 @@ export interface ContactInformation {
162
162
  */
163
163
  'phone'?: string | null;
164
164
  }
165
+ /**
166
+ * The customer that has placed an order on your platform
167
+ * @export
168
+ * @interface Customer
169
+ */
170
+ export interface Customer {
171
+ /**
172
+ * Unique object identifier
173
+ * @type {string}
174
+ * @memberof Customer
175
+ */
176
+ 'id': string;
177
+ /**
178
+ *
179
+ * @type {string}
180
+ * @memberof Customer
181
+ */
182
+ 'email': string;
183
+ /**
184
+ *
185
+ * @type {string}
186
+ * @memberof Customer
187
+ */
188
+ 'firstName'?: string;
189
+ /**
190
+ *
191
+ * @type {string}
192
+ * @memberof Customer
193
+ */
194
+ 'lastName'?: string;
195
+ }
196
+ /**
197
+ *
198
+ * @export
199
+ * @interface CustomersResponse
200
+ */
201
+ export interface CustomersResponse {
202
+ /**
203
+ *
204
+ * @type {Array<Customer>}
205
+ * @memberof CustomersResponse
206
+ */
207
+ 'customers': Array<Customer>;
208
+ /**
209
+ *
210
+ * @type {number}
211
+ * @memberof CustomersResponse
212
+ */
213
+ 'nextPageToken'?: number | null;
214
+ }
165
215
  /**
166
216
  *
167
217
  * @export
@@ -1586,6 +1636,226 @@ export interface VariantPackedDimensions {
1586
1636
  */
1587
1637
  'depth'?: number;
1588
1638
  }
1639
+ /**
1640
+ * CustomersApi - axios parameter creator
1641
+ * @export
1642
+ */
1643
+ export declare const CustomersApiAxiosParamCreator: (configuration?: Configuration) => {
1644
+ /**
1645
+ * Export customers as a CSV file
1646
+ * @summary Export customers
1647
+ * @param {string} project Project unique identifier
1648
+ * @param {string} platformId The platform identifier
1649
+ * @param {*} [options] Override http request option.
1650
+ * @throws {RequiredError}
1651
+ */
1652
+ exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1653
+ /**
1654
+ * Get a customer for a platform by a given customer ID.
1655
+ * @summary Get customer
1656
+ * @param {string} project Project unique identifier
1657
+ * @param {string} platformId The platform identifier
1658
+ * @param {string} customerId The customer identifier
1659
+ * @param {*} [options] Override http request option.
1660
+ * @throws {RequiredError}
1661
+ */
1662
+ getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1663
+ /**
1664
+ * List customers for a platform
1665
+ * @summary List customers
1666
+ * @param {string} project Project unique identifier
1667
+ * @param {string} platformId The platform identifier
1668
+ * @param {number} [pageToken] Page reference token
1669
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1670
+ * @param {string} [search] Search term to filter based on order reference, customer name and email
1671
+ * @param {*} [options] Override http request option.
1672
+ * @throws {RequiredError}
1673
+ */
1674
+ listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
1675
+ };
1676
+ /**
1677
+ * CustomersApi - functional programming interface
1678
+ * @export
1679
+ */
1680
+ export declare const CustomersApiFp: (configuration?: Configuration) => {
1681
+ /**
1682
+ * Export customers as a CSV file
1683
+ * @summary Export customers
1684
+ * @param {string} project Project unique identifier
1685
+ * @param {string} platformId The platform identifier
1686
+ * @param {*} [options] Override http request option.
1687
+ * @throws {RequiredError}
1688
+ */
1689
+ exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
1690
+ /**
1691
+ * Get a customer for a platform by a given customer ID.
1692
+ * @summary Get customer
1693
+ * @param {string} project Project unique identifier
1694
+ * @param {string} platformId The platform identifier
1695
+ * @param {string} customerId The customer identifier
1696
+ * @param {*} [options] Override http request option.
1697
+ * @throws {RequiredError}
1698
+ */
1699
+ getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
1700
+ /**
1701
+ * List customers for a platform
1702
+ * @summary List customers
1703
+ * @param {string} project Project unique identifier
1704
+ * @param {string} platformId The platform identifier
1705
+ * @param {number} [pageToken] Page reference token
1706
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
1707
+ * @param {string} [search] Search term to filter based on order reference, customer name and email
1708
+ * @param {*} [options] Override http request option.
1709
+ * @throws {RequiredError}
1710
+ */
1711
+ listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
1712
+ };
1713
+ /**
1714
+ * CustomersApi - factory interface
1715
+ * @export
1716
+ */
1717
+ export declare const CustomersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
1718
+ /**
1719
+ * Export customers as a CSV file
1720
+ * @summary Export customers
1721
+ * @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
1722
+ * @param {*} [options] Override http request option.
1723
+ * @throws {RequiredError}
1724
+ */
1725
+ exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
1726
+ /**
1727
+ * Get a customer for a platform by a given customer ID.
1728
+ * @summary Get customer
1729
+ * @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
1730
+ * @param {*} [options] Override http request option.
1731
+ * @throws {RequiredError}
1732
+ */
1733
+ getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
1734
+ /**
1735
+ * List customers for a platform
1736
+ * @summary List customers
1737
+ * @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
1738
+ * @param {*} [options] Override http request option.
1739
+ * @throws {RequiredError}
1740
+ */
1741
+ listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
1742
+ };
1743
+ /**
1744
+ * Request parameters for exportCustomers operation in CustomersApi.
1745
+ * @export
1746
+ * @interface CustomersApiExportCustomersRequest
1747
+ */
1748
+ export interface CustomersApiExportCustomersRequest {
1749
+ /**
1750
+ * Project unique identifier
1751
+ * @type {string}
1752
+ * @memberof CustomersApiExportCustomers
1753
+ */
1754
+ readonly project: string;
1755
+ /**
1756
+ * The platform identifier
1757
+ * @type {string}
1758
+ * @memberof CustomersApiExportCustomers
1759
+ */
1760
+ readonly platformId: string;
1761
+ }
1762
+ /**
1763
+ * Request parameters for getCustomer operation in CustomersApi.
1764
+ * @export
1765
+ * @interface CustomersApiGetCustomerRequest
1766
+ */
1767
+ export interface CustomersApiGetCustomerRequest {
1768
+ /**
1769
+ * Project unique identifier
1770
+ * @type {string}
1771
+ * @memberof CustomersApiGetCustomer
1772
+ */
1773
+ readonly project: string;
1774
+ /**
1775
+ * The platform identifier
1776
+ * @type {string}
1777
+ * @memberof CustomersApiGetCustomer
1778
+ */
1779
+ readonly platformId: string;
1780
+ /**
1781
+ * The customer identifier
1782
+ * @type {string}
1783
+ * @memberof CustomersApiGetCustomer
1784
+ */
1785
+ readonly customerId: string;
1786
+ }
1787
+ /**
1788
+ * Request parameters for listCustomers operation in CustomersApi.
1789
+ * @export
1790
+ * @interface CustomersApiListCustomersRequest
1791
+ */
1792
+ export interface CustomersApiListCustomersRequest {
1793
+ /**
1794
+ * Project unique identifier
1795
+ * @type {string}
1796
+ * @memberof CustomersApiListCustomers
1797
+ */
1798
+ readonly project: string;
1799
+ /**
1800
+ * The platform identifier
1801
+ * @type {string}
1802
+ * @memberof CustomersApiListCustomers
1803
+ */
1804
+ readonly platformId: string;
1805
+ /**
1806
+ * Page reference token
1807
+ * @type {number}
1808
+ * @memberof CustomersApiListCustomers
1809
+ */
1810
+ readonly pageToken?: number;
1811
+ /**
1812
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
1813
+ * @type {number}
1814
+ * @memberof CustomersApiListCustomers
1815
+ */
1816
+ readonly pageSize?: number;
1817
+ /**
1818
+ * Search term to filter based on order reference, customer name and email
1819
+ * @type {string}
1820
+ * @memberof CustomersApiListCustomers
1821
+ */
1822
+ readonly search?: string;
1823
+ }
1824
+ /**
1825
+ * CustomersApi - object-oriented interface
1826
+ * @export
1827
+ * @class CustomersApi
1828
+ * @extends {BaseAPI}
1829
+ */
1830
+ export declare class CustomersApi extends BaseAPI {
1831
+ /**
1832
+ * Export customers as a CSV file
1833
+ * @summary Export customers
1834
+ * @param {CustomersApiExportCustomersRequest} requestParameters Request parameters.
1835
+ * @param {*} [options] Override http request option.
1836
+ * @throws {RequiredError}
1837
+ * @memberof CustomersApi
1838
+ */
1839
+ exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
1840
+ /**
1841
+ * Get a customer for a platform by a given customer ID.
1842
+ * @summary Get customer
1843
+ * @param {CustomersApiGetCustomerRequest} requestParameters Request parameters.
1844
+ * @param {*} [options] Override http request option.
1845
+ * @throws {RequiredError}
1846
+ * @memberof CustomersApi
1847
+ */
1848
+ getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
1849
+ /**
1850
+ * List customers for a platform
1851
+ * @summary List customers
1852
+ * @param {CustomersApiListCustomersRequest} requestParameters Request parameters.
1853
+ * @param {*} [options] Override http request option.
1854
+ * @throws {RequiredError}
1855
+ * @memberof CustomersApi
1856
+ */
1857
+ listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
1858
+ }
1589
1859
  /**
1590
1860
  * OrdersApi - axios parameter creator
1591
1861
  * @export
@@ -2045,6 +2315,15 @@ export declare class OrdersApi extends BaseAPI {
2045
2315
  * @export
2046
2316
  */
2047
2317
  export declare const PlatformApiAxiosParamCreator: (configuration?: Configuration) => {
2318
+ /**
2319
+ * Export customers as a CSV file
2320
+ * @summary Export customers
2321
+ * @param {string} project Project unique identifier
2322
+ * @param {string} platformId The platform identifier
2323
+ * @param {*} [options] Override http request option.
2324
+ * @throws {RequiredError}
2325
+ */
2326
+ exportCustomers: (project: string, platformId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2048
2327
  /**
2049
2328
  * Export orders as a CSV file
2050
2329
  * @summary Export orders
@@ -2057,6 +2336,16 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
2057
2336
  * @throws {RequiredError}
2058
2337
  */
2059
2338
  exportOrders: (project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2339
+ /**
2340
+ * Get a customer for a platform by a given customer ID.
2341
+ * @summary Get customer
2342
+ * @param {string} project Project unique identifier
2343
+ * @param {string} platformId The platform identifier
2344
+ * @param {string} customerId The customer identifier
2345
+ * @param {*} [options] Override http request option.
2346
+ * @throws {RequiredError}
2347
+ */
2348
+ getCustomer: (project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2060
2349
  /**
2061
2350
  * Get a fulfillment for a platform by a given fulfillment ID.
2062
2351
  * @summary Get fulfillment
@@ -2095,6 +2384,18 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
2095
2384
  * @throws {RequiredError}
2096
2385
  */
2097
2386
  listAvailableFulfillers: (project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2387
+ /**
2388
+ * List customers for a platform
2389
+ * @summary List customers
2390
+ * @param {string} project Project unique identifier
2391
+ * @param {string} platformId The platform identifier
2392
+ * @param {number} [pageToken] Page reference token
2393
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2394
+ * @param {string} [search] Search term to filter based on order reference, customer name and email
2395
+ * @param {*} [options] Override http request option.
2396
+ * @throws {RequiredError}
2397
+ */
2398
+ listCustomers: (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
2098
2399
  /**
2099
2400
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2100
2401
  * @summary List orders
@@ -2157,6 +2458,15 @@ export declare const PlatformApiAxiosParamCreator: (configuration?: Configuratio
2157
2458
  * @export
2158
2459
  */
2159
2460
  export declare const PlatformApiFp: (configuration?: Configuration) => {
2461
+ /**
2462
+ * Export customers as a CSV file
2463
+ * @summary Export customers
2464
+ * @param {string} project Project unique identifier
2465
+ * @param {string} platformId The platform identifier
2466
+ * @param {*} [options] Override http request option.
2467
+ * @throws {RequiredError}
2468
+ */
2469
+ exportCustomers(project: string, platformId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2160
2470
  /**
2161
2471
  * Export orders as a CSV file
2162
2472
  * @summary Export orders
@@ -2169,6 +2479,16 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
2169
2479
  * @throws {RequiredError}
2170
2480
  */
2171
2481
  exportOrders(project: string, platformId: string, start: string, end?: string, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
2482
+ /**
2483
+ * Get a customer for a platform by a given customer ID.
2484
+ * @summary Get customer
2485
+ * @param {string} project Project unique identifier
2486
+ * @param {string} platformId The platform identifier
2487
+ * @param {string} customerId The customer identifier
2488
+ * @param {*} [options] Override http request option.
2489
+ * @throws {RequiredError}
2490
+ */
2491
+ getCustomer(project: string, platformId: string, customerId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Customer>>;
2172
2492
  /**
2173
2493
  * Get a fulfillment for a platform by a given fulfillment ID.
2174
2494
  * @summary Get fulfillment
@@ -2207,6 +2527,18 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
2207
2527
  * @throws {RequiredError}
2208
2528
  */
2209
2529
  listAvailableFulfillers(project: string, platformId: string, fulfillmentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FulfillersResponse>>;
2530
+ /**
2531
+ * List customers for a platform
2532
+ * @summary List customers
2533
+ * @param {string} project Project unique identifier
2534
+ * @param {string} platformId The platform identifier
2535
+ * @param {number} [pageToken] Page reference token
2536
+ * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
2537
+ * @param {string} [search] Search term to filter based on order reference, customer name and email
2538
+ * @param {*} [options] Override http request option.
2539
+ * @throws {RequiredError}
2540
+ */
2541
+ listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>>;
2210
2542
  /**
2211
2543
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2212
2544
  * @summary List orders
@@ -2269,6 +2601,14 @@ export declare const PlatformApiFp: (configuration?: Configuration) => {
2269
2601
  * @export
2270
2602
  */
2271
2603
  export declare const PlatformApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
2604
+ /**
2605
+ * Export customers as a CSV file
2606
+ * @summary Export customers
2607
+ * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
2608
+ * @param {*} [options] Override http request option.
2609
+ * @throws {RequiredError}
2610
+ */
2611
+ exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2272
2612
  /**
2273
2613
  * Export orders as a CSV file
2274
2614
  * @summary Export orders
@@ -2277,6 +2617,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
2277
2617
  * @throws {RequiredError}
2278
2618
  */
2279
2619
  exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
2620
+ /**
2621
+ * Get a customer for a platform by a given customer ID.
2622
+ * @summary Get customer
2623
+ * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
2624
+ * @param {*} [options] Override http request option.
2625
+ * @throws {RequiredError}
2626
+ */
2627
+ getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer>;
2280
2628
  /**
2281
2629
  * Get a fulfillment for a platform by a given fulfillment ID.
2282
2630
  * @summary Get fulfillment
@@ -2309,6 +2657,14 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
2309
2657
  * @throws {RequiredError}
2310
2658
  */
2311
2659
  listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): AxiosPromise<FulfillersResponse>;
2660
+ /**
2661
+ * List customers for a platform
2662
+ * @summary List customers
2663
+ * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
2664
+ * @param {*} [options] Override http request option.
2665
+ * @throws {RequiredError}
2666
+ */
2667
+ listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse>;
2312
2668
  /**
2313
2669
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2314
2670
  * @summary List orders
@@ -2350,6 +2706,25 @@ export declare const PlatformApiFactory: (configuration?: Configuration, basePat
2350
2706
  */
2351
2707
  updateVariant(requestParameters: PlatformApiUpdateVariantRequest, options?: RawAxiosRequestConfig): AxiosPromise<Variant>;
2352
2708
  };
2709
+ /**
2710
+ * Request parameters for exportCustomers operation in PlatformApi.
2711
+ * @export
2712
+ * @interface PlatformApiExportCustomersRequest
2713
+ */
2714
+ export interface PlatformApiExportCustomersRequest {
2715
+ /**
2716
+ * Project unique identifier
2717
+ * @type {string}
2718
+ * @memberof PlatformApiExportCustomers
2719
+ */
2720
+ readonly project: string;
2721
+ /**
2722
+ * The platform identifier
2723
+ * @type {string}
2724
+ * @memberof PlatformApiExportCustomers
2725
+ */
2726
+ readonly platformId: string;
2727
+ }
2353
2728
  /**
2354
2729
  * Request parameters for exportOrders operation in PlatformApi.
2355
2730
  * @export
@@ -2387,6 +2762,31 @@ export interface PlatformApiExportOrdersRequest {
2387
2762
  */
2388
2763
  readonly search?: string;
2389
2764
  }
2765
+ /**
2766
+ * Request parameters for getCustomer operation in PlatformApi.
2767
+ * @export
2768
+ * @interface PlatformApiGetCustomerRequest
2769
+ */
2770
+ export interface PlatformApiGetCustomerRequest {
2771
+ /**
2772
+ * Project unique identifier
2773
+ * @type {string}
2774
+ * @memberof PlatformApiGetCustomer
2775
+ */
2776
+ readonly project: string;
2777
+ /**
2778
+ * The platform identifier
2779
+ * @type {string}
2780
+ * @memberof PlatformApiGetCustomer
2781
+ */
2782
+ readonly platformId: string;
2783
+ /**
2784
+ * The customer identifier
2785
+ * @type {string}
2786
+ * @memberof PlatformApiGetCustomer
2787
+ */
2788
+ readonly customerId: string;
2789
+ }
2390
2790
  /**
2391
2791
  * Request parameters for getFulfillment operation in PlatformApi.
2392
2792
  * @export
@@ -2475,6 +2875,43 @@ export interface PlatformApiListAvailableFulfillersRequest {
2475
2875
  */
2476
2876
  readonly fulfillmentId: string;
2477
2877
  }
2878
+ /**
2879
+ * Request parameters for listCustomers operation in PlatformApi.
2880
+ * @export
2881
+ * @interface PlatformApiListCustomersRequest
2882
+ */
2883
+ export interface PlatformApiListCustomersRequest {
2884
+ /**
2885
+ * Project unique identifier
2886
+ * @type {string}
2887
+ * @memberof PlatformApiListCustomers
2888
+ */
2889
+ readonly project: string;
2890
+ /**
2891
+ * The platform identifier
2892
+ * @type {string}
2893
+ * @memberof PlatformApiListCustomers
2894
+ */
2895
+ readonly platformId: string;
2896
+ /**
2897
+ * Page reference token
2898
+ * @type {number}
2899
+ * @memberof PlatformApiListCustomers
2900
+ */
2901
+ readonly pageToken?: number;
2902
+ /**
2903
+ * Max page size. This is the maximum page size that will be returned, but it might be smaller.
2904
+ * @type {number}
2905
+ * @memberof PlatformApiListCustomers
2906
+ */
2907
+ readonly pageSize?: number;
2908
+ /**
2909
+ * Search term to filter based on order reference, customer name and email
2910
+ * @type {string}
2911
+ * @memberof PlatformApiListCustomers
2912
+ */
2913
+ readonly search?: string;
2914
+ }
2478
2915
  /**
2479
2916
  * Request parameters for listOrders operation in PlatformApi.
2480
2917
  * @export
@@ -2643,6 +3080,15 @@ export interface PlatformApiUpdateVariantRequest {
2643
3080
  * @extends {BaseAPI}
2644
3081
  */
2645
3082
  export declare class PlatformApi extends BaseAPI {
3083
+ /**
3084
+ * Export customers as a CSV file
3085
+ * @summary Export customers
3086
+ * @param {PlatformApiExportCustomersRequest} requestParameters Request parameters.
3087
+ * @param {*} [options] Override http request option.
3088
+ * @throws {RequiredError}
3089
+ * @memberof PlatformApi
3090
+ */
3091
+ exportCustomers(requestParameters: PlatformApiExportCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
2646
3092
  /**
2647
3093
  * Export orders as a CSV file
2648
3094
  * @summary Export orders
@@ -2652,6 +3098,15 @@ export declare class PlatformApi extends BaseAPI {
2652
3098
  * @memberof PlatformApi
2653
3099
  */
2654
3100
  exportOrders(requestParameters: PlatformApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
3101
+ /**
3102
+ * Get a customer for a platform by a given customer ID.
3103
+ * @summary Get customer
3104
+ * @param {PlatformApiGetCustomerRequest} requestParameters Request parameters.
3105
+ * @param {*} [options] Override http request option.
3106
+ * @throws {RequiredError}
3107
+ * @memberof PlatformApi
3108
+ */
3109
+ getCustomer(requestParameters: PlatformApiGetCustomerRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Customer, any>>;
2655
3110
  /**
2656
3111
  * Get a fulfillment for a platform by a given fulfillment ID.
2657
3112
  * @summary Get fulfillment
@@ -2688,6 +3143,15 @@ export declare class PlatformApi extends BaseAPI {
2688
3143
  * @memberof PlatformApi
2689
3144
  */
2690
3145
  listAvailableFulfillers(requestParameters: PlatformApiListAvailableFulfillersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FulfillersResponse, any>>;
3146
+ /**
3147
+ * List customers for a platform
3148
+ * @summary List customers
3149
+ * @param {PlatformApiListCustomersRequest} requestParameters Request parameters.
3150
+ * @param {*} [options] Override http request option.
3151
+ * @throws {RequiredError}
3152
+ * @memberof PlatformApi
3153
+ */
3154
+ listCustomers(requestParameters: PlatformApiListCustomersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CustomersResponse, any>>;
2691
3155
  /**
2692
3156
  * Lists all orders placed on projects belonging to this platform, paginated into configurable chunks.
2693
3157
  * @summary List orders