@teemill/platform 0.33.1 → 0.34.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/README.md +4 -2
- package/api.ts +229 -14
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +138 -9
- package/dist/api.js +124 -11
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +138 -9
- package/dist/esm/api.js +124 -11
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/CustomersApi.md +81 -0
- package/docs/InlineObject1.md +4 -2
- package/docs/InlineObject2.md +20 -0
- package/docs/PaymentApi.md +2 -2
- package/index.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
## @teemill/platform@0.
|
|
1
|
+
## @teemill/platform@0.34.1
|
|
2
2
|
|
|
3
3
|
This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
|
|
4
4
|
|
|
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
|
|
|
36
36
|
_published:_
|
|
37
37
|
|
|
38
38
|
```
|
|
39
|
-
npm install @teemill/platform@0.
|
|
39
|
+
npm install @teemill/platform@0.34.1 --save
|
|
40
40
|
```
|
|
41
41
|
|
|
42
42
|
_unPublished (not recommended):_
|
|
@@ -53,6 +53,7 @@ Class | Method | HTTP request | Description
|
|
|
53
53
|
------------ | ------------- | ------------- | -------------
|
|
54
54
|
*CustomersApi* | [**exportCustomers**](docs/CustomersApi.md#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers
|
|
55
55
|
*CustomersApi* | [**getCustomer**](docs/CustomersApi.md#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer
|
|
56
|
+
*CustomersApi* | [**listCustomerTags**](docs/CustomersApi.md#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags
|
|
56
57
|
*CustomersApi* | [**listCustomers**](docs/CustomersApi.md#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers
|
|
57
58
|
*DashboardApi* | [**getDashboard**](docs/DashboardApi.md#getdashboard) | **GET** /v1/platform/{platformId}/dashboard | Get the platform\'s dashboard
|
|
58
59
|
*DashboardApi* | [**saveDashboard**](docs/DashboardApi.md#savedashboard) | **PUT** /v1/platform/{platformId}/dashboard | Save the platform\'s dashboard
|
|
@@ -144,6 +145,7 @@ Class | Method | HTTP request | Description
|
|
|
144
145
|
- [Image](docs/Image.md)
|
|
145
146
|
- [InlineObject](docs/InlineObject.md)
|
|
146
147
|
- [InlineObject1](docs/InlineObject1.md)
|
|
148
|
+
- [InlineObject2](docs/InlineObject2.md)
|
|
147
149
|
- [ListCustomerEnquiries200Response](docs/ListCustomerEnquiries200Response.md)
|
|
148
150
|
- [ListCustomerEnquiryLogs200Response](docs/ListCustomerEnquiryLogs200Response.md)
|
|
149
151
|
- [ListCustomerEnquiryLogs200ResponseLogsInner](docs/ListCustomerEnquiryLogs200ResponseLogsInner.md)
|
package/api.ts
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Platform API
|
|
5
5
|
* Manage Your podOS platform
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 0.
|
|
7
|
+
* The version of the OpenAPI document: 0.34.1
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -1146,10 +1146,29 @@ export interface InlineObject {
|
|
|
1146
1146
|
* @interface InlineObject1
|
|
1147
1147
|
*/
|
|
1148
1148
|
export interface InlineObject1 {
|
|
1149
|
+
/**
|
|
1150
|
+
*
|
|
1151
|
+
* @type {Array<string>}
|
|
1152
|
+
* @memberof InlineObject1
|
|
1153
|
+
*/
|
|
1154
|
+
'tags': Array<string>;
|
|
1155
|
+
/**
|
|
1156
|
+
*
|
|
1157
|
+
* @type {number}
|
|
1158
|
+
* @memberof InlineObject1
|
|
1159
|
+
*/
|
|
1160
|
+
'nextPageToken'?: number | null;
|
|
1161
|
+
}
|
|
1162
|
+
/**
|
|
1163
|
+
*
|
|
1164
|
+
* @export
|
|
1165
|
+
* @interface InlineObject2
|
|
1166
|
+
*/
|
|
1167
|
+
export interface InlineObject2 {
|
|
1149
1168
|
/**
|
|
1150
1169
|
* The URL to redirect to
|
|
1151
1170
|
* @type {string}
|
|
1152
|
-
* @memberof
|
|
1171
|
+
* @memberof InlineObject2
|
|
1153
1172
|
*/
|
|
1154
1173
|
'redirect_url': string;
|
|
1155
1174
|
}
|
|
@@ -2490,6 +2509,8 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2490
2509
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2491
2510
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2492
2511
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2512
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2513
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2493
2514
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2494
2515
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2495
2516
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2502,7 +2523,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2502
2523
|
* @param {*} [options] Override http request option.
|
|
2503
2524
|
* @throws {RequiredError}
|
|
2504
2525
|
*/
|
|
2505
|
-
exportCustomers: async (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2526
|
+
exportCustomers: async (project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2506
2527
|
// verify required parameter 'project' is not null or undefined
|
|
2507
2528
|
assertParamExists('exportCustomers', 'project', project)
|
|
2508
2529
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -2551,6 +2572,14 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2551
2572
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
2552
2573
|
}
|
|
2553
2574
|
|
|
2575
|
+
if (demographics) {
|
|
2576
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
2577
|
+
}
|
|
2578
|
+
|
|
2579
|
+
if (tags) {
|
|
2580
|
+
localVarQueryParameter['tags'] = tags;
|
|
2581
|
+
}
|
|
2582
|
+
|
|
2554
2583
|
if (usedDiscount !== undefined) {
|
|
2555
2584
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
2556
2585
|
}
|
|
@@ -2643,6 +2672,69 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2643
2672
|
|
|
2644
2673
|
|
|
2645
2674
|
|
|
2675
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2676
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2677
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
2678
|
+
|
|
2679
|
+
return {
|
|
2680
|
+
url: toPathString(localVarUrlObj),
|
|
2681
|
+
options: localVarRequestOptions,
|
|
2682
|
+
};
|
|
2683
|
+
},
|
|
2684
|
+
/**
|
|
2685
|
+
* List customer tags
|
|
2686
|
+
* @summary List customer tags
|
|
2687
|
+
* @param {string} project Project unique identifier
|
|
2688
|
+
* @param {string} platformId The platform identifier
|
|
2689
|
+
* @param {number} [pageToken] Page reference token
|
|
2690
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2691
|
+
* @param {string} [search] Search term to filter results
|
|
2692
|
+
* @param {*} [options] Override http request option.
|
|
2693
|
+
* @throws {RequiredError}
|
|
2694
|
+
*/
|
|
2695
|
+
listCustomerTags: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2696
|
+
// verify required parameter 'project' is not null or undefined
|
|
2697
|
+
assertParamExists('listCustomerTags', 'project', project)
|
|
2698
|
+
// verify required parameter 'platformId' is not null or undefined
|
|
2699
|
+
assertParamExists('listCustomerTags', 'platformId', platformId)
|
|
2700
|
+
const localVarPath = `/v1/platform/{platformId}/customers/tags`
|
|
2701
|
+
.replace(`{${"platformId"}}`, encodeURIComponent(String(platformId)));
|
|
2702
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
2703
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
2704
|
+
let baseOptions;
|
|
2705
|
+
if (configuration) {
|
|
2706
|
+
baseOptions = configuration.baseOptions;
|
|
2707
|
+
}
|
|
2708
|
+
|
|
2709
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
2710
|
+
const localVarHeaderParameter = {} as any;
|
|
2711
|
+
const localVarQueryParameter = {} as any;
|
|
2712
|
+
|
|
2713
|
+
// authentication session-oauth required
|
|
2714
|
+
// oauth required
|
|
2715
|
+
await setOAuthToObject(localVarHeaderParameter, "session-oauth", [], configuration)
|
|
2716
|
+
|
|
2717
|
+
// authentication api-key required
|
|
2718
|
+
await setApiKeyToObject(localVarHeaderParameter, "Authorization", configuration)
|
|
2719
|
+
|
|
2720
|
+
if (project !== undefined) {
|
|
2721
|
+
localVarQueryParameter['project'] = project;
|
|
2722
|
+
}
|
|
2723
|
+
|
|
2724
|
+
if (pageToken !== undefined) {
|
|
2725
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
2726
|
+
}
|
|
2727
|
+
|
|
2728
|
+
if (pageSize !== undefined) {
|
|
2729
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
2730
|
+
}
|
|
2731
|
+
|
|
2732
|
+
if (search !== undefined) {
|
|
2733
|
+
localVarQueryParameter['search'] = search;
|
|
2734
|
+
}
|
|
2735
|
+
|
|
2736
|
+
|
|
2737
|
+
|
|
2646
2738
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
2647
2739
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
2648
2740
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -2665,6 +2757,8 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2665
2757
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2666
2758
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2667
2759
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2760
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2761
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2668
2762
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2669
2763
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2670
2764
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2677,7 +2771,7 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2677
2771
|
* @param {*} [options] Override http request option.
|
|
2678
2772
|
* @throws {RequiredError}
|
|
2679
2773
|
*/
|
|
2680
|
-
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2774
|
+
listCustomers: async (project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
2681
2775
|
// verify required parameter 'project' is not null or undefined
|
|
2682
2776
|
assertParamExists('listCustomers', 'project', project)
|
|
2683
2777
|
// verify required parameter 'platformId' is not null or undefined
|
|
@@ -2738,6 +2832,14 @@ export const CustomersApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2738
2832
|
localVarQueryParameter['productTypes'] = productTypes;
|
|
2739
2833
|
}
|
|
2740
2834
|
|
|
2835
|
+
if (demographics) {
|
|
2836
|
+
localVarQueryParameter['demographics'] = demographics;
|
|
2837
|
+
}
|
|
2838
|
+
|
|
2839
|
+
if (tags) {
|
|
2840
|
+
localVarQueryParameter['tags'] = tags;
|
|
2841
|
+
}
|
|
2842
|
+
|
|
2741
2843
|
if (usedDiscount !== undefined) {
|
|
2742
2844
|
localVarQueryParameter['usedDiscount'] = usedDiscount;
|
|
2743
2845
|
}
|
|
@@ -2807,6 +2909,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2807
2909
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2808
2910
|
* @param {ExportCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2809
2911
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2912
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2913
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2810
2914
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2811
2915
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2812
2916
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2819,8 +2923,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2819
2923
|
* @param {*} [options] Override http request option.
|
|
2820
2924
|
* @throws {RequiredError}
|
|
2821
2925
|
*/
|
|
2822
|
-
async exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
2823
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2926
|
+
async exportCustomers(project: string, platformId: string, sortBy?: Array<ExportCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ExportCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>> {
|
|
2927
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.exportCustomers(project, platformId, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2824
2928
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2825
2929
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.exportCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2826
2930
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2840,6 +2944,23 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2840
2944
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.getCustomer']?.[localVarOperationServerIndex]?.url;
|
|
2841
2945
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2842
2946
|
},
|
|
2947
|
+
/**
|
|
2948
|
+
* List customer tags
|
|
2949
|
+
* @summary List customer tags
|
|
2950
|
+
* @param {string} project Project unique identifier
|
|
2951
|
+
* @param {string} platformId The platform identifier
|
|
2952
|
+
* @param {number} [pageToken] Page reference token
|
|
2953
|
+
* @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
2954
|
+
* @param {string} [search] Search term to filter results
|
|
2955
|
+
* @param {*} [options] Override http request option.
|
|
2956
|
+
* @throws {RequiredError}
|
|
2957
|
+
*/
|
|
2958
|
+
async listCustomerTags(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject1>> {
|
|
2959
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomerTags(project, platformId, pageToken, pageSize, search, options);
|
|
2960
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2961
|
+
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomerTags']?.[localVarOperationServerIndex]?.url;
|
|
2962
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2963
|
+
},
|
|
2843
2964
|
/**
|
|
2844
2965
|
* List customers for a platform
|
|
2845
2966
|
* @summary List customers
|
|
@@ -2853,6 +2974,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2853
2974
|
* @param {Array<string>} [projects] Filter customers by project. In the absence of this field, all projects will be included in the export.
|
|
2854
2975
|
* @param {ListCustomersGenderEnum} [gender] Filter customers by gender equal to the value provided
|
|
2855
2976
|
* @param {Array<number>} [productTypes] Filter customers by purchased product types. In the absence of this field, all customers will be included in the export.
|
|
2977
|
+
* @param {Array<string>} [demographics] Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
2978
|
+
* @param {Array<string>} [tags] Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
2856
2979
|
* @param {boolean} [usedDiscount] Filter customers by whether they have used a discount
|
|
2857
2980
|
* @param {number} [minimumTotalOrderCount] Filter customers by total order count greater than or equal to the value provided
|
|
2858
2981
|
* @param {number} [maximumTotalOrderCount] Filter customers by total order count less than or equal to the value provided
|
|
@@ -2865,8 +2988,8 @@ export const CustomersApiFp = function(configuration?: Configuration) {
|
|
|
2865
2988
|
* @param {*} [options] Override http request option.
|
|
2866
2989
|
* @throws {RequiredError}
|
|
2867
2990
|
*/
|
|
2868
|
-
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2869
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2991
|
+
async listCustomers(project: string, platformId: string, pageToken?: number, pageSize?: number, search?: string, sortBy?: Array<ListCustomersSortByEnum>, countries?: Array<string>, projects?: Array<string>, gender?: ListCustomersGenderEnum, productTypes?: Array<number>, demographics?: Array<string>, tags?: Array<string>, usedDiscount?: boolean, minimumTotalOrderCount?: number, maximumTotalOrderCount?: number, minimumRefundedOrderCount?: number, maximumRefundedOrderCount?: number, minimumLifetimeValue?: number, maximumLifetimeValue?: number, lastPurchasedStart?: string, lastPurchasedEnd?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CustomersResponse>> {
|
|
2992
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listCustomers(project, platformId, pageToken, pageSize, search, sortBy, countries, projects, gender, productTypes, demographics, tags, usedDiscount, minimumTotalOrderCount, maximumTotalOrderCount, minimumRefundedOrderCount, maximumRefundedOrderCount, minimumLifetimeValue, maximumLifetimeValue, lastPurchasedStart, lastPurchasedEnd, options);
|
|
2870
2993
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
2871
2994
|
const localVarOperationServerBasePath = operationServerMap['CustomersApi.listCustomers']?.[localVarOperationServerIndex]?.url;
|
|
2872
2995
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -2889,7 +3012,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2889
3012
|
* @throws {RequiredError}
|
|
2890
3013
|
*/
|
|
2891
3014
|
exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File> {
|
|
2892
|
-
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
3015
|
+
return localVarFp.exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2893
3016
|
},
|
|
2894
3017
|
/**
|
|
2895
3018
|
* Get a customer for a platform by a given customer ID.
|
|
@@ -2901,6 +3024,16 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2901
3024
|
getCustomer(requestParameters: CustomersApiGetCustomerRequest, options?: RawAxiosRequestConfig): AxiosPromise<Customer> {
|
|
2902
3025
|
return localVarFp.getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(axios, basePath));
|
|
2903
3026
|
},
|
|
3027
|
+
/**
|
|
3028
|
+
* List customer tags
|
|
3029
|
+
* @summary List customer tags
|
|
3030
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
3031
|
+
* @param {*} [options] Override http request option.
|
|
3032
|
+
* @throws {RequiredError}
|
|
3033
|
+
*/
|
|
3034
|
+
listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject1> {
|
|
3035
|
+
return localVarFp.listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(axios, basePath));
|
|
3036
|
+
},
|
|
2904
3037
|
/**
|
|
2905
3038
|
* List customers for a platform
|
|
2906
3039
|
* @summary List customers
|
|
@@ -2909,7 +3042,7 @@ export const CustomersApiFactory = function (configuration?: Configuration, base
|
|
|
2909
3042
|
* @throws {RequiredError}
|
|
2910
3043
|
*/
|
|
2911
3044
|
listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig): AxiosPromise<CustomersResponse> {
|
|
2912
|
-
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
3045
|
+
return localVarFp.listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(axios, basePath));
|
|
2913
3046
|
},
|
|
2914
3047
|
};
|
|
2915
3048
|
};
|
|
@@ -2969,6 +3102,20 @@ export interface CustomersApiExportCustomersRequest {
|
|
|
2969
3102
|
*/
|
|
2970
3103
|
readonly productTypes?: Array<number>
|
|
2971
3104
|
|
|
3105
|
+
/**
|
|
3106
|
+
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
3107
|
+
* @type {Array<string>}
|
|
3108
|
+
* @memberof CustomersApiExportCustomers
|
|
3109
|
+
*/
|
|
3110
|
+
readonly demographics?: Array<string>
|
|
3111
|
+
|
|
3112
|
+
/**
|
|
3113
|
+
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
3114
|
+
* @type {Array<string>}
|
|
3115
|
+
* @memberof CustomersApiExportCustomers
|
|
3116
|
+
*/
|
|
3117
|
+
readonly tags?: Array<string>
|
|
3118
|
+
|
|
2972
3119
|
/**
|
|
2973
3120
|
* Filter customers by whether they have used a discount
|
|
2974
3121
|
* @type {boolean}
|
|
@@ -3061,6 +3208,48 @@ export interface CustomersApiGetCustomerRequest {
|
|
|
3061
3208
|
readonly customerId: string
|
|
3062
3209
|
}
|
|
3063
3210
|
|
|
3211
|
+
/**
|
|
3212
|
+
* Request parameters for listCustomerTags operation in CustomersApi.
|
|
3213
|
+
* @export
|
|
3214
|
+
* @interface CustomersApiListCustomerTagsRequest
|
|
3215
|
+
*/
|
|
3216
|
+
export interface CustomersApiListCustomerTagsRequest {
|
|
3217
|
+
/**
|
|
3218
|
+
* Project unique identifier
|
|
3219
|
+
* @type {string}
|
|
3220
|
+
* @memberof CustomersApiListCustomerTags
|
|
3221
|
+
*/
|
|
3222
|
+
readonly project: string
|
|
3223
|
+
|
|
3224
|
+
/**
|
|
3225
|
+
* The platform identifier
|
|
3226
|
+
* @type {string}
|
|
3227
|
+
* @memberof CustomersApiListCustomerTags
|
|
3228
|
+
*/
|
|
3229
|
+
readonly platformId: string
|
|
3230
|
+
|
|
3231
|
+
/**
|
|
3232
|
+
* Page reference token
|
|
3233
|
+
* @type {number}
|
|
3234
|
+
* @memberof CustomersApiListCustomerTags
|
|
3235
|
+
*/
|
|
3236
|
+
readonly pageToken?: number
|
|
3237
|
+
|
|
3238
|
+
/**
|
|
3239
|
+
* Max page size. This is the maximum page size that will be returned, but it might be smaller.
|
|
3240
|
+
* @type {number}
|
|
3241
|
+
* @memberof CustomersApiListCustomerTags
|
|
3242
|
+
*/
|
|
3243
|
+
readonly pageSize?: number
|
|
3244
|
+
|
|
3245
|
+
/**
|
|
3246
|
+
* Search term to filter results
|
|
3247
|
+
* @type {string}
|
|
3248
|
+
* @memberof CustomersApiListCustomerTags
|
|
3249
|
+
*/
|
|
3250
|
+
readonly search?: string
|
|
3251
|
+
}
|
|
3252
|
+
|
|
3064
3253
|
/**
|
|
3065
3254
|
* Request parameters for listCustomers operation in CustomersApi.
|
|
3066
3255
|
* @export
|
|
@@ -3137,6 +3326,20 @@ export interface CustomersApiListCustomersRequest {
|
|
|
3137
3326
|
*/
|
|
3138
3327
|
readonly productTypes?: Array<number>
|
|
3139
3328
|
|
|
3329
|
+
/**
|
|
3330
|
+
* Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export.
|
|
3331
|
+
* @type {Array<string>}
|
|
3332
|
+
* @memberof CustomersApiListCustomers
|
|
3333
|
+
*/
|
|
3334
|
+
readonly demographics?: Array<string>
|
|
3335
|
+
|
|
3336
|
+
/**
|
|
3337
|
+
* Filter customers by purchase tags. In the absence of this field, all customers will be included in the export.
|
|
3338
|
+
* @type {Array<string>}
|
|
3339
|
+
* @memberof CustomersApiListCustomers
|
|
3340
|
+
*/
|
|
3341
|
+
readonly tags?: Array<string>
|
|
3342
|
+
|
|
3140
3343
|
/**
|
|
3141
3344
|
* Filter customers by whether they have used a discount
|
|
3142
3345
|
* @type {boolean}
|
|
@@ -3217,7 +3420,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
3217
3420
|
* @memberof CustomersApi
|
|
3218
3421
|
*/
|
|
3219
3422
|
public exportCustomers(requestParameters: CustomersApiExportCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
3220
|
-
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
3423
|
+
return CustomersApiFp(this.configuration).exportCustomers(requestParameters.project, requestParameters.platformId, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
3221
3424
|
}
|
|
3222
3425
|
|
|
3223
3426
|
/**
|
|
@@ -3232,6 +3435,18 @@ export class CustomersApi extends BaseAPI {
|
|
|
3232
3435
|
return CustomersApiFp(this.configuration).getCustomer(requestParameters.project, requestParameters.platformId, requestParameters.customerId, options).then((request) => request(this.axios, this.basePath));
|
|
3233
3436
|
}
|
|
3234
3437
|
|
|
3438
|
+
/**
|
|
3439
|
+
* List customer tags
|
|
3440
|
+
* @summary List customer tags
|
|
3441
|
+
* @param {CustomersApiListCustomerTagsRequest} requestParameters Request parameters.
|
|
3442
|
+
* @param {*} [options] Override http request option.
|
|
3443
|
+
* @throws {RequiredError}
|
|
3444
|
+
* @memberof CustomersApi
|
|
3445
|
+
*/
|
|
3446
|
+
public listCustomerTags(requestParameters: CustomersApiListCustomerTagsRequest, options?: RawAxiosRequestConfig) {
|
|
3447
|
+
return CustomersApiFp(this.configuration).listCustomerTags(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, options).then((request) => request(this.axios, this.basePath));
|
|
3448
|
+
}
|
|
3449
|
+
|
|
3235
3450
|
/**
|
|
3236
3451
|
* List customers for a platform
|
|
3237
3452
|
* @summary List customers
|
|
@@ -3241,7 +3456,7 @@ export class CustomersApi extends BaseAPI {
|
|
|
3241
3456
|
* @memberof CustomersApi
|
|
3242
3457
|
*/
|
|
3243
3458
|
public listCustomers(requestParameters: CustomersApiListCustomersRequest, options?: RawAxiosRequestConfig) {
|
|
3244
|
-
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
3459
|
+
return CustomersApiFp(this.configuration).listCustomers(requestParameters.project, requestParameters.platformId, requestParameters.pageToken, requestParameters.pageSize, requestParameters.search, requestParameters.sortBy, requestParameters.countries, requestParameters.projects, requestParameters.gender, requestParameters.productTypes, requestParameters.demographics, requestParameters.tags, requestParameters.usedDiscount, requestParameters.minimumTotalOrderCount, requestParameters.maximumTotalOrderCount, requestParameters.minimumRefundedOrderCount, requestParameters.maximumRefundedOrderCount, requestParameters.minimumLifetimeValue, requestParameters.maximumLifetimeValue, requestParameters.lastPurchasedStart, requestParameters.lastPurchasedEnd, options).then((request) => request(this.axios, this.basePath));
|
|
3245
3460
|
}
|
|
3246
3461
|
}
|
|
3247
3462
|
|
|
@@ -6164,7 +6379,7 @@ export const PaymentApiFp = function(configuration?: Configuration) {
|
|
|
6164
6379
|
* @param {*} [options] Override http request option.
|
|
6165
6380
|
* @throws {RequiredError}
|
|
6166
6381
|
*/
|
|
6167
|
-
async authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
6382
|
+
async authorizeStripe(project: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InlineObject2>> {
|
|
6168
6383
|
const localVarAxiosArgs = await localVarAxiosParamCreator.authorizeStripe(project, options);
|
|
6169
6384
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
6170
6385
|
const localVarOperationServerBasePath = operationServerMap['PaymentApi.authorizeStripe']?.[localVarOperationServerIndex]?.url;
|
|
@@ -6213,7 +6428,7 @@ export const PaymentApiFactory = function (configuration?: Configuration, basePa
|
|
|
6213
6428
|
* @param {*} [options] Override http request option.
|
|
6214
6429
|
* @throws {RequiredError}
|
|
6215
6430
|
*/
|
|
6216
|
-
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
6431
|
+
authorizeStripe(requestParameters: PaymentApiAuthorizeStripeRequest, options?: RawAxiosRequestConfig): AxiosPromise<InlineObject2> {
|
|
6217
6432
|
return localVarFp.authorizeStripe(requestParameters.project, options).then((request) => request(axios, basePath));
|
|
6218
6433
|
},
|
|
6219
6434
|
/**
|
package/base.ts
CHANGED
package/common.ts
CHANGED
package/configuration.ts
CHANGED