hostinger-api-sdk 1.31.0 → 1.33.0

package/docs/ReachV1CampaignsCampaignResource.md

@@ -0,0 +1,44 @@
+# ReachV1CampaignsCampaignResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**title** | **string** |  | [optional] [default to undefined]
+**subject** | **string** |  | [optional] [default to undefined]
+**sender_name** | **string** |  | [optional] [default to undefined]
+**sender_email** | **string** |  | [optional] [default to undefined]
+**template_uuid** | **string** | The email template this campaign uses. The template title is not exposed. | [optional] [default to undefined]
+**status** | **string** | A fully sent campaign is `publish`. There is no `sent`, `paused` or `archived` status. | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+**sent_at** | **string** |  | [optional] [default to undefined]
+**scheduled_at** | **string** |  | [optional] [default to undefined]
+**statistics** | [**ReachV1CampaignsCampaignSummaryStatisticsResource**](ReachV1CampaignsCampaignSummaryStatisticsResource.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1CampaignsCampaignResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1CampaignsCampaignResource = {
+    uuid,
+    title,
+    subject,
+    sender_name,
+    sender_email,
+    template_uuid,
+    status,
+    type,
+    created_at,
+    updated_at,
+    sent_at,
+    scheduled_at,
+    statistics,
+};
+```
+
+[[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/ReachV1CampaignsCampaignStatisticsResource.md

@@ -0,0 +1,49 @@
+# ReachV1CampaignsCampaignStatisticsResource
+
+Campaign performance. Every count is unique contacts rather than raw events, so a contact who opens the same email five times is counted once.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_sent** | **number** | Emails sent for this campaign, and the denominator of every rate below. | [optional] [default to undefined]
+**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]
+**processed_count** | **number** |  | [optional] [default to undefined]
+**delivered_count** | **number** |  | [optional] [default to undefined]
+**dropped_count** | **number** |  | [optional] [default to undefined]
+**bounced_count** | **number** |  | [optional] [default to undefined]
+**soft_bounced_count** | **number** |  | [optional] [default to undefined]
+**opened_count** | **number** | Contacts who opened this campaign. | [optional] [default to undefined]
+**clicked_count** | **number** | Contacts who clicked a link. Only clicks from contacts who also registered an open count. | [optional] [default to undefined]
+**unsubscribed_count** | **number** | Contacts who unsubscribed through this campaign. | [optional] [default to undefined]
+**open_rate** | **number** | Percentage of sent emails that were opened. | [optional] [default to undefined]
+**click_rate** | **number** | Percentage of sent emails that got a click. | [optional] [default to undefined]
+**click_to_open_rate** | **number** | Percentage of the contacts who opened that went on to click. | [optional] [default to undefined]
+**unsubscribe_rate** | **number** | Percentage of sent emails that led to an unsubscribe. | [optional] [default to undefined]
+**has_bounced_contacts** | **boolean** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1CampaignsCampaignStatisticsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1CampaignsCampaignStatisticsResource = {
+    total_sent,
+    estimated_total_recipients,
+    processed_count,
+    delivered_count,
+    dropped_count,
+    bounced_count,
+    soft_bounced_count,
+    opened_count,
+    clicked_count,
+    unsubscribed_count,
+    open_rate,
+    click_rate,
+    click_to_open_rate,
+    unsubscribe_rate,
+    has_bounced_contacts,
+};
+```
+
+[[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/ReachV1CampaignsCampaignSummaryStatisticsResource.md

@@ -0,0 +1,27 @@
+# ReachV1CampaignsCampaignSummaryStatisticsResource
+
+Headline engagement rates. The statistics endpoint carries the full breakdown.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_sent** | **number** | Emails sent for this campaign, and the denominator of the rates below. | [optional] [default to undefined]
+**open_rate** | **number** | Percentage of sent emails that were opened. | [optional] [default to undefined]
+**click_rate** | **number** | Percentage of sent emails that got a click. | [optional] [default to undefined]
+**click_to_open_rate** | **number** | Percentage of the contacts who opened that went on to click. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1CampaignsCampaignSummaryStatisticsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1CampaignsCampaignSummaryStatisticsResource = {
+    total_sent,
+    open_rate,
+    click_rate,
+    click_to_open_rate,
+};
+```
+
+[[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/ReachV1FormsFormDetailsResource.md

@@ -0,0 +1,34 @@
+# ReachV1FormsFormDetailsResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | **string** | A `paused` form keeps its template online but stops accepting submissions. | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**template** | [**ReachV1FormsFormTemplateDetailsResource**](ReachV1FormsFormTemplateDetailsResource.md) |  | [optional] [default to undefined]
+**tags** | [**Array<ReachV1FormsFormTagResource>**](ReachV1FormsFormTagResource.md) | Tags applied to every contact this form captures. | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1FormsFormDetailsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1FormsFormDetailsResource = {
+    uuid,
+    name,
+    status,
+    type,
+    template,
+    tags,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/ReachV1FormsFormResource.md

@@ -0,0 +1,32 @@
+# ReachV1FormsFormResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | **string** | A `paused` form keeps its template online but stops accepting submissions. | [optional] [default to undefined]
+**type** | **string** |  | [optional] [default to undefined]
+**template** | [**ReachV1FormsFormTemplateResource**](ReachV1FormsFormTemplateResource.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1FormsFormResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1FormsFormResource = {
+    uuid,
+    name,
+    status,
+    type,
+    template,
+    created_at,
+    updated_at,
+};
+```
+
+[[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/ReachV1FormsFormTagResource.md

@@ -0,0 +1,25 @@
+# ReachV1FormsFormTagResource
+
+A tag applied to every contact this form captures.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**value** | **string** |  | [optional] [default to undefined]
+**type** | **string** | How the tag came about. `custom` covers the tags you create yourself, `import` the ones added by contact imports, and `form` and `system` the ones Reach creates on its own. Every form gets a `form:{name}` tag when it is created. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1FormsFormTagResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1FormsFormTagResource = {
+    uuid,
+    value,
+    type,
+};
+```
+
+[[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/ReachV1FormsFormTemplateDetailsResource.md

@@ -0,0 +1,25 @@
+# ReachV1FormsFormTemplateDetailsResource
+
+The rendered form template. There is no ready-made embed snippet - either serve the HTML behind `url` or build your own embed around the form uuid. All fields stay null until the template has been generated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**path** | **string** | Storage path of the template HTML, relative to the storage directory of this profile. `url` already includes that prefix, so prefer it unless you resolve storage paths yourself. | [optional] [default to undefined]
+**url** | **string** | Publicly reachable URL of the template HTML. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1FormsFormTemplateDetailsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1FormsFormTemplateDetailsResource = {
+    uuid,
+    path,
+    url,
+};
+```
+
+[[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/ReachV1FormsFormTemplateResource.md

@@ -0,0 +1,23 @@
+# ReachV1FormsFormTemplateResource
+
+The rendered form template. Both fields stay null until the template has been generated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**path** | **string** | Storage path of the template HTML, relative to the storage directory of this profile. Get the form details to receive a directly usable URL instead. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1FormsFormTemplateResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1FormsFormTemplateResource = {
+    uuid,
+    path,
+};
+```
+
+[[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/ReachV1ProfilesPlanLimitUsageResource.md

@@ -0,0 +1,25 @@
+# ReachV1ProfilesPlanLimitUsageResource
+
+Allowance, consumption and headroom of a single plan limit for the current period.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limit** | **number** | The allowance for the current period. | [optional] [default to undefined]
+**used** | **number** | How much of the allowance has been consumed so far. | [optional] [default to undefined]
+**remaining** | **number** | Headroom left. Floors at 0, so it never reports a negative overage. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesPlanLimitUsageResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ProfilesPlanLimitUsageResource = {
+    limit,
+    used,
+    remaining,
+};
+```
+
+[[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/ReachV1ProfilesPlanLimitsResource.md

@@ -0,0 +1,29 @@
+# ReachV1ProfilesPlanLimitsResource
+
+What the plan allows and what is left of it for the current period.  `emails` counts every email sent. `recipients` counts the distinct contacts emailed - it is not the size of the contact list, a contact emailed three times counts once and a contact never emailed does not count at all. `ai_credits` counts the AI generations used, and its limit includes any extra credits bought on top of the plan.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**emails** | [**ReachV1ProfilesPlanLimitUsageResource**](ReachV1ProfilesPlanLimitUsageResource.md) |  | [optional] [default to undefined]
+**recipients** | [**ReachV1ProfilesPlanLimitUsageResource**](ReachV1ProfilesPlanLimitUsageResource.md) |  | [optional] [default to undefined]
+**ai_credits** | [**ReachV1ProfilesPlanLimitUsageResource**](ReachV1ProfilesPlanLimitUsageResource.md) |  | [optional] [default to undefined]
+**period_start** | **string** | Start of the current period. Periods are calendar months rather than billing anniversaries, so the counters reset at midnight UTC on the 1st no matter when the subscription started. | [optional] [default to undefined]
+**period_end** | **string** | End of the current period, that is the last moment of the calendar month. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesPlanLimitsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ProfilesPlanLimitsResource = {
+    emails,
+    recipients,
+    ai_credits,
+    period_start,
+    period_end,
+};
+```
+
+[[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

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.35.0
  *
  * NOTE: This file is auto-generated, DO NOT EDIT THIS FILE MANUALLY!
  * 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

@@ -1,6 +1,6 @@
 {
   "name": "hostinger-api-sdk",
-  "version": "1.31.0",
+  "version": "1.33.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {