@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.
@@ -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
@@ -4,7 +4,7 @@
4
4
  * Platform API
5
5
  * Manage Your podOS platform
6
6
  *
7
- * The version of the OpenAPI document: 0.20.0
7
+ * The version of the OpenAPI document: 0.22.0
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.20.0",
3
+ "version": "0.22.0",
4
4
  "description": "OpenAPI client for @teemill/platform",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {