@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.4

package/docs/DNSApi.md

@@ -4,12 +4,97 @@ All URIs are relative to *https://api.hostafrica.com*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**addDnsRecord**](DNSApi.md#adddnsrecord) | **POST** /dns/add-record |  |
 | [**createRdnsRecord**](DNSApi.md#createrdnsrecord) | **POST** /dns/create-rdns-record |  |
+| [**deleteDnsRecord**](DNSApi.md#deletednsrecord) | **POST** /dns/delete-record |  |
 | [**deleteRdnsRecord**](DNSApi.md#deleterdnsrecord) | **POST** /dns/delete-rdns-record |  |
+| [**editDnsRecord**](DNSApi.md#editdnsrecord) | **POST** /dns/edit-record |  |
+| [**getDnsZoneDetails**](DNSApi.md#getdnszonedetails) | **POST** /dns/get-zone |  |
+| [**listDnsCreateCandidates**](DNSApi.md#listdnscreatecandidates) | **POST** /dns/list-create-candidates |  |
+| [**listDnsZones**](DNSApi.md#listdnszones) | **POST** /dns/list-zones |  |
 | [**listRdnsRecords**](DNSApi.md#listrdnsrecords) | **POST** /dns/list-rdns-records |  |
 
 
 
+## addDnsRecord
+
+> AddDnsRecordResponseContent addDnsRecord(addDnsRecordRequestContent)
+
+
+
+Adds a DNS record to a zone via DNSManager.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { AddDnsRecordRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  const body = {
+    // AddDnsRecordRequestContent
+    addDnsRecordRequestContent: ...,
+  } satisfies AddDnsRecordRequest;
+
+  try {
+    const data = await api.addDnsRecord(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **addDnsRecordRequestContent** | [AddDnsRecordRequestContent](AddDnsRecordRequestContent.md) |  | |
+
+### Return type
+
+[**AddDnsRecordResponseContent**](AddDnsRecordResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | AddDnsRecord 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## createRdnsRecord
 
 > CreateRdnsRecordResponseContent createRdnsRecord(createRdnsRecordRequestContent)
@@ -89,6 +174,85 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteDnsRecord
+
+> DeleteDnsRecordResponseContent deleteDnsRecord(deleteDnsRecordRequestContent)
+
+
+
+Deletes a DNS record from a zone via DNSManager.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { DeleteDnsRecordRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  const body = {
+    // DeleteDnsRecordRequestContent
+    deleteDnsRecordRequestContent: ...,
+  } satisfies DeleteDnsRecordRequest;
+
+  try {
+    const data = await api.deleteDnsRecord(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deleteDnsRecordRequestContent** | [DeleteDnsRecordRequestContent](DeleteDnsRecordRequestContent.md) |  | |
+
+### Return type
+
+[**DeleteDnsRecordResponseContent**](DeleteDnsRecordResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | DeleteDnsRecord 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteRdnsRecord
 
 > DeleteRdnsRecordResponseContent deleteRdnsRecord(deleteRdnsRecordRequestContent)
@@ -168,6 +332,304 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## editDnsRecord
+
+> EditDnsRecordResponseContent editDnsRecord(editDnsRecordRequestContent)
+
+
+
+Edits a DNS record in a zone via DNSManager.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { EditDnsRecordRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  const body = {
+    // EditDnsRecordRequestContent
+    editDnsRecordRequestContent: ...,
+  } satisfies EditDnsRecordRequest;
+
+  try {
+    const data = await api.editDnsRecord(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **editDnsRecordRequestContent** | [EditDnsRecordRequestContent](EditDnsRecordRequestContent.md) |  | |
+
+### Return type
+
+[**EditDnsRecordResponseContent**](EditDnsRecordResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | EditDnsRecord 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getDnsZoneDetails
+
+> GetDnsZoneDetailsResponseContent getDnsZoneDetails(getDnsZoneDetailsRequestContent)
+
+
+
+Retrieves DNS zone details and records for an owned domain.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { GetDnsZoneDetailsRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  const body = {
+    // GetDnsZoneDetailsRequestContent
+    getDnsZoneDetailsRequestContent: ...,
+  } satisfies GetDnsZoneDetailsRequest;
+
+  try {
+    const data = await api.getDnsZoneDetails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getDnsZoneDetailsRequestContent** | [GetDnsZoneDetailsRequestContent](GetDnsZoneDetailsRequestContent.md) |  | |
+
+### Return type
+
+[**GetDnsZoneDetailsResponseContent**](GetDnsZoneDetailsResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | GetDnsZoneDetails 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDnsCreateCandidates
+
+> ListDnsCreateCandidatesResponseContent listDnsCreateCandidates()
+
+
+
+Lists domains and services eligible for new DNS zone creation.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { ListDnsCreateCandidatesRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  try {
+    const data = await api.listDnsCreateCandidates();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDnsCreateCandidatesResponseContent**](ListDnsCreateCandidatesResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | ListDnsCreateCandidates 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listDnsZones
+
+> ListDnsZonesResponseContent listDnsZones()
+
+
+
+Lists DNS zones belonging to the authenticated client.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DNSApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { ListDnsZonesRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DNSApi(config);
+
+  try {
+    const data = await api.listDnsZones();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDnsZonesResponseContent**](ListDnsZonesResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | ListDnsZones 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listRdnsRecords
 
 > ListRdnsRecordsResponseContent listRdnsRecords()

package/docs/DeleteDnsRecordRequestContent.md

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