@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.4

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)
+
+

package/docs/NoVncConsoleDetails.md

@@ -8,6 +8,9 @@ noVNC console connection details
 Name | Type
 ------------ | -------------
 `novncRedirectUrl` | string
+`mode` | string
+`websocketUrl` | string
+`password` | string
 
 ## Example
 
@@ -17,6 +20,9 @@ import type { NoVncConsoleDetails } from '@hostafrica/ha-sdk-typescript'
 // TODO: Update the object below with actual values
 const example = {
   "novncRedirectUrl": null,
+  "mode": null,
+  "websocketUrl": null,
+  "password": null,
 } satisfies NoVncConsoleDetails
 
 console.log(example)

package/docs/PasswordEncryptionInfo.md

@@ -0,0 +1,41 @@
+
+# PasswordEncryptionInfo
+
+Encryption metadata for an RSA-OAEP encrypted password
+
+## Properties
+
+Name | Type
+------------ | -------------
+`algorithm` | string
+`hash` | string
+`keySize` | number
+`encoding` | string
+
+## Example
+
+```typescript
+import type { PasswordEncryptionInfo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "algorithm": null,
+  "hash": null,
+  "keySize": null,
+  "encoding": null,
+} satisfies PasswordEncryptionInfo
+
+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 PasswordEncryptionInfo
+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/ServiceManagementApi.md

@@ -99,7 +99,7 @@ example().catch(console.error);
 
 
 
-Creates an order through checkout. Returns payment status; on failure also includes payment_error with code and message.
+Creates an order for a VPS service. Returns payment status; on failure also includes payment_error with code and message.
 
 ### Example
 
@@ -406,7 +406,7 @@ example().catch(console.error);
 
 
 
-Validates pricing for one or more products, returning per-product breakdown and order summary
+Validates pricing for one or more VPC service products, returning per-product breakdown and order summary
 
 ### Example
 

package/docs/SnapshotsApi.md

@@ -101,7 +101,7 @@ example().catch(console.error);
 
 
 
-[Under development] Creates a new snapshot job for a VPS service. Use period=\'hourly\' with run_every, or period=\'daily\' with days and start_time.
+Creates a new snapshot job for a VPS service. Use period=\'hourly\' with run_every, or period=\'daily\' with days and start_time.
 
 ### Example
 
@@ -259,7 +259,7 @@ example().catch(console.error);
 
 
 
-[Under development]Deletes a snapshot job from a VPS service
+Deletes a snapshot job from a VPS service
 
 ### Example
 
@@ -338,7 +338,7 @@ example().catch(console.error);
 
 
 
-[Under development]Retrieves the list of snapshot jobs for a VPS service
+Retrieves the list of snapshot jobs for a VPS service
 
 ### Example
 
@@ -654,7 +654,7 @@ example().catch(console.error);
 
 
 
-[Under development] Updates an existing snapshot job. Only provide fields you want to change.
+Updates an existing snapshot job. Only provide fields you want to change.
 
 ### Example
 

package/docs/UpdateDomainContactsData.md

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

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

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

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

@@ -0,0 +1,44 @@
+
+# UpdateDomainNameserversRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`domainId` | string
+`ns1` | string
+`ns2` | string
+`ns3` | string
+`ns4` | string
+`ns5` | string
+
+## Example
+
+```typescript
+import type { UpdateDomainNameserversRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "domainId": null,
+  "ns1": null,
+  "ns2": null,
+  "ns3": null,
+  "ns4": null,
+  "ns5": null,
+} satisfies UpdateDomainNameserversRequestContent
+
+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 UpdateDomainNameserversRequestContent
+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/UpdateDomainNameserversResponseContent.md

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

@@ -4,6 +4,7 @@ All URIs are relative to *https://api.hostafrica.com*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**getEncryptedPassword**](VPSManagementApi.md#getencryptedpassword) | **POST** /vps/get-encrypted-password |  |
 | [**getVpsConfig**](VPSManagementApi.md#getvpsconfig) | **POST** /vps/get-config |  |
 | [**getVpsDetails**](VPSManagementApi.md#getvpsdetails) | **POST** /vps/get-details |  |
 | [**listIsos**](VPSManagementApi.md#listisos) | **POST** /vps/list-isos |  |
@@ -15,6 +16,85 @@ All URIs are relative to *https://api.hostafrica.com*
 
 
 
+## getEncryptedPassword
+
+> GetEncryptedPasswordResponseContent getEncryptedPassword(getEncryptedPasswordRequestContent)
+
+
+
+Retrieves the VPS username and root password without exposing plaintext over the API. Send a PEM-encoded RSA 4096-bit public key; the API encrypts the password with RSA-OAEP (SHA-256), and returns base64 ciphertext plus encryption metadata. Never send the private key. Invalid or non-4096-bit keys return HTTP 422 ValidationError. Generate a key with: openssl genrsa -out private.pem 4096 && openssl rsa -in private.pem -pubout -out public.pem. Decrypt with: echo CIPHERTEXT | base64 -d | openssl pkeyutl -decrypt -inkey private.pem -pkeyopt rsa_padding_mode:oaep -pkeyopt rsa_oaep_md:sha256 -pkeyopt rsa_mgf1_md:sha256 (macOS: base64 -D).
+
+### Example
+
+```ts
+import {
+  Configuration,
+  VPSManagementApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { GetEncryptedPasswordRequest } 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 VPSManagementApi(config);
+
+  const body = {
+    // GetEncryptedPasswordRequestContent
+    getEncryptedPasswordRequestContent: ...,
+  } satisfies GetEncryptedPasswordRequest;
+
+  try {
+    const data = await api.getEncryptedPassword(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getEncryptedPasswordRequestContent** | [GetEncryptedPasswordRequestContent](GetEncryptedPasswordRequestContent.md) |  | |
+
+### Return type
+
+[**GetEncryptedPasswordResponseContent**](GetEncryptedPasswordResponseContent.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** | GetEncryptedPassword 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)
+
+
 ## getVpsConfig
 
 > GetVpsConfigResponseContent getVpsConfig(getVpsConfigRequestContent)
@@ -100,7 +180,7 @@ example().catch(console.error);
 
 
 
-Gets detailed information about a VPS service including configuration, network settings, and statistics
+Gets detailed information about a VPS service including configuration, network settings, and statistics. Credentials.password is always \&quot;&lt;redacted&gt;\&quot;; plaintext passwords are never returned. To retrieve the password securely, use GetEncryptedPassword (/vps/get-encrypted-password).
 
 ### Example
 

package/docs/VpsDetailsResponse.md

@@ -12,7 +12,7 @@ Name | Type
 `memory` | [VpsMemoryInfo](VpsMemoryInfo.md)
 `disk` | [VpsDiskInfo](VpsDiskInfo.md)
 `networkRate` | [VpsNetworkRate](VpsNetworkRate.md)
-`ipAddresses` | Array<string>
+`ipAddresses` | [Array<VpsIpAddressDetail>](VpsIpAddressDetail.md)
 `credentials` | [VpsCredentials](VpsCredentials.md)
 `availableFeatures` | [VpsAvailableFeatures](VpsAvailableFeatures.md)
 `osInfo` | [VpsOsInfo](VpsOsInfo.md)

package/docs/VpsIpAddressDetail.md

@@ -0,0 +1,43 @@
+
+# VpsIpAddressDetail
+
+Detailed IP address assignment for a VPS
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ip` | string
+`address` | string
+`subnet` | string
+`gateway` | string
+`mac` | string
+
+## Example
+
+```typescript
+import type { VpsIpAddressDetail } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "ip": null,
+  "address": null,
+  "subnet": null,
+  "gateway": null,
+  "mac": null,
+} satisfies VpsIpAddressDetail
+
+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 VpsIpAddressDetail
+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)
+
+