@teemill/platform 0.21.0 → 0.22.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 +12 -3
- package/api.ts +577 -16
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +322 -17
- package/dist/api.js +411 -1
- 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 +322 -17
- package/dist/esm/api.js +411 -1
- 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/CreateDomainRequest.md +20 -0
- package/docs/Domain.md +26 -0
- package/docs/InlineObject.md +22 -0
- package/docs/InlineObject1.md +20 -0
- package/docs/PaymentApi.md +2 -2
- package/docs/PlatformApi.md +330 -0
- package/index.ts +1 -1
- package/package.json +1 -1
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
|
+
> InlineObject1 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
|
+
**InlineObject1**
|
|
44
44
|
|
|
45
45
|
### Authorization
|
|
46
46
|
|
package/docs/PlatformApi.md
CHANGED
|
@@ -4,9 +4,241 @@ All URIs are relative to *https://localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**createClientDomain**](#createclientdomain) | **POST** /v1/platform/clients/domains | Create a platform client domain|
|
|
8
|
+
|[**createDomain**](#createdomain) | **POST** /v1/platform/domains | Create a platform domain|
|
|
9
|
+
|[**deleteClientDomain**](#deleteclientdomain) | **DELETE** /v1/platform/clients/domains/{domain} | Delete a platform client domain|
|
|
10
|
+
|[**deleteDomain**](#deletedomain) | **DELETE** /v1/platform/domains/{domain} | Delete a platform domain|
|
|
7
11
|
|[**getPlatform**](#getplatform) | **GET** /v1/platform | Get platform details|
|
|
12
|
+
|[**listClientDomains**](#listclientdomains) | **GET** /v1/platform/clients/domains | List platform client domains|
|
|
13
|
+
|[**listDomains**](#listdomains) | **GET** /v1/platform/domains | List platform domains|
|
|
8
14
|
|[**updatePlatform**](#updateplatform) | **PATCH** /v1/platform | Update platform|
|
|
9
15
|
|
|
16
|
+
# **createClientDomain**
|
|
17
|
+
> Domain createClientDomain()
|
|
18
|
+
|
|
19
|
+
Create a new client platform domain
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
import {
|
|
25
|
+
PlatformApi,
|
|
26
|
+
Configuration,
|
|
27
|
+
CreateDomainRequest
|
|
28
|
+
} from '@teemill/platform';
|
|
29
|
+
|
|
30
|
+
const configuration = new Configuration();
|
|
31
|
+
const apiInstance = new PlatformApi(configuration);
|
|
32
|
+
|
|
33
|
+
let createDomainRequest: CreateDomainRequest; // (optional)
|
|
34
|
+
|
|
35
|
+
const { status, data } = await apiInstance.createClientDomain(
|
|
36
|
+
createDomainRequest
|
|
37
|
+
);
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### Parameters
|
|
41
|
+
|
|
42
|
+
|Name | Type | Description | Notes|
|
|
43
|
+
|------------- | ------------- | ------------- | -------------|
|
|
44
|
+
| **createDomainRequest** | **CreateDomainRequest**| | |
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
**Domain**
|
|
50
|
+
|
|
51
|
+
### Authorization
|
|
52
|
+
|
|
53
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
54
|
+
|
|
55
|
+
### HTTP request headers
|
|
56
|
+
|
|
57
|
+
- **Content-Type**: application/json
|
|
58
|
+
- **Accept**: application/json
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
### HTTP response details
|
|
62
|
+
| Status code | Description | Response headers |
|
|
63
|
+
|-------------|-------------|------------------|
|
|
64
|
+
|**200** | A single domain | - |
|
|
65
|
+
|**400** | Failed validation | - |
|
|
66
|
+
|**401** | Not authorised to access this resource | - |
|
|
67
|
+
|**403** | Refuse to authorize | - |
|
|
68
|
+
|**404** | Resource not found | - |
|
|
69
|
+
|**500** | Unknown server error | - |
|
|
70
|
+
|
|
71
|
+
[[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)
|
|
72
|
+
|
|
73
|
+
# **createDomain**
|
|
74
|
+
> Domain createDomain()
|
|
75
|
+
|
|
76
|
+
Create a new platform domain
|
|
77
|
+
|
|
78
|
+
### Example
|
|
79
|
+
|
|
80
|
+
```typescript
|
|
81
|
+
import {
|
|
82
|
+
PlatformApi,
|
|
83
|
+
Configuration,
|
|
84
|
+
CreateDomainRequest
|
|
85
|
+
} from '@teemill/platform';
|
|
86
|
+
|
|
87
|
+
const configuration = new Configuration();
|
|
88
|
+
const apiInstance = new PlatformApi(configuration);
|
|
89
|
+
|
|
90
|
+
let createDomainRequest: CreateDomainRequest; // (optional)
|
|
91
|
+
|
|
92
|
+
const { status, data } = await apiInstance.createDomain(
|
|
93
|
+
createDomainRequest
|
|
94
|
+
);
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
### Parameters
|
|
98
|
+
|
|
99
|
+
|Name | Type | Description | Notes|
|
|
100
|
+
|------------- | ------------- | ------------- | -------------|
|
|
101
|
+
| **createDomainRequest** | **CreateDomainRequest**| | |
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
**Domain**
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | A single domain | - |
|
|
122
|
+
|**400** | Failed validation | - |
|
|
123
|
+
|**401** | Not authorised to access this resource | - |
|
|
124
|
+
|**403** | Refuse to authorize | - |
|
|
125
|
+
|**404** | Resource not found | - |
|
|
126
|
+
|**500** | Unknown server error | - |
|
|
127
|
+
|
|
128
|
+
[[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)
|
|
129
|
+
|
|
130
|
+
# **deleteClientDomain**
|
|
131
|
+
> deleteClientDomain()
|
|
132
|
+
|
|
133
|
+
Delete an existing client platform domain
|
|
134
|
+
|
|
135
|
+
### Example
|
|
136
|
+
|
|
137
|
+
```typescript
|
|
138
|
+
import {
|
|
139
|
+
PlatformApi,
|
|
140
|
+
Configuration
|
|
141
|
+
} from '@teemill/platform';
|
|
142
|
+
|
|
143
|
+
const configuration = new Configuration();
|
|
144
|
+
const apiInstance = new PlatformApi(configuration);
|
|
145
|
+
|
|
146
|
+
let domain: string; //The domain identifier (default to undefined)
|
|
147
|
+
|
|
148
|
+
const { status, data } = await apiInstance.deleteClientDomain(
|
|
149
|
+
domain
|
|
150
|
+
);
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
### Parameters
|
|
154
|
+
|
|
155
|
+
|Name | Type | Description | Notes|
|
|
156
|
+
|------------- | ------------- | ------------- | -------------|
|
|
157
|
+
| **domain** | [**string**] | The domain identifier | defaults to undefined|
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### Return type
|
|
161
|
+
|
|
162
|
+
void (empty response body)
|
|
163
|
+
|
|
164
|
+
### Authorization
|
|
165
|
+
|
|
166
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
167
|
+
|
|
168
|
+
### HTTP request headers
|
|
169
|
+
|
|
170
|
+
- **Content-Type**: Not defined
|
|
171
|
+
- **Accept**: application/json
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
### HTTP response details
|
|
175
|
+
| Status code | Description | Response headers |
|
|
176
|
+
|-------------|-------------|------------------|
|
|
177
|
+
|**204** | Successfully deleted domain from platform | - |
|
|
178
|
+
|**400** | Failed validation | - |
|
|
179
|
+
|**401** | Not authorised to access this resource | - |
|
|
180
|
+
|**403** | Refuse to authorize | - |
|
|
181
|
+
|**404** | Resource not found | - |
|
|
182
|
+
|**500** | Unknown server error | - |
|
|
183
|
+
|
|
184
|
+
[[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)
|
|
185
|
+
|
|
186
|
+
# **deleteDomain**
|
|
187
|
+
> deleteDomain()
|
|
188
|
+
|
|
189
|
+
Delete an existing platform domain
|
|
190
|
+
|
|
191
|
+
### Example
|
|
192
|
+
|
|
193
|
+
```typescript
|
|
194
|
+
import {
|
|
195
|
+
PlatformApi,
|
|
196
|
+
Configuration
|
|
197
|
+
} from '@teemill/platform';
|
|
198
|
+
|
|
199
|
+
const configuration = new Configuration();
|
|
200
|
+
const apiInstance = new PlatformApi(configuration);
|
|
201
|
+
|
|
202
|
+
let domain: string; //The domain identifier (default to undefined)
|
|
203
|
+
|
|
204
|
+
const { status, data } = await apiInstance.deleteDomain(
|
|
205
|
+
domain
|
|
206
|
+
);
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
### Parameters
|
|
210
|
+
|
|
211
|
+
|Name | Type | Description | Notes|
|
|
212
|
+
|------------- | ------------- | ------------- | -------------|
|
|
213
|
+
| **domain** | [**string**] | The domain identifier | defaults to undefined|
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
void (empty response body)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: Not defined
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
### HTTP response details
|
|
231
|
+
| Status code | Description | Response headers |
|
|
232
|
+
|-------------|-------------|------------------|
|
|
233
|
+
|**204** | Successfully deleted domain from platform | - |
|
|
234
|
+
|**400** | Failed validation | - |
|
|
235
|
+
|**401** | Not authorised to access this resource | - |
|
|
236
|
+
|**403** | Refuse to authorize | - |
|
|
237
|
+
|**404** | Resource not found | - |
|
|
238
|
+
|**500** | Unknown server error | - |
|
|
239
|
+
|
|
240
|
+
[[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)
|
|
241
|
+
|
|
10
242
|
# **getPlatform**
|
|
11
243
|
> Platform getPlatform()
|
|
12
244
|
|
|
@@ -61,6 +293,104 @@ const { status, data } = await apiInstance.getPlatform(
|
|
|
61
293
|
|
|
62
294
|
[[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)
|
|
63
295
|
|
|
296
|
+
# **listClientDomains**
|
|
297
|
+
> InlineObject listClientDomains()
|
|
298
|
+
|
|
299
|
+
List the client domains attached to a platform
|
|
300
|
+
|
|
301
|
+
### Example
|
|
302
|
+
|
|
303
|
+
```typescript
|
|
304
|
+
import {
|
|
305
|
+
PlatformApi,
|
|
306
|
+
Configuration
|
|
307
|
+
} from '@teemill/platform';
|
|
308
|
+
|
|
309
|
+
const configuration = new Configuration();
|
|
310
|
+
const apiInstance = new PlatformApi(configuration);
|
|
311
|
+
|
|
312
|
+
const { status, data } = await apiInstance.listClientDomains();
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
### Parameters
|
|
316
|
+
This endpoint does not have any parameters.
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
### Return type
|
|
320
|
+
|
|
321
|
+
**InlineObject**
|
|
322
|
+
|
|
323
|
+
### Authorization
|
|
324
|
+
|
|
325
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
326
|
+
|
|
327
|
+
### HTTP request headers
|
|
328
|
+
|
|
329
|
+
- **Content-Type**: Not defined
|
|
330
|
+
- **Accept**: application/json
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
### HTTP response details
|
|
334
|
+
| Status code | Description | Response headers |
|
|
335
|
+
|-------------|-------------|------------------|
|
|
336
|
+
|**200** | List of domains | - |
|
|
337
|
+
|**400** | Failed validation | - |
|
|
338
|
+
|**401** | Not authorised to access this resource | - |
|
|
339
|
+
|**403** | Refuse to authorize | - |
|
|
340
|
+
|**404** | Resource not found | - |
|
|
341
|
+
|**500** | Unknown server error | - |
|
|
342
|
+
|
|
343
|
+
[[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)
|
|
344
|
+
|
|
345
|
+
# **listDomains**
|
|
346
|
+
> InlineObject listDomains()
|
|
347
|
+
|
|
348
|
+
List the domains attached to a platform
|
|
349
|
+
|
|
350
|
+
### Example
|
|
351
|
+
|
|
352
|
+
```typescript
|
|
353
|
+
import {
|
|
354
|
+
PlatformApi,
|
|
355
|
+
Configuration
|
|
356
|
+
} from '@teemill/platform';
|
|
357
|
+
|
|
358
|
+
const configuration = new Configuration();
|
|
359
|
+
const apiInstance = new PlatformApi(configuration);
|
|
360
|
+
|
|
361
|
+
const { status, data } = await apiInstance.listDomains();
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Parameters
|
|
365
|
+
This endpoint does not have any parameters.
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
### Return type
|
|
369
|
+
|
|
370
|
+
**InlineObject**
|
|
371
|
+
|
|
372
|
+
### Authorization
|
|
373
|
+
|
|
374
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
375
|
+
|
|
376
|
+
### HTTP request headers
|
|
377
|
+
|
|
378
|
+
- **Content-Type**: Not defined
|
|
379
|
+
- **Accept**: application/json
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
### HTTP response details
|
|
383
|
+
| Status code | Description | Response headers |
|
|
384
|
+
|-------------|-------------|------------------|
|
|
385
|
+
|**200** | List of domains | - |
|
|
386
|
+
|**400** | Failed validation | - |
|
|
387
|
+
|**401** | Not authorised to access this resource | - |
|
|
388
|
+
|**403** | Refuse to authorize | - |
|
|
389
|
+
|**404** | Resource not found | - |
|
|
390
|
+
|**500** | Unknown server error | - |
|
|
391
|
+
|
|
392
|
+
[[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)
|
|
393
|
+
|
|
64
394
|
# **updatePlatform**
|
|
65
395
|
> Platform updatePlatform(updatePlatformRequest)
|
|
66
396
|
|
package/index.ts
CHANGED