@pidginhost/sdk 0.2.0

package/docs/PaginatedPrivateNetworkList.md

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

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

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

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,48 @@
+# PatchedClusterDetail
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**status** | [**StatusA57Enum**](StatusA57Enum.md) |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**cluster_type** | **string** |  | [optional] [readonly] [default to undefined]
+**kube_version** | **string** |  | [optional] [readonly] [default to undefined]
+**price_per_month** | **string** |  | [optional] [default to undefined]
+**price_per_hour** | **string** |  | [optional] [readonly] [default to undefined]
+**features** | [**Array<FeaturesEnum>**](FeaturesEnum.md) |  | [optional] [default to undefined]
+**features_ready** | **boolean** |  | [optional] [readonly] [default to undefined]
+**kubeconfig_valid_until** | **string** |  | [optional] [readonly] [default to undefined]
+**ipv4_address** | **string** |  | [optional] [readonly] [default to undefined]
+**_protected** | **boolean** |  | [optional] [default to undefined]
+**talos_version** | **string** |  | [optional] [readonly] [default to undefined]
+**talos_upgrade_available** | **string** |  | [optional] [readonly] [default to undefined]
+**talos_next_version** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedClusterDetail } from '@pidginhost/sdk';
+
+const instance: PatchedClusterDetail = {
+    id,
+    status,
+    name,
+    cluster_type,
+    kube_version,
+    price_per_month,
+    price_per_hour,
+    features,
+    features_ready,
+    kubeconfig_valid_until,
+    ipv4_address,
+    _protected,
+    talos_version,
+    talos_upgrade_available,
+    talos_next_version,
+};
+```
+
+[[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/PatchedCompany.md

@@ -0,0 +1,36 @@
+# PatchedCompany
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**cif_vat** | **string** |  | [optional] [default to undefined]
+**reg** | **string** |  | [optional] [default to undefined]
+**iban** | **string** |  | [optional] [default to undefined]
+**bank** | **string** |  | [optional] [default to undefined]
+**contact_name** | **string** |  | [optional] [default to undefined]
+**contact_email** | **string** |  | [optional] [default to undefined]
+**address** | [**Address**](Address.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedCompany } from '@pidginhost/sdk';
+
+const instance: PatchedCompany = {
+    id,
+    name,
+    cif_vat,
+    reg,
+    iban,
+    bank,
+    contact_name,
+    contact_email,
+    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/PatchedDomain.md

@@ -0,0 +1,42 @@
+# PatchedDomain
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**domain** | **string** |  | [optional] [readonly] [default to undefined]
+**tld** | [**TLD**](TLD.md) |  | [optional] [readonly] [default to undefined]
+**idna** | **boolean** | Domain name is encoded with IDN | [optional] [readonly] [default to undefined]
+**nameservers** | **string** | List of 2-5 name-servers separated by comma. | [optional] [default to undefined]
+**expiration_date** | **string** |  | [optional] [readonly] [default to undefined]
+**registration_date** | **string** |  | [optional] [readonly] [default to undefined]
+**service** | [**Service**](Service.md) |  | [optional] [readonly] [default to undefined]
+**idna_name** | **string** |  | [optional] [readonly] [default to undefined]
+**max_renew_years** | **number** |  | [optional] [readonly] [default to undefined]
+**service_status** | **string** | Service status | [optional] [readonly] [default to undefined]
+**contacts** | **any** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedDomain } from '@pidginhost/sdk';
+
+const instance: PatchedDomain = {
+    id,
+    domain,
+    tld,
+    idna,
+    nameservers,
+    expiration_date,
+    registration_date,
+    service,
+    idna_name,
+    max_renew_years,
+    service_status,
+    contacts,
+};
+```
+
+[[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/PatchedDomainRegistrant.md

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

@@ -0,0 +1,42 @@
+# PatchedFirewallRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**direction** | [**FirewallRuleDirectionEnum**](FirewallRuleDirectionEnum.md) |  | [optional] [default to undefined]
+**action** | [**FwPolicyOutEnum**](FwPolicyOutEnum.md) |  | [optional] [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** |  | [optional] [readonly] [default to undefined]
+**error_message** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedFirewallRule } from '@pidginhost/sdk';
+
+const instance: PatchedFirewallRule = {
+    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/PatchedFirewallRulesSet.md

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

@@ -0,0 +1,45 @@
+# PatchedHTTPRoute
+
+Serializer for HTTPRoute resources with automatic certificate issuance.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+**namespace** | **string** |  | [optional] [default to undefined]
+**hostnames** | **Array<string>** | List of hostnames to route (e.g., [\"example.com\", \"www.example.com\"]) | [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']
+**path_prefix** | **string** | Path prefix to match (default: /) | [optional] [default to '/']
+**enable_tls** | **boolean** | Enable TLS termination with automatic certificate issuance | [optional] [default to true]
+**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 { PatchedHTTPRoute } from '@pidginhost/sdk';
+
+const instance: PatchedHTTPRoute = {
+    id,
+    name,
+    namespace,
+    hostnames,
+    backend_service_name,
+    backend_service_port,
+    backend_namespace,
+    path_prefix,
+    enable_tls,
+    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)