hostinger-api-sdk 1.32.0 → 1.33.0

package/docs/ReachFormsApi.md

@@ -0,0 +1,182 @@
+# ReachFormsApi
+
+All URIs are relative to *https://developers.hostinger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**deleteFormV1**](#deleteformv1) | **DELETE** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Delete form|
+|[**getFormDetailsV1**](#getformdetailsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms/{formUuid} | Get form details|
+|[**listFormsV1**](#listformsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/forms | List forms|
+
+# **deleteFormV1**
+> CommonSuccessEmptyResource deleteFormV1()
+
+Permanently delete a form together with its template.  A form that has already captured submissions cannot be deleted, so that the contacts it collected are never silently discarded - pause the form instead to stop it collecting new ones. Views alone do not block deletion.
+
+### Example
+
+```typescript
+import {
+    ReachFormsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachFormsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let formUuid: string; //Form uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.deleteFormV1(
+    profileUuid,
+    formUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **formUuid** | [**string**] | Form uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**CommonSuccessEmptyResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Success empty response |  -  |
+|**401** | Unauthenticated response |  -  |
+|**409** | 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)
+
+# **getFormDetailsV1**
+> ReachV1FormsFormDetailsResource getFormDetailsV1()
+
+Get a single form with the URL of its hosted template and the tags it applies to the contacts it captures.  There is no ready-made embed snippet in the response - either serve the template HTML yourself or build your own embed around the form uuid.
+
+### Example
+
+```typescript
+import {
+    ReachFormsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachFormsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let formUuid: string; //Form uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.getFormDetailsV1(
+    profileUuid,
+    formUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **formUuid** | [**string**] | Form uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1FormsFormDetailsResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+
+# **listFormsV1**
+> ReachListFormsV1200Response listFormsV1()
+
+Get a paginated list of the signup forms in a profile.  Each form carries a reference to the template that renders it. Get the form details for a directly usable template URL and for the tags the form puts on the contacts it captures.
+
+### Example
+
+```typescript
+import {
+    ReachFormsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachFormsApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+let page: number; //Page number (optional) (default to undefined)
+let perPage: number; //Number of items per page (optional) (default to 25)
+
+const { status, data } = await apiInstance.listFormsV1(
+    profileUuid,
+    page,
+    perPage
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+| **page** | [**number**] | Page number | (optional) defaults to undefined|
+| **perPage** | [**number**] | Number of items per page | (optional) defaults to 25|
+
+
+### Return type
+
+**ReachListFormsV1200Response**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **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)
+

package/docs/ReachListFormsV1200Response.md

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

@@ -5,6 +5,7 @@ All URIs are relative to *https://developers.hostinger.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getProfileDomainDNSStatusV1**](#getprofiledomaindnsstatusv1) | **GET** /api/reach/v1/profiles/{profileUuid}/domains/dns-status | Get profile domain DNS status|
+|[**getRemainingPlanLimitsV1**](#getremainingplanlimitsv1) | **GET** /api/reach/v1/profiles/{profileUuid}/limits | Get remaining plan limits|
 |[**listProfilesV1**](#listprofilesv1) | **GET** /api/reach/v1/profiles | List Profiles|
 
 # **getProfileDomainDNSStatusV1**
@@ -51,6 +52,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)
+
+# **getRemainingPlanLimitsV1**
+> ReachV1ProfilesPlanLimitsResource getRemainingPlanLimitsV1()
+
+Get how much of the plan is left for the current period.  Two things to keep in mind before you build alerting on this. The period is a calendar month rather than a billing anniversary, so the counters reset on the 1st no matter when the subscription started. And usage is tracked per order, so every profile on the same order shares one pool and reports the same numbers here. Only the current period is available, past usage is not kept.
+
+### Example
+
+```typescript
+import {
+    ReachProfilesApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ReachProfilesApi(configuration);
+
+let profileUuid: string; //Profile uuid parameter (default to undefined)
+
+const { status, data } = await apiInstance.getRemainingPlanLimitsV1(
+    profileUuid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **profileUuid** | [**string**] | Profile uuid parameter | defaults to undefined|
+
+
+### Return type
+
+**ReachV1ProfilesPlanLimitsResource**
+
+### Authorization
+
+[apiToken](../README.md#apiToken)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|

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.34.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.32.0",
+  "version": "1.33.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {