hostinger-api-sdk 1.31.0 → 1.33.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 +1440 -52
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +2 -2
- package/dist/api.d.ts +1045 -15
- package/dist/api.js +710 -9
- 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 +1045 -15
- package/dist/esm/api.js +693 -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/ReachCampaignsApi.md +190 -0
- package/docs/ReachFormsApi.md +182 -0
- package/docs/ReachListCampaignsV1200Response.md +22 -0
- package/docs/ReachListFormsV1200Response.md +22 -0
- package/docs/ReachProfilesApi.md +54 -0
- package/docs/ReachV1CampaignsCampaignDeliveryResource.md +25 -0
- package/docs/ReachV1CampaignsCampaignDetailsResource.md +52 -0
- package/docs/ReachV1CampaignsCampaignResource.md +44 -0
- package/docs/ReachV1CampaignsCampaignStatisticsResource.md +49 -0
- package/docs/ReachV1CampaignsCampaignSummaryStatisticsResource.md +27 -0
- package/docs/ReachV1FormsFormDetailsResource.md +34 -0
- package/docs/ReachV1FormsFormResource.md +32 -0
- package/docs/ReachV1FormsFormTagResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateDetailsResource.md +25 -0
- package/docs/ReachV1FormsFormTemplateResource.md +23 -0
- package/docs/ReachV1ProfilesPlanLimitUsageResource.md +25 -0
- package/docs/ReachV1ProfilesPlanLimitsResource.md +29 -0
- package/index.ts +1 -1
- package/package.json +1 -1
package/dist/esm/base.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.35.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/base.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.35.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/esm/common.d.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Hostinger API
|
|
3
3
|
*
|
|
4
|
-
* API Version: 1.
|
|
4
|
+
* API Version: 1.35.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/common.js
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
/**
|
|
4
4
|
* Hostinger API
|
|
5
5
|
*
|
|
6
|
-
* API Version: 1.
|
|
6
|
+
* API Version: 1.35.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.35.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.35.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.33.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.35.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.35.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.35.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.35.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,190 @@
|
|
|
1
|
+
# ReachCampaignsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://developers.hostinger.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**getCampaignDetailsV1**](#getcampaigndetailsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid} | Get campaign details|
|
|
8
|
+
|[**getCampaignPerformanceV1**](#getcampaignperformancev1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns/{campaignUuid}/statistics | Get campaign performance|
|
|
9
|
+
|[**listCampaignsV1**](#listcampaignsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/campaigns | List campaigns|
|
|
10
|
+
|
|
11
|
+
# **getCampaignDetailsV1**
|
|
12
|
+
> ReachV1CampaignsCampaignDetailsResource getCampaignDetailsV1()
|
|
13
|
+
|
|
14
|
+
Get a single campaign with its sender, subject, template reference, targeting and delivery progress. This describes how the campaign was set up and how far it has got. For opens, clicks and unsubscribes use the campaign statistics endpoint.
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
ReachCampaignsApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from 'hostinger-api-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new ReachCampaignsApi(configuration);
|
|
26
|
+
|
|
27
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
28
|
+
let campaignUuid: string; //Campaign uuid parameter (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.getCampaignDetailsV1(
|
|
31
|
+
profileUuid,
|
|
32
|
+
campaignUuid
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
41
|
+
| **campaignUuid** | [**string**] | Campaign uuid parameter | defaults to undefined|
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**ReachV1CampaignsCampaignDetailsResource**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
[apiToken](../README.md#apiToken)
|
|
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** | Success response | - |
|
|
62
|
+
|**401** | Unauthenticated response | - |
|
|
63
|
+
|**500** | Error response | - |
|
|
64
|
+
|
|
65
|
+
[[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
|
+
|
|
67
|
+
# **getCampaignPerformanceV1**
|
|
68
|
+
> ReachV1CampaignsCampaignStatisticsResource getCampaignPerformanceV1()
|
|
69
|
+
|
|
70
|
+
Get the performance of a campaign: delivery, opens, clicks and unsubscribes, with the matching rates. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
ReachCampaignsApi,
|
|
77
|
+
Configuration
|
|
78
|
+
} from 'hostinger-api-sdk';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new ReachCampaignsApi(configuration);
|
|
82
|
+
|
|
83
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
84
|
+
let campaignUuid: string; //Campaign uuid parameter (default to undefined)
|
|
85
|
+
|
|
86
|
+
const { status, data } = await apiInstance.getCampaignPerformanceV1(
|
|
87
|
+
profileUuid,
|
|
88
|
+
campaignUuid
|
|
89
|
+
);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
|Name | Type | Description | Notes|
|
|
95
|
+
|------------- | ------------- | ------------- | -------------|
|
|
96
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
97
|
+
| **campaignUuid** | [**string**] | Campaign uuid parameter | defaults to undefined|
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### Return type
|
|
101
|
+
|
|
102
|
+
**ReachV1CampaignsCampaignStatisticsResource**
|
|
103
|
+
|
|
104
|
+
### Authorization
|
|
105
|
+
|
|
106
|
+
[apiToken](../README.md#apiToken)
|
|
107
|
+
|
|
108
|
+
### HTTP request headers
|
|
109
|
+
|
|
110
|
+
- **Content-Type**: Not defined
|
|
111
|
+
- **Accept**: application/json
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### HTTP response details
|
|
115
|
+
| Status code | Description | Response headers |
|
|
116
|
+
|-------------|-------------|------------------|
|
|
117
|
+
|**200** | Success response | - |
|
|
118
|
+
|**401** | Unauthenticated response | - |
|
|
119
|
+
|**500** | Error response | - |
|
|
120
|
+
|
|
121
|
+
[[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
|
+
|
|
123
|
+
# **listCampaignsV1**
|
|
124
|
+
> ReachListCampaignsV1200Response listCampaignsV1()
|
|
125
|
+
|
|
126
|
+
Get a paginated list of the campaigns in a profile. Each campaign carries its headline engagement rates. Filter by status to find drafts, scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign has the status `publish`. By default only regular campaigns are returned - pass `type` to get the emails sent by automations or the double opt-in confirmations instead.
|
|
127
|
+
|
|
128
|
+
### Example
|
|
129
|
+
|
|
130
|
+
```typescript
|
|
131
|
+
import {
|
|
132
|
+
ReachCampaignsApi,
|
|
133
|
+
Configuration
|
|
134
|
+
} from 'hostinger-api-sdk';
|
|
135
|
+
|
|
136
|
+
const configuration = new Configuration();
|
|
137
|
+
const apiInstance = new ReachCampaignsApi(configuration);
|
|
138
|
+
|
|
139
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
140
|
+
let status: 'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'; //Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived. (optional) (default to undefined)
|
|
141
|
+
let type: 'campaign' | 'automation' | 'double_opt_in'; //Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations. (optional) (default to 'campaign')
|
|
142
|
+
let sortDirection: 'asc' | 'desc'; //Order campaigns by creation date. Newest first unless set to `asc`. (optional) (default to undefined)
|
|
143
|
+
let page: number; //Page number (optional) (default to undefined)
|
|
144
|
+
let perPage: number; //Number of items per page (optional) (default to 25)
|
|
145
|
+
|
|
146
|
+
const { status, data } = await apiInstance.listCampaignsV1(
|
|
147
|
+
profileUuid,
|
|
148
|
+
status,
|
|
149
|
+
type,
|
|
150
|
+
sortDirection,
|
|
151
|
+
page,
|
|
152
|
+
perPage
|
|
153
|
+
);
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
### Parameters
|
|
157
|
+
|
|
158
|
+
|Name | Type | Description | Notes|
|
|
159
|
+
|------------- | ------------- | ------------- | -------------|
|
|
160
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
161
|
+
| **status** | [**'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'**]**Array<'draft' | 'scheduled' | 'sending' | 'publish' | 'failed'>** | Filter campaigns by status. A fully sent campaign has the status `publish`. There is no `sent` status, and campaigns can be neither paused nor archived. | (optional) defaults to undefined|
|
|
162
|
+
| **type** | [**'campaign' | 'automation' | 'double_opt_in'**]**Array<'campaign' | 'automation' | 'double_opt_in'>** | Filter campaigns by type. Defaults to `campaign`, which leaves out the emails sent by automations and the double opt-in confirmations. | (optional) defaults to 'campaign'|
|
|
163
|
+
| **sortDirection** | [**'asc' | 'desc'**]**Array<'asc' | 'desc'>** | Order campaigns by creation date. Newest first unless set to `asc`. | (optional) defaults to undefined|
|
|
164
|
+
| **page** | [**number**] | Page number | (optional) defaults to undefined|
|
|
165
|
+
| **perPage** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
### Return type
|
|
169
|
+
|
|
170
|
+
**ReachListCampaignsV1200Response**
|
|
171
|
+
|
|
172
|
+
### Authorization
|
|
173
|
+
|
|
174
|
+
[apiToken](../README.md#apiToken)
|
|
175
|
+
|
|
176
|
+
### HTTP request headers
|
|
177
|
+
|
|
178
|
+
- **Content-Type**: Not defined
|
|
179
|
+
- **Accept**: application/json
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
### HTTP response details
|
|
183
|
+
| Status code | Description | Response headers |
|
|
184
|
+
|-------------|-------------|------------------|
|
|
185
|
+
|**200** | Success response | - |
|
|
186
|
+
|**401** | Unauthenticated response | - |
|
|
187
|
+
|**500** | Error response | - |
|
|
188
|
+
|
|
189
|
+
[[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)
|
|
190
|
+
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
# ReachFormsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://developers.hostinger.com*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**deleteFormV1**](#deleteformv1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Delete form|
|
|
8
|
+
|[**getFormDetailsV1**](#getformdetailsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Get form details|
|
|
9
|
+
|[**listFormsV1**](#listformsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms | List forms|
|
|
10
|
+
|
|
11
|
+
# **deleteFormV1**
|
|
12
|
+
> CommonSuccessEmptyResource deleteFormV1()
|
|
13
|
+
|
|
14
|
+
Permanently delete a form together with its template. A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
ReachFormsApi,
|
|
21
|
+
Configuration
|
|
22
|
+
} from 'hostinger-api-sdk';
|
|
23
|
+
|
|
24
|
+
const configuration = new Configuration();
|
|
25
|
+
const apiInstance = new ReachFormsApi(configuration);
|
|
26
|
+
|
|
27
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
28
|
+
let formUuid: string; //Form uuid parameter (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.deleteFormV1(
|
|
31
|
+
profileUuid,
|
|
32
|
+
formUuid
|
|
33
|
+
);
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
### Parameters
|
|
37
|
+
|
|
38
|
+
|Name | Type | Description | Notes|
|
|
39
|
+
|------------- | ------------- | ------------- | -------------|
|
|
40
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
41
|
+
| **formUuid** | [**string**] | Form uuid parameter | defaults to undefined|
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
### Return type
|
|
45
|
+
|
|
46
|
+
**CommonSuccessEmptyResource**
|
|
47
|
+
|
|
48
|
+
### Authorization
|
|
49
|
+
|
|
50
|
+
[apiToken](../README.md#apiToken)
|
|
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** | Success empty response | - |
|
|
62
|
+
|**401** | Unauthenticated response | - |
|
|
63
|
+
|**409** | Error 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
|
+
# **getFormDetailsV1**
|
|
69
|
+
> ReachV1FormsFormDetailsResource getFormDetailsV1()
|
|
70
|
+
|
|
71
|
+
Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures. There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
|
|
72
|
+
|
|
73
|
+
### Example
|
|
74
|
+
|
|
75
|
+
```typescript
|
|
76
|
+
import {
|
|
77
|
+
ReachFormsApi,
|
|
78
|
+
Configuration
|
|
79
|
+
} from 'hostinger-api-sdk';
|
|
80
|
+
|
|
81
|
+
const configuration = new Configuration();
|
|
82
|
+
const apiInstance = new ReachFormsApi(configuration);
|
|
83
|
+
|
|
84
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
85
|
+
let formUuid: string; //Form uuid parameter (default to undefined)
|
|
86
|
+
|
|
87
|
+
const { status, data } = await apiInstance.getFormDetailsV1(
|
|
88
|
+
profileUuid,
|
|
89
|
+
formUuid
|
|
90
|
+
);
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Parameters
|
|
94
|
+
|
|
95
|
+
|Name | Type | Description | Notes|
|
|
96
|
+
|------------- | ------------- | ------------- | -------------|
|
|
97
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
98
|
+
| **formUuid** | [**string**] | Form uuid parameter | defaults to undefined|
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
### Return type
|
|
102
|
+
|
|
103
|
+
**ReachV1FormsFormDetailsResource**
|
|
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 response | - |
|
|
119
|
+
|**401** | Unauthenticated response | - |
|
|
120
|
+
|**500** | Error response | - |
|
|
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
|
+
# **listFormsV1**
|
|
125
|
+
> ReachListFormsV1200Response listFormsV1()
|
|
126
|
+
|
|
127
|
+
Get a paginated list of the signup forms in a profile. Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
128
|
+
|
|
129
|
+
### Example
|
|
130
|
+
|
|
131
|
+
```typescript
|
|
132
|
+
import {
|
|
133
|
+
ReachFormsApi,
|
|
134
|
+
Configuration
|
|
135
|
+
} from 'hostinger-api-sdk';
|
|
136
|
+
|
|
137
|
+
const configuration = new Configuration();
|
|
138
|
+
const apiInstance = new ReachFormsApi(configuration);
|
|
139
|
+
|
|
140
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
141
|
+
let page: number; //Page number (optional) (default to undefined)
|
|
142
|
+
let perPage: number; //Number of items per page (optional) (default to 25)
|
|
143
|
+
|
|
144
|
+
const { status, data } = await apiInstance.listFormsV1(
|
|
145
|
+
profileUuid,
|
|
146
|
+
page,
|
|
147
|
+
perPage
|
|
148
|
+
);
|
|
149
|
+
```
|
|
150
|
+
|
|
151
|
+
### Parameters
|
|
152
|
+
|
|
153
|
+
|Name | Type | Description | Notes|
|
|
154
|
+
|------------- | ------------- | ------------- | -------------|
|
|
155
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
156
|
+
| **page** | [**number**] | Page number | (optional) defaults to undefined|
|
|
157
|
+
| **perPage** | [**number**] | Number of items per page | (optional) defaults to 25|
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
### Return type
|
|
161
|
+
|
|
162
|
+
**ReachListFormsV1200Response**
|
|
163
|
+
|
|
164
|
+
### Authorization
|
|
165
|
+
|
|
166
|
+
[apiToken](../README.md#apiToken)
|
|
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** | Success response | - |
|
|
178
|
+
|**401** | Unauthenticated response | - |
|
|
179
|
+
|**500** | Error response | - |
|
|
180
|
+
|
|
181
|
+
[[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)
|
|
182
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ReachListCampaignsV1200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**Array<ReachV1CampaignsCampaignResource>**](ReachV1CampaignsCampaignResource.md) | Array of [`Reach.V1.Campaigns.CampaignResource`](#model/reachv1campaignscampaignresource) | [optional] [default to undefined]
|
|
9
|
+
**meta** | [**CommonSchemaPaginationMetaSchema**](CommonSchemaPaginationMetaSchema.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ReachListCampaignsV1200Response } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ReachListCampaignsV1200Response = {
|
|
17
|
+
data,
|
|
18
|
+
meta,
|
|
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,22 @@
|
|
|
1
|
+
# ReachListFormsV1200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**data** | [**Array<ReachV1FormsFormResource>**](ReachV1FormsFormResource.md) | Array of [`Reach.V1.Forms.FormResource`](#model/reachv1formsformresource) | [optional] [default to undefined]
|
|
9
|
+
**meta** | [**CommonSchemaPaginationMetaSchema**](CommonSchemaPaginationMetaSchema.md) | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ReachListFormsV1200Response } from 'hostinger-api-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ReachListFormsV1200Response = {
|
|
17
|
+
data,
|
|
18
|
+
meta,
|
|
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)
|
package/docs/ReachProfilesApi.md
CHANGED
|
@@ -5,6 +5,7 @@ All URIs are relative to *https://developers.hostinger.com*
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
7
|
|[**getProfileDomainDNSStatusV1**](#getprofiledomaindnsstatusv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains/dns-status | Get profile domain DNS status|
|
|
8
|
+
|[**getRemainingPlanLimitsV1**](#getremainingplanlimitsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/limits | Get remaining plan limits|
|
|
8
9
|
|[**listProfilesV1**](#listprofilesv1) | **GET** /api/reach/v1/profiles | List Profiles|
|
|
9
10
|
|
|
10
11
|
# **getProfileDomainDNSStatusV1**
|
|
@@ -51,6 +52,59 @@ const { status, data } = await apiInstance.getProfileDomainDNSStatusV1(
|
|
|
51
52
|
- **Accept**: application/json
|
|
52
53
|
|
|
53
54
|
|
|
55
|
+
### HTTP response details
|
|
56
|
+
| Status code | Description | Response headers |
|
|
57
|
+
|-------------|-------------|------------------|
|
|
58
|
+
|**200** | Success response | - |
|
|
59
|
+
|**401** | Unauthenticated response | - |
|
|
60
|
+
|**500** | Error response | - |
|
|
61
|
+
|
|
62
|
+
[[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)
|
|
63
|
+
|
|
64
|
+
# **getRemainingPlanLimitsV1**
|
|
65
|
+
> ReachV1ProfilesPlanLimitsResource getRemainingPlanLimitsV1()
|
|
66
|
+
|
|
67
|
+
Get how much of the plan is left for the current period. Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
|
|
68
|
+
|
|
69
|
+
### Example
|
|
70
|
+
|
|
71
|
+
```typescript
|
|
72
|
+
import {
|
|
73
|
+
ReachProfilesApi,
|
|
74
|
+
Configuration
|
|
75
|
+
} from 'hostinger-api-sdk';
|
|
76
|
+
|
|
77
|
+
const configuration = new Configuration();
|
|
78
|
+
const apiInstance = new ReachProfilesApi(configuration);
|
|
79
|
+
|
|
80
|
+
let profileUuid: string; //Profile uuid parameter (default to undefined)
|
|
81
|
+
|
|
82
|
+
const { status, data } = await apiInstance.getRemainingPlanLimitsV1(
|
|
83
|
+
profileUuid
|
|
84
|
+
);
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
### Parameters
|
|
88
|
+
|
|
89
|
+
|Name | Type | Description | Notes|
|
|
90
|
+
|------------- | ------------- | ------------- | -------------|
|
|
91
|
+
| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
### Return type
|
|
95
|
+
|
|
96
|
+
**ReachV1ProfilesPlanLimitsResource**
|
|
97
|
+
|
|
98
|
+
### Authorization
|
|
99
|
+
|
|
100
|
+
[apiToken](../README.md#apiToken)
|
|
101
|
+
|
|
102
|
+
### HTTP request headers
|
|
103
|
+
|
|
104
|
+
- **Content-Type**: Not defined
|
|
105
|
+
- **Accept**: application/json
|
|
106
|
+
|
|
107
|
+
|
|
54
108
|
### HTTP response details
|
|
55
109
|
| Status code | Description | Response headers |
|
|
56
110
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# ReachV1CampaignsCampaignDeliveryResource
|
|
2
|
+
|
|
3
|
+
Delivery progress. While the campaign is `sending`, `total_sent` climbs towards the estimate.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**total_sent** | **number** | Emails sent so far. | [optional] [default to undefined]
|
|
10
|
+
**estimated_total_recipients** | **number** | Recipients this campaign was estimated to reach when sending started. Null for campaigns that have not started sending. | [optional] [default to undefined]
|
|
11
|
+
**subscribers_count** | **number** | Contacts currently targeted by this campaign. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ReachV1CampaignsCampaignDeliveryResource } from 'hostinger-api-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ReachV1CampaignsCampaignDeliveryResource = {
|
|
19
|
+
total_sent,
|
|
20
|
+
estimated_total_recipients,
|
|
21
|
+
subscribers_count,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[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,52 @@
|
|
|
1
|
+
# ReachV1CampaignsCampaignDetailsResource
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**uuid** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**subject** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**sender_name** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**sender_email** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**template_uuid** | **string** | The email template this campaign uses. The template title is not exposed. | [optional] [default to undefined]
|
|
14
|
+
**status** | **string** | A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status. | [optional] [default to undefined]
|
|
15
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**failure_reason** | **string** | Set only while the status is `failed`. | [optional] [default to undefined]
|
|
17
|
+
**is_smart_send** | **boolean** | Whether delivery time is picked per contact rather than sent to everyone at once. | [optional] [default to undefined]
|
|
18
|
+
**is_all_contacts** | **boolean** | Whether the campaign targets every contact instead of the listed segments. | [optional] [default to undefined]
|
|
19
|
+
**delivery** | [**ReachV1CampaignsCampaignDeliveryResource**](ReachV1CampaignsCampaignDeliveryResource.md) | | [optional] [default to undefined]
|
|
20
|
+
**segment_uuids** | **Array<string>** | Segments this campaign targets. Empty when it targets all contacts. | [optional] [default to undefined]
|
|
21
|
+
**created_at** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**updated_at** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**sent_at** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**scheduled_at** | **string** | | [optional] [default to undefined]
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import { ReachV1CampaignsCampaignDetailsResource } from 'hostinger-api-sdk';
|
|
30
|
+
|
|
31
|
+
const instance: ReachV1CampaignsCampaignDetailsResource = {
|
|
32
|
+
uuid,
|
|
33
|
+
title,
|
|
34
|
+
subject,
|
|
35
|
+
sender_name,
|
|
36
|
+
sender_email,
|
|
37
|
+
template_uuid,
|
|
38
|
+
status,
|
|
39
|
+
type,
|
|
40
|
+
failure_reason,
|
|
41
|
+
is_smart_send,
|
|
42
|
+
is_all_contacts,
|
|
43
|
+
delivery,
|
|
44
|
+
segment_uuids,
|
|
45
|
+
created_at,
|
|
46
|
+
updated_at,
|
|
47
|
+
sent_at,
|
|
48
|
+
scheduled_at,
|
|
49
|
+
};
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|