@pidginhost/sdk 0.6.0 → 0.8.0

package/docs/EmailService.md

@@ -0,0 +1,44 @@
+# EmailService
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**tier** | **string** |  | [readonly] [default to undefined]
+**status** | [**StatusA57Enum**](StatusA57Enum.md) |  | [readonly] [default to undefined]
+**sandbox_mode** | **boolean** |  | [readonly] [default to undefined]
+**auto_suspended** | **boolean** |  | [readonly] [default to undefined]
+**auto_suspend_reason** | **string** |  | [readonly] [default to undefined]
+**msgs_sent_24h** | **number** |  | [readonly] [default to undefined]
+**msgs_sent_30d** | **number** |  | [readonly] [default to undefined]
+**bounce_rate_pct** | **string** |  | [readonly] [default to undefined]
+**complaint_rate_pct** | **string** |  | [readonly] [default to undefined]
+**dedicated_ip_addon** | **boolean** |  | [readonly] [default to undefined]
+**quota_monthly** | **string** |  | [readonly] [default to undefined]
+**price_monthly_eur** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { EmailService } from '@pidginhost/sdk';
+
+const instance: EmailService = {
+    id,
+    tier,
+    status,
+    sandbox_mode,
+    auto_suspended,
+    auto_suspend_reason,
+    msgs_sent_24h,
+    msgs_sent_30d,
+    bounce_rate_pct,
+    complaint_rate_pct,
+    dedicated_ip_addon,
+    quota_monthly,
+    price_monthly_eur,
+};
+```
+
+[[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/FloatingIPAuthorization.md

@@ -0,0 +1,27 @@
+# FloatingIPAuthorization
+
+Read-only authorization row for either v4 or v6 (shape is identical).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**server_id** | **number** |  | [readonly] [default to undefined]
+**server_hostname** | **string** |  | [readonly] [default to undefined]
+**created_at** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { FloatingIPAuthorization } from '@pidginhost/sdk';
+
+const instance: FloatingIPAuthorization = {
+    id,
+    server_id,
+    server_hostname,
+    created_at,
+};
+```
+
+[[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/FloatingIPAuthorizeRequest.md

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

package/docs/FloatingIPv4.md

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

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

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

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

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

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

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

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

@@ -0,0 +1,34 @@
+# InboundRoute
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**domain** | **number** |  | [readonly] [default to undefined]
+**pattern** | **string** |  | [default to undefined]
+**mode** | [**ModeEnum**](ModeEnum.md) |  | [default to undefined]
+**webhook_url** | **string** |  | [optional] [default to undefined]
+**forward_to** | **string** |  | [optional] [default to undefined]
+**active** | **boolean** |  | [optional] [default to undefined]
+**created_at** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { InboundRoute } from '@pidginhost/sdk';
+
+const instance: InboundRoute = {
+    id,
+    domain,
+    pattern,
+    mode,
+    webhook_url,
+    forward_to,
+    active,
+    created_at,
+};
+```
+
+[[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/ModeEnum.md

@@ -0,0 +1,11 @@
+# ModeEnum
+
+* `webhook` - HTTP webhook * `forward` - Forward
+
+## Enum
+
+* `Webhook` (value: `'webhook'`)
+
+* `Forward` (value: `'forward'`)
+
+[[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/PaginatedApiCredentialList.md

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,44 @@
+# PatchedEmailService
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [optional] [readonly] [default to undefined]
+**tier** | **string** |  | [optional] [readonly] [default to undefined]
+**status** | [**StatusA57Enum**](StatusA57Enum.md) |  | [optional] [readonly] [default to undefined]
+**sandbox_mode** | **boolean** |  | [optional] [readonly] [default to undefined]
+**auto_suspended** | **boolean** |  | [optional] [readonly] [default to undefined]
+**auto_suspend_reason** | **string** |  | [optional] [readonly] [default to undefined]
+**msgs_sent_24h** | **number** |  | [optional] [readonly] [default to undefined]
+**msgs_sent_30d** | **number** |  | [optional] [readonly] [default to undefined]
+**bounce_rate_pct** | **string** |  | [optional] [readonly] [default to undefined]
+**complaint_rate_pct** | **string** |  | [optional] [readonly] [default to undefined]
+**dedicated_ip_addon** | **boolean** |  | [optional] [readonly] [default to undefined]
+**quota_monthly** | **string** |  | [optional] [readonly] [default to undefined]
+**price_monthly_eur** | **string** |  | [optional] [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { PatchedEmailService } from '@pidginhost/sdk';
+
+const instance: PatchedEmailService = {
+    id,
+    tier,
+    status,
+    sandbox_mode,
+    auto_suspended,
+    auto_suspend_reason,
+    msgs_sent_24h,
+    msgs_sent_30d,
+    bounce_rate_pct,
+    complaint_rate_pct,
+    dedicated_ip_addon,
+    quota_monthly,
+    price_monthly_eur,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)