@teemill/platform 0.33.1 → 0.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/api.ts +211 -2152
- package/base.ts +1 -25
- package/common.ts +1 -2
- package/configuration.ts +1 -18
- package/dist/api.d.ts +128 -2155
- package/dist/api.js +123 -131
- package/dist/base.d.ts +1 -25
- package/dist/base.js +1 -20
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -18
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +128 -2155
- package/dist/esm/api.js +123 -131
- package/dist/esm/base.d.ts +1 -25
- package/dist/esm/base.js +1 -20
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -18
- 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/ListCustomerTags200Response.md +22 -0
- package/docs/ListDomains200Response.md +22 -0
- package/docs/PaymentApi.md +2 -2
- package/docs/Platform.md +2 -0
- package/docs/PlatformApi.md +4 -4
- package/docs/UpdatePlatformRequest.md +2 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/base.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.
|
|
5
|
+
* The version of the OpenAPI document: 0.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -12,42 +12,22 @@
|
|
|
12
12
|
import type { Configuration } from './configuration';
|
|
13
13
|
import type { AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
export declare const BASE_PATH: string;
|
|
15
|
-
/**
|
|
16
|
-
*
|
|
17
|
-
* @export
|
|
18
|
-
*/
|
|
19
15
|
export declare const COLLECTION_FORMATS: {
|
|
20
16
|
csv: string;
|
|
21
17
|
ssv: string;
|
|
22
18
|
tsv: string;
|
|
23
19
|
pipes: string;
|
|
24
20
|
};
|
|
25
|
-
/**
|
|
26
|
-
*
|
|
27
|
-
* @export
|
|
28
|
-
* @interface RequestArgs
|
|
29
|
-
*/
|
|
30
21
|
export interface RequestArgs {
|
|
31
22
|
url: string;
|
|
32
23
|
options: RawAxiosRequestConfig;
|
|
33
24
|
}
|
|
34
|
-
/**
|
|
35
|
-
*
|
|
36
|
-
* @export
|
|
37
|
-
* @class BaseAPI
|
|
38
|
-
*/
|
|
39
25
|
export declare class BaseAPI {
|
|
40
26
|
protected basePath: string;
|
|
41
27
|
protected axios: AxiosInstance;
|
|
42
28
|
protected configuration: Configuration | undefined;
|
|
43
29
|
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
|
|
44
30
|
}
|
|
45
|
-
/**
|
|
46
|
-
*
|
|
47
|
-
* @export
|
|
48
|
-
* @class RequiredError
|
|
49
|
-
* @extends {Error}
|
|
50
|
-
*/
|
|
51
31
|
export declare class RequiredError extends Error {
|
|
52
32
|
field: string;
|
|
53
33
|
constructor(field: string, msg?: string);
|
|
@@ -58,9 +38,5 @@ interface ServerMap {
|
|
|
58
38
|
description: string;
|
|
59
39
|
}[];
|
|
60
40
|
}
|
|
61
|
-
/**
|
|
62
|
-
*
|
|
63
|
-
* @export
|
|
64
|
-
*/
|
|
65
41
|
export declare const operationServerMap: ServerMap;
|
|
66
42
|
export {};
|
package/dist/esm/base.js
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.35.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -13,21 +13,12 @@
|
|
|
13
13
|
*/
|
|
14
14
|
import globalAxios from 'axios';
|
|
15
15
|
export const BASE_PATH = "https://localhost:8080".replace(/\/+$/, "");
|
|
16
|
-
/**
|
|
17
|
-
*
|
|
18
|
-
* @export
|
|
19
|
-
*/
|
|
20
16
|
export const COLLECTION_FORMATS = {
|
|
21
17
|
csv: ",",
|
|
22
18
|
ssv: " ",
|
|
23
19
|
tsv: "\t",
|
|
24
20
|
pipes: "|",
|
|
25
21
|
};
|
|
26
|
-
/**
|
|
27
|
-
*
|
|
28
|
-
* @export
|
|
29
|
-
* @class BaseAPI
|
|
30
|
-
*/
|
|
31
22
|
export class BaseAPI {
|
|
32
23
|
constructor(configuration, basePath = BASE_PATH, axios = globalAxios) {
|
|
33
24
|
var _a;
|
|
@@ -40,12 +31,6 @@ export class BaseAPI {
|
|
|
40
31
|
}
|
|
41
32
|
}
|
|
42
33
|
;
|
|
43
|
-
/**
|
|
44
|
-
*
|
|
45
|
-
* @export
|
|
46
|
-
* @class RequiredError
|
|
47
|
-
* @extends {Error}
|
|
48
|
-
*/
|
|
49
34
|
export class RequiredError extends Error {
|
|
50
35
|
constructor(field, msg) {
|
|
51
36
|
super(msg);
|
|
@@ -53,8 +38,4 @@ export class RequiredError extends Error {
|
|
|
53
38
|
this.name = "RequiredError";
|
|
54
39
|
}
|
|
55
40
|
}
|
|
56
|
-
/**
|
|
57
|
-
*
|
|
58
|
-
* @export
|
|
59
|
-
*/
|
|
60
41
|
export const operationServerMap = {};
|
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
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.
|
|
5
|
+
* The version of the OpenAPI document: 0.35.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -23,49 +23,32 @@ export declare class Configuration {
|
|
|
23
23
|
/**
|
|
24
24
|
* parameter for apiKey security
|
|
25
25
|
* @param name security name
|
|
26
|
-
* @memberof Configuration
|
|
27
26
|
*/
|
|
28
27
|
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
|
|
29
28
|
/**
|
|
30
29
|
* parameter for basic security
|
|
31
|
-
*
|
|
32
|
-
* @type {string}
|
|
33
|
-
* @memberof Configuration
|
|
34
30
|
*/
|
|
35
31
|
username?: string;
|
|
36
32
|
/**
|
|
37
33
|
* parameter for basic security
|
|
38
|
-
*
|
|
39
|
-
* @type {string}
|
|
40
|
-
* @memberof Configuration
|
|
41
34
|
*/
|
|
42
35
|
password?: string;
|
|
43
36
|
/**
|
|
44
37
|
* parameter for oauth2 security
|
|
45
38
|
* @param name security name
|
|
46
39
|
* @param scopes oauth2 scope
|
|
47
|
-
* @memberof Configuration
|
|
48
40
|
*/
|
|
49
41
|
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
|
|
50
42
|
/**
|
|
51
43
|
* override base path
|
|
52
|
-
*
|
|
53
|
-
* @type {string}
|
|
54
|
-
* @memberof Configuration
|
|
55
44
|
*/
|
|
56
45
|
basePath?: string;
|
|
57
46
|
/**
|
|
58
47
|
* override server index
|
|
59
|
-
*
|
|
60
|
-
* @type {number}
|
|
61
|
-
* @memberof Configuration
|
|
62
48
|
*/
|
|
63
49
|
serverIndex?: number;
|
|
64
50
|
/**
|
|
65
51
|
* base options for axios calls
|
|
66
|
-
*
|
|
67
|
-
* @type {any}
|
|
68
|
-
* @memberof Configuration
|
|
69
52
|
*/
|
|
70
53
|
baseOptions?: any;
|
|
71
54
|
/**
|
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/CustomersApi.md
CHANGED
|
@@ -6,6 +6,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**exportCustomers**](#exportcustomers) | **GET** /v1/platform/{platformId}/customers/export | Export customers|
|
|
8
8
|
|[**getCustomer**](#getcustomer) | **GET** /v1/platform/{platformId}/customers/{customerId} | Get customer|
|
|
9
|
+
|[**listCustomerTags**](#listcustomertags) | **GET** /v1/platform/{platformId}/customers/tags | List customer tags|
|
|
9
10
|
|[**listCustomers**](#listcustomers) | **GET** /v1/platform/{platformId}/customers | List customers|
|
|
10
11
|
|
|
11
12
|
# **exportCustomers**
|
|
@@ -31,6 +32,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
31
32
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
32
33
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
33
34
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
35
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
36
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
34
37
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
35
38
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
36
39
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -49,6 +52,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
49
52
|
projects,
|
|
50
53
|
gender,
|
|
51
54
|
productTypes,
|
|
55
|
+
demographics,
|
|
56
|
+
tags,
|
|
52
57
|
usedDiscount,
|
|
53
58
|
minimumTotalOrderCount,
|
|
54
59
|
maximumTotalOrderCount,
|
|
@@ -72,6 +77,8 @@ const { status, data } = await apiInstance.exportCustomers(
|
|
|
72
77
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
73
78
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
74
79
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
80
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
81
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
75
82
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
76
83
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
77
84
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
|
@@ -171,6 +178,74 @@ const { status, data } = await apiInstance.getCustomer(
|
|
|
171
178
|
|
|
172
179
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
173
180
|
|
|
181
|
+
# **listCustomerTags**
|
|
182
|
+
> ListCustomerTags200Response listCustomerTags()
|
|
183
|
+
|
|
184
|
+
List customer tags
|
|
185
|
+
|
|
186
|
+
### Example
|
|
187
|
+
|
|
188
|
+
```typescript
|
|
189
|
+
import {
|
|
190
|
+
CustomersApi,
|
|
191
|
+
Configuration
|
|
192
|
+
} from '@teemill/platform';
|
|
193
|
+
|
|
194
|
+
const configuration = new Configuration();
|
|
195
|
+
const apiInstance = new CustomersApi(configuration);
|
|
196
|
+
|
|
197
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
198
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
199
|
+
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
200
|
+
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
201
|
+
let search: string; //Search term to filter results (optional) (default to undefined)
|
|
202
|
+
|
|
203
|
+
const { status, data } = await apiInstance.listCustomerTags(
|
|
204
|
+
project,
|
|
205
|
+
platformId,
|
|
206
|
+
pageToken,
|
|
207
|
+
pageSize,
|
|
208
|
+
search
|
|
209
|
+
);
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Parameters
|
|
213
|
+
|
|
214
|
+
|Name | Type | Description | Notes|
|
|
215
|
+
|------------- | ------------- | ------------- | -------------|
|
|
216
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
217
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
218
|
+
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
219
|
+
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
220
|
+
| **search** | [**string**] | Search term to filter results | (optional) defaults to undefined|
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
### Return type
|
|
224
|
+
|
|
225
|
+
**ListCustomerTags200Response**
|
|
226
|
+
|
|
227
|
+
### Authorization
|
|
228
|
+
|
|
229
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
230
|
+
|
|
231
|
+
### HTTP request headers
|
|
232
|
+
|
|
233
|
+
- **Content-Type**: Not defined
|
|
234
|
+
- **Accept**: application/json
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
### HTTP response details
|
|
238
|
+
| Status code | Description | Response headers |
|
|
239
|
+
|-------------|-------------|------------------|
|
|
240
|
+
|**200** | Customer tags response | - |
|
|
241
|
+
|**400** | Failed validation | - |
|
|
242
|
+
|**401** | Not authorised to access this resource | - |
|
|
243
|
+
|**403** | Refuse to authorize | - |
|
|
244
|
+
|**404** | Resource not found | - |
|
|
245
|
+
|**500** | Unknown server error | - |
|
|
246
|
+
|
|
247
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
248
|
+
|
|
174
249
|
# **listCustomers**
|
|
175
250
|
> CustomersResponse listCustomers()
|
|
176
251
|
|
|
@@ -197,6 +272,8 @@ let countries: Array<string>; //Filter customers by country code (optional) (def
|
|
|
197
272
|
let projects: Array<string>; //Filter customers by project. In the absence of this field, all projects will be included in the export. (optional) (default to undefined)
|
|
198
273
|
let gender: 'male' | 'female'; //Filter customers by gender equal to the value provided (optional) (default to undefined)
|
|
199
274
|
let productTypes: Array<number>; //Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
275
|
+
let demographics: Array<string>; //Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
276
|
+
let tags: Array<string>; //Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. (optional) (default to undefined)
|
|
200
277
|
let usedDiscount: boolean; //Filter customers by whether they have used a discount (optional) (default to undefined)
|
|
201
278
|
let minimumTotalOrderCount: number; //Filter customers by total order count greater than or equal to the value provided (optional) (default to undefined)
|
|
202
279
|
let maximumTotalOrderCount: number; //Filter customers by total order count less than or equal to the value provided (optional) (default to undefined)
|
|
@@ -218,6 +295,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
218
295
|
projects,
|
|
219
296
|
gender,
|
|
220
297
|
productTypes,
|
|
298
|
+
demographics,
|
|
299
|
+
tags,
|
|
221
300
|
usedDiscount,
|
|
222
301
|
minimumTotalOrderCount,
|
|
223
302
|
maximumTotalOrderCount,
|
|
@@ -244,6 +323,8 @@ const { status, data } = await apiInstance.listCustomers(
|
|
|
244
323
|
| **projects** | **Array<string>** | Filter customers by project. In the absence of this field, all projects will be included in the export. | (optional) defaults to undefined|
|
|
245
324
|
| **gender** | [**'male' | 'female'**]**Array<'male' | 'female'>** | Filter customers by gender equal to the value provided | (optional) defaults to undefined|
|
|
246
325
|
| **productTypes** | **Array<number>** | Filter customers by purchased product types. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
326
|
+
| **demographics** | **Array<string>** | Filter customers by purchase demographics. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
327
|
+
| **tags** | **Array<string>** | Filter customers by purchase tags. In the absence of this field, all customers will be included in the export. | (optional) defaults to undefined|
|
|
247
328
|
| **usedDiscount** | [**boolean**] | Filter customers by whether they have used a discount | (optional) defaults to undefined|
|
|
248
329
|
| **minimumTotalOrderCount** | [**number**] | Filter customers by total order count greater than or equal to the value provided | (optional) defaults to undefined|
|
|
249
330
|
| **maximumTotalOrderCount** | [**number**] | Filter customers by total order count less than or equal to the value provided | (optional) defaults to undefined|
|
package/docs/InlineObject1.md
CHANGED
|
@@ -5,7 +5,8 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**tags** | **Array<string>** | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -13,7 +14,8 @@ Name | Type | Description | Notes
|
|
|
13
14
|
import { InlineObject1 } from '@teemill/platform';
|
|
14
15
|
|
|
15
16
|
const instance: InlineObject1 = {
|
|
16
|
-
|
|
17
|
+
tags,
|
|
18
|
+
nextPageToken,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# InlineObject2
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**redirect_url** | **string** | The URL to redirect to | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { InlineObject2 } from '@teemill/platform';
|
|
14
|
+
|
|
15
|
+
const instance: InlineObject2 = {
|
|
16
|
+
redirect_url,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ListCustomerTags200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**tags** | **Array<string>** | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ListCustomerTags200Response } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: ListCustomerTags200Response = {
|
|
17
|
+
tags,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ListDomains200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**domains** | [**Array<Domain>**](Domain.md) | | [default to undefined]
|
|
9
|
+
**nextPageToken** | **number** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ListDomains200Response } from '@teemill/platform';
|
|
15
|
+
|
|
16
|
+
const instance: ListDomains200Response = {
|
|
17
|
+
domains,
|
|
18
|
+
nextPageToken,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/PaymentApi.md
CHANGED
|
@@ -9,7 +9,7 @@ All URIs are relative to *https://localhost:8080*
|
|
|
9
9
|
|[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/platform/payment/stripe | Get Stripe Payment Account|
|
|
10
10
|
|
|
11
11
|
# **authorizeStripe**
|
|
12
|
-
>
|
|
12
|
+
> AuthorizeStripe200Response authorizeStripe()
|
|
13
13
|
|
|
14
14
|
Authorize a Stripe payment account
|
|
15
15
|
|
|
@@ -40,7 +40,7 @@ const { status, data } = await apiInstance.authorizeStripe(
|
|
|
40
40
|
|
|
41
41
|
### Return type
|
|
42
42
|
|
|
43
|
-
**
|
|
43
|
+
**AuthorizeStripe200Response**
|
|
44
44
|
|
|
45
45
|
### Authorization
|
|
46
46
|
|
package/docs/Platform.md
CHANGED
|
@@ -14,6 +14,7 @@ Name | Type | Description | Notes
|
|
|
14
14
|
**storeSubscriptionFee** | **number** | The subscription fee for the platform | [default to undefined]
|
|
15
15
|
**orderHandlingFee** | **number** | The order handling fee for the platform | [default to undefined]
|
|
16
16
|
**itemHandlingFee** | **number** | The item handling fee for the platform | [default to undefined]
|
|
17
|
+
**neckPrintFee** | **number** | The neck print fee for the platform | [default to undefined]
|
|
17
18
|
**chargeClients** | **boolean** | Whether the platform can charge clients for orders | [default to undefined]
|
|
18
19
|
|
|
19
20
|
## Example
|
|
@@ -31,6 +32,7 @@ const instance: Platform = {
|
|
|
31
32
|
storeSubscriptionFee,
|
|
32
33
|
orderHandlingFee,
|
|
33
34
|
itemHandlingFee,
|
|
35
|
+
neckPrintFee,
|
|
34
36
|
chargeClients,
|
|
35
37
|
};
|
|
36
38
|
```
|
package/docs/PlatformApi.md
CHANGED
|
@@ -306,7 +306,7 @@ const { status, data } = await apiInstance.getPlatform(
|
|
|
306
306
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
307
307
|
|
|
308
308
|
# **listClientDomains**
|
|
309
|
-
>
|
|
309
|
+
> ListDomains200Response listClientDomains()
|
|
310
310
|
|
|
311
311
|
List the client domains attached to a platform
|
|
312
312
|
|
|
@@ -337,7 +337,7 @@ const { status, data } = await apiInstance.listClientDomains(
|
|
|
337
337
|
|
|
338
338
|
### Return type
|
|
339
339
|
|
|
340
|
-
**
|
|
340
|
+
**ListDomains200Response**
|
|
341
341
|
|
|
342
342
|
### Authorization
|
|
343
343
|
|
|
@@ -362,7 +362,7 @@ const { status, data } = await apiInstance.listClientDomains(
|
|
|
362
362
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
363
363
|
|
|
364
364
|
# **listDomains**
|
|
365
|
-
>
|
|
365
|
+
> ListDomains200Response listDomains()
|
|
366
366
|
|
|
367
367
|
List the domains attached to a platform
|
|
368
368
|
|
|
@@ -393,7 +393,7 @@ const { status, data } = await apiInstance.listDomains(
|
|
|
393
393
|
|
|
394
394
|
### Return type
|
|
395
395
|
|
|
396
|
-
**
|
|
396
|
+
**ListDomains200Response**
|
|
397
397
|
|
|
398
398
|
### Authorization
|
|
399
399
|
|
|
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
|
|
|
11
11
|
**storeSubscriptionFee** | **number** | | [optional] [default to undefined]
|
|
12
12
|
**orderHandlingFee** | **number** | | [optional] [default to undefined]
|
|
13
13
|
**itemHandlingFee** | **number** | | [optional] [default to undefined]
|
|
14
|
+
**neckPrintFee** | **number** | | [optional] [default to undefined]
|
|
14
15
|
**chargeClients** | **boolean** | | [optional] [default to undefined]
|
|
15
16
|
|
|
16
17
|
## Example
|
|
@@ -25,6 +26,7 @@ const instance: UpdatePlatformRequest = {
|
|
|
25
26
|
storeSubscriptionFee,
|
|
26
27
|
orderHandlingFee,
|
|
27
28
|
itemHandlingFee,
|
|
29
|
+
neckPrintFee,
|
|
28
30
|
chargeClients,
|
|
29
31
|
};
|
|
30
32
|
```
|
package/index.ts
CHANGED