@hostafrica/ha-sdk-typescript 1.0.14 → 1.1.3

package/docs/EditDnsRecordRequestContent.md

@@ -0,0 +1,38 @@
+
+# EditDnsRecordRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainName` | string
+`zoneId` | string
+`record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
+
+## Example
+
+```typescript
+import type { EditDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainName": null,
+  "zoneId": null,
+  "record": null,
+} satisfies EditDnsRecordRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EditDnsRecordRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/EditDnsRecordResponseContent.md

@@ -0,0 +1,36 @@
+
+# EditDnsRecordResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [DnsRecordMutationData](DnsRecordMutationData.md)
+
+## Example
+
+```typescript
+import type { EditDnsRecordResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies EditDnsRecordResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as EditDnsRecordResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDnsZoneDetailsData.md

@@ -0,0 +1,50 @@
+
+# GetDnsZoneDetailsData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`domainId` | string
+`zoneId` | string
+`zoneExists` | boolean
+`managementAvailable` | boolean
+`domainNameservers` | Array<string>
+`nsChanging` | string
+`packageSettings` | any
+`records` | [Array<DnsRecordInfo>](DnsRecordInfo.md)
+
+## Example
+
+```typescript
+import type { GetDnsZoneDetailsData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "domainId": null,
+  "zoneId": null,
+  "zoneExists": null,
+  "managementAvailable": null,
+  "domainNameservers": null,
+  "nsChanging": null,
+  "packageSettings": null,
+  "records": null,
+} satisfies GetDnsZoneDetailsData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDnsZoneDetailsRequestContent.md

@@ -0,0 +1,34 @@
+
+# GetDnsZoneDetailsRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+
+## Example
+
+```typescript
+import type { GetDnsZoneDetailsRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+} satisfies GetDnsZoneDetailsRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDnsZoneDetailsResponseContent.md

@@ -0,0 +1,36 @@
+
+# GetDnsZoneDetailsResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [GetDnsZoneDetailsData](GetDnsZoneDetailsData.md)
+
+## Example
+
+```typescript
+import type { GetDnsZoneDetailsResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies GetDnsZoneDetailsResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainContactsData.md

@@ -0,0 +1,41 @@
+
+# GetDomainContactsData
+
+Domain contact information returned by get-domain-contacts
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`domainId` | string
+`domain` | string
+`contacts` | [DomainContacts](DomainContacts.md)
+
+## Example
+
+```typescript
+import type { GetDomainContactsData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "domainId": null,
+  "domain": null,
+  "contacts": null,
+} satisfies GetDomainContactsData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainContactsData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainContactsRequestContent.md

@@ -0,0 +1,34 @@
+
+# GetDomainContactsRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+
+## Example
+
+```typescript
+import type { GetDomainContactsRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+} satisfies GetDomainContactsRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainContactsRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainContactsResponseContent.md

@@ -0,0 +1,36 @@
+
+# GetDomainContactsResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [GetDomainContactsData](GetDomainContactsData.md)
+
+## Example
+
+```typescript
+import type { GetDomainContactsResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies GetDomainContactsResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainContactsResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainData.md

@@ -0,0 +1,37 @@
+
+# GetDomainData
+
+Response data for get-domain
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`domain` | [DomainDetail](DomainDetail.md)
+
+## Example
+
+```typescript
+import type { GetDomainData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "domain": null,
+} satisfies GetDomainData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainRequestContent.md

@@ -0,0 +1,34 @@
+
+# GetDomainRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+
+## Example
+
+```typescript
+import type { GetDomainRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+} satisfies GetDomainRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/GetDomainResponseContent.md

@@ -0,0 +1,36 @@
+
+# GetDomainResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [GetDomainData](GetDomainData.md)
+
+## Example
+
+```typescript
+import type { GetDomainResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies GetDomainResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as GetDomainResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnsCreateCandidatesData.md

@@ -0,0 +1,38 @@
+
+# ListDnsCreateCandidatesData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`candidates` | [Array<DnsCreateCandidateInfo>](DnsCreateCandidateInfo.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { ListDnsCreateCandidatesData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "candidates": null,
+  "total": null,
+} satisfies ListDnsCreateCandidatesData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnsCreateCandidatesData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnsCreateCandidatesResponseContent.md

@@ -0,0 +1,36 @@
+
+# ListDnsCreateCandidatesResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [ListDnsCreateCandidatesData](ListDnsCreateCandidatesData.md)
+
+## Example
+
+```typescript
+import type { ListDnsCreateCandidatesResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies ListDnsCreateCandidatesResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnsCreateCandidatesResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnsZonesData.md

@@ -0,0 +1,38 @@
+
+# ListDnsZonesData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`zones` | [Array<DnsZoneInfo>](DnsZoneInfo.md)
+`total` | number
+
+## Example
+
+```typescript
+import type { ListDnsZonesData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "zones": null,
+  "total": null,
+} satisfies ListDnsZonesData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnsZonesData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnsZonesResponseContent.md

@@ -0,0 +1,36 @@
+
+# ListDnsZonesResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [ListDnsZonesData](ListDnsZonesData.md)
+
+## Example
+
+```typescript
+import type { ListDnsZonesResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies ListDnsZonesResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnsZonesResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnssecRecordsData.md

@@ -0,0 +1,36 @@
+
+# ListDnssecRecordsData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`records` | [Array<DnssecRecordInfo>](DnssecRecordInfo.md)
+
+## Example
+
+```typescript
+import type { ListDnssecRecordsData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "records": null,
+} satisfies ListDnssecRecordsData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnssecRecordsData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnssecRecordsRequestContent.md

@@ -0,0 +1,34 @@
+
+# ListDnssecRecordsRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+
+## Example
+
+```typescript
+import type { ListDnssecRecordsRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+} satisfies ListDnssecRecordsRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnssecRecordsRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListDnssecRecordsResponseContent.md

@@ -0,0 +1,36 @@
+
+# ListDnssecRecordsResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [ListDnssecRecordsData](ListDnssecRecordsData.md)
+
+## Example
+
+```typescript
+import type { ListDnssecRecordsResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies ListDnssecRecordsResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListDnssecRecordsResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+