@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.3

package/docs/DeleteDnsRecordResponseContent.md

@@ -0,0 +1,36 @@
+
+# DeleteDnsRecordResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [DnsRecordMutationData](DnsRecordMutationData.md)
+
+## Example
+
+```typescript
+import type { DeleteDnsRecordResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies DeleteDnsRecordResponseContent
+
+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 DeleteDnsRecordResponseContent
+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/DnsCreateCandidateInfo.md

@@ -0,0 +1,43 @@
+
+# DnsCreateCandidateInfo
+
+A domain or service eligible for DNS zone creation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainName` | string
+`domainId` | string
+`relid` | number
+`type` | number
+`name` | string
+
+## Example
+
+```typescript
+import type { DnsCreateCandidateInfo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainName": null,
+  "domainId": null,
+  "relid": null,
+  "type": null,
+  "name": null,
+} satisfies DnsCreateCandidateInfo
+
+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 DnsCreateCandidateInfo
+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/DnsRecordInfo.md

@@ -0,0 +1,49 @@
+
+# DnsRecordInfo
+
+A DNS record within a zone.  Record values are normalized to a flat `content` string. Structured record types use additional top-level fields; the proxy maps these to upstream `data` / `rdata_raw` shapes:  - **A / AAAA**: `content` is the IP address (`data.address`). - **CNAME**: `content` is the target hostname (`data.cname`). - **TXT**: `content` is the text value (`data.txtdata`). - **NS**: `content` is the nameserver hostname (`data.nsdname`). - **MX**: `content` is the mail exchange hostname; `priority` is the MX preference   (`data.exchange`, `data.preference`). - **SRV**: `content` is the target hostname; `priority`, `weight`, and `port` are the   SRV parameters (`data.target`, `data.priority`, `data.weight`, `data.port`).  When upstream returns structured `rdata_raw` without a string `rdata` value, `content` and the type-specific fields are derived from `rdata_raw`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`type` | string
+`content` | string
+`ttl` | number
+`priority` | number
+`weight` | number
+`port` | number
+
+## Example
+
+```typescript
+import type { DnsRecordInfo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "type": null,
+  "content": null,
+  "ttl": null,
+  "priority": null,
+  "weight": null,
+  "port": null,
+} satisfies DnsRecordInfo
+
+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 DnsRecordInfo
+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/DnsRecordMutationData.md

@@ -0,0 +1,36 @@
+
+# DnsRecordMutationData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`records` | [Array<DnsRecordInfo>](DnsRecordInfo.md)
+
+## Example
+
+```typescript
+import type { DnsRecordMutationData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "records": null,
+} satisfies DnsRecordMutationData
+
+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 DnsRecordMutationData
+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/DnsRecordMutationRecord.md

@@ -0,0 +1,49 @@
+
+# DnsRecordMutationRecord
+
+DNS record fields for add, edit, or delete via DNSManager.  See `DnsRecordInfo` for how `content` and structured fields map to upstream record data. Delete requires only `id`, `name`, and `type`.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`type` | string
+`content` | string
+`ttl` | number
+`priority` | number
+`weight` | number
+`port` | number
+
+## Example
+
+```typescript
+import type { DnsRecordMutationRecord } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "type": null,
+  "content": null,
+  "ttl": null,
+  "priority": null,
+  "weight": null,
+  "port": null,
+} satisfies DnsRecordMutationRecord
+
+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 DnsRecordMutationRecord
+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/DnsZoneInfo.md

@@ -0,0 +1,51 @@
+
+# DnsZoneInfo
+
+A DNS zone owned by the authenticated client
+
+## Properties
+
+Name | Type
+------------ | -------------
+`zoneId` | string
+`domainId` | string
+`domainName` | string
+`hostingId` | number
+`type` | number
+`typeKey` | string
+`packageName` | string
+`hasHosting` | [DomainHostingLink](DomainHostingLink.md)
+`hasDnsManagerZone` | boolean
+
+## Example
+
+```typescript
+import type { DnsZoneInfo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "zoneId": null,
+  "domainId": null,
+  "domainName": null,
+  "hostingId": null,
+  "type": null,
+  "typeKey": null,
+  "packageName": null,
+  "hasHosting": null,
+  "hasDnsManagerZone": null,
+} satisfies DnsZoneInfo
+
+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 DnsZoneInfo
+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/DnssecRecordInfo.md

@@ -0,0 +1,41 @@
+
+# DnssecRecordInfo
+
+A DNSSEC DS record
+
+## Properties
+
+Name | Type
+------------ | -------------
+`keyTag` | number
+`alg` | number
+`digestType` | number
+`digest` | string
+
+## Example
+
+```typescript
+import type { DnssecRecordInfo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "keyTag": null,
+  "alg": null,
+  "digestType": null,
+  "digest": null,
+} satisfies DnssecRecordInfo
+
+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 DnssecRecordInfo
+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/DomainAddonFeature.md

@@ -0,0 +1,43 @@
+
+# DomainAddonFeature
+
+Priced addon/feature block returned under available_features
+
+## Properties
+
+Name | Type
+------------ | -------------
+`enabled` | boolean
+`price` | number
+`title` | string
+`description` | string
+`productDesc` | string
+
+## Example
+
+```typescript
+import type { DomainAddonFeature } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "enabled": null,
+  "price": null,
+  "title": null,
+  "description": null,
+  "productDesc": null,
+} satisfies DomainAddonFeature
+
+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 DomainAddonFeature
+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/DomainAvailableFeatures.md

@@ -0,0 +1,47 @@
+
+# DomainAvailableFeatures
+
+Feature flags and priced addons available for a domain
+
+## Properties
+
+Name | Type
+------------ | -------------
+`eppcode` | boolean
+`dnssec` | boolean
+`privateNameservers` | boolean
+`redirector` | boolean
+`dnsmanagement` | [DomainAddonFeature](DomainAddonFeature.md)
+`emailforwarding` | [DomainAddonFeature](DomainAddonFeature.md)
+`idprotection` | [DomainAddonFeature](DomainAddonFeature.md)
+
+## Example
+
+```typescript
+import type { DomainAvailableFeatures } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "eppcode": null,
+  "dnssec": null,
+  "privateNameservers": null,
+  "redirector": null,
+  "dnsmanagement": null,
+  "emailforwarding": null,
+  "idprotection": null,
+} satisfies DomainAvailableFeatures
+
+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 DomainAvailableFeatures
+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/DomainContactSourceType.md

@@ -0,0 +1,32 @@
+
+# DomainContactSourceType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DomainContactSourceType } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DomainContactSourceType
+
+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 DomainContactSourceType
+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/DomainContactUpdate.md

@@ -0,0 +1,39 @@
+
+# DomainContactUpdate
+
+Update payload for one WHOIS contact role
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [DomainContactSourceType](DomainContactSourceType.md)
+`id` | number
+`fields` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { DomainContactUpdate } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "id": null,
+  "fields": null,
+} satisfies DomainContactUpdate
+
+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 DomainContactUpdate
+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/DomainContactUpdates.md

@@ -0,0 +1,41 @@
+
+# DomainContactUpdates
+
+WHOIS contact updates keyed by Registrant, Admin, Tech, and Billing
+
+## Properties
+
+Name | Type
+------------ | -------------
+`registrant` | [DomainContactUpdate](DomainContactUpdate.md)
+`admin` | [DomainContactUpdate](DomainContactUpdate.md)
+`tech` | [DomainContactUpdate](DomainContactUpdate.md)
+`billing` | [DomainContactUpdate](DomainContactUpdate.md)
+
+## Example
+
+```typescript
+import type { DomainContactUpdates } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "registrant": null,
+  "admin": null,
+  "tech": null,
+  "billing": null,
+} satisfies DomainContactUpdates
+
+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 DomainContactUpdates
+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/DomainContacts.md

@@ -0,0 +1,41 @@
+
+# DomainContacts
+
+WHOIS contacts keyed by contact role
+
+## Properties
+
+Name | Type
+------------ | -------------
+`registrant` | { [key: string]: string; }
+`admin` | { [key: string]: string; }
+`tech` | { [key: string]: string; }
+`billing` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { DomainContacts } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "registrant": null,
+  "admin": null,
+  "tech": null,
+  "billing": null,
+} satisfies DomainContacts
+
+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 DomainContacts
+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/DomainDetail.md

@@ -0,0 +1,107 @@
+
+# DomainDetail
+
+Full domain details returned by get-domain
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+`type` | string
+`domain` | string
+`sld` | string
+`tld` | string
+`status` | string
+`period` | number
+`registrationdate` | string
+`donotrenew` | number
+`idProtection` | number
+`idProtectionSupported` | boolean
+`firstpaymentamount` | string
+`recurringamount` | string
+`dnsmanagement` | boolean
+`emailforwarding` | boolean
+`isPremium` | boolean
+`lockStatus` | string
+`gracePeriod` | number
+`redemptionPeriod` | number
+`gracePeriodFee` | number
+`redemptionPeriodFee` | number
+`inGrace` | boolean
+`inRedemption` | boolean
+`expirydate` | string
+`nextinvoicedate` | string
+`nextduedate` | string
+`availableFeatures` | [DomainAvailableFeatures](DomainAvailableFeatures.md)
+`domainNameservers` | Array<string>
+`defaultNameservers` | Array<string>
+`nsChanging` | string
+`hasHosting` | [DomainHostingLink](DomainHostingLink.md)
+`hasDnsManagerZone` | boolean
+`expiryCountdown` | [DomainExpiryCountdown](DomainExpiryCountdown.md)
+`evaluation` | any
+`domainEvaluationAvailable` | boolean
+`hasRedirect` | any
+`noEpp` | boolean
+
+## Example
+
+```typescript
+import type { DomainDetail } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+  "type": null,
+  "domain": null,
+  "sld": null,
+  "tld": null,
+  "status": null,
+  "period": null,
+  "registrationdate": null,
+  "donotrenew": null,
+  "idProtection": null,
+  "idProtectionSupported": null,
+  "firstpaymentamount": null,
+  "recurringamount": null,
+  "dnsmanagement": null,
+  "emailforwarding": null,
+  "isPremium": null,
+  "lockStatus": null,
+  "gracePeriod": null,
+  "redemptionPeriod": null,
+  "gracePeriodFee": null,
+  "redemptionPeriodFee": null,
+  "inGrace": null,
+  "inRedemption": null,
+  "expirydate": null,
+  "nextinvoicedate": null,
+  "nextduedate": null,
+  "availableFeatures": null,
+  "domainNameservers": null,
+  "defaultNameservers": null,
+  "nsChanging": null,
+  "hasHosting": null,
+  "hasDnsManagerZone": null,
+  "expiryCountdown": null,
+  "evaluation": null,
+  "domainEvaluationAvailable": null,
+  "hasRedirect": null,
+  "noEpp": null,
+} satisfies DomainDetail
+
+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 DomainDetail
+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)
+
+