@pidginhost/sdk 0.2.0

package/docs/DedicatedApi.md

@@ -0,0 +1,551 @@
+# DedicatedApi
+
+All URIs are relative to *https://www.pidginhost.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**dedicatedServersList**](#dedicatedserverslist) | **GET** /api/dedicated/servers/ | |
+|[**dedicatedServersList2**](#dedicatedserverslist2) | **GET** /api/v1/dedicated/servers/ | |
+|[**dedicatedServersPowerCreate**](#dedicatedserverspowercreate) | **POST** /api/dedicated/servers/{id}/power/ | |
+|[**dedicatedServersPowerCreate2**](#dedicatedserverspowercreate2) | **POST** /api/v1/dedicated/servers/{id}/power/ | |
+|[**dedicatedServersRdnsCreate**](#dedicatedserversrdnscreate) | **POST** /api/dedicated/servers/{id}/rdns/ | |
+|[**dedicatedServersRdnsCreate2**](#dedicatedserversrdnscreate2) | **POST** /api/v1/dedicated/servers/{id}/rdns/ | |
+|[**dedicatedServersReinstallCreate**](#dedicatedserversreinstallcreate) | **POST** /api/dedicated/servers/{id}/reinstall/ | |
+|[**dedicatedServersReinstallCreate2**](#dedicatedserversreinstallcreate2) | **POST** /api/v1/dedicated/servers/{id}/reinstall/ | |
+|[**dedicatedServersRetrieve**](#dedicatedserversretrieve) | **GET** /api/dedicated/servers/{id}/ | |
+|[**dedicatedServersRetrieve2**](#dedicatedserversretrieve2) | **GET** /api/v1/dedicated/servers/{id}/ | |
+
+# **dedicatedServersList**
+> PaginatedDedicatedServerList dedicatedServersList()
+
+List and manage dedicated server services.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let page: number; //A page number within the paginated result set. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.dedicatedServersList(
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDedicatedServerList**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: 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)
+
+# **dedicatedServersList2**
+> PaginatedDedicatedServerList dedicatedServersList2()
+
+List and manage dedicated server services.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let page: number; //A page number within the paginated result set. (optional) (default to undefined)
+
+const { status, data } = await apiInstance.dedicatedServersList2(
+    page
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | A page number within the paginated result set. | (optional) defaults to undefined|
+
+
+### Return type
+
+**PaginatedDedicatedServerList**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: 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)
+
+# **dedicatedServersPowerCreate**
+> PowerActionResponse dedicatedServersPowerCreate(powerAction)
+
+Execute a power management action (start, stop, restart, shutdown).
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    PowerAction
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let powerAction: PowerAction; //
+
+const { status, data } = await apiInstance.dedicatedServersPowerCreate(
+    id,
+    powerAction
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **powerAction** | **PowerAction**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PowerActionResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersPowerCreate2**
+> PowerActionResponse dedicatedServersPowerCreate2(powerAction)
+
+Execute a power management action (start, stop, restart, shutdown).
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    PowerAction
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let powerAction: PowerAction; //
+
+const { status, data } = await apiInstance.dedicatedServersPowerCreate2(
+    id,
+    powerAction
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **powerAction** | **PowerAction**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PowerActionResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersRdnsCreate**
+> RDNSUpdateResponse dedicatedServersRdnsCreate(dedicatedRDNS)
+
+Update reverse DNS for a dedicated server IP.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    DedicatedRDNS
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let dedicatedRDNS: DedicatedRDNS; //
+
+const { status, data } = await apiInstance.dedicatedServersRdnsCreate(
+    id,
+    dedicatedRDNS
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **dedicatedRDNS** | **DedicatedRDNS**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RDNSUpdateResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersRdnsCreate2**
+> RDNSUpdateResponse dedicatedServersRdnsCreate2(dedicatedRDNS)
+
+Update reverse DNS for a dedicated server IP.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    DedicatedRDNS
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let dedicatedRDNS: DedicatedRDNS; //
+
+const { status, data } = await apiInstance.dedicatedServersRdnsCreate2(
+    id,
+    dedicatedRDNS
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **dedicatedRDNS** | **DedicatedRDNS**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**RDNSUpdateResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersReinstallCreate**
+> ReinstallResponse dedicatedServersReinstallCreate(reinstall)
+
+Reinstall the dedicated server with a new operating system.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    Reinstall
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let reinstall: Reinstall; //
+
+const { status, data } = await apiInstance.dedicatedServersReinstallCreate(
+    id,
+    reinstall
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reinstall** | **Reinstall**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ReinstallResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersReinstallCreate2**
+> ReinstallResponse dedicatedServersReinstallCreate2(reinstall)
+
+Reinstall the dedicated server with a new operating system.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration,
+    Reinstall
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+let reinstall: Reinstall; //
+
+const { status, data } = await apiInstance.dedicatedServersReinstallCreate2(
+    id,
+    reinstall
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **reinstall** | **Reinstall**|  | |
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ReinstallResponse**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: 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)
+
+# **dedicatedServersRetrieve**
+> DedicatedServer dedicatedServersRetrieve()
+
+List and manage dedicated server services.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.dedicatedServersRetrieve(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DedicatedServer**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: 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)
+
+# **dedicatedServersRetrieve2**
+> DedicatedServer dedicatedServersRetrieve2()
+
+List and manage dedicated server services.
+
+### Example
+
+```typescript
+import {
+    DedicatedApi,
+    Configuration
+} from '@pidginhost/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new DedicatedApi(configuration);
+
+let id: string; // (default to undefined)
+
+const { status, data } = await apiInstance.dedicatedServersRetrieve2(
+    id
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**DedicatedServer**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [tokenAuth](../README.md#tokenAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: 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/DedicatedRDNS.md

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

@@ -0,0 +1,39 @@
+# DedicatedServer
+
+Read-only serializer for dedicated server services.
+
+## 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]
+**server_status** | **string** |  | [readonly] [default to undefined]
+**ips** | **string** |  | [readonly] [default to undefined]
+**os_name** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { DedicatedServer } from '@pidginhost/sdk';
+
+const instance: DedicatedServer = {
+    id,
+    hostname,
+    status,
+    price,
+    next_invoice,
+    created,
+    billing_cycle,
+    server_status,
+    ips,
+    os_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/DeleteRecord.md

@@ -0,0 +1,20 @@
+# DeleteRecord
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line** | **number** | Line number of the DNS record to delete. | [default to undefined]
+
+## Example
+
+```typescript
+import { DeleteRecord } from '@pidginhost/sdk';
+
+const instance: DeleteRecord = {
+    line,
+};
+```
+
+[[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/DeleteRecordResponse.md

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

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

@@ -0,0 +1,32 @@
+# Deposit
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**status** | [**DepositStatusEnum**](DepositStatusEnum.md) |  | [readonly] [default to undefined]
+**amount** | **string** | Fara TVA | [readonly] [default to undefined]
+**vat_value** | **string** | TVA | [readonly] [default to undefined]
+**vat_percentage** | **number** |  | [readonly] [default to undefined]
+**total** | **string** | Cu TVA | [readonly] [default to undefined]
+**created** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { Deposit } from '@pidginhost/sdk';
+
+const instance: Deposit = {
+    id,
+    status,
+    amount,
+    vat_value,
+    vat_percentage,
+    total,
+    created,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)