hostinger-api-sdk 1.31.0 → 1.32.0

package/docs/ReachListCampaignsV1200Response.md

@@ -0,0 +1,22 @@
+# ReachListCampaignsV1200Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**data** | [**Array<ReachV1CampaignsCampaignResource>**](ReachV1CampaignsCampaignResource.md) | Array of [`Reach.V1.Campaigns.CampaignResource`](#model/reachv1campaignscampaignresource) | [optional] [default to undefined]
+**meta** | [**CommonSchemaPaginationMetaSchema**](CommonSchemaPaginationMetaSchema.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachListCampaignsV1200Response } from 'hostinger-api-sdk';
+
+const instance: ReachListCampaignsV1200Response = {
+    data,
+    meta,
+};
+```
+
+[[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/ReachV1CampaignsCampaignDeliveryResource.md

@@ -0,0 +1,25 @@
+# ReachV1CampaignsCampaignDeliveryResource
+
+Delivery progress. While the campaign is `sending`, `total_sent` climbs towards the estimate.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_sent** | **number** | Emails sent so far. | [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]
+**subscribers_count** | **number** | Contacts currently targeted by this campaign. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1CampaignsCampaignDeliveryResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1CampaignsCampaignDeliveryResource = {
+    total_sent,
+    estimated_total_recipients,
+    subscribers_count,
+};
+```
+
+[[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/ReachV1CampaignsCampaignDetailsResource.md

@@ -0,0 +1,52 @@
+# ReachV1CampaignsCampaignDetailsResource
+
+
+## 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]
+**failure_reason** | **string** | Set only while the status is `failed`. | [optional] [default to undefined]
+**is_smart_send** | **boolean** | Whether delivery time is picked per contact rather than sent to everyone at once. | [optional] [default to undefined]
+**is_all_contacts** | **boolean** | Whether the campaign targets every contact instead of the listed segments. | [optional] [default to undefined]
+**delivery** | [**ReachV1CampaignsCampaignDeliveryResource**](ReachV1CampaignsCampaignDeliveryResource.md) |  | [optional] [default to undefined]
+**segment_uuids** | **Array<string>** | Segments this campaign targets. Empty when it targets all contacts. | [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]
+
+## Example
+
+```typescript
+import { ReachV1CampaignsCampaignDetailsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1CampaignsCampaignDetailsResource = {
+    uuid,
+    title,
+    subject,
+    sender_name,
+    sender_email,
+    template_uuid,
+    status,
+    type,
+    failure_reason,
+    is_smart_send,
+    is_all_contacts,
+    delivery,
+    segment_uuids,
+    created_at,
+    updated_at,
+    sent_at,
+    scheduled_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/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/index.ts

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.33.0
+ * API Version: 1.34.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.32.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {