@teemill/platform 0.20.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 +16 -3
- package/api.ts +990 -92
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +538 -17
- package/dist/api.js +612 -2
- 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 +538 -17
- package/dist/esm/api.js +607 -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/docs/SaveTermsRequest.md +24 -0
- package/docs/Terms.md +32 -0
- package/docs/TermsApi.md +127 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/TermsApi.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
# TermsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getTerms**](#getterms) | **GET** /v1/platform/{platformId}/terms | Get the platform\'s terms|
|
|
8
|
+
|[**saveTerms**](#saveterms) | **POST** /v1/platform/{platformId}/terms | Save the platform\'s terms|
|
|
9
|
+
|
|
10
|
+
# **getTerms**
|
|
11
|
+
> Terms getTerms()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
TermsApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@teemill/platform';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new TermsApi(configuration);
|
|
24
|
+
|
|
25
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
26
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
27
|
+
|
|
28
|
+
const { status, data } = await apiInstance.getTerms(
|
|
29
|
+
project,
|
|
30
|
+
platformId
|
|
31
|
+
);
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Parameters
|
|
35
|
+
|
|
36
|
+
|Name | Type | Description | Notes|
|
|
37
|
+
|------------- | ------------- | ------------- | -------------|
|
|
38
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
39
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**Terms**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: Not defined
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | Successfully retrieved the terms. | - |
|
|
60
|
+
|**401** | Not authorised to access this resource | - |
|
|
61
|
+
|**403** | Refuse to authorize | - |
|
|
62
|
+
|**404** | Resource not found | - |
|
|
63
|
+
|**500** | Unknown server error | - |
|
|
64
|
+
|
|
65
|
+
[[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)
|
|
66
|
+
|
|
67
|
+
# **saveTerms**
|
|
68
|
+
> Terms saveTerms(saveTermsRequest)
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
### Example
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
import {
|
|
75
|
+
TermsApi,
|
|
76
|
+
Configuration,
|
|
77
|
+
SaveTermsRequest
|
|
78
|
+
} from '@teemill/platform';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new TermsApi(configuration);
|
|
82
|
+
|
|
83
|
+
let project: string; //Project unique identifier (default to undefined)
|
|
84
|
+
let platformId: string; //The platform identifier (default to undefined)
|
|
85
|
+
let saveTermsRequest: SaveTermsRequest; //Save terms
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.saveTerms(
|
|
88
|
+
project,
|
|
89
|
+
platformId,
|
|
90
|
+
saveTermsRequest
|
|
91
|
+
);
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Parameters
|
|
95
|
+
|
|
96
|
+
|Name | Type | Description | Notes|
|
|
97
|
+
|------------- | ------------- | ------------- | -------------|
|
|
98
|
+
| **saveTermsRequest** | **SaveTermsRequest**| Save terms | |
|
|
99
|
+
| **project** | [**string**] | Project unique identifier | defaults to undefined|
|
|
100
|
+
| **platformId** | [**string**] | The platform identifier | defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
**Terms**
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: application/json
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**200** | Successfully retrieved the terms. | - |
|
|
121
|
+
|**401** | Not authorised to access this resource | - |
|
|
122
|
+
|**403** | Refuse to authorize | - |
|
|
123
|
+
|**404** | Resource not found | - |
|
|
124
|
+
|**500** | Unknown server error | - |
|
|
125
|
+
|
|
126
|
+
[[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)
|
|
127
|
+
|
package/index.ts
CHANGED