hostinger-api-sdk 1.30.7 → 1.31.0

package/docs/ReachListAutomationsV1200Response.md

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

@@ -0,0 +1,27 @@
+# ReachV1AutomationsAutomationEventsResource
+
+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.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**started** | **number** | Contacts that ever entered the automation, including those that already left it. | [optional] [default to undefined]
+**in_progress** | **number** | Contacts currently moving through the automation, including those waiting on a delay step. | [optional] [default to undefined]
+**completed** | **number** | Contacts that reached the end of the workflow. | [optional] [default to undefined]
+**failed** | **number** | Contacts whose journey through the automation errored and stopped. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1AutomationsAutomationEventsResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1AutomationsAutomationEventsResource = {
+    started,
+    in_progress,
+    completed,
+    failed,
+};
+```
+
+[[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/ReachV1AutomationsAutomationResource.md

@@ -0,0 +1,34 @@
+# ReachV1AutomationsAutomationResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**status** | **string** | There is no `completed` status. Use `events.completed` to see how many contacts finished. | [optional] [default to undefined]
+**type** | **string** | What kind of workflow this is. `custom` automations are the ones built from scratch. | [optional] [default to undefined]
+**config** | **object** | Trigger configuration of the automation. The shape depends on the type. | [optional] [default to undefined]
+**events** | [**ReachV1AutomationsAutomationEventsResource**](ReachV1AutomationsAutomationEventsResource.md) |  | [optional] [default to undefined]
+**created_at** | **string** |  | [optional] [default to undefined]
+**updated_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1AutomationsAutomationResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1AutomationsAutomationResource = {
+    uuid,
+    name,
+    status,
+    type,
+    config,
+    events,
+    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/ReachV1AutomationsStepsAutomationStepResource.md

@@ -0,0 +1,30 @@
+# ReachV1AutomationsStepsAutomationStepResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uuid** | **string** |  | [optional] [default to undefined]
+**parent_uuid** | **string** | The step this one branches from. Null for the entry point of the workflow. | [optional] [default to undefined]
+**step_order** | **number** | Position of this step among the steps sharing its parent. | [optional] [default to undefined]
+**type** | **string** | Role of the step in the workflow. A `conditional` step branches into several children. | [optional] [default to undefined]
+**value** | **string** | The concrete trigger, action, decision or delay this step performs. | [optional] [default to undefined]
+**config** | **object** | Step configuration. The shape depends on the value, and is empty for steps that take none. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1AutomationsStepsAutomationStepResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1AutomationsStepsAutomationStepResource = {
+    uuid,
+    parent_uuid,
+    step_order,
+    type,
+    value,
+    config,
+};
+```
+
+[[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.32.6
+ * API Version: 1.33.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.30.7",
+  "version": "1.31.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {