@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/apis/DNSApi.d.ts +85 -1
- package/dist/apis/DNSApi.js +272 -0
- package/dist/apis/DomainsApi.d.ts +46 -1
- package/dist/apis/DomainsApi.js +141 -0
- package/dist/apis/ServiceManagementApi.d.ts +4 -4
- package/dist/apis/ServiceManagementApi.js +4 -4
- package/dist/apis/SnapshotsApi.d.ts +8 -8
- package/dist/apis/SnapshotsApi.js +8 -8
- package/dist/esm/apis/DNSApi.d.ts +85 -1
- package/dist/esm/apis/DNSApi.js +273 -1
- package/dist/esm/apis/DomainsApi.d.ts +46 -1
- package/dist/esm/apis/DomainsApi.js +142 -1
- package/dist/esm/apis/ServiceManagementApi.d.ts +4 -4
- package/dist/esm/apis/ServiceManagementApi.js +4 -4
- package/dist/esm/apis/SnapshotsApi.d.ts +8 -8
- package/dist/esm/apis/SnapshotsApi.js +8 -8
- package/dist/esm/models/AddDnsRecordRequestContent.d.ts +45 -0
- package/dist/esm/models/AddDnsRecordRequestContent.js +50 -0
- package/dist/esm/models/AddDnsRecordResponseContent.d.ts +40 -0
- package/dist/esm/models/AddDnsRecordResponseContent.js +49 -0
- package/dist/esm/models/DeleteDnsRecordRequestContent.d.ts +45 -0
- package/dist/esm/models/DeleteDnsRecordRequestContent.js +50 -0
- package/dist/esm/models/DeleteDnsRecordResponseContent.d.ts +40 -0
- package/dist/esm/models/DeleteDnsRecordResponseContent.js +49 -0
- package/dist/esm/models/DnsCreateCandidateInfo.d.ts +56 -0
- package/dist/esm/models/DnsCreateCandidateInfo.js +49 -0
- package/dist/esm/models/DnsRecordInfo.d.ts +89 -0
- package/dist/esm/models/DnsRecordInfo.js +55 -0
- package/dist/esm/models/DnsRecordMutationData.d.ts +39 -0
- package/dist/esm/models/DnsRecordMutationData.js +46 -0
- package/dist/esm/models/DnsRecordMutationRecord.d.ts +77 -0
- package/dist/esm/models/DnsRecordMutationRecord.js +55 -0
- package/dist/esm/models/DnsZoneInfo.d.ts +81 -0
- package/dist/esm/models/DnsZoneInfo.js +60 -0
- package/dist/esm/models/DnssecRecordInfo.d.ts +50 -0
- package/dist/esm/models/DnssecRecordInfo.js +55 -0
- package/dist/esm/models/DomainAddonFeature.d.ts +56 -0
- package/dist/esm/models/DomainAddonFeature.js +57 -0
- package/dist/esm/models/DomainAvailableFeatures.d.ts +69 -0
- package/dist/esm/models/DomainAvailableFeatures.js +54 -0
- package/dist/esm/models/DomainContactSourceType.d.ts +26 -0
- package/dist/esm/models/DomainContactSourceType.js +44 -0
- package/dist/esm/models/DomainContactUpdate.d.ts +47 -0
- package/dist/esm/models/DomainContactUpdate.js +48 -0
- package/dist/esm/models/DomainContactUpdates.d.ts +51 -0
- package/dist/esm/models/DomainContactUpdates.js +48 -0
- package/dist/esm/models/DomainContacts.d.ts +58 -0
- package/dist/esm/models/DomainContacts.js +47 -0
- package/dist/esm/models/DomainDetail.d.ts +251 -0
- package/dist/esm/models/DomainDetail.js +136 -0
- package/dist/esm/models/DomainExpiryCountdown.d.ts +44 -0
- package/dist/esm/models/DomainExpiryCountdown.js +51 -0
- package/dist/esm/models/DomainHostingLink.d.ts +4 -4
- package/dist/esm/models/DomainHostingLink.js +2 -6
- package/dist/esm/models/DomainInfo.d.ts +6 -0
- package/dist/esm/models/DomainInfo.js +2 -0
- package/dist/esm/models/DomainNameservers.d.ts +56 -0
- package/dist/esm/models/DomainNameservers.js +49 -0
- package/dist/esm/models/EditDnsRecordRequestContent.d.ts +45 -0
- package/dist/esm/models/EditDnsRecordRequestContent.js +50 -0
- package/dist/esm/models/EditDnsRecordResponseContent.d.ts +40 -0
- package/dist/esm/models/EditDnsRecordResponseContent.js +49 -0
- package/dist/esm/models/GetDnsZoneDetailsData.d.ts +81 -0
- package/dist/esm/models/GetDnsZoneDetailsData.js +60 -0
- package/dist/esm/models/GetDnsZoneDetailsRequestContent.d.ts +32 -0
- package/dist/esm/models/GetDnsZoneDetailsRequestContent.js +43 -0
- package/dist/esm/models/GetDnsZoneDetailsResponseContent.d.ts +40 -0
- package/dist/esm/models/GetDnsZoneDetailsResponseContent.js +49 -0
- package/dist/esm/models/GetDomainContactsData.d.ts +4 -3
- package/dist/esm/models/GetDomainContactsData.js +3 -2
- package/dist/esm/models/GetDomainData.d.ts +3 -3
- package/dist/esm/models/GetDomainData.js +3 -3
- package/dist/esm/models/ListDnsCreateCandidatesData.d.ts +45 -0
- package/dist/esm/models/ListDnsCreateCandidatesData.js +52 -0
- package/dist/esm/models/ListDnsCreateCandidatesResponseContent.d.ts +40 -0
- package/dist/esm/models/ListDnsCreateCandidatesResponseContent.js +49 -0
- package/dist/esm/models/ListDnsZonesData.d.ts +45 -0
- package/dist/esm/models/ListDnsZonesData.js +52 -0
- package/dist/esm/models/ListDnsZonesResponseContent.d.ts +40 -0
- package/dist/esm/models/ListDnsZonesResponseContent.js +49 -0
- package/dist/esm/models/ListDnssecRecordsData.d.ts +39 -0
- package/dist/esm/models/ListDnssecRecordsData.js +48 -0
- package/dist/esm/models/ListDnssecRecordsRequestContent.d.ts +32 -0
- package/dist/esm/models/ListDnssecRecordsRequestContent.js +43 -0
- package/dist/esm/models/ListDnssecRecordsResponseContent.d.ts +40 -0
- package/dist/esm/models/ListDnssecRecordsResponseContent.js +49 -0
- package/dist/esm/models/UpdateDomainContactsData.d.ts +38 -0
- package/dist/esm/models/UpdateDomainContactsData.js +45 -0
- package/dist/esm/models/UpdateDomainContactsRequestContent.d.ts +39 -0
- package/dist/esm/models/UpdateDomainContactsRequestContent.js +48 -0
- package/dist/esm/models/UpdateDomainContactsResponseContent.d.ts +40 -0
- package/dist/esm/models/UpdateDomainContactsResponseContent.js +49 -0
- package/dist/esm/models/UpdateDomainNameserversData.d.ts +45 -0
- package/dist/esm/models/UpdateDomainNameserversData.js +48 -0
- package/dist/esm/models/UpdateDomainNameserversRequestContent.d.ts +62 -0
- package/dist/esm/models/UpdateDomainNameserversRequestContent.js +57 -0
- package/dist/esm/models/UpdateDomainNameserversResponseContent.d.ts +40 -0
- package/dist/esm/models/UpdateDomainNameserversResponseContent.js +49 -0
- package/dist/esm/models/index.d.ts +37 -0
- package/dist/esm/models/index.js +37 -0
- package/dist/esm/retryablePaths.js +4 -0
- package/dist/models/AddDnsRecordRequestContent.d.ts +45 -0
- package/dist/models/AddDnsRecordRequestContent.js +57 -0
- package/dist/models/AddDnsRecordResponseContent.d.ts +40 -0
- package/dist/models/AddDnsRecordResponseContent.js +56 -0
- package/dist/models/DeleteDnsRecordRequestContent.d.ts +45 -0
- package/dist/models/DeleteDnsRecordRequestContent.js +57 -0
- package/dist/models/DeleteDnsRecordResponseContent.d.ts +40 -0
- package/dist/models/DeleteDnsRecordResponseContent.js +56 -0
- package/dist/models/DnsCreateCandidateInfo.d.ts +56 -0
- package/dist/models/DnsCreateCandidateInfo.js +56 -0
- package/dist/models/DnsRecordInfo.d.ts +89 -0
- package/dist/models/DnsRecordInfo.js +62 -0
- package/dist/models/DnsRecordMutationData.d.ts +39 -0
- package/dist/models/DnsRecordMutationData.js +53 -0
- package/dist/models/DnsRecordMutationRecord.d.ts +77 -0
- package/dist/models/DnsRecordMutationRecord.js +62 -0
- package/dist/models/DnsZoneInfo.d.ts +81 -0
- package/dist/models/DnsZoneInfo.js +67 -0
- package/dist/models/DnssecRecordInfo.d.ts +50 -0
- package/dist/models/DnssecRecordInfo.js +62 -0
- package/dist/models/DomainAddonFeature.d.ts +56 -0
- package/dist/models/DomainAddonFeature.js +64 -0
- package/dist/models/DomainAvailableFeatures.d.ts +69 -0
- package/dist/models/DomainAvailableFeatures.js +61 -0
- package/dist/models/DomainContactSourceType.d.ts +26 -0
- package/dist/models/DomainContactSourceType.js +52 -0
- package/dist/models/DomainContactUpdate.d.ts +47 -0
- package/dist/models/DomainContactUpdate.js +55 -0
- package/dist/models/DomainContactUpdates.d.ts +51 -0
- package/dist/models/DomainContactUpdates.js +55 -0
- package/dist/models/DomainContacts.d.ts +58 -0
- package/dist/models/DomainContacts.js +54 -0
- package/dist/models/DomainDetail.d.ts +251 -0
- package/dist/models/DomainDetail.js +143 -0
- package/dist/models/DomainExpiryCountdown.d.ts +44 -0
- package/dist/models/DomainExpiryCountdown.js +58 -0
- package/dist/models/DomainHostingLink.d.ts +4 -4
- package/dist/models/DomainHostingLink.js +2 -6
- package/dist/models/DomainInfo.d.ts +6 -0
- package/dist/models/DomainInfo.js +2 -0
- package/dist/models/DomainNameservers.d.ts +56 -0
- package/dist/models/DomainNameservers.js +56 -0
- package/dist/models/EditDnsRecordRequestContent.d.ts +45 -0
- package/dist/models/EditDnsRecordRequestContent.js +57 -0
- package/dist/models/EditDnsRecordResponseContent.d.ts +40 -0
- package/dist/models/EditDnsRecordResponseContent.js +56 -0
- package/dist/models/GetDnsZoneDetailsData.d.ts +81 -0
- package/dist/models/GetDnsZoneDetailsData.js +67 -0
- package/dist/models/GetDnsZoneDetailsRequestContent.d.ts +32 -0
- package/dist/models/GetDnsZoneDetailsRequestContent.js +50 -0
- package/dist/models/GetDnsZoneDetailsResponseContent.d.ts +40 -0
- package/dist/models/GetDnsZoneDetailsResponseContent.js +56 -0
- package/dist/models/GetDomainContactsData.d.ts +4 -3
- package/dist/models/GetDomainContactsData.js +3 -2
- package/dist/models/GetDomainData.d.ts +3 -3
- package/dist/models/GetDomainData.js +3 -3
- package/dist/models/ListDnsCreateCandidatesData.d.ts +45 -0
- package/dist/models/ListDnsCreateCandidatesData.js +59 -0
- package/dist/models/ListDnsCreateCandidatesResponseContent.d.ts +40 -0
- package/dist/models/ListDnsCreateCandidatesResponseContent.js +56 -0
- package/dist/models/ListDnsZonesData.d.ts +45 -0
- package/dist/models/ListDnsZonesData.js +59 -0
- package/dist/models/ListDnsZonesResponseContent.d.ts +40 -0
- package/dist/models/ListDnsZonesResponseContent.js +56 -0
- package/dist/models/ListDnssecRecordsData.d.ts +39 -0
- package/dist/models/ListDnssecRecordsData.js +55 -0
- package/dist/models/ListDnssecRecordsRequestContent.d.ts +32 -0
- package/dist/models/ListDnssecRecordsRequestContent.js +50 -0
- package/dist/models/ListDnssecRecordsResponseContent.d.ts +40 -0
- package/dist/models/ListDnssecRecordsResponseContent.js +56 -0
- package/dist/models/UpdateDomainContactsData.d.ts +38 -0
- package/dist/models/UpdateDomainContactsData.js +52 -0
- package/dist/models/UpdateDomainContactsRequestContent.d.ts +39 -0
- package/dist/models/UpdateDomainContactsRequestContent.js +55 -0
- package/dist/models/UpdateDomainContactsResponseContent.d.ts +40 -0
- package/dist/models/UpdateDomainContactsResponseContent.js +56 -0
- package/dist/models/UpdateDomainNameserversData.d.ts +45 -0
- package/dist/models/UpdateDomainNameserversData.js +55 -0
- package/dist/models/UpdateDomainNameserversRequestContent.d.ts +62 -0
- package/dist/models/UpdateDomainNameserversRequestContent.js +64 -0
- package/dist/models/UpdateDomainNameserversResponseContent.d.ts +40 -0
- package/dist/models/UpdateDomainNameserversResponseContent.js +56 -0
- package/dist/models/index.d.ts +37 -0
- package/dist/models/index.js +37 -0
- package/dist/retryablePaths.js +4 -0
- package/dist.zip +0 -0
- package/docs/AddDnsRecordRequestContent.md +38 -0
- package/docs/AddDnsRecordResponseContent.md +36 -0
- package/docs/DNSApi.md +462 -0
- package/docs/DeleteDnsRecordRequestContent.md +38 -0
- package/docs/DeleteDnsRecordResponseContent.md +36 -0
- package/docs/DnsCreateCandidateInfo.md +43 -0
- package/docs/DnsRecordInfo.md +49 -0
- package/docs/DnsRecordMutationData.md +36 -0
- package/docs/DnsRecordMutationRecord.md +49 -0
- package/docs/DnsZoneInfo.md +51 -0
- package/docs/DnssecRecordInfo.md +41 -0
- package/docs/DomainAddonFeature.md +43 -0
- package/docs/DomainAvailableFeatures.md +47 -0
- package/docs/DomainContactSourceType.md +32 -0
- package/docs/DomainContactUpdate.md +39 -0
- package/docs/DomainContactUpdates.md +41 -0
- package/docs/DomainContacts.md +41 -0
- package/docs/DomainDetail.md +107 -0
- package/docs/DomainExpiryCountdown.md +39 -0
- package/docs/DomainInfo.md +2 -0
- package/docs/DomainNameservers.md +43 -0
- package/docs/DomainsApi.md +240 -0
- package/docs/EditDnsRecordRequestContent.md +38 -0
- package/docs/EditDnsRecordResponseContent.md +36 -0
- package/docs/GetDnsZoneDetailsData.md +50 -0
- package/docs/GetDnsZoneDetailsRequestContent.md +34 -0
- package/docs/GetDnsZoneDetailsResponseContent.md +36 -0
- package/docs/GetDomainContactsData.md +1 -1
- package/docs/GetDomainData.md +1 -1
- package/docs/ListDnsCreateCandidatesData.md +38 -0
- package/docs/ListDnsCreateCandidatesResponseContent.md +36 -0
- package/docs/ListDnsZonesData.md +38 -0
- package/docs/ListDnsZonesResponseContent.md +36 -0
- package/docs/ListDnssecRecordsData.md +36 -0
- package/docs/ListDnssecRecordsRequestContent.md +34 -0
- package/docs/ListDnssecRecordsResponseContent.md +36 -0
- package/docs/ServiceManagementApi.md +2 -2
- package/docs/SnapshotsApi.md +4 -4
- package/docs/UpdateDomainContactsData.md +36 -0
- package/docs/UpdateDomainContactsRequestContent.md +36 -0
- package/docs/UpdateDomainContactsResponseContent.md +36 -0
- package/docs/UpdateDomainNameserversData.md +38 -0
- package/docs/UpdateDomainNameserversRequestContent.md +44 -0
- package/docs/UpdateDomainNameserversResponseContent.md +36 -0
- package/package.json +1 -1
- package/src/apis/DNSApi.ts +356 -0
- package/src/apis/DomainsApi.ts +195 -0
- package/src/apis/ServiceManagementApi.ts +4 -4
- package/src/apis/SnapshotsApi.ts +8 -8
- package/src/models/AddDnsRecordRequestContent.ts +91 -0
- package/src/models/AddDnsRecordResponseContent.ts +92 -0
- package/src/models/DeleteDnsRecordRequestContent.ts +91 -0
- package/src/models/DeleteDnsRecordResponseContent.ts +92 -0
- package/src/models/DnsCreateCandidateInfo.ts +97 -0
- package/src/models/DnsRecordInfo.ts +136 -0
- package/src/models/DnsRecordMutationData.ts +82 -0
- package/src/models/DnsRecordMutationRecord.ts +124 -0
- package/src/models/DnsZoneInfo.ts +138 -0
- package/src/models/DnssecRecordInfo.ts +93 -0
- package/src/models/DomainAddonFeature.ts +101 -0
- package/src/models/DomainAvailableFeatures.ts +121 -0
- package/src/models/DomainContactSourceType.ts +54 -0
- package/src/models/DomainContactUpdate.ts +92 -0
- package/src/models/DomainContactUpdates.ts +97 -0
- package/src/models/DomainContacts.ts +89 -0
- package/src/models/DomainDetail.ts +385 -0
- package/src/models/DomainExpiryCountdown.ts +84 -0
- package/src/models/DomainHostingLink.ts +6 -8
- package/src/models/DomainInfo.ts +8 -0
- package/src/models/DomainNameservers.ts +97 -0
- package/src/models/EditDnsRecordRequestContent.ts +91 -0
- package/src/models/EditDnsRecordResponseContent.ts +92 -0
- package/src/models/GetDnsZoneDetailsData.ts +138 -0
- package/src/models/GetDnsZoneDetailsRequestContent.ts +66 -0
- package/src/models/GetDnsZoneDetailsResponseContent.ts +92 -0
- package/src/models/GetDomainContactsData.ts +13 -5
- package/src/models/GetDomainData.ts +10 -10
- package/src/models/ListDnsCreateCandidatesData.ts +92 -0
- package/src/models/ListDnsCreateCandidatesResponseContent.ts +92 -0
- package/src/models/ListDnsZonesData.ts +92 -0
- package/src/models/ListDnsZonesResponseContent.ts +92 -0
- package/src/models/ListDnssecRecordsData.ts +83 -0
- package/src/models/ListDnssecRecordsRequestContent.ts +66 -0
- package/src/models/ListDnssecRecordsResponseContent.ts +92 -0
- package/src/models/UpdateDomainContactsData.ts +74 -0
- package/src/models/UpdateDomainContactsRequestContent.ts +83 -0
- package/src/models/UpdateDomainContactsResponseContent.ts +92 -0
- package/src/models/UpdateDomainNameserversData.ts +90 -0
- package/src/models/UpdateDomainNameserversRequestContent.ts +108 -0
- package/src/models/UpdateDomainNameserversResponseContent.ts +92 -0
- package/src/models/index.ts +37 -0
- package/src/retryablePaths.ts +4 -0
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
|
|
2
|
+
# DomainExpiryCountdown
|
|
3
|
+
|
|
4
|
+
Countdown until domain expiry
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`years` | number
|
|
11
|
+
`months` | number
|
|
12
|
+
`days` | number
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import type { DomainExpiryCountdown } from '@hostafrica/ha-sdk-typescript'
|
|
18
|
+
|
|
19
|
+
// TODO: Update the object below with actual values
|
|
20
|
+
const example = {
|
|
21
|
+
"years": null,
|
|
22
|
+
"months": null,
|
|
23
|
+
"days": null,
|
|
24
|
+
} satisfies DomainExpiryCountdown
|
|
25
|
+
|
|
26
|
+
console.log(example)
|
|
27
|
+
|
|
28
|
+
// Convert the instance to a JSON string
|
|
29
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
30
|
+
console.log(exampleJSON)
|
|
31
|
+
|
|
32
|
+
// Parse the JSON string back to an object
|
|
33
|
+
const exampleParsed = JSON.parse(exampleJSON) as DomainExpiryCountdown
|
|
34
|
+
console.log(exampleParsed)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
38
|
+
|
|
39
|
+
|
package/docs/DomainInfo.md
CHANGED
|
@@ -22,6 +22,7 @@ Name | Type
|
|
|
22
22
|
`hasHosting` | [DomainHostingLink](DomainHostingLink.md)
|
|
23
23
|
`hasDnsManagerZone` | boolean
|
|
24
24
|
`evaluation` | any
|
|
25
|
+
`noEpp` | boolean
|
|
25
26
|
|
|
26
27
|
## Example
|
|
27
28
|
|
|
@@ -45,6 +46,7 @@ const example = {
|
|
|
45
46
|
"hasHosting": null,
|
|
46
47
|
"hasDnsManagerZone": null,
|
|
47
48
|
"evaluation": null,
|
|
49
|
+
"noEpp": null,
|
|
48
50
|
} satisfies DomainInfo
|
|
49
51
|
|
|
50
52
|
console.log(example)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
|
|
2
|
+
# DomainNameservers
|
|
3
|
+
|
|
4
|
+
Nameserver hostnames applied to a domain
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
Name | Type
|
|
9
|
+
------------ | -------------
|
|
10
|
+
`ns1` | string
|
|
11
|
+
`ns2` | string
|
|
12
|
+
`ns3` | string
|
|
13
|
+
`ns4` | string
|
|
14
|
+
`ns5` | string
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import type { DomainNameservers } from '@hostafrica/ha-sdk-typescript'
|
|
20
|
+
|
|
21
|
+
// TODO: Update the object below with actual values
|
|
22
|
+
const example = {
|
|
23
|
+
"ns1": null,
|
|
24
|
+
"ns2": null,
|
|
25
|
+
"ns3": null,
|
|
26
|
+
"ns4": null,
|
|
27
|
+
"ns5": null,
|
|
28
|
+
} satisfies DomainNameservers
|
|
29
|
+
|
|
30
|
+
console.log(example)
|
|
31
|
+
|
|
32
|
+
// Convert the instance to a JSON string
|
|
33
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
34
|
+
console.log(exampleJSON)
|
|
35
|
+
|
|
36
|
+
// Parse the JSON string back to an object
|
|
37
|
+
const exampleParsed = JSON.parse(exampleJSON) as DomainNameservers
|
|
38
|
+
console.log(exampleParsed)
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
42
|
+
|
|
43
|
+
|
package/docs/DomainsApi.md
CHANGED
|
@@ -7,10 +7,13 @@ All URIs are relative to *https://api.hostafrica.com*
|
|
|
7
7
|
| [**checkDomainAvailability**](DomainsApi.md#checkdomainavailability) | **POST** /domain/check-availability | |
|
|
8
8
|
| [**getDomain**](DomainsApi.md#getdomain) | **POST** /domain/get-domain | |
|
|
9
9
|
| [**getDomainContacts**](DomainsApi.md#getdomaincontacts) | **POST** /domain/get-domain-contacts | |
|
|
10
|
+
| [**listDnssecRecords**](DomainsApi.md#listdnssecrecords) | **POST** /domain/list-dnssec-records | |
|
|
10
11
|
| [**listDomains**](DomainsApi.md#listdomains) | **POST** /domain/list-domains | |
|
|
11
12
|
| [**listDomainsRequiringData**](DomainsApi.md#listdomainsrequiringdata) | **POST** /domain/list-domains-requiring-data | |
|
|
12
13
|
| [**saveDomainRequiredData**](DomainsApi.md#savedomainrequireddata) | **POST** /domain/save-domain-required-data | |
|
|
13
14
|
| [**suggestDomains**](DomainsApi.md#suggestdomains) | **POST** /domain/suggest | |
|
|
15
|
+
| [**updateDomainContacts**](DomainsApi.md#updatedomaincontacts) | **POST** /domain/update-domain-contacts | |
|
|
16
|
+
| [**updateDomainNameservers**](DomainsApi.md#updatedomainnameservers) | **POST** /domain/update-nameservers | |
|
|
14
17
|
| [**updateDomainSettings**](DomainsApi.md#updatedomainsettings) | **POST** /domain/update-domain-settings | |
|
|
15
18
|
|
|
16
19
|
|
|
@@ -251,6 +254,85 @@ example().catch(console.error);
|
|
|
251
254
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
252
255
|
|
|
253
256
|
|
|
257
|
+
## listDnssecRecords
|
|
258
|
+
|
|
259
|
+
> ListDnssecRecordsResponseContent listDnssecRecords(listDnssecRecordsRequestContent)
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
Lists DNSSEC DS records configured for an owned domain.
|
|
264
|
+
|
|
265
|
+
### Example
|
|
266
|
+
|
|
267
|
+
```ts
|
|
268
|
+
import {
|
|
269
|
+
Configuration,
|
|
270
|
+
DomainsApi,
|
|
271
|
+
} from '@hostafrica/ha-sdk-typescript';
|
|
272
|
+
import type { ListDnssecRecordsRequest } from '@hostafrica/ha-sdk-typescript';
|
|
273
|
+
|
|
274
|
+
async function example() {
|
|
275
|
+
console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
|
|
276
|
+
const config = new Configuration({
|
|
277
|
+
// Configure HTTP bearer authorization: BearerAuth
|
|
278
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
279
|
+
});
|
|
280
|
+
const api = new DomainsApi(config);
|
|
281
|
+
|
|
282
|
+
const body = {
|
|
283
|
+
// ListDnssecRecordsRequestContent
|
|
284
|
+
listDnssecRecordsRequestContent: ...,
|
|
285
|
+
} satisfies ListDnssecRecordsRequest;
|
|
286
|
+
|
|
287
|
+
try {
|
|
288
|
+
const data = await api.listDnssecRecords(body);
|
|
289
|
+
console.log(data);
|
|
290
|
+
} catch (error) {
|
|
291
|
+
console.error(error);
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
// Run the test
|
|
296
|
+
example().catch(console.error);
|
|
297
|
+
```
|
|
298
|
+
|
|
299
|
+
### Parameters
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
| Name | Type | Description | Notes |
|
|
303
|
+
|------------- | ------------- | ------------- | -------------|
|
|
304
|
+
| **listDnssecRecordsRequestContent** | [ListDnssecRecordsRequestContent](ListDnssecRecordsRequestContent.md) | | |
|
|
305
|
+
|
|
306
|
+
### Return type
|
|
307
|
+
|
|
308
|
+
[**ListDnssecRecordsResponseContent**](ListDnssecRecordsResponseContent.md)
|
|
309
|
+
|
|
310
|
+
### Authorization
|
|
311
|
+
|
|
312
|
+
[BearerAuth](../README.md#BearerAuth)
|
|
313
|
+
|
|
314
|
+
### HTTP request headers
|
|
315
|
+
|
|
316
|
+
- **Content-Type**: `application/json`
|
|
317
|
+
- **Accept**: `application/json`
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
### HTTP response details
|
|
321
|
+
| Status code | Description | Response headers |
|
|
322
|
+
|-------------|-------------|------------------|
|
|
323
|
+
| **200** | ListDnssecRecords 200 response | - |
|
|
324
|
+
| **400** | BadRequestError 400 response | - |
|
|
325
|
+
| **401** | UnauthorizedError 401 response | - |
|
|
326
|
+
| **403** | ForbiddenError 403 response | - |
|
|
327
|
+
| **404** | ResourceNotFoundError 404 response | - |
|
|
328
|
+
| **422** | ValidationError 422 response | - |
|
|
329
|
+
| **429** | TooManyRequestsError 429 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
330
|
+
| **500** | InternalServiceError 500 response | - |
|
|
331
|
+
| **503** | ServiceUnavailableError 503 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
332
|
+
|
|
333
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
334
|
+
|
|
335
|
+
|
|
254
336
|
## listDomains
|
|
255
337
|
|
|
256
338
|
> ListDomainsResponseContent listDomains()
|
|
@@ -548,6 +630,164 @@ example().catch(console.error);
|
|
|
548
630
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
549
631
|
|
|
550
632
|
|
|
633
|
+
## updateDomainContacts
|
|
634
|
+
|
|
635
|
+
> UpdateDomainContactsResponseContent updateDomainContacts(updateDomainContactsRequestContent)
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
Updates WHOIS contact information for an owned domain. Each role (Registrant, Admin, Tech, Billing) uses a source type: owner (client profile), contact (saved WHMCS contact id), or custom (inline WHOIS fields). WHOIS values must be nested under fields; for owner and contact they are flattened upstream when present.
|
|
640
|
+
|
|
641
|
+
### Example
|
|
642
|
+
|
|
643
|
+
```ts
|
|
644
|
+
import {
|
|
645
|
+
Configuration,
|
|
646
|
+
DomainsApi,
|
|
647
|
+
} from '@hostafrica/ha-sdk-typescript';
|
|
648
|
+
import type { UpdateDomainContactsRequest } from '@hostafrica/ha-sdk-typescript';
|
|
649
|
+
|
|
650
|
+
async function example() {
|
|
651
|
+
console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
|
|
652
|
+
const config = new Configuration({
|
|
653
|
+
// Configure HTTP bearer authorization: BearerAuth
|
|
654
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
655
|
+
});
|
|
656
|
+
const api = new DomainsApi(config);
|
|
657
|
+
|
|
658
|
+
const body = {
|
|
659
|
+
// UpdateDomainContactsRequestContent
|
|
660
|
+
updateDomainContactsRequestContent: ...,
|
|
661
|
+
} satisfies UpdateDomainContactsRequest;
|
|
662
|
+
|
|
663
|
+
try {
|
|
664
|
+
const data = await api.updateDomainContacts(body);
|
|
665
|
+
console.log(data);
|
|
666
|
+
} catch (error) {
|
|
667
|
+
console.error(error);
|
|
668
|
+
}
|
|
669
|
+
}
|
|
670
|
+
|
|
671
|
+
// Run the test
|
|
672
|
+
example().catch(console.error);
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
### Parameters
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
| Name | Type | Description | Notes |
|
|
679
|
+
|------------- | ------------- | ------------- | -------------|
|
|
680
|
+
| **updateDomainContactsRequestContent** | [UpdateDomainContactsRequestContent](UpdateDomainContactsRequestContent.md) | | |
|
|
681
|
+
|
|
682
|
+
### Return type
|
|
683
|
+
|
|
684
|
+
[**UpdateDomainContactsResponseContent**](UpdateDomainContactsResponseContent.md)
|
|
685
|
+
|
|
686
|
+
### Authorization
|
|
687
|
+
|
|
688
|
+
[BearerAuth](../README.md#BearerAuth)
|
|
689
|
+
|
|
690
|
+
### HTTP request headers
|
|
691
|
+
|
|
692
|
+
- **Content-Type**: `application/json`
|
|
693
|
+
- **Accept**: `application/json`
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
### HTTP response details
|
|
697
|
+
| Status code | Description | Response headers |
|
|
698
|
+
|-------------|-------------|------------------|
|
|
699
|
+
| **200** | UpdateDomainContacts 200 response | - |
|
|
700
|
+
| **400** | BadRequestError 400 response | - |
|
|
701
|
+
| **401** | UnauthorizedError 401 response | - |
|
|
702
|
+
| **403** | ForbiddenError 403 response | - |
|
|
703
|
+
| **404** | ResourceNotFoundError 404 response | - |
|
|
704
|
+
| **422** | ValidationError 422 response | - |
|
|
705
|
+
| **429** | TooManyRequestsError 429 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
706
|
+
| **500** | InternalServiceError 500 response | - |
|
|
707
|
+
| **503** | ServiceUnavailableError 503 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
708
|
+
|
|
709
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
## updateDomainNameservers
|
|
713
|
+
|
|
714
|
+
> UpdateDomainNameserversResponseContent updateDomainNameservers(updateDomainNameserversRequestContent)
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
|
|
718
|
+
Updates nameservers for an owned domain. ns1 and ns2 are required; ns3 through ns5 are optional.
|
|
719
|
+
|
|
720
|
+
### Example
|
|
721
|
+
|
|
722
|
+
```ts
|
|
723
|
+
import {
|
|
724
|
+
Configuration,
|
|
725
|
+
DomainsApi,
|
|
726
|
+
} from '@hostafrica/ha-sdk-typescript';
|
|
727
|
+
import type { UpdateDomainNameserversRequest } from '@hostafrica/ha-sdk-typescript';
|
|
728
|
+
|
|
729
|
+
async function example() {
|
|
730
|
+
console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
|
|
731
|
+
const config = new Configuration({
|
|
732
|
+
// Configure HTTP bearer authorization: BearerAuth
|
|
733
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
734
|
+
});
|
|
735
|
+
const api = new DomainsApi(config);
|
|
736
|
+
|
|
737
|
+
const body = {
|
|
738
|
+
// UpdateDomainNameserversRequestContent
|
|
739
|
+
updateDomainNameserversRequestContent: ...,
|
|
740
|
+
} satisfies UpdateDomainNameserversRequest;
|
|
741
|
+
|
|
742
|
+
try {
|
|
743
|
+
const data = await api.updateDomainNameservers(body);
|
|
744
|
+
console.log(data);
|
|
745
|
+
} catch (error) {
|
|
746
|
+
console.error(error);
|
|
747
|
+
}
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
// Run the test
|
|
751
|
+
example().catch(console.error);
|
|
752
|
+
```
|
|
753
|
+
|
|
754
|
+
### Parameters
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
| Name | Type | Description | Notes |
|
|
758
|
+
|------------- | ------------- | ------------- | -------------|
|
|
759
|
+
| **updateDomainNameserversRequestContent** | [UpdateDomainNameserversRequestContent](UpdateDomainNameserversRequestContent.md) | | |
|
|
760
|
+
|
|
761
|
+
### Return type
|
|
762
|
+
|
|
763
|
+
[**UpdateDomainNameserversResponseContent**](UpdateDomainNameserversResponseContent.md)
|
|
764
|
+
|
|
765
|
+
### Authorization
|
|
766
|
+
|
|
767
|
+
[BearerAuth](../README.md#BearerAuth)
|
|
768
|
+
|
|
769
|
+
### HTTP request headers
|
|
770
|
+
|
|
771
|
+
- **Content-Type**: `application/json`
|
|
772
|
+
- **Accept**: `application/json`
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
### HTTP response details
|
|
776
|
+
| Status code | Description | Response headers |
|
|
777
|
+
|-------------|-------------|------------------|
|
|
778
|
+
| **200** | UpdateDomainNameservers 200 response | - |
|
|
779
|
+
| **400** | BadRequestError 400 response | - |
|
|
780
|
+
| **401** | UnauthorizedError 401 response | - |
|
|
781
|
+
| **403** | ForbiddenError 403 response | - |
|
|
782
|
+
| **404** | ResourceNotFoundError 404 response | - |
|
|
783
|
+
| **422** | ValidationError 422 response | - |
|
|
784
|
+
| **429** | TooManyRequestsError 429 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
785
|
+
| **500** | InternalServiceError 500 response | - |
|
|
786
|
+
| **503** | ServiceUnavailableError 503 response | * Retry-After - Number of seconds to wait before retrying <br> |
|
|
787
|
+
|
|
788
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
789
|
+
|
|
790
|
+
|
|
551
791
|
## updateDomainSettings
|
|
552
792
|
|
|
553
793
|
> UpdateDomainSettingsResponseContent updateDomainSettings(updateDomainSettingsRequestContent)
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# EditDnsRecordRequestContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`domainName` | string
|
|
10
|
+
`zoneId` | string
|
|
11
|
+
`record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { EditDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescript'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"domainName": null,
|
|
21
|
+
"zoneId": null,
|
|
22
|
+
"record": null,
|
|
23
|
+
} satisfies EditDnsRecordRequestContent
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as EditDnsRecordRequestContent
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# EditDnsRecordResponseContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`status` | [OperationStatus](OperationStatus.md)
|
|
10
|
+
`data` | [DnsRecordMutationData](DnsRecordMutationData.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { EditDnsRecordResponseContent } from '@hostafrica/ha-sdk-typescript'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"status": null,
|
|
20
|
+
"data": null,
|
|
21
|
+
} satisfies EditDnsRecordResponseContent
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as EditDnsRecordResponseContent
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
|
|
2
|
+
# GetDnsZoneDetailsData
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`message` | string
|
|
10
|
+
`domainId` | string
|
|
11
|
+
`zoneId` | string
|
|
12
|
+
`zoneExists` | boolean
|
|
13
|
+
`managementAvailable` | boolean
|
|
14
|
+
`domainNameservers` | Array<string>
|
|
15
|
+
`nsChanging` | string
|
|
16
|
+
`packageSettings` | any
|
|
17
|
+
`records` | [Array<DnsRecordInfo>](DnsRecordInfo.md)
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```typescript
|
|
22
|
+
import type { GetDnsZoneDetailsData } from '@hostafrica/ha-sdk-typescript'
|
|
23
|
+
|
|
24
|
+
// TODO: Update the object below with actual values
|
|
25
|
+
const example = {
|
|
26
|
+
"message": null,
|
|
27
|
+
"domainId": null,
|
|
28
|
+
"zoneId": null,
|
|
29
|
+
"zoneExists": null,
|
|
30
|
+
"managementAvailable": null,
|
|
31
|
+
"domainNameservers": null,
|
|
32
|
+
"nsChanging": null,
|
|
33
|
+
"packageSettings": null,
|
|
34
|
+
"records": null,
|
|
35
|
+
} satisfies GetDnsZoneDetailsData
|
|
36
|
+
|
|
37
|
+
console.log(example)
|
|
38
|
+
|
|
39
|
+
// Convert the instance to a JSON string
|
|
40
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
41
|
+
console.log(exampleJSON)
|
|
42
|
+
|
|
43
|
+
// Parse the JSON string back to an object
|
|
44
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsData
|
|
45
|
+
console.log(exampleParsed)
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
49
|
+
|
|
50
|
+
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
|
|
2
|
+
# GetDnsZoneDetailsRequestContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`domainId` | string
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import type { GetDnsZoneDetailsRequestContent } from '@hostafrica/ha-sdk-typescript'
|
|
15
|
+
|
|
16
|
+
// TODO: Update the object below with actual values
|
|
17
|
+
const example = {
|
|
18
|
+
"domainId": null,
|
|
19
|
+
} satisfies GetDnsZoneDetailsRequestContent
|
|
20
|
+
|
|
21
|
+
console.log(example)
|
|
22
|
+
|
|
23
|
+
// Convert the instance to a JSON string
|
|
24
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
25
|
+
console.log(exampleJSON)
|
|
26
|
+
|
|
27
|
+
// Parse the JSON string back to an object
|
|
28
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsRequestContent
|
|
29
|
+
console.log(exampleParsed)
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
33
|
+
|
|
34
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# GetDnsZoneDetailsResponseContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`status` | [OperationStatus](OperationStatus.md)
|
|
10
|
+
`data` | [GetDnsZoneDetailsData](GetDnsZoneDetailsData.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { GetDnsZoneDetailsResponseContent } from '@hostafrica/ha-sdk-typescript'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"status": null,
|
|
20
|
+
"data": null,
|
|
21
|
+
} satisfies GetDnsZoneDetailsResponseContent
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as GetDnsZoneDetailsResponseContent
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
package/docs/GetDomainData.md
CHANGED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ListDnsCreateCandidatesData
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`message` | string
|
|
10
|
+
`candidates` | [Array<DnsCreateCandidateInfo>](DnsCreateCandidateInfo.md)
|
|
11
|
+
`total` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ListDnsCreateCandidatesData } from '@hostafrica/ha-sdk-typescript'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"message": null,
|
|
21
|
+
"candidates": null,
|
|
22
|
+
"total": null,
|
|
23
|
+
} satisfies ListDnsCreateCandidatesData
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListDnsCreateCandidatesData
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
|
|
2
|
+
# ListDnsCreateCandidatesResponseContent
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`status` | [OperationStatus](OperationStatus.md)
|
|
10
|
+
`data` | [ListDnsCreateCandidatesData](ListDnsCreateCandidatesData.md)
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import type { ListDnsCreateCandidatesResponseContent } from '@hostafrica/ha-sdk-typescript'
|
|
16
|
+
|
|
17
|
+
// TODO: Update the object below with actual values
|
|
18
|
+
const example = {
|
|
19
|
+
"status": null,
|
|
20
|
+
"data": null,
|
|
21
|
+
} satisfies ListDnsCreateCandidatesResponseContent
|
|
22
|
+
|
|
23
|
+
console.log(example)
|
|
24
|
+
|
|
25
|
+
// Convert the instance to a JSON string
|
|
26
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
27
|
+
console.log(exampleJSON)
|
|
28
|
+
|
|
29
|
+
// Parse the JSON string back to an object
|
|
30
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListDnsCreateCandidatesResponseContent
|
|
31
|
+
console.log(exampleParsed)
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
|
|
2
|
+
# ListDnsZonesData
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type
|
|
8
|
+
------------ | -------------
|
|
9
|
+
`message` | string
|
|
10
|
+
`zones` | [Array<DnsZoneInfo>](DnsZoneInfo.md)
|
|
11
|
+
`total` | number
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import type { ListDnsZonesData } from '@hostafrica/ha-sdk-typescript'
|
|
17
|
+
|
|
18
|
+
// TODO: Update the object below with actual values
|
|
19
|
+
const example = {
|
|
20
|
+
"message": null,
|
|
21
|
+
"zones": null,
|
|
22
|
+
"total": null,
|
|
23
|
+
} satisfies ListDnsZonesData
|
|
24
|
+
|
|
25
|
+
console.log(example)
|
|
26
|
+
|
|
27
|
+
// Convert the instance to a JSON string
|
|
28
|
+
const exampleJSON: string = JSON.stringify(example)
|
|
29
|
+
console.log(exampleJSON)
|
|
30
|
+
|
|
31
|
+
// Parse the JSON string back to an object
|
|
32
|
+
const exampleParsed = JSON.parse(exampleJSON) as ListDnsZonesData
|
|
33
|
+
console.log(exampleParsed)
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
37
|
+
|
|
38
|
+
|