@teemill/platform 0.21.0 → 0.22.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.
@@ -0,0 +1,22 @@
1
+ # InlineObject
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **domains** | [**Array<Domain>**](Domain.md) | | [optional] [default to undefined]
9
+ **nextPageToken** | **number** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { InlineObject } from '@teemill/platform';
15
+
16
+ const instance: InlineObject = {
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)
@@ -0,0 +1,20 @@
1
+ # InlineObject1
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 { InlineObject1 } from '@teemill/platform';
14
+
15
+ const instance: InlineObject1 = {
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)
@@ -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
- > AuthorizeStripe200Response authorizeStripe()
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
- **AuthorizeStripe200Response**
43
+ **InlineObject1**
44
44
 
45
45
  ### Authorization
46
46
 
@@ -4,9 +4,253 @@ 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 project: string; //Project unique identifier (default to undefined)
34
+ let createDomainRequest: CreateDomainRequest; // (optional)
35
+
36
+ const { status, data } = await apiInstance.createClientDomain(
37
+ project,
38
+ createDomainRequest
39
+ );
40
+ ```
41
+
42
+ ### Parameters
43
+
44
+ |Name | Type | Description | Notes|
45
+ |------------- | ------------- | ------------- | -------------|
46
+ | **createDomainRequest** | **CreateDomainRequest**| | |
47
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
48
+
49
+
50
+ ### Return type
51
+
52
+ **Domain**
53
+
54
+ ### Authorization
55
+
56
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
57
+
58
+ ### HTTP request headers
59
+
60
+ - **Content-Type**: application/json
61
+ - **Accept**: application/json
62
+
63
+
64
+ ### HTTP response details
65
+ | Status code | Description | Response headers |
66
+ |-------------|-------------|------------------|
67
+ |**200** | A single domain | - |
68
+ |**400** | Failed validation | - |
69
+ |**401** | Not authorised to access this resource | - |
70
+ |**403** | Refuse to authorize | - |
71
+ |**404** | Resource not found | - |
72
+ |**500** | Unknown server error | - |
73
+
74
+ [[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)
75
+
76
+ # **createDomain**
77
+ > Domain createDomain()
78
+
79
+ Create a new platform domain
80
+
81
+ ### Example
82
+
83
+ ```typescript
84
+ import {
85
+ PlatformApi,
86
+ Configuration,
87
+ CreateDomainRequest
88
+ } from '@teemill/platform';
89
+
90
+ const configuration = new Configuration();
91
+ const apiInstance = new PlatformApi(configuration);
92
+
93
+ let project: string; //Project unique identifier (default to undefined)
94
+ let createDomainRequest: CreateDomainRequest; // (optional)
95
+
96
+ const { status, data } = await apiInstance.createDomain(
97
+ project,
98
+ createDomainRequest
99
+ );
100
+ ```
101
+
102
+ ### Parameters
103
+
104
+ |Name | Type | Description | Notes|
105
+ |------------- | ------------- | ------------- | -------------|
106
+ | **createDomainRequest** | **CreateDomainRequest**| | |
107
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
108
+
109
+
110
+ ### Return type
111
+
112
+ **Domain**
113
+
114
+ ### Authorization
115
+
116
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
117
+
118
+ ### HTTP request headers
119
+
120
+ - **Content-Type**: application/json
121
+ - **Accept**: application/json
122
+
123
+
124
+ ### HTTP response details
125
+ | Status code | Description | Response headers |
126
+ |-------------|-------------|------------------|
127
+ |**200** | A single domain | - |
128
+ |**400** | Failed validation | - |
129
+ |**401** | Not authorised to access this resource | - |
130
+ |**403** | Refuse to authorize | - |
131
+ |**404** | Resource not found | - |
132
+ |**500** | Unknown server error | - |
133
+
134
+ [[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)
135
+
136
+ # **deleteClientDomain**
137
+ > deleteClientDomain()
138
+
139
+ Delete an existing client platform domain
140
+
141
+ ### Example
142
+
143
+ ```typescript
144
+ import {
145
+ PlatformApi,
146
+ Configuration
147
+ } from '@teemill/platform';
148
+
149
+ const configuration = new Configuration();
150
+ const apiInstance = new PlatformApi(configuration);
151
+
152
+ let project: string; //Project unique identifier (default to undefined)
153
+ let domain: string; //The domain identifier (default to undefined)
154
+
155
+ const { status, data } = await apiInstance.deleteClientDomain(
156
+ project,
157
+ domain
158
+ );
159
+ ```
160
+
161
+ ### Parameters
162
+
163
+ |Name | Type | Description | Notes|
164
+ |------------- | ------------- | ------------- | -------------|
165
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
166
+ | **domain** | [**string**] | The domain identifier | defaults to undefined|
167
+
168
+
169
+ ### Return type
170
+
171
+ void (empty response body)
172
+
173
+ ### Authorization
174
+
175
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
176
+
177
+ ### HTTP request headers
178
+
179
+ - **Content-Type**: Not defined
180
+ - **Accept**: application/json
181
+
182
+
183
+ ### HTTP response details
184
+ | Status code | Description | Response headers |
185
+ |-------------|-------------|------------------|
186
+ |**204** | Successfully deleted domain from platform | - |
187
+ |**400** | Failed validation | - |
188
+ |**401** | Not authorised to access this resource | - |
189
+ |**403** | Refuse to authorize | - |
190
+ |**404** | Resource not found | - |
191
+ |**500** | Unknown server error | - |
192
+
193
+ [[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)
194
+
195
+ # **deleteDomain**
196
+ > deleteDomain()
197
+
198
+ Delete an existing platform domain
199
+
200
+ ### Example
201
+
202
+ ```typescript
203
+ import {
204
+ PlatformApi,
205
+ Configuration
206
+ } from '@teemill/platform';
207
+
208
+ const configuration = new Configuration();
209
+ const apiInstance = new PlatformApi(configuration);
210
+
211
+ let project: string; //Project unique identifier (default to undefined)
212
+ let domain: string; //The domain identifier (default to undefined)
213
+
214
+ const { status, data } = await apiInstance.deleteDomain(
215
+ project,
216
+ domain
217
+ );
218
+ ```
219
+
220
+ ### Parameters
221
+
222
+ |Name | Type | Description | Notes|
223
+ |------------- | ------------- | ------------- | -------------|
224
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
225
+ | **domain** | [**string**] | The domain identifier | defaults to undefined|
226
+
227
+
228
+ ### Return type
229
+
230
+ void (empty response body)
231
+
232
+ ### Authorization
233
+
234
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: Not defined
239
+ - **Accept**: application/json
240
+
241
+
242
+ ### HTTP response details
243
+ | Status code | Description | Response headers |
244
+ |-------------|-------------|------------------|
245
+ |**204** | Successfully deleted domain from platform | - |
246
+ |**400** | Failed validation | - |
247
+ |**401** | Not authorised to access this resource | - |
248
+ |**403** | Refuse to authorize | - |
249
+ |**404** | Resource not found | - |
250
+ |**500** | Unknown server error | - |
251
+
252
+ [[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)
253
+
10
254
  # **getPlatform**
11
255
  > Platform getPlatform()
12
256
 
@@ -61,6 +305,118 @@ const { status, data } = await apiInstance.getPlatform(
61
305
 
62
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)
63
307
 
308
+ # **listClientDomains**
309
+ > InlineObject listClientDomains()
310
+
311
+ List the client domains attached to a platform
312
+
313
+ ### Example
314
+
315
+ ```typescript
316
+ import {
317
+ PlatformApi,
318
+ Configuration
319
+ } from '@teemill/platform';
320
+
321
+ const configuration = new Configuration();
322
+ const apiInstance = new PlatformApi(configuration);
323
+
324
+ let project: string; //Project unique identifier (default to undefined)
325
+
326
+ const { status, data } = await apiInstance.listClientDomains(
327
+ project
328
+ );
329
+ ```
330
+
331
+ ### Parameters
332
+
333
+ |Name | Type | Description | Notes|
334
+ |------------- | ------------- | ------------- | -------------|
335
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
336
+
337
+
338
+ ### Return type
339
+
340
+ **InlineObject**
341
+
342
+ ### Authorization
343
+
344
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: Not defined
349
+ - **Accept**: application/json
350
+
351
+
352
+ ### HTTP response details
353
+ | Status code | Description | Response headers |
354
+ |-------------|-------------|------------------|
355
+ |**200** | List of domains | - |
356
+ |**400** | Failed validation | - |
357
+ |**401** | Not authorised to access this resource | - |
358
+ |**403** | Refuse to authorize | - |
359
+ |**404** | Resource not found | - |
360
+ |**500** | Unknown server error | - |
361
+
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
+
364
+ # **listDomains**
365
+ > InlineObject listDomains()
366
+
367
+ List the domains attached to a platform
368
+
369
+ ### Example
370
+
371
+ ```typescript
372
+ import {
373
+ PlatformApi,
374
+ Configuration
375
+ } from '@teemill/platform';
376
+
377
+ const configuration = new Configuration();
378
+ const apiInstance = new PlatformApi(configuration);
379
+
380
+ let project: string; //Project unique identifier (default to undefined)
381
+
382
+ const { status, data } = await apiInstance.listDomains(
383
+ project
384
+ );
385
+ ```
386
+
387
+ ### Parameters
388
+
389
+ |Name | Type | Description | Notes|
390
+ |------------- | ------------- | ------------- | -------------|
391
+ | **project** | [**string**] | Project unique identifier | defaults to undefined|
392
+
393
+
394
+ ### Return type
395
+
396
+ **InlineObject**
397
+
398
+ ### Authorization
399
+
400
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
401
+
402
+ ### HTTP request headers
403
+
404
+ - **Content-Type**: Not defined
405
+ - **Accept**: application/json
406
+
407
+
408
+ ### HTTP response details
409
+ | Status code | Description | Response headers |
410
+ |-------------|-------------|------------------|
411
+ |**200** | List of domains | - |
412
+ |**400** | Failed validation | - |
413
+ |**401** | Not authorised to access this resource | - |
414
+ |**403** | Refuse to authorize | - |
415
+ |**404** | Resource not found | - |
416
+ |**500** | Unknown server error | - |
417
+
418
+ [[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)
419
+
64
420
  # **updatePlatform**
65
421
  > Platform updatePlatform(updatePlatformRequest)
66
422
 
package/index.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.21.0
7
+ * The version of the OpenAPI document: 0.22.1
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@teemill/platform",
3
- "version": "0.21.0",
3
+ "version": "0.22.1",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {