@hostinger/sdk 1.46.3 → 1.47.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 +483 -59
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +341 -59
- package/dist/api.js +281 -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 +341 -59
- package/dist/esm/api.js +267 -2
- 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/AgencyHostingV1SetupsCreateSetupRequest.md +0 -4
- package/docs/ReachCampaignsApi.md +59 -0
- package/docs/ReachTemplatesApi.md +120 -0
- package/docs/ReachV1CampaignsCreatedCampaignResource.md +43 -0
- package/docs/ReachV1CampaignsStoreRequest.md +31 -0
- package/docs/ReachV1CampaignsStoreRequestMetadata.md +23 -0
- package/docs/ReachV1TemplatesStoreRequest.md +23 -0
- package/docs/ReachV1TemplatesTemplateResource.md +26 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/AgencyHostingV1SetupsCreateSetupRequestClone.md +0 -21
- package/docs/AgencyHostingV1SetupsCreateSetupRequestDeriveDomain.md +0 -21
- package/docs/AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost.md +0 -22
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# ReachV1CampaignsCreatedCampaignResource
|
|
2
|
+
|
|
3
|
+
The campaign as it was stored, without targeting or delivery progress
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**uuid** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**sender_name** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**sender_email** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**template_uuid** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**status** | **string** | Always `draft` for a campaign that was just created. | [optional] [default to undefined]
|
|
16
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**is_all_contacts** | **boolean** | Whether the campaign targets every contact instead of selected segments. | [optional] [default to undefined]
|
|
18
|
+
**metadata** | **{ [key: string]: string; }** | The stored extra fields, including the ones Reach sets itself. | [optional] [default to undefined]
|
|
19
|
+
**created_at** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**updated_at** | **string** | | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { ReachV1CampaignsCreatedCampaignResource } from '@hostinger/sdk';
|
|
26
|
+
|
|
27
|
+
const instance: ReachV1CampaignsCreatedCampaignResource = {
|
|
28
|
+
uuid,
|
|
29
|
+
title,
|
|
30
|
+
subject,
|
|
31
|
+
sender_name,
|
|
32
|
+
sender_email,
|
|
33
|
+
template_uuid,
|
|
34
|
+
status,
|
|
35
|
+
type,
|
|
36
|
+
is_all_contacts,
|
|
37
|
+
metadata,
|
|
38
|
+
created_at,
|
|
39
|
+
updated_at,
|
|
40
|
+
};
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
[[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,31 @@
|
|
|
1
|
+
# ReachV1CampaignsStoreRequest
|
|
2
|
+
|
|
3
|
+
Create a campaign in draft status
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**sender_name** | **string** | From name shown to the recipients. | [default to undefined]
|
|
10
|
+
**sender_email** | **string** | From address of the campaign. Its domain has to be verified on the profile before the campaign can be sent. | [default to undefined]
|
|
11
|
+
**title** | **string** | Name the campaign is listed under. Not shown to the recipients. | [optional] [default to undefined]
|
|
12
|
+
**subject** | **string** | Subject line of the email. | [optional] [default to undefined]
|
|
13
|
+
**template_uuid** | **string** | Template to send, as returned by the template endpoints. Can be left out and attached later, but the campaign cannot be sent without one. | [optional] [default to undefined]
|
|
14
|
+
**metadata** | [**ReachV1CampaignsStoreRequestMetadata**](ReachV1CampaignsStoreRequestMetadata.md) | | [optional] [default to undefined]
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import { ReachV1CampaignsStoreRequest } from '@hostinger/sdk';
|
|
20
|
+
|
|
21
|
+
const instance: ReachV1CampaignsStoreRequest = {
|
|
22
|
+
sender_name,
|
|
23
|
+
sender_email,
|
|
24
|
+
title,
|
|
25
|
+
subject,
|
|
26
|
+
template_uuid,
|
|
27
|
+
metadata,
|
|
28
|
+
};
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
[[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,23 @@
|
|
|
1
|
+
# ReachV1CampaignsStoreRequestMetadata
|
|
2
|
+
|
|
3
|
+
Extra campaign fields. Any key outside the listed ones is rejected.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**preheader** | **string** | Preview text shown after the subject line in the inbox. | [optional] [default to undefined]
|
|
10
|
+
**source** | **string** | Where the campaign was created from. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ReachV1CampaignsStoreRequestMetadata } from '@hostinger/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ReachV1CampaignsStoreRequestMetadata = {
|
|
18
|
+
preheader,
|
|
19
|
+
source,
|
|
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)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# ReachV1TemplatesStoreRequest
|
|
2
|
+
|
|
3
|
+
Create a reusable email template
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**template_content** | **string** | The email body as HTML. It is sanitised before it is stored, so the saved template can differ from what was sent - inline any styles the email clients need and keep the markup self-contained. | [default to undefined]
|
|
10
|
+
**title** | **string** | Name the template is listed under. Not shown to the recipients. | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ReachV1TemplatesStoreRequest } from '@hostinger/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ReachV1TemplatesStoreRequest = {
|
|
18
|
+
template_content,
|
|
19
|
+
title,
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# ReachV1TemplatesTemplateResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uuid** | **string** | Pass this as the `template_uuid` of a campaign. | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | Null for templates that were never named. | [optional] [default to undefined]
|
|
10
|
+
**created_at** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**updated_at** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ReachV1TemplatesTemplateResource } from '@hostinger/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ReachV1TemplatesTemplateResource = {
|
|
19
|
+
uuid,
|
|
20
|
+
title,
|
|
21
|
+
created_at,
|
|
22
|
+
updated_at,
|
|
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)
|
package/index.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.47.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/package.json
CHANGED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# AgencyHostingV1SetupsCreateSetupRequestClone
|
|
2
|
-
|
|
3
|
-
Clone the new website from an existing website
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**website_uid** | **string** | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { AgencyHostingV1SetupsCreateSetupRequestClone } from '@hostinger/sdk';
|
|
15
|
-
|
|
16
|
-
const instance: AgencyHostingV1SetupsCreateSetupRequestClone = {
|
|
17
|
-
website_uid,
|
|
18
|
-
};
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# AgencyHostingV1SetupsCreateSetupRequestDeriveDomain
|
|
2
|
-
|
|
3
|
-
Derive the domain from an existing vhost
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**from_vhost** | [**AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost**](AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost.md) | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { AgencyHostingV1SetupsCreateSetupRequestDeriveDomain } from '@hostinger/sdk';
|
|
15
|
-
|
|
16
|
-
const instance: AgencyHostingV1SetupsCreateSetupRequestDeriveDomain = {
|
|
17
|
-
from_vhost,
|
|
18
|
-
};
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**username** | **string** | | [default to undefined]
|
|
9
|
-
**vhost** | **string** | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost } from '@hostinger/sdk';
|
|
15
|
-
|
|
16
|
-
const instance: AgencyHostingV1SetupsCreateSetupRequestDeriveDomainFromVhost = {
|
|
17
|
-
username,
|
|
18
|
-
vhost,
|
|
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)
|