@teemill/website 0.25.1 → 0.26.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 +6 -2
- package/api.ts +387 -3
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +195 -3
- package/dist/api.js +297 -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 +195 -3
- package/dist/esm/api.js +297 -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/InlineObject.md +2 -2
- package/docs/PaymentApi.md +171 -0
- package/docs/WebsiteApi.md +61 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/docs/PaymentApi.md
CHANGED
|
@@ -4,10 +4,69 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**authorizePayPal**](#authorizepaypal) | **GET** /v1/website/payment/paypal/authorize | Authorize PayPal|
|
|
7
8
|
|[**authorizeStripe**](#authorizestripe) | **GET** /v1/website/payment/stripe/authorize | Authorize Stripe|
|
|
9
|
+
|[**deauthorizePayPal**](#deauthorizepaypal) | **DELETE** /v1/website/payment/paypal/deauthorize | Deauthorize PayPal|
|
|
8
10
|
|[**deauthorizeStripe**](#deauthorizestripe) | **DELETE** /v1/website/payment/stripe/deauthorize | Deauthorize Stripe|
|
|
11
|
+
|[**getPayPalPaymentAccount**](#getpaypalpaymentaccount) | **GET** /v1/website/payment/paypal | Get PayPal Payment Account|
|
|
9
12
|
|[**getStripePaymentAccount**](#getstripepaymentaccount) | **GET** /v1/website/payment/stripe | Get Stripe Payment Account|
|
|
10
13
|
|
|
14
|
+
# **authorizePayPal**
|
|
15
|
+
> InlineObject1 authorizePayPal()
|
|
16
|
+
|
|
17
|
+
Authorize a PayPal payment account
|
|
18
|
+
|
|
19
|
+
### Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import {
|
|
23
|
+
PaymentApi,
|
|
24
|
+
Configuration
|
|
25
|
+
} from '@teemill/website';
|
|
26
|
+
|
|
27
|
+
const configuration = new Configuration();
|
|
28
|
+
const apiInstance = new PaymentApi(configuration);
|
|
29
|
+
|
|
30
|
+
let project: string; //What project it is (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.authorizePayPal(
|
|
33
|
+
project
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**InlineObject1**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
51
|
+
|
|
52
|
+
### HTTP request headers
|
|
53
|
+
|
|
54
|
+
- **Content-Type**: Not defined
|
|
55
|
+
- **Accept**: application/json
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
### HTTP response details
|
|
59
|
+
| Status code | Description | Response headers |
|
|
60
|
+
|-------------|-------------|------------------|
|
|
61
|
+
|**200** | Redirect to authorize PayPal | - |
|
|
62
|
+
|**400** | Failed validation | - |
|
|
63
|
+
|**401** | Not authorised to access this resource | - |
|
|
64
|
+
|**403** | Refuse to authorize | - |
|
|
65
|
+
|**404** | Resource not found | - |
|
|
66
|
+
|**500** | Unknown server error | - |
|
|
67
|
+
|
|
68
|
+
[[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)
|
|
69
|
+
|
|
11
70
|
# **authorizeStripe**
|
|
12
71
|
> InlineObject1 authorizeStripe()
|
|
13
72
|
|
|
@@ -64,6 +123,62 @@ const { status, data } = await apiInstance.authorizeStripe(
|
|
|
64
123
|
|
|
65
124
|
[[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
125
|
|
|
126
|
+
# **deauthorizePayPal**
|
|
127
|
+
> deauthorizePayPal()
|
|
128
|
+
|
|
129
|
+
Deauthorize a PayPal payment account
|
|
130
|
+
|
|
131
|
+
### Example
|
|
132
|
+
|
|
133
|
+
```typescript
|
|
134
|
+
import {
|
|
135
|
+
PaymentApi,
|
|
136
|
+
Configuration
|
|
137
|
+
} from '@teemill/website';
|
|
138
|
+
|
|
139
|
+
const configuration = new Configuration();
|
|
140
|
+
const apiInstance = new PaymentApi(configuration);
|
|
141
|
+
|
|
142
|
+
let project: string; //What project it is (default to undefined)
|
|
143
|
+
|
|
144
|
+
const { status, data } = await apiInstance.deauthorizePayPal(
|
|
145
|
+
project
|
|
146
|
+
);
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### Parameters
|
|
150
|
+
|
|
151
|
+
|Name | Type | Description | Notes|
|
|
152
|
+
|------------- | ------------- | ------------- | -------------|
|
|
153
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
### Return type
|
|
157
|
+
|
|
158
|
+
void (empty response body)
|
|
159
|
+
|
|
160
|
+
### Authorization
|
|
161
|
+
|
|
162
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
163
|
+
|
|
164
|
+
### HTTP request headers
|
|
165
|
+
|
|
166
|
+
- **Content-Type**: Not defined
|
|
167
|
+
- **Accept**: application/json
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
### HTTP response details
|
|
171
|
+
| Status code | Description | Response headers |
|
|
172
|
+
|-------------|-------------|------------------|
|
|
173
|
+
|**204** | Successfully deauthorized PayPal payment account | - |
|
|
174
|
+
|**400** | Failed validation | - |
|
|
175
|
+
|**401** | Not authorised to access this resource | - |
|
|
176
|
+
|**403** | Refuse to authorize | - |
|
|
177
|
+
|**404** | Resource not found | - |
|
|
178
|
+
|**500** | Unknown server error | - |
|
|
179
|
+
|
|
180
|
+
[[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)
|
|
181
|
+
|
|
67
182
|
# **deauthorizeStripe**
|
|
68
183
|
> deauthorizeStripe()
|
|
69
184
|
|
|
@@ -120,6 +235,62 @@ void (empty response body)
|
|
|
120
235
|
|
|
121
236
|
[[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)
|
|
122
237
|
|
|
238
|
+
# **getPayPalPaymentAccount**
|
|
239
|
+
> PaymentAccount getPayPalPaymentAccount()
|
|
240
|
+
|
|
241
|
+
Get the PayPal payment account information for the project
|
|
242
|
+
|
|
243
|
+
### Example
|
|
244
|
+
|
|
245
|
+
```typescript
|
|
246
|
+
import {
|
|
247
|
+
PaymentApi,
|
|
248
|
+
Configuration
|
|
249
|
+
} from '@teemill/website';
|
|
250
|
+
|
|
251
|
+
const configuration = new Configuration();
|
|
252
|
+
const apiInstance = new PaymentApi(configuration);
|
|
253
|
+
|
|
254
|
+
let project: string; //What project it is (default to undefined)
|
|
255
|
+
|
|
256
|
+
const { status, data } = await apiInstance.getPayPalPaymentAccount(
|
|
257
|
+
project
|
|
258
|
+
);
|
|
259
|
+
```
|
|
260
|
+
|
|
261
|
+
### Parameters
|
|
262
|
+
|
|
263
|
+
|Name | Type | Description | Notes|
|
|
264
|
+
|------------- | ------------- | ------------- | -------------|
|
|
265
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
### Return type
|
|
269
|
+
|
|
270
|
+
**PaymentAccount**
|
|
271
|
+
|
|
272
|
+
### Authorization
|
|
273
|
+
|
|
274
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
275
|
+
|
|
276
|
+
### HTTP request headers
|
|
277
|
+
|
|
278
|
+
- **Content-Type**: Not defined
|
|
279
|
+
- **Accept**: application/json
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
### HTTP response details
|
|
283
|
+
| Status code | Description | Response headers |
|
|
284
|
+
|-------------|-------------|------------------|
|
|
285
|
+
|**200** | Successfully connected PayPal payment account | - |
|
|
286
|
+
|**400** | Failed validation | - |
|
|
287
|
+
|**401** | Not authorised to access this resource | - |
|
|
288
|
+
|**403** | Refuse to authorize | - |
|
|
289
|
+
|**404** | Resource not found | - |
|
|
290
|
+
|**500** | Unknown server error | - |
|
|
291
|
+
|
|
292
|
+
[[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)
|
|
293
|
+
|
|
123
294
|
# **getStripePaymentAccount**
|
|
124
295
|
> PaymentAccount getStripePaymentAccount()
|
|
125
296
|
|
package/docs/WebsiteApi.md
CHANGED
|
@@ -7,6 +7,7 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
7
7
|
|[**createDomain**](#createdomain) | **POST** /v1/website/domains | Create a website domain|
|
|
8
8
|
|[**deleteDomain**](#deletedomain) | **DELETE** /v1/website/domains/{domain} | Delete a website domain|
|
|
9
9
|
|[**listDomains**](#listdomains) | **GET** /v1/website/domains | List website domains|
|
|
10
|
+
|[**updateBaseDomain**](#updatebasedomain) | **PUT** /v1/website/domains/base | Update base domain|
|
|
10
11
|
|
|
11
12
|
# **createDomain**
|
|
12
13
|
> Domain createDomain()
|
|
@@ -183,3 +184,63 @@ const { status, data } = await apiInstance.listDomains(
|
|
|
183
184
|
|
|
184
185
|
[[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
|
|
|
187
|
+
# **updateBaseDomain**
|
|
188
|
+
> updateBaseDomain()
|
|
189
|
+
|
|
190
|
+
Updated a websites base domain
|
|
191
|
+
|
|
192
|
+
### Example
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
import {
|
|
196
|
+
WebsiteApi,
|
|
197
|
+
Configuration,
|
|
198
|
+
CreateDomainRequest
|
|
199
|
+
} from '@teemill/website';
|
|
200
|
+
|
|
201
|
+
const configuration = new Configuration();
|
|
202
|
+
const apiInstance = new WebsiteApi(configuration);
|
|
203
|
+
|
|
204
|
+
let project: string; //What project it is (default to undefined)
|
|
205
|
+
let createDomainRequest: CreateDomainRequest; // (optional)
|
|
206
|
+
|
|
207
|
+
const { status, data } = await apiInstance.updateBaseDomain(
|
|
208
|
+
project,
|
|
209
|
+
createDomainRequest
|
|
210
|
+
);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
|Name | Type | Description | Notes|
|
|
216
|
+
|------------- | ------------- | ------------- | -------------|
|
|
217
|
+
| **createDomainRequest** | **CreateDomainRequest**| | |
|
|
218
|
+
| **project** | [**string**] | What project it is | defaults to undefined|
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
### Return type
|
|
222
|
+
|
|
223
|
+
void (empty response body)
|
|
224
|
+
|
|
225
|
+
### Authorization
|
|
226
|
+
|
|
227
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
228
|
+
|
|
229
|
+
### HTTP request headers
|
|
230
|
+
|
|
231
|
+
- **Content-Type**: application/json
|
|
232
|
+
- **Accept**: application/json
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
### HTTP response details
|
|
236
|
+
| Status code | Description | Response headers |
|
|
237
|
+
|-------------|-------------|------------------|
|
|
238
|
+
|**204** | Base domain successfully updated | - |
|
|
239
|
+
|**400** | Failed validation | - |
|
|
240
|
+
|**401** | Not authorised to access this resource | - |
|
|
241
|
+
|**403** | Refuse to authorize | - |
|
|
242
|
+
|**404** | Resource not found | - |
|
|
243
|
+
|**500** | Unknown server error | - |
|
|
244
|
+
|
|
245
|
+
[[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)
|
|
246
|
+
|
package/index.ts
CHANGED