@pidginhost/sdk 0.2.0

package/docs/ReinstallResponse.md

@@ -0,0 +1,20 @@
+# ReinstallResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ReinstallResponse } from '@pidginhost/sdk';
+
+const instance: ReinstallResponse = {
+    message,
+};
+```
+
+[[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/RemoveServerResponse.md

@@ -0,0 +1,20 @@
+# RemoveServerResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**removed** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RemoveServerResponse } from '@pidginhost/sdk';
+
+const instance: RemoveServerResponse = {
+    removed,
+};
+```
+
+[[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/RenewDomain.md

@@ -0,0 +1,20 @@
+# RenewDomain
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**years** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RenewDomain } from '@pidginhost/sdk';
+
+const instance: RenewDomain = {
+    years,
+};
+```
+
+[[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/ResourcePool.md

@@ -0,0 +1,28 @@
+# ResourcePool
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**_package** | **string** |  | [readonly] [default to undefined]
+**size** | **string** |  | [readonly] [default to undefined]
+**nodes** | [**Array<ResourcePoolNode>**](ResourcePoolNode.md) |  | [readonly] [default to undefined]
+**new_size** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ResourcePool } from '@pidginhost/sdk';
+
+const instance: ResourcePool = {
+    id,
+    _package,
+    size,
+    nodes,
+    new_size,
+};
+```
+
+[[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/ResourcePoolAdd.md

@@ -0,0 +1,22 @@
+# ResourcePoolAdd
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**resource_pool_package** | **string** | ID or slug | [default to undefined]
+**resource_pool_size** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ResourcePoolAdd } from '@pidginhost/sdk';
+
+const instance: ResourcePoolAdd = {
+    resource_pool_package,
+    resource_pool_size,
+};
+```
+
+[[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/ResourcePoolAddResponse.md

@@ -0,0 +1,20 @@
+# ResourcePoolAddResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ResourcePoolAddResponse } from '@pidginhost/sdk';
+
+const instance: ResourcePoolAddResponse = {
+    id,
+};
+```
+
+[[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/ResourcePoolNode.md

@@ -0,0 +1,24 @@
+# ResourcePoolNode
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**ip** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ResourcePoolNode } from '@pidginhost/sdk';
+
+const instance: ResourcePoolNode = {
+    id,
+    name,
+    ip,
+};
+```
+
+[[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/RetryProvision.md

@@ -0,0 +1,20 @@
+# RetryProvision
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**retry** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { RetryProvision } from '@pidginhost/sdk';
+
+const instance: RetryProvision = {
+    retry,
+};
+```
+
+[[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/ReverseDNS.md

@@ -0,0 +1,20 @@
+# ReverseDNS
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reverse_dns** | **string** | Fully-qualified domain name for PTR record (e.g., host.example.com) | [default to undefined]
+
+## Example
+
+```typescript
+import { ReverseDNS } from '@pidginhost/sdk';
+
+const instance: ReverseDNS = {
+    reverse_dns,
+};
+```
+
+[[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/SSHKey.md

@@ -0,0 +1,26 @@
+# SSHKey
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**alias** | **string** |  | [optional] [default to undefined]
+**fingerprint** | **string** |  | [readonly] [default to undefined]
+**key** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { SSHKey } from '@pidginhost/sdk';
+
+const instance: SSHKey = {
+    id,
+    alias,
+    fingerprint,
+    key,
+};
+```
+
+[[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/SchemaApi.md

@@ -0,0 +1,117 @@
+# SchemaApi
+
+All URIs are relative to *https://www.pidginhost.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**schemaRetrieve**](#schemaretrieve) | **GET** /api/schema/ | |
+|[**schemaRetrieve2**](#schemaretrieve2) | **GET** /api/v1/schema/ | |
+
+# **schemaRetrieve**
+> { [key: string]: any; } schemaRetrieve()
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```typescript
+import {
+    SchemaApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SchemaApi(configuration);
+
+let format: 'json' | 'yaml'; // (optional) (default to undefined)
+let lang: 'en' | 'ro'; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.schemaRetrieve(
+    format,
+    lang
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **format** | [**&#39;json&#39; | &#39;yaml&#39;**]**Array<&#39;json&#39; &#124; &#39;yaml&#39;>** |  | (optional) defaults to undefined|
+| **lang** | [**&#39;en&#39; | &#39;ro&#39;**]**Array<&#39;en&#39; &#124; &#39;ro&#39;>** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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)
+
+# **schemaRetrieve2**
+> { [key: string]: any; } schemaRetrieve2()
+
+OpenApi3 schema for this API. Format can be selected via content negotiation.  - YAML: application/vnd.oai.openapi - JSON: application/vnd.oai.openapi+json
+
+### Example
+
+```typescript
+import {
+    SchemaApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new SchemaApi(configuration);
+
+let format: 'json' | 'yaml'; // (optional) (default to undefined)
+let lang: 'en' | 'ro'; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.schemaRetrieve2(
+    format,
+    lang
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **format** | [**&#39;json&#39; | &#39;yaml&#39;**]**Array<&#39;json&#39; &#124; &#39;yaml&#39;>** |  | (optional) defaults to undefined|
+| **lang** | [**&#39;en&#39; | &#39;ro&#39;**]**Array<&#39;en&#39; &#124; &#39;ro&#39;>** |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**{ [key: string]: any; }**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/vnd.oai.openapi, application/yaml, application/vnd.oai.openapi+json, application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** |  |  -  |
+
+[[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/ScopeEnum.md

@@ -0,0 +1,11 @@
+# ScopeEnum
+
+* `read_only` - Read only * `read_write` - Read & Write
+
+## Enum
+
+* `ReadOnly` (value: `'read_only'`)
+
+* `ReadWrite` (value: `'read_write'`)
+
+[[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/Server.md

@@ -0,0 +1,42 @@
+# Server
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**hostname** | **string** |  | [optional] [default to undefined]
+**project** | **string** |  | [optional] [default to undefined]
+**image** | **string** |  | [readonly] [default to undefined]
+**_package** | **string** |  | [readonly] [default to undefined]
+**cpus** | **string** |  | [readonly] [default to undefined]
+**memory** | **string** |  | [readonly] [default to undefined]
+**disk_size** | **string** |  | [readonly] [default to undefined]
+**status** | [**StatusA57Enum**](StatusA57Enum.md) |  | [optional] [default to undefined]
+**destroy_protection** | **boolean** | Prevents the server from being destroyed until disabled. | [readonly] [default to undefined]
+**ha_enabled** | **boolean** | Enables Proxmox HA — automatic restart and migration on node failure. | [readonly] [default to undefined]
+**networks** | **{ [key: string]: any; }** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Server } from '@pidginhost/sdk';
+
+const instance: Server = {
+    id,
+    hostname,
+    project,
+    image,
+    _package,
+    cpus,
+    memory,
+    disk_size,
+    status,
+    destroy_protection,
+    ha_enabled,
+    networks,
+};
+```
+
+[[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/ServerAdd.md

@@ -0,0 +1,58 @@
+# ServerAdd
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**image** | **string** | ID or slug | [default to undefined]
+**_package** | **string** | ID or slug | [default to undefined]
+**hostname** | **string** |  | [optional] [default to undefined]
+**project** | **string** |  | [optional] [default to undefined]
+**password** | **string** |  | [optional] [default to undefined]
+**ssh_pub_key** | **string** | New SSH key | [optional] [default to undefined]
+**ssh_pub_key_id** | **string** | ID or fingerprint | [optional] [default to undefined]
+**public_ip** | **string** | ID or slug | [optional] [default to undefined]
+**new_ipv4** | **boolean** |  | [optional] [default to undefined]
+**public_ipv6** | **string** | ID or slug | [optional] [default to undefined]
+**new_ipv6** | **boolean** |  | [optional] [default to undefined]
+**fw_rules_set** | **string** | ID or slug | [optional] [default to undefined]
+**fw_policy_in** | [**FwPolicyOutEnum**](FwPolicyOutEnum.md) |  | [optional] [default to undefined]
+**fw_policy_out** | [**FwPolicyOutEnum**](FwPolicyOutEnum.md) |  | [optional] [default to undefined]
+**private_network** | **string** | ID or slug | [optional] [default to undefined]
+**private_address** | **string** | Leave empty for auto-assign | [optional] [default to undefined]
+**extra_volume_product** | **string** | ID or slug | [optional] [default to undefined]
+**extra_volume_size** | **number** |  | [optional] [default to 0]
+**no_network_acknowledged** | **boolean** |  | [optional] [default to undefined]
+**enable_ha** | **boolean** |  | [optional] [default to false]
+
+## Example
+
+```typescript
+import { ServerAdd } from '@pidginhost/sdk';
+
+const instance: ServerAdd = {
+    image,
+    _package,
+    hostname,
+    project,
+    password,
+    ssh_pub_key,
+    ssh_pub_key_id,
+    public_ip,
+    new_ipv4,
+    public_ipv6,
+    new_ipv6,
+    fw_rules_set,
+    fw_policy_in,
+    fw_policy_out,
+    private_network,
+    private_address,
+    extra_volume_product,
+    extra_volume_size,
+    no_network_acknowledged,
+    enable_ha,
+};
+```
+
+[[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/ServerAddResponse.md

@@ -0,0 +1,20 @@
+# ServerAddResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ServerAddResponse } from '@pidginhost/sdk';
+
+const instance: ServerAddResponse = {
+    id,
+};
+```
+
+[[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/ServerProduct.md

@@ -0,0 +1,24 @@
+# ServerProduct
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**slug** | **string** |  | [default to undefined]
+**name** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ServerProduct } from '@pidginhost/sdk';
+
+const instance: ServerProduct = {
+    id,
+    slug,
+    name,
+};
+```
+
+[[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/ServerProductUpgrade.md

@@ -0,0 +1,20 @@
+# ServerProductUpgrade
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_package** | **string** | ID or slug | [default to undefined]
+
+## Example
+
+```typescript
+import { ServerProductUpgrade } from '@pidginhost/sdk';
+
+const instance: ServerProductUpgrade = {
+    _package,
+};
+```
+
+[[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/ServerUpgradeResponse.md

@@ -0,0 +1,20 @@
+# ServerUpgradeResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**upgrading** | **boolean** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ServerUpgradeResponse } from '@pidginhost/sdk';
+
+const instance: ServerUpgradeResponse = {
+    upgrading,
+};
+```
+
+[[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/ServerUsageResponse.md

@@ -0,0 +1,28 @@
+# ServerUsageResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **string** |  | [default to undefined]
+**uptime** | **number** |  | [default to undefined]
+**uptime_text** | **string** |  | [default to undefined]
+**cpu** | **{ [key: string]: any; }** |  | [default to undefined]
+**memory** | **{ [key: string]: any; }** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { ServerUsageResponse } from '@pidginhost/sdk';
+
+const instance: ServerUsageResponse = {
+    status,
+    uptime,
+    uptime_text,
+    cpu,
+    memory,
+};
+```
+
+[[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/Service.md

@@ -0,0 +1,40 @@
+# Service
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**company** | **number** |  | [optional] [default to undefined]
+**billing_cycle** | **number** |  | [readonly] [default to undefined]
+**hostname** | **string** |  | [readonly] [default to undefined]
+**price** | **string** | Euro without TVA | [readonly] [default to undefined]
+**status** | [**Status63aEnum**](Status63aEnum.md) |  | [readonly] [default to undefined]
+**created** | **string** |  | [readonly] [default to undefined]
+**modified** | **string** |  | [readonly] [default to undefined]
+**terminated** | **string** |  | [readonly] [default to undefined]
+**next_invoice** | **string** |  | [readonly] [default to undefined]
+**primary_service** | **number** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Service } from '@pidginhost/sdk';
+
+const instance: Service = {
+    id,
+    company,
+    billing_cycle,
+    hostname,
+    price,
+    status,
+    created,
+    modified,
+    terminated,
+    next_invoice,
+    primary_service,
+};
+```
+
+[[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/ServiceList.md

@@ -0,0 +1,36 @@
+# ServiceList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**hostname** | **string** |  | [readonly] [default to undefined]
+**status** | [**Status63aEnum**](Status63aEnum.md) |  | [readonly] [default to undefined]
+**price** | **string** | Euro without TVA | [readonly] [default to undefined]
+**next_invoice** | **string** |  | [readonly] [default to undefined]
+**created** | **string** |  | [readonly] [default to undefined]
+**billing_cycle** | **string** |  | [readonly] [default to undefined]
+**auto_payment** | **string** |  | [readonly] [default to undefined]
+**company** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { ServiceList } from '@pidginhost/sdk';
+
+const instance: ServiceList = {
+    id,
+    hostname,
+    status,
+    price,
+    next_invoice,
+    created,
+    billing_cycle,
+    auto_payment,
+    company,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)