hostinger-api-sdk 1.33.1 → 1.34.0

package/dist/esm/index.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.35.1
+ * API Version: 1.36.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/dist/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.35.1
+ * API Version: 1.36.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/dist/index.js

@@ -4,7 +4,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.35.1
+ * API Version: 1.36.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/docs/AgencyHostingPHPApi.md

@@ -0,0 +1,400 @@
+# AgencyHostingPHPApi
+
+All URIs are relative to *https://developers.hostinger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listAvailablePHPVersionsForAWebsiteV1**](#listavailablephpversionsforawebsitev1) | **GET** /api/agency-hosting/v1/websites/{website_uid}/php-settings/versions | List available PHP versions for a website|
+|[**listAvailablePHPVersionsForAnOrderV1**](#listavailablephpversionsforanorderv1) | **GET** /api/agency-hosting/v1/orders/{order_id}/websites/php-settings/versions | List available PHP versions for an order|
+|[**listPHPExtensionsForAWebsiteV1**](#listphpextensionsforawebsitev1) | **GET** /api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions | List PHP extensions for a website|
+|[**listPHPOptionsForAWebsiteV1**](#listphpoptionsforawebsitev1) | **GET** /api/agency-hosting/v1/websites/{website_uid}/php-settings/options | List PHP options for a website|
+|[**replaceWebsitePHPExtensionsV1**](#replacewebsitephpextensionsv1) | **PUT** /api/agency-hosting/v1/websites/{website_uid}/php-settings/extensions | Replace website PHP extensions|
+|[**replaceWebsitePHPOptionsV1**](#replacewebsitephpoptionsv1) | **PUT** /api/agency-hosting/v1/websites/{website_uid}/php-settings/options | Replace website PHP options|
+|[**updateWebsitePHPVersionV1**](#updatewebsitephpversionv1) | **PATCH** /api/agency-hosting/v1/websites/{website_uid}/php-settings/version | Update website PHP version|
+
+# **listAvailablePHPVersionsForAWebsiteV1**
+> Array<AgencyHostingV1PhpVersionResource> listAvailablePHPVersionsForAWebsiteV1()
+
+Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+
+const { status, data } = await apiInstance.listAvailablePHPVersionsForAWebsiteV1(
+    websiteUid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
+
+
+### Return type
+
+**Array<AgencyHostingV1PhpVersionResource>**
+
+### 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)
+
+# **listAvailablePHPVersionsForAnOrderV1**
+> Array<AgencyHostingV1PhpVersionResource> listAvailablePHPVersionsForAnOrderV1()
+
+Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let orderId: number; //Agency Plan order ID (default to undefined)
+
+const { status, data } = await apiInstance.listAvailablePHPVersionsForAnOrderV1(
+    orderId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Agency Plan order ID | defaults to undefined|
+
+
+### Return type
+
+**Array<AgencyHostingV1PhpVersionResource>**
+
+### 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)
+
+# **listPHPExtensionsForAWebsiteV1**
+> Array<AgencyHostingV1PhpExtensionResource> listPHPExtensionsForAWebsiteV1()
+
+Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+
+const { status, data } = await apiInstance.listPHPExtensionsForAWebsiteV1(
+    websiteUid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
+
+
+### Return type
+
+**Array<AgencyHostingV1PhpExtensionResource>**
+
+### 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)
+
+# **listPHPOptionsForAWebsiteV1**
+> Array<AgencyHostingV1PhpOptionResource> listPHPOptionsForAWebsiteV1()
+
+Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+
+const { status, data } = await apiInstance.listPHPOptionsForAWebsiteV1(
+    websiteUid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **websiteUid** | [**string**] | Agency Plan website UID | defaults to undefined|
+
+
+### Return type
+
+**Array<AgencyHostingV1PhpOptionResource>**
+
+### 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)
+
+# **replaceWebsitePHPExtensionsV1**
+> CommonSuccessEmptyResource replaceWebsitePHPExtensionsV1(agencyHostingV1PhpUpdateExtensionsRequest)
+
+Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the \"built-in\" state, are always active and are unaffected.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration,
+    AgencyHostingV1PhpUpdateExtensionsRequest
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+let agencyHostingV1PhpUpdateExtensionsRequest: AgencyHostingV1PhpUpdateExtensionsRequest; //
+
+const { status, data } = await apiInstance.replaceWebsitePHPExtensionsV1(
+    websiteUid,
+    agencyHostingV1PhpUpdateExtensionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **agencyHostingV1PhpUpdateExtensionsRequest** | **AgencyHostingV1PhpUpdateExtensionsRequest**|  | |
+| **websiteUid** | [**string**] | Agency Plan website UID | 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)
+
+# **replaceWebsitePHPOptionsV1**
+> CommonSuccessEmptyResource replaceWebsitePHPOptionsV1(agencyHostingV1PhpUpdateOptionsRequest)
+
+Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration,
+    AgencyHostingV1PhpUpdateOptionsRequest
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+let agencyHostingV1PhpUpdateOptionsRequest: AgencyHostingV1PhpUpdateOptionsRequest; //
+
+const { status, data } = await apiInstance.replaceWebsitePHPOptionsV1(
+    websiteUid,
+    agencyHostingV1PhpUpdateOptionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **agencyHostingV1PhpUpdateOptionsRequest** | **AgencyHostingV1PhpUpdateOptionsRequest**|  | |
+| **websiteUid** | [**string**] | Agency Plan website UID | 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)
+
+# **updateWebsitePHPVersionV1**
+> CommonSuccessEmptyResource updateWebsitePHPVersionV1(agencyHostingV1PhpUpdateVersionRequest)
+
+Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingPHPApi,
+    Configuration,
+    AgencyHostingV1PhpUpdateVersionRequest
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingPHPApi(configuration);
+
+let websiteUid: string; //Agency Plan website UID (default to undefined)
+let agencyHostingV1PhpUpdateVersionRequest: AgencyHostingV1PhpUpdateVersionRequest; //
+
+const { status, data } = await apiInstance.updateWebsitePHPVersionV1(
+    websiteUid,
+    agencyHostingV1PhpUpdateVersionRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **agencyHostingV1PhpUpdateVersionRequest** | **AgencyHostingV1PhpUpdateVersionRequest**|  | |
+| **websiteUid** | [**string**] | Agency Plan website UID | 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)
+

package/docs/AgencyHostingV1PhpExtensionResource.md

@@ -0,0 +1,24 @@
+# AgencyHostingV1PhpExtensionResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | PHP extension name. | [optional] [default to undefined]
+**description** | **string** | What the extension provides. | [optional] [default to undefined]
+**state** | **string** | Whether the extension is currently enabled. Extensions in the \"built-in\" state are compiled into PHP and cannot be turned off. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpExtensionResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpExtensionResource = {
+    name,
+    description,
+    state,
+};
+```
+
+[[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/AgencyHostingV1PhpOptionResource.md

@@ -0,0 +1,30 @@
+# AgencyHostingV1PhpOptionResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | php.ini directive name. | [optional] [default to undefined]
+**description** | **string** | What the directive controls. | [optional] [default to undefined]
+**default_value** | **string** | Value applied when no custom value is set. | [optional] [default to undefined]
+**allowed_values** | **Array<string>** | Values this option accepts. Null when the option accepts any value of its type. | [optional] [default to undefined]
+**value** | **string** | Value currently in effect for the website. | [optional] [default to undefined]
+**type** | **string** | Whether the option takes a single value or a list of values. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpOptionResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpOptionResource = {
+    name,
+    description,
+    default_value,
+    allowed_values,
+    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/AgencyHostingV1PhpUpdateExtensionsRequest.md

@@ -0,0 +1,20 @@
+# AgencyHostingV1PhpUpdateExtensionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**extensions** | **Array<string>** | Extension names, exactly as returned by the extensions endpoint. | [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpUpdateExtensionsRequest } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpUpdateExtensionsRequest = {
+    extensions,
+};
+```
+
+[[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/AgencyHostingV1PhpUpdateOptionsRequest.md

@@ -0,0 +1,20 @@
+# AgencyHostingV1PhpUpdateOptionsRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_options** | [**Array<AgencyHostingV1PhpUpdateOptionsRequestOptionsInner>**](AgencyHostingV1PhpUpdateOptionsRequestOptionsInner.md) | Option names and values. Each name must be one of the options returned by the options endpoint, and each value must satisfy that option\'s allowed_values when it declares them. | [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpUpdateOptionsRequest } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpUpdateOptionsRequest = {
+    _options,
+};
+```
+
+[[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/AgencyHostingV1PhpUpdateOptionsRequestOptionsInner.md

@@ -0,0 +1,22 @@
+# AgencyHostingV1PhpUpdateOptionsRequestOptionsInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | php.ini directive name. | [default to undefined]
+**value** | **string** | Value to apply. | [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpUpdateOptionsRequestOptionsInner } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpUpdateOptionsRequestOptionsInner = {
+    name,
+    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/AgencyHostingV1PhpUpdateVersionRequest.md

@@ -0,0 +1,20 @@
+# AgencyHostingV1PhpUpdateVersionRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **string** | PHP version to switch the website to, as major.minor. Must be one of the versions returned by the available versions endpoint. | [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpUpdateVersionRequest } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpUpdateVersionRequest = {
+    version,
+};
+```
+
+[[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/AgencyHostingV1PhpVersionResource.md

@@ -0,0 +1,20 @@
+# AgencyHostingV1PhpVersionResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**version** | **string** | PHP version available for the website. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1PhpVersionResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1PhpVersionResource = {
+    version,
+};
+```
+
+[[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.35.1
+ * API Version: 1.36.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.33.1",
+  "version": "1.34.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {