@hostinger/sdk 1.53.2 → 1.54.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 +2 -2
- package/api.ts +392 -1
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +208 -1
- package/dist/api.js +358 -12
- 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 +2 -2
- package/dist/esm/api.d.ts +208 -1
- package/dist/esm/api.js +342 -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 +2 -2
- 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/AgencyHostingSSLApi.md +238 -0
- package/docs/AgencyHostingV1SslSslStatusResource.md +24 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.54.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.54.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.54.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -13,7 +13,7 @@ export class Configuration {
|
|
|
13
13
|
var _a;
|
|
14
14
|
this.accessToken = param.accessToken;
|
|
15
15
|
this.basePath = param.basePath;
|
|
16
|
-
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.
|
|
16
|
+
this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.54.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
17
17
|
this.formDataCtor = param.formDataCtor;
|
|
18
18
|
}
|
|
19
19
|
/**
|
package/dist/esm/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.54.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/esm/index.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.54.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/index.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.54.0
|
|
5
5
|
*
|
|
6
6
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
7
7
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
package/dist/index.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/**
|
|
5
5
|
* Hostinger API
|
|
6
6
|
*
|
|
7
|
-
* API Version: 1.
|
|
7
|
+
* API Version: 1.54.0
|
|
8
8
|
*
|
|
9
9
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
10
10
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|
|
@@ -0,0 +1,238 @@
|
|
|
1
|
+
# AgencyHostingSSLApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://developers.hostinger.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getWebsiteSSLStatusV1**](#getwebsitesslstatusv1) | **GET** /api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/status | Get website SSL status|
|
|
8
|
+
|[**installWebsiteSSLV1**](#installwebsitesslv1) | **POST** /api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/setup | Install website SSL|
|
|
9
|
+
|[**reinstallWebsiteSSLV1**](#reinstallwebsitesslv1) | **POST** /api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl/reinstall | Reinstall website SSL|
|
|
10
|
+
|[**uninstallWebsiteSSLV1**](#uninstallwebsitesslv1) | **DELETE** /api/agency-hosting/v1/websites/{website_uid}/domains/{domain}/ssl | Uninstall website SSL|
|
|
11
|
+
|
|
12
|
+
# **getWebsiteSSLStatusV1**
|
|
13
|
+
> AgencyHostingV1SslSslStatusResource getWebsiteSSLStatusV1()
|
|
14
|
+
|
|
15
|
+
Returns the SSL state of one domain of an Agency Plan website: the certificate `status`, whether the certificate was uploaded by the customer, and when it stops being valid. `installing` means a certificate setup is running or retrying; the `ssl_setup` entry of `List website processes` shows the same progress. `active` means a valid certificate is in place: uploaded by the customer, issued by the platform, or a lifetime certificate bought for the domain. `failed` means the last setup gave up and no valid certificate is in place. `expired` means the certificate has run out. `not_installed` means the domain has no certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
AgencyHostingSSLApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@hostinger/sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new AgencyHostingSSLApi(configuration);
|
|
27
|
+
|
|
28
|
+
let websiteUid: string; //Agency Plan website UID (default to undefined)
|
|
29
|
+
let domain: string; //Domain name (default to undefined)
|
|
30
|
+
|
|
31
|
+
const { status, data } = await apiInstance.getWebsiteSSLStatusV1(
|
|
32
|
+
websiteUid,
|
|
33
|
+
domain
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
|
|
42
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
### Return type
|
|
46
|
+
|
|
47
|
+
**AgencyHostingV1SslSslStatusResource**
|
|
48
|
+
|
|
49
|
+
### Authorization
|
|
50
|
+
|
|
51
|
+
[apiToken](../README.md#apiToken)
|
|
52
|
+
|
|
53
|
+
### HTTP request headers
|
|
54
|
+
|
|
55
|
+
- **Content-Type**: Not defined
|
|
56
|
+
- **Accept**: application/json
|
|
57
|
+
|
|
58
|
+
|
|
59
|
+
### HTTP response details
|
|
60
|
+
| Status code | Description | Response headers |
|
|
61
|
+
|-------------|-------------|------------------|
|
|
62
|
+
|**200** | Success response | - |
|
|
63
|
+
|**401** | Unauthenticated response | - |
|
|
64
|
+
|**500** | Error response | - |
|
|
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
|
+
# **installWebsiteSSLV1**
|
|
69
|
+
> CommonSuccessEmptyResource installWebsiteSSLV1()
|
|
70
|
+
|
|
71
|
+
Starts a Let\'s Encrypt certificate setup for the domain and returns at once; the setup runs in the background. `Get website SSL status` reports `installing` while it runs, then `active` or `failed`; the `ssl_setup` entry of `List website processes` shows the same progress. Returns 422 when the domain already has a platform certificate that is not expired, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import {
|
|
77
|
+
AgencyHostingSSLApi,
|
|
78
|
+
Configuration
|
|
79
|
+
} from '@hostinger/sdk';
|
|
80
|
+
|
|
81
|
+
const configuration = new Configuration();
|
|
82
|
+
const apiInstance = new AgencyHostingSSLApi(configuration);
|
|
83
|
+
|
|
84
|
+
let websiteUid: string; //Agency Plan website UID (default to undefined)
|
|
85
|
+
let domain: string; //Domain name (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.installWebsiteSSLV1(
|
|
88
|
+
websiteUid,
|
|
89
|
+
domain
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
|
|
98
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### Return type
|
|
102
|
+
|
|
103
|
+
**CommonSuccessEmptyResource**
|
|
104
|
+
|
|
105
|
+
### Authorization
|
|
106
|
+
|
|
107
|
+
[apiToken](../README.md#apiToken)
|
|
108
|
+
|
|
109
|
+
### HTTP request headers
|
|
110
|
+
|
|
111
|
+
- **Content-Type**: Not defined
|
|
112
|
+
- **Accept**: application/json
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
### HTTP response details
|
|
116
|
+
| Status code | Description | Response headers |
|
|
117
|
+
|-------------|-------------|------------------|
|
|
118
|
+
|**200** | Success empty response | - |
|
|
119
|
+
|**422** | Validation error response | - |
|
|
120
|
+
|**401** | Unauthenticated response | - |
|
|
121
|
+
|**500** | Error response | - |
|
|
122
|
+
|
|
123
|
+
[[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)
|
|
124
|
+
|
|
125
|
+
# **reinstallWebsiteSSLV1**
|
|
126
|
+
> CommonSuccessEmptyResource reinstallWebsiteSSLV1()
|
|
127
|
+
|
|
128
|
+
Replaces the Let\'s Encrypt certificate of the domain: the current platform certificate, when one is recorded, is revoked and removed, then a new setup starts in the background. Returns at once; `Get website SSL status` reports `installing` while it runs, then `active` or `failed`. Returns 422 for free subdomains, when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), or when the domain hit its limit of three setups per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
129
|
+
|
|
130
|
+
### Example
|
|
131
|
+
|
|
132
|
+
```typescript
|
|
133
|
+
import {
|
|
134
|
+
AgencyHostingSSLApi,
|
|
135
|
+
Configuration
|
|
136
|
+
} from '@hostinger/sdk';
|
|
137
|
+
|
|
138
|
+
const configuration = new Configuration();
|
|
139
|
+
const apiInstance = new AgencyHostingSSLApi(configuration);
|
|
140
|
+
|
|
141
|
+
let websiteUid: string; //Agency Plan website UID (default to undefined)
|
|
142
|
+
let domain: string; //Domain name (default to undefined)
|
|
143
|
+
|
|
144
|
+
const { status, data } = await apiInstance.reinstallWebsiteSSLV1(
|
|
145
|
+
websiteUid,
|
|
146
|
+
domain
|
|
147
|
+
);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
### Parameters
|
|
151
|
+
|
|
152
|
+
|Name | Type | Description | Notes|
|
|
153
|
+
|------------- | ------------- | ------------- | -------------|
|
|
154
|
+
| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
|
|
155
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
### Return type
|
|
159
|
+
|
|
160
|
+
**CommonSuccessEmptyResource**
|
|
161
|
+
|
|
162
|
+
### Authorization
|
|
163
|
+
|
|
164
|
+
[apiToken](../README.md#apiToken)
|
|
165
|
+
|
|
166
|
+
### HTTP request headers
|
|
167
|
+
|
|
168
|
+
- **Content-Type**: Not defined
|
|
169
|
+
- **Accept**: application/json
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
### HTTP response details
|
|
173
|
+
| Status code | Description | Response headers |
|
|
174
|
+
|-------------|-------------|------------------|
|
|
175
|
+
|**200** | Success empty response | - |
|
|
176
|
+
|**422** | Validation error response | - |
|
|
177
|
+
|**401** | Unauthenticated response | - |
|
|
178
|
+
|**500** | Error response | - |
|
|
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
|
+
|
|
182
|
+
# **uninstallWebsiteSSLV1**
|
|
183
|
+
> CommonSuccessEmptyResource uninstallWebsiteSSLV1()
|
|
184
|
+
|
|
185
|
+
Removes the platform-issued Let\'s Encrypt certificate of the domain: the certificate is revoked and deleted before the response, so the domain is no longer served with a platform certificate until a new setup completes. Also succeeds when the domain has no platform certificate to remove. Uploaded (custom) certificates are not affected. Returns 422 when a certificate process is recorded for the domain (a failed setup counts until it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
186
|
+
|
|
187
|
+
### Example
|
|
188
|
+
|
|
189
|
+
```typescript
|
|
190
|
+
import {
|
|
191
|
+
AgencyHostingSSLApi,
|
|
192
|
+
Configuration
|
|
193
|
+
} from '@hostinger/sdk';
|
|
194
|
+
|
|
195
|
+
const configuration = new Configuration();
|
|
196
|
+
const apiInstance = new AgencyHostingSSLApi(configuration);
|
|
197
|
+
|
|
198
|
+
let websiteUid: string; //Agency Plan website UID (default to undefined)
|
|
199
|
+
let domain: string; //Domain name (default to undefined)
|
|
200
|
+
|
|
201
|
+
const { status, data } = await apiInstance.uninstallWebsiteSSLV1(
|
|
202
|
+
websiteUid,
|
|
203
|
+
domain
|
|
204
|
+
);
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
### Parameters
|
|
208
|
+
|
|
209
|
+
|Name | Type | Description | Notes|
|
|
210
|
+
|------------- | ------------- | ------------- | -------------|
|
|
211
|
+
| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
|
|
212
|
+
| **domain** | [**string**] | Domain name | defaults to undefined|
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
### Return type
|
|
216
|
+
|
|
217
|
+
**CommonSuccessEmptyResource**
|
|
218
|
+
|
|
219
|
+
### Authorization
|
|
220
|
+
|
|
221
|
+
[apiToken](../README.md#apiToken)
|
|
222
|
+
|
|
223
|
+
### HTTP request headers
|
|
224
|
+
|
|
225
|
+
- **Content-Type**: Not defined
|
|
226
|
+
- **Accept**: application/json
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
### HTTP response details
|
|
230
|
+
| Status code | Description | Response headers |
|
|
231
|
+
|-------------|-------------|------------------|
|
|
232
|
+
|**200** | Success empty response | - |
|
|
233
|
+
|**422** | Validation error response | - |
|
|
234
|
+
|**401** | Unauthenticated response | - |
|
|
235
|
+
|**500** | Error response | - |
|
|
236
|
+
|
|
237
|
+
[[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)
|
|
238
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# AgencyHostingV1SslSslStatusResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**status** | **string** | `installing` while a certificate setup is running or retrying, `active` when a valid certificate is in place (uploaded, platform-issued, or a lifetime certificate bought for the domain), `failed` when the last setup gave up and no valid certificate is in place, `expired` when the certificate has run out, `not_installed` when the domain has no certificate and no setup process. | [default to undefined]
|
|
9
|
+
**is_custom** | **boolean** | Whether the certificate was uploaded by the customer instead of issued or sold by the platform. | [default to undefined]
|
|
10
|
+
**expires_at** | **string** | End of the validity period of the certificate in place; null when there is none or the uploaded certificate carries no expiry. | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { AgencyHostingV1SslSslStatusResource } from '@hostinger/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: AgencyHostingV1SslSslStatusResource = {
|
|
18
|
+
status,
|
|
19
|
+
is_custom,
|
|
20
|
+
expires_at,
|
|
21
|
+
};
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
[[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/index.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.54.0
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
|
|
9
9
|
* If you want to contribute or request a new feature, please create an issue or pull request on https://github.com/hostinger/api
|