@teemill/website 0.23.0 → 0.25.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 +10 -3
- package/api.ts +395 -18
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +252 -19
- package/dist/api.js +249 -3
- 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 +252 -19
- package/dist/esm/api.js +243 -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/SalePrice.md +23 -0
- package/docs/Variant.md +1 -1
- package/docs/WebsiteApi.md +172 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
|
@@ -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)
|
package/docs/PaymentApi.md
CHANGED
|
@@ -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
|
-
>
|
|
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
|
-
**
|
|
43
|
+
**InlineObject1**
|
|
44
44
|
|
|
45
45
|
### Authorization
|
|
46
46
|
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# SalePrice
|
|
2
|
+
|
|
3
|
+
Discounted price including tax.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**amount** | **number** | Discounted price including tax in the specified currency. | [default to undefined]
|
|
10
|
+
**currencyCode** | **string** | Currency code for the currency the sale price is valued in. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { SalePrice } from '@teemill/website';
|
|
16
|
+
|
|
17
|
+
const instance: SalePrice = {
|
|
18
|
+
amount,
|
|
19
|
+
currencyCode,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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/Variant.md
CHANGED
|
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
|
|
|
12
12
|
**product** | [**VariantProduct**](VariantProduct.md) | | [optional] [default to undefined]
|
|
13
13
|
**sortOrder** | **number** | | [optional] [readonly] [default to undefined]
|
|
14
14
|
**retailPrice** | [**Price**](Price.md) | | [optional] [default to undefined]
|
|
15
|
-
**salePrice** | [**
|
|
15
|
+
**salePrice** | [**SalePrice**](SalePrice.md) | | [optional] [default to undefined]
|
|
16
16
|
**price** | [**Price**](Price.md) | | [optional] [readonly] [default to undefined]
|
|
17
17
|
**stock** | [**Stock**](Stock.md) | | [optional] [default to undefined]
|
|
18
18
|
**createdAt** | **string** | | [optional] [default to undefined]
|
|
@@ -0,0 +1,172 @@
|
|
|
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 createDomainRequest: CreateDomainRequest; // (optional)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.createDomain(
|
|
31
|
+
createDomainRequest
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **createDomainRequest** | **CreateDomainRequest**| | |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**Domain**
|
|
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**: application/json
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | A single domain | - |
|
|
60
|
+
|**400** | Failed validation | - |
|
|
61
|
+
|**401** | Not authorised to access this resource | - |
|
|
62
|
+
|**403** | Refuse to authorize | - |
|
|
63
|
+
|**404** | Resource not found | - |
|
|
64
|
+
|**500** | Unknown server error | - |
|
|
65
|
+
|
|
66
|
+
[[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)
|
|
67
|
+
|
|
68
|
+
# **deleteDomain**
|
|
69
|
+
> deleteDomain()
|
|
70
|
+
|
|
71
|
+
Delete an existing website domain
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import {
|
|
77
|
+
WebsiteApi,
|
|
78
|
+
Configuration
|
|
79
|
+
} from '@teemill/website';
|
|
80
|
+
|
|
81
|
+
const configuration = new Configuration();
|
|
82
|
+
const apiInstance = new WebsiteApi(configuration);
|
|
83
|
+
|
|
84
|
+
let domain: string; //The domain identifier (default to undefined)
|
|
85
|
+
|
|
86
|
+
const { status, data } = await apiInstance.deleteDomain(
|
|
87
|
+
domain
|
|
88
|
+
);
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
### Parameters
|
|
92
|
+
|
|
93
|
+
|Name | Type | Description | Notes|
|
|
94
|
+
|------------- | ------------- | ------------- | -------------|
|
|
95
|
+
| **domain** | [**string**] | The domain identifier | defaults to undefined|
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
### Return type
|
|
99
|
+
|
|
100
|
+
void (empty response body)
|
|
101
|
+
|
|
102
|
+
### Authorization
|
|
103
|
+
|
|
104
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
105
|
+
|
|
106
|
+
### HTTP request headers
|
|
107
|
+
|
|
108
|
+
- **Content-Type**: Not defined
|
|
109
|
+
- **Accept**: application/json
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
### HTTP response details
|
|
113
|
+
| Status code | Description | Response headers |
|
|
114
|
+
|-------------|-------------|------------------|
|
|
115
|
+
|**204** | Successfully deleted domain from website | - |
|
|
116
|
+
|**400** | Failed validation | - |
|
|
117
|
+
|**401** | Not authorised to access this resource | - |
|
|
118
|
+
|**403** | Refuse to authorize | - |
|
|
119
|
+
|**404** | Resource not found | - |
|
|
120
|
+
|**500** | Unknown server error | - |
|
|
121
|
+
|
|
122
|
+
[[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)
|
|
123
|
+
|
|
124
|
+
# **listDomains**
|
|
125
|
+
> InlineObject listDomains()
|
|
126
|
+
|
|
127
|
+
List the domains attached to a website
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
|
|
131
|
+
```typescript
|
|
132
|
+
import {
|
|
133
|
+
WebsiteApi,
|
|
134
|
+
Configuration
|
|
135
|
+
} from '@teemill/website';
|
|
136
|
+
|
|
137
|
+
const configuration = new Configuration();
|
|
138
|
+
const apiInstance = new WebsiteApi(configuration);
|
|
139
|
+
|
|
140
|
+
const { status, data } = await apiInstance.listDomains();
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
### Parameters
|
|
144
|
+
This endpoint does not have any parameters.
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
**InlineObject**
|
|
150
|
+
|
|
151
|
+
### Authorization
|
|
152
|
+
|
|
153
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: Not defined
|
|
158
|
+
- **Accept**: application/json
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
### HTTP response details
|
|
162
|
+
| Status code | Description | Response headers |
|
|
163
|
+
|-------------|-------------|------------------|
|
|
164
|
+
|**200** | List of domains | - |
|
|
165
|
+
|**400** | Failed validation | - |
|
|
166
|
+
|**401** | Not authorised to access this resource | - |
|
|
167
|
+
|**403** | Refuse to authorize | - |
|
|
168
|
+
|**404** | Resource not found | - |
|
|
169
|
+
|**500** | Unknown server error | - |
|
|
170
|
+
|
|
171
|
+
[[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)
|
|
172
|
+
|
package/index.ts
CHANGED