hostinger-api-sdk 1.40.2 → 1.41.1

package/docs/ReachSegmentsApi.md

@@ -13,7 +13,9 @@ All URIs are relative to *https://developers.hostinger.com*
 |[**listProfileSegmentContactsV1**](#listprofilesegmentcontactsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts | List profile segment contacts|
 |[**listProfileSegmentsV1**](#listprofilesegmentsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/segmentation/segments | List profile segments|
 |[**listSegmentContactsV1**](#listsegmentcontactsv1) | **GET** /api/reach/v1/segmentation/segments/{segmentUuid}/contacts | List segment contacts|
+|[**listSegmentFilterAttributesV1**](#listsegmentfilterattributesv1) | **GET** /api/reach/v1/profiles/{profileUuid}/segmentation/filters/attributes | List segment filter attributes|
 |[**listSegmentsV1**](#listsegmentsv1) | **GET** /api/reach/v1/segmentation/segments | List segments|
+|[**previewContactsMatchingConditionsV1**](#previewcontactsmatchingconditionsv1) | **POST** /api/reach/v1/profiles/{profileUuid}/segmentation/filters/contacts | Preview contacts matching conditions|
 |[**updateAProfileSegmentV1**](#updateaprofilesegmentv1) | **PUT** /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid} | Update a profile segment|
 
 # **countProfileSegmentContactsV1**
@@ -524,6 +526,59 @@ const { status, data } = await apiInstance.listSegmentContactsV1(
  - **Accept**: application/json
 
 
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**500** | Error response |  -  |
+
+[[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)
+
+# **listSegmentFilterAttributesV1**
+> ReachV1ContactsSegmentsSegmentFilterAttributesResource listSegmentFilterAttributesV1()
+
+List every attribute a segment condition can filter on, with the operators each attribute accepts, the value format they expect and, where the value is constrained, the allowed values.  The list is profile specific: it includes the profile\'s custom contact fields, its tags and its 20 most recently published campaigns, so the valid attributes cannot be hardcoded. Read it before creating or updating a segment to discover the valid `attribute`, `operator` and `value` combinations.
+
+### Example
+
+```typescript
+import {
+    ReachSegmentsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachSegmentsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.listSegmentFilterAttributesV1(
+    profileUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1ContactsSegmentsSegmentFilterAttributesResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -579,6 +634,64 @@ This endpoint does not have any parameters.
 
 [[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)
 
+# **previewContactsMatchingConditionsV1**
+> ReachListProfileContactsV1200Response previewContactsMatchingConditionsV1(reachV1ContactsSegmentsProfileFilterContactsRequest)
+
+Preview the contacts matching a set of conditions without saving a segment.  The body is the same set of conditions accepted when creating or updating a segment, so this is how to check who a filter reaches, and how many, before persisting it. Nothing is stored and no contact is modified.  Call the segment filter attributes endpoint first to discover the valid `attribute`, `operator` and `value` combinations.
+
+### Example
+
+```typescript
+import {
+    ReachSegmentsApi,
+    Configuration,
+    ReachV1ContactsSegmentsProfileFilterContactsRequest
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachSegmentsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let reachV1ContactsSegmentsProfileFilterContactsRequest: ReachV1ContactsSegmentsProfileFilterContactsRequest; //
+
+const { status, data } = await apiInstance.previewContactsMatchingConditionsV1(
+    profileUuid,
+    reachV1ContactsSegmentsProfileFilterContactsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reachV1ContactsSegmentsProfileFilterContactsRequest** | **ReachV1ContactsSegmentsProfileFilterContactsRequest**|  | |
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachListProfileContactsV1200Response**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success response |  -  |
+|**422** | Validation error response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**500** | Error response |  -  |
+
+[[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)
+
 # **updateAProfileSegmentV1**
 > ReachV1ContactsSegmentsSegmentResource updateAProfileSegmentV1(reachV1ContactsSegmentsProfileUpdateRequest)
 

package/docs/ReachV1ContactsSegmentsProfileFilterContactsRequest.md

@@ -0,0 +1,33 @@
+# ReachV1ContactsSegmentsProfileFilterContactsRequest
+
+Conditions to preview, in the same shape accepted when creating a segment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conditions** | [**Array<ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner>**](ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner.md) | Conditions a contact must satisfy to appear in the preview | [default to undefined]
+**logic** | **string** | How to combine multiple conditions | [default to undefined]
+**page** | **number** | Page number | [optional] [default to undefined]
+**per_page** | **number** | Number of items per page | [optional] [default to undefined]
+**search** | **string** | Narrow the preview to contacts whose email matches | [optional] [default to undefined]
+**sort_by** | **string** |  | [optional] [default to undefined]
+**sort_direction** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ContactsSegmentsProfileFilterContactsRequest } from 'hostinger-api-sdk';
+
+const instance: ReachV1ContactsSegmentsProfileFilterContactsRequest = {
+    conditions,
+    logic,
+    page,
+    per_page,
+    search,
+    sort_by,
+    sort_direction,
+};
+```
+
+[[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/ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner.md

@@ -0,0 +1,24 @@
+# ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attribute** | **string** | A built-in contact attribute, or `cf:{fieldUuid}` to target a custom contact field. Which operators are accepted depends on the attribute, so read the segment filter attributes endpoint for the authoritative list. | [default to undefined]
+**operator** | **string** |  | [default to undefined]
+**value** | **string** | Always a string, including for numeric and date comparisons | [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner } from 'hostinger-api-sdk';
+
+const instance: ReachV1ContactsSegmentsProfileFilterContactsRequestConditionsInner = {
+    attribute,
+    operator,
+    value,
+};
+```
+
+[[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/ReachV1ContactsSegmentsSegmentFilterAttributeResource.md

@@ -0,0 +1,27 @@
+# ReachV1ContactsSegmentsSegmentFilterAttributeResource
+
+One attribute a segment condition can filter on.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Value to send as the condition `attribute`. | [optional] [default to undefined]
+**type** | **string** | Where the attribute is sourced from. | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**operators** | [**{ [key: string]: ReachV1ContactsSegmentsSegmentFilterOperatorResource; }**](ReachV1ContactsSegmentsSegmentFilterOperatorResource.md) | Operators this attribute accepts, keyed by operator name. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ContactsSegmentsSegmentFilterAttributeResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ContactsSegmentsSegmentFilterAttributeResource = {
+    name,
+    type,
+    description,
+    operators,
+};
+```
+
+[[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/ReachV1ContactsSegmentsSegmentFilterAttributesResource.md

@@ -0,0 +1,23 @@
+# ReachV1ContactsSegmentsSegmentFilterAttributesResource
+
+The vocabulary a segment condition can be built from, for one profile.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**attributes** | [**{ [key: string]: ReachV1ContactsSegmentsSegmentFilterAttributeResource; }**](ReachV1ContactsSegmentsSegmentFilterAttributeResource.md) | Every attribute a condition can filter on, keyed by the value to send as `attribute`. Custom contact fields are keyed `cf:{fieldUuid}`, tags and campaigns by their uuid, so the keys are not a fixed list and should be read from this response rather than hardcoded. | [optional] [default to undefined]
+**logic_operators** | **{ [key: string]: string; }** | The values accepted by `logic` when a segment combines several conditions. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ContactsSegmentsSegmentFilterAttributesResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ContactsSegmentsSegmentFilterAttributesResource = {
+    attributes,
+    logic_operators,
+};
+```
+
+[[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/ReachV1ContactsSegmentsSegmentFilterOperatorResource.md

@@ -0,0 +1,29 @@
+# ReachV1ContactsSegmentsSegmentFilterOperatorResource
+
+One operator an attribute accepts, and the value format it expects.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**operator** | **string** | Value to send as the condition `operator`. | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**input_type** | **string** | Shape of the value this operator expects, useful for rendering an input. | [optional] [default to undefined]
+**example** | **string** | An example value in the format this operator expects. | [optional] [default to undefined]
+**enum_values** | **{ [key: string]: string; }** | The values this operator accepts, keyed by the value to send. Only present when the operator is constrained to a fixed set, such as a tag or campaign picker. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ContactsSegmentsSegmentFilterOperatorResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ContactsSegmentsSegmentFilterOperatorResource = {
+    operator,
+    description,
+    input_type,
+    example,
+    enum_values,
+};
+```
+
+[[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/ReachV1ContactsStoreRequest.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **surname** | **string** |  | [optional] [default to undefined]
 **phone** | **string** | Phone number in E.164 format (leading \"+\" then 7-15 digits) | [optional] [default to undefined]
 **note** | **string** |  | [optional] [default to undefined]
+**tag_uuids** | **Array<string>** | Existing tags to attach to the created contact | [optional] [default to undefined]
 
 ## Example
 
@@ -22,6 +23,7 @@ const instance: ReachV1ContactsStoreRequest = {
     surname,
     phone,
     note,
+    tag_uuids,
 };
 ```
 

package/docs/ReachV1ProfilesDomainsSendingDomainResource.md

@@ -0,0 +1,29 @@
+# ReachV1ProfilesDomainsSendingDomainResource
+
+The sending domain connected to the profile.  When no domain is connected every field is `null` and `suspended_sender_emails` is empty, so the shape stays the same whether or not the profile is set up for sending.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** | Domain campaigns are sent from. It may be a subdomain of the domain that was connected, so it will not always match the website domain. | [optional] [default to undefined]
+**status** | **string** | Campaigns can only be sent while the domain is `active`. | [optional] [default to undefined]
+**created_at** | **string** | When the domain was connected to the profile. | [optional] [default to undefined]
+**updated_at** | **string** | When the domain or its verification state last changed. | [optional] [default to undefined]
+**suspended_sender_emails** | [**Array<ReachV1ProfilesDomainsSuspendedSenderEmailResource>**](ReachV1ProfilesDomainsSuspendedSenderEmailResource.md) | Sender addresses on this domain that have been suspended. A campaign using one of them will not go out even while the domain itself is active. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesDomainsSendingDomainResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ProfilesDomainsSendingDomainResource = {
+    domain,
+    status,
+    created_at,
+    updated_at,
+    suspended_sender_emails,
+};
+```
+
+[[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/ReachV1ProfilesDomainsSuspendedSenderEmailResource.md

@@ -0,0 +1,25 @@
+# ReachV1ProfilesDomainsSuspendedSenderEmailResource
+
+A sender address on the connected domain that is no longer allowed to send.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **string** |  | [optional] [default to undefined]
+**email_local_part** | **string** | The part of the address before the @. | [optional] [default to undefined]
+**suspended_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesDomainsSuspendedSenderEmailResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ProfilesDomainsSuspendedSenderEmailResource = {
+    email,
+    email_local_part,
+    suspended_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/ReachV1ProfilesFeaturesPlanFeatureResource.md

@@ -0,0 +1,25 @@
+# ReachV1ProfilesFeaturesPlanFeatureResource
+
+Whether a single plan feature can be used on the profile.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feature** | **string** |  | [optional] [default to undefined]
+**is_available** | **boolean** | Whether the feature can be used right now. | [optional] [default to undefined]
+**is_locked** | **boolean** | Whether the feature sits outside the base plan and needs an upgrade. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesFeaturesPlanFeatureResource } from 'hostinger-api-sdk';
+
+const instance: ReachV1ProfilesFeaturesPlanFeatureResource = {
+    feature,
+    is_available,
+    is_locked,
+};
+```
+
+[[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.42.2
+ * API Version: 1.43.1
  *
  * 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.40.2",
+  "version": "1.41.1",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {