@pidginhost/sdk 0.6.0 → 0.8.0

package/docs/PatchedInboundRoute.md

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

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

@@ -0,0 +1,15 @@
+# ReasonEnum
+
+* `hard_bounce` - Hard bounce * `complaint` - Complaint * `manual` - Manual * `unsubscribe` - Unsubscribe
+
+## Enum
+
+* `HardBounce` (value: `'hard_bounce'`)
+
+* `Complaint` (value: `'complaint'`)
+
+* `Manual` (value: `'manual'`)
+
+* `Unsubscribe` (value: `'unsubscribe'`)
+
+[[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/SandboxAddress.md

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

@@ -0,0 +1,42 @@
+# SendingDomain
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**name** | **string** |  | [readonly] [default to undefined]
+**status** | [**SendingDomainStatusEnum**](SendingDomainStatusEnum.md) |  | [readonly] [default to undefined]
+**dns_source** | [**DnsSourceEnum**](DnsSourceEnum.md) |  | [readonly] [default to undefined]
+**use_inbound** | **boolean** |  | [readonly] [default to undefined]
+**dkim_selector** | **string** |  | [readonly] [default to undefined]
+**dkim_record** | **string** |  | [readonly] [default to undefined]
+**spf_record** | **string** |  | [readonly] [default to undefined]
+**dmarc_record** | **string** |  | [readonly] [default to undefined]
+**verified_at** | **string** |  | [readonly] [default to undefined]
+**last_check_at** | **string** |  | [readonly] [default to undefined]
+**last_check_errors** | **any** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { SendingDomain } from '@pidginhost/sdk';
+
+const instance: SendingDomain = {
+    id,
+    name,
+    status,
+    dns_source,
+    use_inbound,
+    dkim_selector,
+    dkim_record,
+    spf_record,
+    dmarc_record,
+    verified_at,
+    last_check_at,
+    last_check_errors,
+};
+```
+
+[[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/SendingDomainStatusEnum.md

@@ -0,0 +1,17 @@
+# SendingDomainStatusEnum
+
+* `pending` - Pending * `verifying` - Verifying * `verified` - Verified * `failed` - Failed * `suspended` - Suspended
+
+## Enum
+
+* `Pending` (value: `'pending'`)
+
+* `Verifying` (value: `'verifying'`)
+
+* `Verified` (value: `'verified'`)
+
+* `Failed` (value: `'failed'`)
+
+* `Suspended` (value: `'suspended'`)
+
+[[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/ServerProduct.md

@@ -8,6 +8,10 @@ Name | Type | Description | Notes
 **id** | **number** |  | [readonly] [default to undefined]
 **slug** | **string** |  | [default to undefined]
 **name** | **string** |  | [readonly] [default to undefined]
+**cpus** | **number** |  | [readonly] [default to undefined]
+**memory** | **number** |  | [readonly] [default to undefined]
+**disk_size** | **number** |  | [readonly] [default to undefined]
+**traffic** | **number** |  | [readonly] [default to undefined]
 
 ## Example
 
@@ -18,6 +22,10 @@ const instance: ServerProduct = {
     id,
     slug,
     name,
+    cpus,
+    memory,
+    disk_size,
+    traffic,
 };
 ```
 

package/docs/SmtpCredential.md

@@ -0,0 +1,30 @@
+# SmtpCredential
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**label** | **string** |  | [readonly] [default to undefined]
+**username** | **string** |  | [readonly] [default to undefined]
+**active** | **boolean** |  | [readonly] [default to undefined]
+**created_at** | **string** |  | [readonly] [default to undefined]
+**revoked_at** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { SmtpCredential } from '@pidginhost/sdk';
+
+const instance: SmtpCredential = {
+    id,
+    label,
+    username,
+    active,
+    created_at,
+    revoked_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/Subscribe.md

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

@@ -0,0 +1,28 @@
+# SuppressionEntry
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** |  | [readonly] [default to undefined]
+**address** | **string** |  | [readonly] [default to undefined]
+**reason** | [**ReasonEnum**](ReasonEnum.md) |  | [readonly] [default to undefined]
+**detail** | **string** |  | [readonly] [default to undefined]
+**created_at** | **string** |  | [readonly] [default to undefined]
+
+## Example
+
+```typescript
+import { SuppressionEntry } from '@pidginhost/sdk';
+
+const instance: SuppressionEntry = {
+    id,
+    address,
+    reason,
+    detail,
+    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/TierEnum.md

@@ -0,0 +1,13 @@
+# TierEnum
+
+* `starter` - Starter * `pro` - Pro * `business` - Business
+
+## Enum
+
+* `Starter` (value: `'starter'`)
+
+* `Pro` (value: `'pro'`)
+
+* `Business` (value: `'business'`)
+
+[[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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pidginhost/sdk",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "OpenAPI client for @pidginhost/sdk",
   "author": "OpenAPI-Generator Contributors",
   "repository": {