hostinger-api-sdk 1.30.8 → 1.32.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.
Files changed (39) hide show
  1. package/README.md +2 -2
  2. package/api.ts +2234 -982
  3. package/base.ts +1 -1
  4. package/common.ts +1 -1
  5. package/configuration.ts +2 -2
  6. package/dist/api.d.ts +977 -49
  7. package/dist/api.js +683 -9
  8. package/dist/base.d.ts +1 -1
  9. package/dist/base.js +1 -1
  10. package/dist/common.d.ts +1 -1
  11. package/dist/common.js +1 -1
  12. package/dist/configuration.d.ts +1 -1
  13. package/dist/configuration.js +2 -2
  14. package/dist/esm/api.d.ts +977 -49
  15. package/dist/esm/api.js +667 -1
  16. package/dist/esm/base.d.ts +1 -1
  17. package/dist/esm/base.js +1 -1
  18. package/dist/esm/common.d.ts +1 -1
  19. package/dist/esm/common.js +1 -1
  20. package/dist/esm/configuration.d.ts +1 -1
  21. package/dist/esm/configuration.js +2 -2
  22. package/dist/esm/index.d.ts +1 -1
  23. package/dist/esm/index.js +1 -1
  24. package/dist/index.d.ts +1 -1
  25. package/dist/index.js +1 -1
  26. package/docs/ReachAutomationsApi.md +187 -0
  27. package/docs/ReachCampaignsApi.md +190 -0
  28. package/docs/ReachListAutomationsV1200Response.md +22 -0
  29. package/docs/ReachListCampaignsV1200Response.md +22 -0
  30. package/docs/ReachV1AutomationsAutomationEventsResource.md +27 -0
  31. package/docs/ReachV1AutomationsAutomationResource.md +34 -0
  32. package/docs/ReachV1AutomationsStepsAutomationStepResource.md +30 -0
  33. package/docs/ReachV1CampaignsCampaignDeliveryResource.md +25 -0
  34. package/docs/ReachV1CampaignsCampaignDetailsResource.md +52 -0
  35. package/docs/ReachV1CampaignsCampaignResource.md +44 -0
  36. package/docs/ReachV1CampaignsCampaignStatisticsResource.md +49 -0
  37. package/docs/ReachV1CampaignsCampaignSummaryStatisticsResource.md +27 -0
  38. package/index.ts +1 -1
  39. package/package.json +1 -1
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Hostinger API
3
3
  *
4
- * API Version: 1.32.6
4
+ * API Version: 1.34.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.32.6
6
+ * API Version: 1.34.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.32.6
4
+ * API Version: 1.34.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.32.6
6
+ * API Version: 1.34.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.32.6
4
+ * API Version: 1.34.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.32.6
6
+ * API Version: 1.34.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.30.8" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
16
+ this.baseOptions = Object.assign(Object.assign({}, param.baseOptions), { headers: Object.assign({ 'User-Agent': "hostinger-typescript-sdk/1.32.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
17
17
  this.formDataCtor = param.formDataCtor;
18
18
  }
19
19
  /**
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Hostinger API
3
3
  *
4
- * API Version: 1.32.6
4
+ * API Version: 1.34.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.32.6
6
+ * API Version: 1.34.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.32.6
4
+ * API Version: 1.34.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.32.6
7
+ * API Version: 1.34.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,187 @@
1
+ # ReachAutomationsApi
2
+
3
+ All URIs are relative to *https://developers.hostinger.com*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getAutomationDetailsV1**](#getautomationdetailsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid} | Get automation details|
8
+ |[**listAutomationStepsV1**](#listautomationstepsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations/{automationUuid}/steps | List automation steps|
9
+ |[**listAutomationsV1**](#listautomationsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/automations | List automations|
10
+
11
+ # **getAutomationDetailsV1**
12
+ > ReachV1AutomationsAutomationResource getAutomationDetailsV1()
13
+
14
+ Get a single automation with the counts of contacts that entered it, are moving through it, finished it or failed on the way. This describes the automation itself. To see the workflow it runs, use the steps endpoint.
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ ReachAutomationsApi,
21
+ Configuration
22
+ } from 'hostinger-api-sdk';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new ReachAutomationsApi(configuration);
26
+
27
+ let profileUuid: string; //Profile uuid parameter (default to undefined)
28
+ let automationUuid: string; //Automation uuid parameter (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.getAutomationDetailsV1(
31
+ profileUuid,
32
+ automationUuid
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
41
+ | **automationUuid** | [**string**] | Automation uuid parameter | defaults to undefined|
42
+
43
+
44
+ ### Return type
45
+
46
+ **ReachV1AutomationsAutomationResource**
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
+ # **listAutomationStepsV1**
68
+ > Array<ReachV1AutomationsStepsAutomationStepResource> listAutomationStepsV1()
69
+
70
+ Get the workflow of an automation as a flat list of steps. The steps form a tree rather than a straight line: follow `parent_uuid` to reconstruct the branches, and use `step_order` to order the steps that share a parent. An automation with no steps yet returns an empty list.
71
+
72
+ ### Example
73
+
74
+ ```typescript
75
+ import {
76
+ ReachAutomationsApi,
77
+ Configuration
78
+ } from 'hostinger-api-sdk';
79
+
80
+ const configuration = new Configuration();
81
+ const apiInstance = new ReachAutomationsApi(configuration);
82
+
83
+ let profileUuid: string; //Profile uuid parameter (default to undefined)
84
+ let automationUuid: string; //Automation uuid parameter (default to undefined)
85
+
86
+ const { status, data } = await apiInstance.listAutomationStepsV1(
87
+ profileUuid,
88
+ automationUuid
89
+ );
90
+ ```
91
+
92
+ ### Parameters
93
+
94
+ |Name | Type | Description | Notes|
95
+ |------------- | ------------- | ------------- | -------------|
96
+ | **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
97
+ | **automationUuid** | [**string**] | Automation uuid parameter | defaults to undefined|
98
+
99
+
100
+ ### Return type
101
+
102
+ **Array<ReachV1AutomationsStepsAutomationStepResource>**
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
+ # **listAutomationsV1**
124
+ > ReachListAutomationsV1200Response listAutomationsV1()
125
+
126
+ Get a paginated list of the automations in a profile. Every automation comes with the counts of contacts that entered it, are moving through it, finished it or failed on the way. Those counts describe the contact journey and are not email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics endpoint instead.
127
+
128
+ ### Example
129
+
130
+ ```typescript
131
+ import {
132
+ ReachAutomationsApi,
133
+ Configuration
134
+ } from 'hostinger-api-sdk';
135
+
136
+ const configuration = new Configuration();
137
+ const apiInstance = new ReachAutomationsApi(configuration);
138
+
139
+ let profileUuid: string; //Profile uuid parameter (default to undefined)
140
+ let status: 'active' | 'paused' | 'draft'; //Filter automations by status. There is no `completed` status. An automation that has finished for every contact still reports `active`. (optional) (default to undefined)
141
+ let sortDirection: 'asc' | 'desc'; //Order automations by creation date. Newest first unless set to `asc`. (optional) (default to undefined)
142
+ let page: number; //Page number (optional) (default to undefined)
143
+ let perPage: number; //Number of items per page (optional) (default to 25)
144
+
145
+ const { status, data } = await apiInstance.listAutomationsV1(
146
+ profileUuid,
147
+ status,
148
+ sortDirection,
149
+ page,
150
+ perPage
151
+ );
152
+ ```
153
+
154
+ ### Parameters
155
+
156
+ |Name | Type | Description | Notes|
157
+ |------------- | ------------- | ------------- | -------------|
158
+ | **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
159
+ | **status** | [**&#39;active&#39; | &#39;paused&#39; | &#39;draft&#39;**]**Array<&#39;active&#39; &#124; &#39;paused&#39; &#124; &#39;draft&#39;>** | Filter automations by status. There is no &#x60;completed&#x60; status. An automation that has finished for every contact still reports &#x60;active&#x60;. | (optional) defaults to undefined|
160
+ | **sortDirection** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Order automations by creation date. Newest first unless set to &#x60;asc&#x60;. | (optional) defaults to undefined|
161
+ | **page** | [**number**] | Page number | (optional) defaults to undefined|
162
+ | **perPage** | [**number**] | Number of items per page | (optional) defaults to 25|
163
+
164
+
165
+ ### Return type
166
+
167
+ **ReachListAutomationsV1200Response**
168
+
169
+ ### Authorization
170
+
171
+ [apiToken](../README.md#apiToken)
172
+
173
+ ### HTTP request headers
174
+
175
+ - **Content-Type**: Not defined
176
+ - **Accept**: application/json
177
+
178
+
179
+ ### HTTP response details
180
+ | Status code | Description | Response headers |
181
+ |-------------|-------------|------------------|
182
+ |**200** | Success response | - |
183
+ |**401** | Unauthenticated response | - |
184
+ |**500** | Error response | - |
185
+
186
+ [[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)
187
+
@@ -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** | [**&#39;draft&#39; | &#39;scheduled&#39; | &#39;sending&#39; | &#39;publish&#39; | &#39;failed&#39;**]**Array<&#39;draft&#39; &#124; &#39;scheduled&#39; &#124; &#39;sending&#39; &#124; &#39;publish&#39; &#124; &#39;failed&#39;>** | Filter campaigns by status. A fully sent campaign has the status &#x60;publish&#x60;. There is no &#x60;sent&#x60; status, and campaigns can be neither paused nor archived. | (optional) defaults to undefined|
162
+ | **type** | [**&#39;campaign&#39; | &#39;automation&#39; | &#39;double_opt_in&#39;**]**Array<&#39;campaign&#39; &#124; &#39;automation&#39; &#124; &#39;double_opt_in&#39;>** | Filter campaigns by type. Defaults to &#x60;campaign&#x60;, which leaves out the emails sent by automations and the double opt-in confirmations. | (optional) defaults to 'campaign'|
163
+ | **sortDirection** | [**&#39;asc&#39; | &#39;desc&#39;**]**Array<&#39;asc&#39; &#124; &#39;desc&#39;>** | Order campaigns by creation date. Newest first unless set to &#x60;asc&#x60;. | (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,22 @@
1
+ # ReachListAutomationsV1200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**Array&lt;ReachV1AutomationsAutomationResource&gt;**](ReachV1AutomationsAutomationResource.md) | Array of [&#x60;Reach.V1.Automations.AutomationResource&#x60;](#model/reachv1automationsautomationresource) | [optional] [default to undefined]
9
+ **meta** | [**CommonSchemaPaginationMetaSchema**](CommonSchemaPaginationMetaSchema.md) | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { ReachListAutomationsV1200Response } from 'hostinger-api-sdk';
15
+
16
+ const instance: ReachListAutomationsV1200Response = {
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
+ # ReachListCampaignsV1200Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **data** | [**Array&lt;ReachV1CampaignsCampaignResource&gt;**](ReachV1CampaignsCampaignResource.md) | Array of [&#x60;Reach.V1.Campaigns.CampaignResource&#x60;](#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,27 @@
1
+ # ReachV1AutomationsAutomationEventsResource
2
+
3
+ Counts of contacts moving through the automation. These are not email engagement metrics. Automations expose no sent, open or click counters - use the campaign statistics endpoint for those.
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **started** | **number** | Contacts that ever entered the automation, including those that already left it. | [optional] [default to undefined]
10
+ **in_progress** | **number** | Contacts currently moving through the automation, including those waiting on a delay step. | [optional] [default to undefined]
11
+ **completed** | **number** | Contacts that reached the end of the workflow. | [optional] [default to undefined]
12
+ **failed** | **number** | Contacts whose journey through the automation errored and stopped. | [optional] [default to undefined]
13
+
14
+ ## Example
15
+
16
+ ```typescript
17
+ import { ReachV1AutomationsAutomationEventsResource } from 'hostinger-api-sdk';
18
+
19
+ const instance: ReachV1AutomationsAutomationEventsResource = {
20
+ started,
21
+ in_progress,
22
+ completed,
23
+ failed,
24
+ };
25
+ ```
26
+
27
+ [[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,34 @@
1
+ # ReachV1AutomationsAutomationResource
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **uuid** | **string** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+ **status** | **string** | There is no &#x60;completed&#x60; status. Use &#x60;events.completed&#x60; to see how many contacts finished. | [optional] [default to undefined]
11
+ **type** | **string** | What kind of workflow this is. &#x60;custom&#x60; automations are the ones built from scratch. | [optional] [default to undefined]
12
+ **config** | **object** | Trigger configuration of the automation. The shape depends on the type. | [optional] [default to undefined]
13
+ **events** | [**ReachV1AutomationsAutomationEventsResource**](ReachV1AutomationsAutomationEventsResource.md) | | [optional] [default to undefined]
14
+ **created_at** | **string** | | [optional] [default to undefined]
15
+ **updated_at** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { ReachV1AutomationsAutomationResource } from 'hostinger-api-sdk';
21
+
22
+ const instance: ReachV1AutomationsAutomationResource = {
23
+ uuid,
24
+ name,
25
+ status,
26
+ type,
27
+ config,
28
+ events,
29
+ created_at,
30
+ updated_at,
31
+ };
32
+ ```
33
+
34
+ [[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,30 @@
1
+ # ReachV1AutomationsStepsAutomationStepResource
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **uuid** | **string** | | [optional] [default to undefined]
9
+ **parent_uuid** | **string** | The step this one branches from. Null for the entry point of the workflow. | [optional] [default to undefined]
10
+ **step_order** | **number** | Position of this step among the steps sharing its parent. | [optional] [default to undefined]
11
+ **type** | **string** | Role of the step in the workflow. A &#x60;conditional&#x60; step branches into several children. | [optional] [default to undefined]
12
+ **value** | **string** | The concrete trigger, action, decision or delay this step performs. | [optional] [default to undefined]
13
+ **config** | **object** | Step configuration. The shape depends on the value, and is empty for steps that take none. | [optional] [default to undefined]
14
+
15
+ ## Example
16
+
17
+ ```typescript
18
+ import { ReachV1AutomationsStepsAutomationStepResource } from 'hostinger-api-sdk';
19
+
20
+ const instance: ReachV1AutomationsStepsAutomationStepResource = {
21
+ uuid,
22
+ parent_uuid,
23
+ step_order,
24
+ type,
25
+ value,
26
+ config,
27
+ };
28
+ ```
29
+
30
+ [[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,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)