hostinger-api-sdk 1.35.0 → 1.36.0

package/dist/esm/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.37.0
+ * API Version: 1.38.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/esm/index.js

@@ -3,7 +3,7 @@
 /**
  * Hostinger API
  *
- * API Version: 1.37.0
+ * API Version: 1.38.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.37.0
+ * API Version: 1.38.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.37.0
+ * API Version: 1.38.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/AgencyHostingMetricsApi.md

@@ -0,0 +1,123 @@
+# AgencyHostingMetricsApi
+
+All URIs are relative to *https://developers.hostinger.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listAgencyPlanOrderDiskUsageMetricsV1**](#listagencyplanorderdiskusagemetricsv1) | **GET** /api/agency-hosting/v1/orders/{order_id}/disk-usage-metrics | List Agency Plan order disk usage metrics|
+|[**listOrderResourceUsageMetricsV1**](#listorderresourceusagemetricsv1) | **GET** /api/agency-hosting/v1/orders/{order_id}/resource-usage-metrics | List order resource usage metrics|
+
+# **listAgencyPlanOrderDiskUsageMetricsV1**
+> AgencyHostingV1OrdersDiskUsageMetricsMetricsResource listAgencyPlanOrderDiskUsageMetricsV1()
+
+Returns aggregated disk and inode usage for the Agency Plan order over the selected time frame, plus the plan quotas. Figures cover the whole order account. Values may be up to one hour stale. CPU, memory, and process usage are on the resource-usage-metrics endpoint.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingMetricsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingMetricsApi(configuration);
+
+let orderId: number; //Agency Plan order ID (default to undefined)
+let timeFrameDays: 1 | 7 | 14 | 30; //Length of the window in days, ending now. Bucket size grows with the window. (optional) (default to 1)
+
+const { status, data } = await apiInstance.listAgencyPlanOrderDiskUsageMetricsV1(
+    orderId,
+    timeFrameDays
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Agency Plan order ID | defaults to undefined|
+| **timeFrameDays** | [**1 | 7 | 14 | 30**]**Array<1 &#124; 7 &#124; 14 &#124; 30>** | Length of the window in days, ending now. Bucket size grows with the window. | (optional) defaults to 1|
+
+
+### Return type
+
+**AgencyHostingV1OrdersDiskUsageMetricsMetricsResource**
+
+### 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 |  -  |
+|**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)
+
+# **listOrderResourceUsageMetricsV1**
+> AgencyHostingV1OrdersResourceUsageMetricsMetricsResource listOrderResourceUsageMetricsV1()
+
+Returns aggregated CPU, memory, and process usage for the Agency Plan order over the selected time frame, plus the plan quotas and a per-website breakdown. Each website is identified by uid. Suspended and deleted websites are excluded from both the order totals and the per-website breakdown. Values may be up to one hour stale. Disk and inode usage are on the disk-usage-metrics endpoint.
+
+### Example
+
+```typescript
+import {
+    AgencyHostingMetricsApi,
+    Configuration
+} from 'hostinger-api-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new AgencyHostingMetricsApi(configuration);
+
+let orderId: number; //Agency Plan order ID (default to undefined)
+let timeFrameHours: 1 | 24 | 168 | 336 | 720; //Length of the window in hours, ending now. Bucket size grows with the window. (optional) (default to 24)
+
+const { status, data } = await apiInstance.listOrderResourceUsageMetricsV1(
+    orderId,
+    timeFrameHours
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **orderId** | [**number**] | Agency Plan order ID | defaults to undefined|
+| **timeFrameHours** | [**1 | 24 | 168 | 336 | 720**]**Array<1 &#124; 24 &#124; 168 &#124; 336 &#124; 720>** | Length of the window in hours, ending now. Bucket size grows with the window. | (optional) defaults to 24|
+
+
+### Return type
+
+**AgencyHostingV1OrdersResourceUsageMetricsMetricsResource**
+
+### 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 |  -  |
+|**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/AgencyHostingV1OrdersDiskUsageMetricsLimitsResource.md

@@ -0,0 +1,22 @@
+# AgencyHostingV1OrdersDiskUsageMetricsLimitsResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**disk_bytes** | **number** | Disk usage quota in bytes | [optional] [default to undefined]
+**inodes** | **number** | Inodes quota | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersDiskUsageMetricsLimitsResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersDiskUsageMetricsLimitsResource = {
+    disk_bytes,
+    inodes,
+};
+```
+
+[[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/AgencyHostingV1OrdersDiskUsageMetricsMetricResource.md

@@ -0,0 +1,24 @@
+# AgencyHostingV1OrdersDiskUsageMetricsMetricResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**disk_bytes** | **number** | Disk usage in bytes at this sample | [optional] [default to undefined]
+**inodes** | **number** | Number of inodes used at this sample | [optional] [default to undefined]
+**timestamp** | **number** | Unix timestamp of the sample | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersDiskUsageMetricsMetricResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersDiskUsageMetricsMetricResource = {
+    disk_bytes,
+    inodes,
+    timestamp,
+};
+```
+
+[[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/AgencyHostingV1OrdersDiskUsageMetricsMetricsResource.md

@@ -0,0 +1,22 @@
+# AgencyHostingV1OrdersDiskUsageMetricsMetricsResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limits** | [**AgencyHostingV1OrdersDiskUsageMetricsLimitsResource**](AgencyHostingV1OrdersDiskUsageMetricsLimitsResource.md) |  | [optional] [default to undefined]
+**metrics** | [**Array<AgencyHostingV1OrdersDiskUsageMetricsMetricResource>**](AgencyHostingV1OrdersDiskUsageMetricsMetricResource.md) | Array of [`AgencyHosting.V1.Orders.DiskUsageMetrics.MetricResource`](#model/agencyhostingv1ordersdiskusagemetricsmetricresource) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersDiskUsageMetricsMetricsResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersDiskUsageMetricsMetricsResource = {
+    limits,
+    metrics,
+};
+```
+
+[[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/AgencyHostingV1OrdersResourceUsageMetricsLimitsResource.md

@@ -0,0 +1,24 @@
+# AgencyHostingV1OrdersResourceUsageMetricsLimitsResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**memory_bytes** | **number** | Memory usage quota in bytes | [optional] [default to undefined]
+**cpu_percent** | **number** | CPU usage quota in percent | [optional] [default to undefined]
+**processes** | **number** | Process usage quota | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersResourceUsageMetricsLimitsResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersResourceUsageMetricsLimitsResource = {
+    memory_bytes,
+    cpu_percent,
+    processes,
+};
+```
+
+[[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/AgencyHostingV1OrdersResourceUsageMetricsMetricResource.md

@@ -0,0 +1,26 @@
+# AgencyHostingV1OrdersResourceUsageMetricsMetricResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu_percent** | **number** | CPU usage percentage at this sample | [optional] [default to undefined]
+**memory_bytes** | **number** | Memory usage in bytes at this sample | [optional] [default to undefined]
+**processes** | **number** | Number of processes at this sample | [optional] [default to undefined]
+**timestamp** | **number** | Unix timestamp of the sample | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersResourceUsageMetricsMetricResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersResourceUsageMetricsMetricResource = {
+    cpu_percent,
+    memory_bytes,
+    processes,
+    timestamp,
+};
+```
+
+[[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/AgencyHostingV1OrdersResourceUsageMetricsMetricsResource.md

@@ -0,0 +1,24 @@
+# AgencyHostingV1OrdersResourceUsageMetricsMetricsResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**limits** | [**AgencyHostingV1OrdersResourceUsageMetricsLimitsResource**](AgencyHostingV1OrdersResourceUsageMetricsLimitsResource.md) |  | [optional] [default to undefined]
+**metrics** | [**Array<AgencyHostingV1OrdersResourceUsageMetricsMetricResource>**](AgencyHostingV1OrdersResourceUsageMetricsMetricResource.md) | Array of [`AgencyHosting.V1.Orders.ResourceUsageMetrics.MetricResource`](#model/agencyhostingv1ordersresourceusagemetricsmetricresource) | [optional] [default to undefined]
+**websites** | [**Array<AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource>**](AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource.md) | Array of [`AgencyHosting.V1.Orders.ResourceUsageMetrics.WebsiteResource`](#model/agencyhostingv1ordersresourceusagemetricswebsiteresource) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersResourceUsageMetricsMetricsResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersResourceUsageMetricsMetricsResource = {
+    limits,
+    metrics,
+    websites,
+};
+```
+
+[[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/AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource.md

@@ -0,0 +1,24 @@
+# AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** | Website UID | [optional] [default to undefined]
+**domains** | **Array<string>** | Domains associated with the website | [optional] [default to undefined]
+**metrics** | [**Array<AgencyHostingV1OrdersResourceUsageMetricsMetricResource>**](AgencyHostingV1OrdersResourceUsageMetricsMetricResource.md) | Array of [`AgencyHosting.V1.Orders.ResourceUsageMetrics.MetricResource`](#model/agencyhostingv1ordersresourceusagemetricsmetricresource) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource } from 'hostinger-api-sdk';
+
+const instance: AgencyHostingV1OrdersResourceUsageMetricsWebsiteResource = {
+    uid,
+    domains,
+    metrics,
+};
+```
+
+[[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.37.0
+ * API Version: 1.38.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.35.0",
+  "version": "1.36.0",
   "description": "Hostinger API TypeScript SDK",
   "author": "Hostinger",
   "repository": {