@pidginhost/sdk 0.2.0

package/docs/LBFirewallRule.md

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

@@ -0,0 +1,13 @@
+# LBFirewallRuleActionEnum
+
+* `ACCEPT` - Accept * `DROP` - Drop * `REJECT` - Reject
+
+## Enum
+
+* `Accept` (value: `'ACCEPT'`)
+
+* `Drop` (value: `'DROP'`)
+
+* `Reject` (value: `'REJECT'`)
+
+[[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/LBFirewallRuleDirectionEnum.md

@@ -0,0 +1,11 @@
+# LBFirewallRuleDirectionEnum
+
+* `in` - Inbound * `out` - Outbound
+
+## 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/LowBalanceSettings.md

@@ -0,0 +1,24 @@
+# LowBalanceSettings
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**threshold_type** | [**ThresholdTypeEnum**](ThresholdTypeEnum.md) |  | [default to undefined]
+**threshold_amount** | **string** |  | [optional] [default to undefined]
+**threshold_days** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { LowBalanceSettings } from '@pidginhost/sdk';
+
+const instance: LowBalanceSettings = {
+    threshold_type,
+    threshold_amount,
+    threshold_days,
+};
+```
+
+[[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/NameserversUpdate.md

@@ -0,0 +1,20 @@
+# NameserversUpdate
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**nameservers** | **Array<string>** | List of 2-5 nameserver hostnames | [default to undefined]
+
+## Example
+
+```typescript
+import { NameserversUpdate } from '@pidginhost/sdk';
+
+const instance: NameserversUpdate = {
+    nameservers,
+};
+```
+
+[[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/NameserversUpdateResponse.md

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

@@ -0,0 +1,32 @@
+# NodeMetricsResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cpu** | **number** |  | [default to undefined]
+**mem** | **number** |  | [default to undefined]
+**maxmem** | **number** |  | [default to undefined]
+**status** | **string** |  | [default to undefined]
+**uptime** | **number** |  | [default to undefined]
+**netin** | **number** |  | [default to undefined]
+**netout** | **number** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { NodeMetricsResponse } from '@pidginhost/sdk';
+
+const instance: NodeMetricsResponse = {
+    cpu,
+    mem,
+    maxmem,
+    status,
+    uptime,
+    netin,
+    netout,
+};
+```
+
+[[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/NodeRRDResponse.md

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

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

@@ -0,0 +1,28 @@
+# OSImage
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**slug** | **string** |  | [default to undefined]
+**name** | **string** | Display name for users | [default to undefined]
+**family_name** | **string** |  | [readonly] [default to undefined]
+**is_default** | **boolean** | Default version within this family (shown pre-selected) | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OSImage } from '@pidginhost/sdk';
+
+const instance: OSImage = {
+    id,
+    slug,
+    name,
+    family_name,
+    is_default,
+};
+```
+
+[[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/OperationEnum.md

@@ -0,0 +1,27 @@
+# OperationEnum
+
+* `added` - Added funds * `used` - Used funds for payment * `refunded` - Refunded funds * `recalculated` - Funds adjustment * `used_for_apps` - Used funds for Apps * `used_for_cloud` - Used funds for cloud services * `used_for_cloud_provision` - Used funds for cloud provision * `downgrade_credit` - Downgrade credit * `referral_reward` - Referral reward * `used_for_wishlist` - Used funds for domain wishlist
+
+## Enum
+
+* `Added` (value: `'added'`)
+
+* `Used` (value: `'used'`)
+
+* `Refunded` (value: `'refunded'`)
+
+* `Recalculated` (value: `'recalculated'`)
+
+* `UsedForApps` (value: `'used_for_apps'`)
+
+* `UsedForCloud` (value: `'used_for_cloud'`)
+
+* `UsedForCloudProvision` (value: `'used_for_cloud_provision'`)
+
+* `DowngradeCredit` (value: `'downgrade_credit'`)
+
+* `ReferralReward` (value: `'referral_reward'`)
+
+* `UsedForWishlist` (value: `'used_for_wishlist'`)
+
+[[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/PaginatedAPITokenListList.md

@@ -0,0 +1,26 @@
+# PaginatedAPITokenListList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<APITokenList>**](APITokenList.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedAPITokenListList } from '@pidginhost/sdk';
+
+const instance: PaginatedAPITokenListList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedClusterDetailList.md

@@ -0,0 +1,26 @@
+# PaginatedClusterDetailList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<ClusterDetail>**](ClusterDetail.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedClusterDetailList } from '@pidginhost/sdk';
+
+const instance: PaginatedClusterDetailList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedClusterTypeList.md

@@ -0,0 +1,26 @@
+# PaginatedClusterTypeList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<ClusterType>**](ClusterType.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedClusterTypeList } from '@pidginhost/sdk';
+
+const instance: PaginatedClusterTypeList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedCompanyList.md

@@ -0,0 +1,26 @@
+# PaginatedCompanyList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<Company>**](Company.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedCompanyList } from '@pidginhost/sdk';
+
+const instance: PaginatedCompanyList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedDedicatedServerList.md

@@ -0,0 +1,26 @@
+# PaginatedDedicatedServerList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<DedicatedServer>**](DedicatedServer.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedDedicatedServerList } from '@pidginhost/sdk';
+
+const instance: PaginatedDedicatedServerList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedDepositList.md

@@ -0,0 +1,26 @@
+# PaginatedDepositList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<Deposit>**](Deposit.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedDepositList } from '@pidginhost/sdk';
+
+const instance: PaginatedDepositList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedDomainList.md

@@ -0,0 +1,26 @@
+# PaginatedDomainList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<Domain>**](Domain.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedDomainList } from '@pidginhost/sdk';
+
+const instance: PaginatedDomainList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedDomainRegistrantList.md

@@ -0,0 +1,26 @@
+# PaginatedDomainRegistrantList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<DomainRegistrant>**](DomainRegistrant.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedDomainRegistrantList } from '@pidginhost/sdk';
+
+const instance: PaginatedDomainRegistrantList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedEmailHistoryList.md

@@ -0,0 +1,26 @@
+# PaginatedEmailHistoryList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<EmailHistory>**](EmailHistory.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedEmailHistoryList } from '@pidginhost/sdk';
+
+const instance: PaginatedEmailHistoryList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedFundsLogList.md

@@ -0,0 +1,26 @@
+# PaginatedFundsLogList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<FundsLog>**](FundsLog.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedFundsLogList } from '@pidginhost/sdk';
+
+const instance: PaginatedFundsLogList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedHostingServiceList.md

@@ -0,0 +1,26 @@
+# PaginatedHostingServiceList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<HostingService>**](HostingService.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedHostingServiceList } from '@pidginhost/sdk';
+
+const instance: PaginatedHostingServiceList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedInvoiceListList.md

@@ -0,0 +1,26 @@
+# PaginatedInvoiceListList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<InvoiceList>**](InvoiceList.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedInvoiceListList } from '@pidginhost/sdk';
+
+const instance: PaginatedInvoiceListList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedLBFirewallRuleList.md

@@ -0,0 +1,26 @@
+# PaginatedLBFirewallRuleList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<LBFirewallRule>**](LBFirewallRule.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedLBFirewallRuleList } from '@pidginhost/sdk';
+
+const instance: PaginatedLBFirewallRuleList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[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/PaginatedOSImageList.md

@@ -0,0 +1,26 @@
+# PaginatedOSImageList
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**count** | **number** |  | [default to undefined]
+**next** | **string** |  | [optional] [default to undefined]
+**previous** | **string** |  | [optional] [default to undefined]
+**results** | [**Array<OSImage>**](OSImage.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PaginatedOSImageList } from '@pidginhost/sdk';
+
+const instance: PaginatedOSImageList = {
+    count,
+    next,
+    previous,
+    results,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)