@teemill/website 0.24.0 → 0.25.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.
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Website API
3
3
  * Manage your PodOS Website
4
4
  *
5
- * The version of the OpenAPI document: 0.24.0
5
+ * The version of the OpenAPI document: 0.25.1
6
6
  *
7
7
  *
8
8
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/dist/index.js CHANGED
@@ -5,7 +5,7 @@
5
5
  * Website API
6
6
  * Manage your PodOS Website
7
7
  *
8
- * The version of the OpenAPI document: 0.24.0
8
+ * The version of the OpenAPI document: 0.25.1
9
9
  *
10
10
  *
11
11
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,20 @@
1
+ # CreateDomainRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **domain** | **string** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { CreateDomainRequest } from '@teemill/website';
14
+
15
+ const instance: CreateDomainRequest = {
16
+ domain,
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)
package/docs/Domain.md ADDED
@@ -0,0 +1,26 @@
1
+ # Domain
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **number** | | [optional] [default to undefined]
9
+ **name** | **string** | | [default to undefined]
10
+ **priority** | **number** | | [default to undefined]
11
+ **enabledAt** | **string** | | [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { Domain } from '@teemill/website';
17
+
18
+ const instance: Domain = {
19
+ id,
20
+ name,
21
+ priority,
22
+ enabledAt,
23
+ };
24
+ ```
25
+
26
+ [[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
+ # 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/website';
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/website';
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://api.localhost:8080*
9
9
  |[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/website/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
 
@@ -0,0 +1,185 @@
1
+ # WebsiteApi
2
+
3
+ All URIs are relative to *https://api.localhost:8080*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**createDomain**](#createdomain) | **POST** /v1/website/domains | Create a website domain|
8
+ |[**deleteDomain**](#deletedomain) | **DELETE** /v1/website/domains/{domain} | Delete a website domain|
9
+ |[**listDomains**](#listdomains) | **GET** /v1/website/domains | List website domains|
10
+
11
+ # **createDomain**
12
+ > Domain createDomain()
13
+
14
+ Create a new website domain
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ WebsiteApi,
21
+ Configuration,
22
+ CreateDomainRequest
23
+ } from '@teemill/website';
24
+
25
+ const configuration = new Configuration();
26
+ const apiInstance = new WebsiteApi(configuration);
27
+
28
+ let project: string; //What project it is (default to undefined)
29
+ let createDomainRequest: CreateDomainRequest; // (optional)
30
+
31
+ const { status, data } = await apiInstance.createDomain(
32
+ project,
33
+ createDomainRequest
34
+ );
35
+ ```
36
+
37
+ ### Parameters
38
+
39
+ |Name | Type | Description | Notes|
40
+ |------------- | ------------- | ------------- | -------------|
41
+ | **createDomainRequest** | **CreateDomainRequest**| | |
42
+ | **project** | [**string**] | What project it is | defaults to undefined|
43
+
44
+
45
+ ### Return type
46
+
47
+ **Domain**
48
+
49
+ ### Authorization
50
+
51
+ [session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
52
+
53
+ ### HTTP request headers
54
+
55
+ - **Content-Type**: application/json
56
+ - **Accept**: application/json
57
+
58
+
59
+ ### HTTP response details
60
+ | Status code | Description | Response headers |
61
+ |-------------|-------------|------------------|
62
+ |**200** | A single domain | - |
63
+ |**400** | Failed validation | - |
64
+ |**401** | Not authorised to access this resource | - |
65
+ |**403** | Refuse to authorize | - |
66
+ |**404** | Resource not found | - |
67
+ |**500** | Unknown server error | - |
68
+
69
+ [[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)
70
+
71
+ # **deleteDomain**
72
+ > deleteDomain()
73
+
74
+ Delete an existing website domain
75
+
76
+ ### Example
77
+
78
+ ```typescript
79
+ import {
80
+ WebsiteApi,
81
+ Configuration
82
+ } from '@teemill/website';
83
+
84
+ const configuration = new Configuration();
85
+ const apiInstance = new WebsiteApi(configuration);
86
+
87
+ let project: string; //What project it is (default to undefined)
88
+ let domain: string; //The domain identifier (default to undefined)
89
+
90
+ const { status, data } = await apiInstance.deleteDomain(
91
+ project,
92
+ domain
93
+ );
94
+ ```
95
+
96
+ ### Parameters
97
+
98
+ |Name | Type | Description | Notes|
99
+ |------------- | ------------- | ------------- | -------------|
100
+ | **project** | [**string**] | What project it is | defaults to undefined|
101
+ | **domain** | [**string**] | The domain identifier | defaults to undefined|
102
+
103
+
104
+ ### Return type
105
+
106
+ void (empty response body)
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**: Not defined
115
+ - **Accept**: application/json
116
+
117
+
118
+ ### HTTP response details
119
+ | Status code | Description | Response headers |
120
+ |-------------|-------------|------------------|
121
+ |**204** | Successfully deleted domain from website | - |
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
+ # **listDomains**
131
+ > InlineObject listDomains()
132
+
133
+ List the domains attached to a website
134
+
135
+ ### Example
136
+
137
+ ```typescript
138
+ import {
139
+ WebsiteApi,
140
+ Configuration
141
+ } from '@teemill/website';
142
+
143
+ const configuration = new Configuration();
144
+ const apiInstance = new WebsiteApi(configuration);
145
+
146
+ let project: string; //What project it is (default to undefined)
147
+
148
+ const { status, data } = await apiInstance.listDomains(
149
+ project
150
+ );
151
+ ```
152
+
153
+ ### Parameters
154
+
155
+ |Name | Type | Description | Notes|
156
+ |------------- | ------------- | ------------- | -------------|
157
+ | **project** | [**string**] | What project it is | defaults to undefined|
158
+
159
+
160
+ ### Return type
161
+
162
+ **InlineObject**
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
+ |**200** | List of domains | - |
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
+
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Website API
5
5
  * Manage your PodOS Website
6
6
  *
7
- * The version of the OpenAPI document: 0.24.0
7
+ * The version of the OpenAPI document: 0.25.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/website",
3
- "version": "0.24.0",
3
+ "version": "0.25.1",
4
4
  "description": "OpenAPI client for @teemill/website",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {