@pidginhost/sdk 0.2.0

package/docs/PatchedLBFirewallRule.md

@@ -0,0 +1,44 @@
+# PatchedLBFirewallRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**direction** | [**LBFirewallRuleDirectionEnum**](LBFirewallRuleDirectionEnum.md) |  | [optional] [default to undefined]
+**action** | [**LBFirewallRuleActionEnum**](LBFirewallRuleActionEnum.md) |  | [optional] [default to undefined]
+**protocol** | **string** | tcp, udp, icmp, etc. | [optional] [default to undefined]
+**source** | **string** | IP address or CIDR | [optional] [default to undefined]
+**sport** | **string** | Port or range (e.g., 1024-65535) | [optional] [default to undefined]
+**destination** | **string** | IP address or CIDR | [optional] [default to undefined]
+**dport** | **string** | Port or range (e.g., 80, 8000-9000) | [optional] [default to undefined]
+**comment** | **string** |  | [optional] [default to undefined]
+**enabled** | **boolean** |  | [optional] [default to undefined]
+**position** | **number** | Rule order (lower = higher priority) | [optional] [default to undefined]
+**created** | **string** |  | [optional] [readonly] [default to undefined]
+**updated** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedLBFirewallRule } from '@pidginhost/sdk';
+
+const instance: PatchedLBFirewallRule = {
+    id,
+    direction,
+    action,
+    protocol,
+    source,
+    sport,
+    destination,
+    dport,
+    comment,
+    enabled,
+    position,
+    created,
+    updated,
+};
+```
+
+[[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/PatchedPrivateNetwork.md

@@ -0,0 +1,30 @@
+# PatchedPrivateNetwork
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**slug** | **string** | CIDR format | [optional] [readonly] [default to undefined]
+**address** | **string** | CIDR format | [optional] [default to undefined]
+**gateway** | **string** |  | [optional] [default to undefined]
+**provisioned** | **boolean** |  | [optional] [readonly] [default to undefined]
+**servers** | **Array<{ [key: string]: string; }>** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedPrivateNetwork } from '@pidginhost/sdk';
+
+const instance: PatchedPrivateNetwork = {
+    id,
+    slug,
+    address,
+    gateway,
+    provisioned,
+    servers,
+};
+```
+
+[[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/PatchedProfile.md

@@ -0,0 +1,26 @@
+# PatchedProfile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **string** |  | [optional] [default to undefined]
+**last_name** | **string** |  | [optional] [default to undefined]
+**funds** | **string** |  | [optional] [readonly] [default to undefined]
+**phone** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedProfile } from '@pidginhost/sdk';
+
+const instance: PatchedProfile = {
+    first_name,
+    last_name,
+    funds,
+    phone,
+};
+```
+
+[[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/PatchedResourcePool.md

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

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

@@ -0,0 +1,41 @@
+# PatchedTCPRoute
+
+Serializer for TCPRoute resources with port validation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**namespace** | **string** |  | [optional] [default to undefined]
+**port** | **number** | External port to expose (blocked: 22, 6443, 50000, 50001) | [optional] [default to undefined]
+**backend_service_name** | **string** | Name of the backend Kubernetes Service | [optional] [default to undefined]
+**backend_service_port** | **number** | Port of the backend Service | [optional] [default to undefined]
+**backend_namespace** | **string** | Namespace of the backend Service | [optional] [default to 'default']
+**status_ready** | **boolean** |  | [optional] [readonly] [default to undefined]
+**status_message** | **string** |  | [optional] [readonly] [default to undefined]
+**created** | **string** |  | [optional] [readonly] [default to undefined]
+**updated** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedTCPRoute } from '@pidginhost/sdk';
+
+const instance: PatchedTCPRoute = {
+    id,
+    name,
+    namespace,
+    port,
+    backend_service_name,
+    backend_service_port,
+    backend_namespace,
+    status_ready,
+    status_message,
+    created,
+    updated,
+};
+```
+
+[[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/PatchedUDPRoute.md

@@ -0,0 +1,41 @@
+# PatchedUDPRoute
+
+Serializer for UDPRoute resources with port validation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**namespace** | **string** |  | [optional] [default to undefined]
+**port** | **number** | External port to expose | [optional] [default to undefined]
+**backend_service_name** | **string** | Name of the backend Kubernetes Service | [optional] [default to undefined]
+**backend_service_port** | **number** | Port of the backend Service | [optional] [default to undefined]
+**backend_namespace** | **string** | Namespace of the backend Service | [optional] [default to 'default']
+**status_ready** | **boolean** |  | [optional] [readonly] [default to undefined]
+**status_message** | **string** |  | [optional] [readonly] [default to undefined]
+**created** | **string** |  | [optional] [readonly] [default to undefined]
+**updated** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedUDPRoute } from '@pidginhost/sdk';
+
+const instance: PatchedUDPRoute = {
+    id,
+    name,
+    namespace,
+    port,
+    backend_service_name,
+    backend_service_port,
+    backend_namespace,
+    status_ready,
+    status_message,
+    created,
+    updated,
+};
+```
+
+[[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/PatchedVolume.md

@@ -0,0 +1,32 @@
+# PatchedVolume
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**project** | **string** |  | [optional] [default to undefined]
+**alias** | **string** |  | [optional] [default to undefined]
+**size** | **number** | GB | [optional] [default to undefined]
+**product** | **string** | ID or slug | [optional] [default to undefined]
+**attached** | **boolean** |  | [optional] [readonly] [default to undefined]
+**server** | **string** |  | [optional] [readonly] [default to '']
+
+## Example
+
+```typescript
+import { PatchedVolume } from '@pidginhost/sdk';
+
+const instance: PatchedVolume = {
+    id,
+    project,
+    alias,
+    size,
+    product,
+    attached,
+    server,
+};
+```
+
+[[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/PayWithFundsResponse.md

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

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

@@ -0,0 +1,15 @@
+# PowerActionActionEnum
+
+* `start` - start * `stop` - stop * `restart` - restart * `shutdown` - shutdown
+
+## Enum
+
+* `Start` (value: `'start'`)
+
+* `Stop` (value: `'stop'`)
+
+* `Restart` (value: `'restart'`)
+
+* `Shutdown` (value: `'shutdown'`)
+
+[[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/PowerActionResponse.md

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

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

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

@@ -0,0 +1,15 @@
+# PowerManagementRequestActionEnum
+
+* `start` - start * `stop` - stop * `shutdown` - shutdown * `reboot` - reboot
+
+## Enum
+
+* `Start` (value: `'start'`)
+
+* `Stop` (value: `'stop'`)
+
+* `Shutdown` (value: `'shutdown'`)
+
+* `Reboot` (value: `'reboot'`)
+
+[[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/Priority3cdEnum.md

@@ -0,0 +1,13 @@
+# Priority3cdEnum
+
+* `low` - Low * `medium` - Medium * `high` - High
+
+## Enum
+
+* `Low` (value: `'low'`)
+
+* `Medium` (value: `'medium'`)
+
+* `High` (value: `'high'`)
+
+[[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/PrivateNetwork.md

@@ -0,0 +1,30 @@
+# PrivateNetwork
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**slug** | **string** | CIDR format | [readonly] [default to undefined]
+**address** | **string** | CIDR format | [default to undefined]
+**gateway** | **string** |  | [optional] [default to undefined]
+**provisioned** | **boolean** |  | [readonly] [default to undefined]
+**servers** | **Array<{ [key: string]: string; }>** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PrivateNetwork } from '@pidginhost/sdk';
+
+const instance: PrivateNetwork = {
+    id,
+    slug,
+    address,
+    gateway,
+    provisioned,
+    servers,
+};
+```
+
+[[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/PrivateNetworkAddHost.md

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

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

@@ -0,0 +1,26 @@
+# Profile
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **string** |  | [default to undefined]
+**last_name** | **string** |  | [default to undefined]
+**funds** | **string** |  | [readonly] [default to undefined]
+**phone** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { Profile } from '@pidginhost/sdk';
+
+const instance: Profile = {
+    first_name,
+    last_name,
+    funds,
+    phone,
+};
+```
+
+[[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/PublicIPv4.md

@@ -0,0 +1,32 @@
+# PublicIPv4
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**slug** | **string** |  | [readonly] [default to undefined]
+**address** | **string** |  | [readonly] [default to undefined]
+**gateway** | **string** |  | [readonly] [default to undefined]
+**prefix** | **number** |  | [readonly] [default to undefined]
+**attached** | **boolean** |  | [readonly] [default to undefined]
+**server** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PublicIPv4 } from '@pidginhost/sdk';
+
+const instance: PublicIPv4 = {
+    id,
+    slug,
+    address,
+    gateway,
+    prefix,
+    attached,
+    server,
+};
+```
+
+[[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/PublicIPv6.md

@@ -0,0 +1,32 @@
+# PublicIPv6
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**slug** | **string** |  | [readonly] [default to undefined]
+**address** | **string** |  | [readonly] [default to undefined]
+**gateway** | **string** |  | [readonly] [default to undefined]
+**prefix** | **number** |  | [readonly] [default to undefined]
+**attached** | **boolean** |  | [readonly] [default to undefined]
+**server** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PublicIPv6 } from '@pidginhost/sdk';
+
+const instance: PublicIPv6 = {
+    id,
+    slug,
+    address,
+    gateway,
+    prefix,
+    attached,
+    server,
+};
+```
+
+[[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/PublicInterface.md

@@ -0,0 +1,30 @@
+# PublicInterface
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**_interface** | **string** |  | [readonly] [default to undefined]
+**ipv4** | **string** |  | [readonly] [default to undefined]
+**ipv6** | **string** |  | [readonly] [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]
+
+## Example
+
+```typescript
+import { PublicInterface } from '@pidginhost/sdk';
+
+const instance: PublicInterface = {
+    _interface,
+    ipv4,
+    ipv6,
+    fw_rules_set,
+    fw_policy_in,
+    fw_policy_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/RDNSUpdateResponse.md

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

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