@pidginhost/sdk 0.2.0

package/docs/DomainCancelResponse.md

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

@@ -0,0 +1,24 @@
+# DomainCreate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** | Domain with tld, ex: example.com | [default to undefined]
+**nameservers** | **string** | List of 2-5 name-servers separated by comma. | [optional] [default to undefined]
+**years** | **number** |  | [optional] [default to 1]
+
+## Example
+
+```typescript
+import { DomainCreate } from '@pidginhost/sdk';
+
+const instance: DomainCreate = {
+    domain,
+    nameservers,
+    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/DomainRegistrant.md

@@ -0,0 +1,44 @@
+# DomainRegistrant
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**first_name** | **string** |  | [default to undefined]
+**last_name** | **string** |  | [default to undefined]
+**company** | **string** |  | [optional] [default to undefined]
+**address** | **string** |  | [default to undefined]
+**city** | **string** |  | [default to undefined]
+**region** | **string** |  | [default to undefined]
+**postal_code** | **string** |  | [default to undefined]
+**country** | [**CountryEnum**](CountryEnum.md) |  | [default to undefined]
+**email** | **string** |  | [default to undefined]
+**phone** | **string** |  | [default to undefined]
+**cif_cnp** | **string** |  | [optional] [default to undefined]
+**reg_com** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DomainRegistrant } from '@pidginhost/sdk';
+
+const instance: DomainRegistrant = {
+    id,
+    first_name,
+    last_name,
+    company,
+    address,
+    city,
+    region,
+    postal_code,
+    country,
+    email,
+    phone,
+    cif_cnp,
+    reg_com,
+};
+```
+
+[[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/EmailHistory.md

@@ -0,0 +1,28 @@
+# EmailHistory
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**subject** | **string** |  | [readonly] [default to undefined]
+**date** | **string** |  | [readonly] [default to undefined]
+**address** | **string** |  | [readonly] [default to undefined]
+**read** | **boolean** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { EmailHistory } from '@pidginhost/sdk';
+
+const instance: EmailHistory = {
+    id,
+    subject,
+    date,
+    address,
+    read,
+};
+```
+
+[[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/FeatureUpgradeRequest.md

@@ -0,0 +1,22 @@
+# FeatureUpgradeRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**feature_name** | **string** | Name of the feature to upgrade (e.g. cert-manager) | [default to undefined]
+**retry** | **boolean** | Retry a failed install | [optional] [default to false]
+
+## Example
+
+```typescript
+import { FeatureUpgradeRequest } from '@pidginhost/sdk';
+
+const instance: FeatureUpgradeRequest = {
+    feature_name,
+    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/FeatureUpgradeResponse.md

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

@@ -0,0 +1,17 @@
+# FeaturesEnum
+
+* `cert-manager` - Certificate manager * `ceph-csi` - Ceph CSI * `metrics-server` - Metrics Server * `cloudnative-pg` - CloudNative PG * `mariadb-operator` - MariaDB Operator
+
+## Enum
+
+* `CertManager` (value: `'cert-manager'`)
+
+* `CephCsi` (value: `'ceph-csi'`)
+
+* `MetricsServer` (value: `'metrics-server'`)
+
+* `CloudnativePg` (value: `'cloudnative-pg'`)
+
+* `MariadbOperator` (value: `'mariadb-operator'`)
+
+[[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/FirewallRule.md

@@ -0,0 +1,42 @@
+# FirewallRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**direction** | [**FirewallRuleDirectionEnum**](FirewallRuleDirectionEnum.md) |  | [default to undefined]
+**action** | [**FwPolicyOutEnum**](FwPolicyOutEnum.md) |  | [default to undefined]
+**protocol** | **string** |  | [optional] [default to undefined]
+**source** | **string** | single IP, range (20.34.101.207-201.3.9.99) or comma separated list | [optional] [default to undefined]
+**sport** | **string** | numbers (0-65535), range (\"\\d+:\\d+\", like \"80:85\"), comma separated list | [optional] [default to undefined]
+**destination** | **string** | single IP, range (20.34.101.207-201.3.9.99) or comma separated list | [optional] [default to undefined]
+**dport** | **string** | numbers (0-65535), range (\"\\d+:\\d+\", like \"80:85\"), comma separated list | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**position** | **number** |  | [optional] [default to undefined]
+**has_error** | **boolean** |  | [readonly] [default to undefined]
+**error_message** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { FirewallRule } from '@pidginhost/sdk';
+
+const instance: FirewallRule = {
+    id,
+    direction,
+    action,
+    protocol,
+    source,
+    sport,
+    destination,
+    dport,
+    enabled,
+    position,
+    has_error,
+    error_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/FirewallRuleDirectionEnum.md

@@ -0,0 +1,11 @@
+# FirewallRuleDirectionEnum
+
+* `in` - IN * `out` - OUT
+
+## Enum
+
+* `In` (value: `'in'`)
+
+* `Out` (value: `'out'`)
+
+[[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/FirewallRulesSet.md

@@ -0,0 +1,28 @@
+# FirewallRulesSet
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**name** | **string** |  | [default to undefined]
+**status** | [**FirewallRulesSetStatusEnum**](FirewallRulesSetStatusEnum.md) |  | [readonly] [default to undefined]
+**rules** | [**Array<FirewallRule>**](FirewallRule.md) |  | [readonly] [default to undefined]
+**read_only** | **boolean** | used with free tier vm | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { FirewallRulesSet } from '@pidginhost/sdk';
+
+const instance: FirewallRulesSet = {
+    id,
+    name,
+    status,
+    rules,
+    read_only,
+};
+```
+
+[[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/FirewallRulesSetStatusEnum.md

@@ -0,0 +1,13 @@
+# FirewallRulesSetStatusEnum
+
+* `validated` - Validated * `invalid` - Invalid * `pending` - Pending
+
+## Enum
+
+* `Validated` (value: `'validated'`)
+
+* `Invalid` (value: `'invalid'`)
+
+* `Pending` (value: `'pending'`)
+
+[[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/FreeDNSDomain.md

@@ -0,0 +1,24 @@
+# FreeDNSDomain
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**domain** | **string** |  | [readonly] [default to undefined]
+**active** | **boolean** |  | [readonly] [default to true]
+**source** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { FreeDNSDomain } from '@pidginhost/sdk';
+
+const instance: FreeDNSDomain = {
+    domain,
+    active,
+    source,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)