@hostinger/sdk 1.63.0 → 1.64.0

package/docs/ReachProfilesApi.md

@@ -4,11 +4,132 @@ All URIs are relative to *https://developers.hostinger.com*
 
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
+|[**connectSendingDomainV1**](#connectsendingdomainv1) | **POST** /api/reach/v1/profiles/{profileUuid}/domains | Connect sending domain|
+|[**deleteSendingDomainV1**](#deletesendingdomainv1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/domains | Delete sending domain|
 |[**getConnectedSendingDomainV1**](#getconnectedsendingdomainv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains | Get connected sending domain|
 |[**getProfileDomainDNSStatusV1**](#getprofiledomaindnsstatusv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains/dns-status | Get profile domain DNS status|
+|[**getProfileSettingsV1**](#getprofilesettingsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/settings | Get profile settings|
 |[**getRemainingPlanLimitsV1**](#getremainingplanlimitsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/limits | Get remaining plan limits|
 |[**listPlanFeatureAccessV1**](#listplanfeatureaccessv1) | **GET** /api/reach/v1/profiles/{profileUuid}/features | List plan feature access|
 |[**listProfilesV1**](#listprofilesv1) | **GET** /api/reach/v1/profiles | List Profiles|
+|[**updateProfileSettingsV1**](#updateprofilesettingsv1) | **PATCH** /api/reach/v1/profiles/{profileUuid}/settings | Update profile settings|
+
+# **connectSendingDomainV1**
+> CommonSuccessEmptyResource connectSendingDomainV1(reachV1ProfilesDomainsConnectRequest)
+
+Connect a sending domain to the profile so emails can be sent from addresses on it.  Connecting does not make the domain ready to send: check the DNS status endpoint next for records that are still missing. A domain the account owns or has already verified connects immediately. Any other domain starts a TXT ownership verification and returns `409`; complete the verification in Reach, then retry. Returns `422` when the profile or another profile already has the domain, the domain is blocked, or its ownership cannot be verified. An already connected domain is never replaced.  On success the sender address of draft and scheduled campaigns, and of published automation and double opt-in emails, moves onto the new domain in the background, keeping the part before the `@`.
+
+### Example
+
+```typescript
+import {
+    ReachProfilesApi,
+    Configuration,
+    ReachV1ProfilesDomainsConnectRequest
+} from '@hostinger/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachProfilesApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let reachV1ProfilesDomainsConnectRequest: ReachV1ProfilesDomainsConnectRequest; //
+
+const { status, data } = await apiInstance.connectSendingDomainV1(
+    profileUuid,
+    reachV1ProfilesDomainsConnectRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reachV1ProfilesDomainsConnectRequest** | **ReachV1ProfilesDomainsConnectRequest**|  | |
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**CommonSuccessEmptyResource**
+
+### 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 empty response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**409** | Conflict response. &#x60;Retry-After&#x60;, when present, is the number of seconds to wait before retrying. |  * Retry-After - Seconds to wait before retrying the request <br>  |
+|**422** | Validation error 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)
+
+# **deleteSendingDomainV1**
+> CommonSuccessEmptyResource deleteSendingDomainV1(reachV1ProfilesDomainsDisconnectRequest)
+
+Disconnect the sending domain from the profile.  The domain record is removed, so the profile has no sending domain afterwards and campaigns cannot be sent until a domain is connected again. Sender addresses already stored on campaigns, automations and settings are left untouched and keep pointing at the removed domain. A domain that is not connected to the profile also succeeds, so success is not proof that anything was deleted. DNS records at the DNS provider are not removed. To switch domains, delete this one and connect the new one. Confirm the domain with the customer before calling.
+
+### Example
+
+```typescript
+import {
+    ReachProfilesApi,
+    Configuration,
+    ReachV1ProfilesDomainsDisconnectRequest
+} from '@hostinger/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachProfilesApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let reachV1ProfilesDomainsDisconnectRequest: ReachV1ProfilesDomainsDisconnectRequest; //
+
+const { status, data } = await apiInstance.deleteSendingDomainV1(
+    profileUuid,
+    reachV1ProfilesDomainsDisconnectRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reachV1ProfilesDomainsDisconnectRequest** | **ReachV1ProfilesDomainsDisconnectRequest**|  | |
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**CommonSuccessEmptyResource**
+
+### 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 empty 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)
 
 # **getConnectedSendingDomainV1**
 > ReachV1ProfilesDomainsSendingDomainResource getConnectedSendingDomainV1()
@@ -107,6 +228,59 @@ const { status, data } = await apiInstance.getProfileDomainDNSStatusV1(
  - **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)
+
+# **getProfileSettingsV1**
+> ReachV1ProfilesSettingsSettingsResource getProfileSettingsV1()
+
+Get the profile\'s saved sender identity and brand details.  Read the default sender before creating a campaign instead of asking the customer, and reuse the brand fields when generating email content. Any field can be `null` for a profile that never filled its settings in. This does not check that the sending domain is verified, use the connected sending domain endpoint for that.
+
+### Example
+
+```typescript
+import {
+    ReachProfilesApi,
+    Configuration
+} from '@hostinger/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachProfilesApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.getProfileSettingsV1(
+    profileUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1ProfilesSettingsSettingsResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
@@ -268,3 +442,61 @@ 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)
 
+# **updateProfileSettingsV1**
+> ReachV1ProfilesSettingsSettingsResource updateProfileSettingsV1(reachV1ProfilesSettingsUpdateRequest)
+
+Change the profile\'s default sender and brand details.  Send only the fields to change: every omitted field keeps its value, and `null` or an empty string clears a text field. The default sender is what campaigns created afterwards start from; existing campaigns keep their own sender. `sender_email` is only the part before the `@`, because Reach combines it with the profile\'s connected sending domain, so an address outside that domain cannot be set. Connecting a sending domain is a separate endpoint and a connected domain cannot be changed here. Returns the settings after the change.
+
+### Example
+
+```typescript
+import {
+    ReachProfilesApi,
+    Configuration,
+    ReachV1ProfilesSettingsUpdateRequest
+} from '@hostinger/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachProfilesApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let reachV1ProfilesSettingsUpdateRequest: ReachV1ProfilesSettingsUpdateRequest; //
+
+const { status, data } = await apiInstance.updateProfileSettingsV1(
+    profileUuid,
+    reachV1ProfilesSettingsUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reachV1ProfilesSettingsUpdateRequest** | **ReachV1ProfilesSettingsUpdateRequest**|  | |
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1ProfilesSettingsSettingsResource**
+
+### 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)
+

package/docs/ReachV1ProfilesDomainsConnectRequest.md

@@ -0,0 +1,21 @@
+# ReachV1ProfilesDomainsConnectRequest
+
+Sending domain to connect to the profile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesDomainsConnectRequest } from '@hostinger/sdk';
+
+const instance: ReachV1ProfilesDomainsConnectRequest = {
+    domain,
+};
+```
+
+[[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/ReachV1ProfilesDomainsDisconnectRequest.md

@@ -0,0 +1,21 @@
+# ReachV1ProfilesDomainsDisconnectRequest
+
+Sending domain to disconnect from the profile
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesDomainsDisconnectRequest } from '@hostinger/sdk';
+
+const instance: ReachV1ProfilesDomainsDisconnectRequest = {
+    domain,
+};
+```
+
+[[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/ReachV1ProfilesDomainsDnsStatusResource.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **spf** | [**ReachV1ProfilesDomainsDnsRecordStatus**](ReachV1ProfilesDomainsDnsRecordStatus.md) |  | [optional] [default to undefined]
 **dkim** | [**ReachV1ProfilesDomainsDnsRecordStatus**](ReachV1ProfilesDomainsDnsRecordStatus.md) |  | [optional] [default to undefined]
 **dmarc** | [**ReachV1ProfilesDomainsDnsRecordStatus**](ReachV1ProfilesDomainsDnsRecordStatus.md) |  | [optional] [default to undefined]
+**a** | [**ReachV1ProfilesDomainsDnsRecordStatus**](ReachV1ProfilesDomainsDnsRecordStatus.md) |  | [optional] [default to undefined]
 
 ## Example
 
@@ -22,6 +23,7 @@ const instance: ReachV1ProfilesDomainsDnsStatusResource = {
     spf,
     dkim,
     dmarc,
+    a,
 };
 ```
 

package/docs/ReachV1ProfilesSettingsSettingsResource.md

@@ -0,0 +1,63 @@
+# ReachV1ProfilesSettingsSettingsResource
+
+Sender identity and brand details saved on the profile.  A profile that never filled its settings in returns empty values, so every field can be `null`.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brand_name** | **string** |  | [optional] [default to undefined]
+**website_url** | **string** |  | [optional] [default to undefined]
+**business_address** | **string** |  | [optional] [default to undefined]
+**privacy_policy_url** | **string** |  | [optional] [default to undefined]
+**accent_color** | **string** |  | [optional] [default to undefined]
+**button_color** | **string** |  | [optional] [default to undefined]
+**background_color** | **string** |  | [optional] [default to undefined]
+**text_color** | **string** |  | [optional] [default to undefined]
+**links_color** | **string** |  | [optional] [default to undefined]
+**button_text** | **string** | Button text colour. | [optional] [default to undefined]
+**button_corners** | **number** | Button corner radius in pixels. | [optional] [default to undefined]
+**font_family** | **string** | Body and button font. | [optional] [default to undefined]
+**heading_font_family** | **string** |  | [optional] [default to undefined]
+**logo_url** | **string** |  | [optional] [default to undefined]
+**social_links** | **Array<string>** |  | [optional] [default to undefined]
+**socials** | **{ [key: string]: string; }** | Social profile links keyed by platform. | [optional] [default to undefined]
+**about** | **string** |  | [optional] [default to undefined]
+**keywords** | **Array<string>** |  | [optional] [default to undefined]
+**topics** | **Array<string>** |  | [optional] [default to undefined]
+**selling_points** | **Array<string>** |  | [optional] [default to undefined]
+**sender_name** | **string** | Default sender name that campaigns created afterwards start from. | [optional] [default to undefined]
+**sender_email** | **string** | Part of the default sender address before the `@`. It is combined with the profile\'s connected sending domain, see the connected sending domain endpoint. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesSettingsSettingsResource } from '@hostinger/sdk';
+
+const instance: ReachV1ProfilesSettingsSettingsResource = {
+    brand_name,
+    website_url,
+    business_address,
+    privacy_policy_url,
+    accent_color,
+    button_color,
+    background_color,
+    text_color,
+    links_color,
+    button_text,
+    button_corners,
+    font_family,
+    heading_font_family,
+    logo_url,
+    social_links,
+    socials,
+    about,
+    keywords,
+    topics,
+    selling_points,
+    sender_name,
+    sender_email,
+};
+```
+
+[[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/ReachV1ProfilesSettingsUpdateRequest.md

@@ -0,0 +1,63 @@
+# ReachV1ProfilesSettingsUpdateRequest
+
+Settings to change. Only the fields sent are changed; `null` or an empty string clears a text field.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**brand_name** | **string** |  | [optional] [default to undefined]
+**website_url** | **string** |  | [optional] [default to undefined]
+**business_address** | **string** |  | [optional] [default to undefined]
+**privacy_policy_url** | **string** |  | [optional] [default to undefined]
+**accent_color** | **string** |  | [optional] [default to undefined]
+**button_color** | **string** |  | [optional] [default to undefined]
+**background_color** | **string** |  | [optional] [default to undefined]
+**text_color** | **string** |  | [optional] [default to undefined]
+**links_color** | **string** |  | [optional] [default to undefined]
+**button_text** | **string** | Button text colour. | [optional] [default to undefined]
+**button_corners** | **number** |  | [optional] [default to undefined]
+**font_family** | **string** |  | [optional] [default to undefined]
+**heading_font_family** | **string** |  | [optional] [default to undefined]
+**logo_url** | **string** | Public image URL. Logo uploads are not supported. | [optional] [default to undefined]
+**social_links** | **Array<string>** |  | [optional] [default to undefined]
+**socials** | **{ [key: string]: string; }** | Social profile links keyed by platform. | [optional] [default to undefined]
+**about** | **string** |  | [optional] [default to undefined]
+**keywords** | **Array<string>** |  | [optional] [default to undefined]
+**topics** | **Array<string>** |  | [optional] [default to undefined]
+**selling_points** | **Array<string>** |  | [optional] [default to undefined]
+**sender_name** | **string** | Default sender name. Letters, numbers and spaces only. | [optional] [default to undefined]
+**sender_email** | **string** | Part of the default sender address before the `@`, for example `hello`. Never send a full address: Reach adds the profile\'s connected sending domain itself. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ReachV1ProfilesSettingsUpdateRequest } from '@hostinger/sdk';
+
+const instance: ReachV1ProfilesSettingsUpdateRequest = {
+    brand_name,
+    website_url,
+    business_address,
+    privacy_policy_url,
+    accent_color,
+    button_color,
+    background_color,
+    text_color,
+    links_color,
+    button_text,
+    button_corners,
+    font_family,
+    heading_font_family,
+    logo_url,
+    social_links,
+    socials,
+    about,
+    keywords,
+    topics,
+    selling_points,
+    sender_name,
+    sender_email,
+};
+```
+
+[[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.63.0
+ * API Version: 1.64.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/sdk",
-  "version": "1.63.0",
+  "version": "1.64.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {