@hostafrica/ha-sdk-typescript 1.1.3 → 1.1.5

package/docs/InvoiceItem.md

@@ -0,0 +1,43 @@
+
+# InvoiceItem
+
+A single invoice line item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`type` | string
+`description` | string
+`amount` | string
+`taxed` | number
+
+## Example
+
+```typescript
+import type { InvoiceItem } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "description": null,
+  "amount": null,
+  "taxed": null,
+} satisfies InvoiceItem
+
+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 InvoiceItem
+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/InvoiceSummary.md

@@ -0,0 +1,57 @@
+
+# InvoiceSummary
+
+Summary of an invoice in the list-invoices response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`invoiceId` | string
+`invoiceNumber` | string
+`date` | string
+`dueDate` | string
+`status` | string
+`tax` | string
+`tax2` | string
+`taxRate` | string
+`taxRate2` | string
+`total` | string
+`subtotal` | string
+`grandTotal` | string
+
+## Example
+
+```typescript
+import type { InvoiceSummary } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "invoiceId": null,
+  "invoiceNumber": null,
+  "date": null,
+  "dueDate": null,
+  "status": null,
+  "tax": null,
+  "tax2": null,
+  "taxRate": null,
+  "taxRate2": null,
+  "total": null,
+  "subtotal": null,
+  "grandTotal": null,
+} satisfies InvoiceSummary
+
+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 InvoiceSummary
+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/InvoiceTransaction.md

@@ -0,0 +1,49 @@
+
+# InvoiceTransaction
+
+A payment or refund transaction recorded against an invoice
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`gateway` | string
+`date` | string
+`description` | string
+`amountIn` | string
+`fees` | string
+`amountOut` | string
+`transId` | string
+
+## Example
+
+```typescript
+import type { InvoiceTransaction } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "gateway": null,
+  "date": null,
+  "description": null,
+  "amountIn": null,
+  "fees": null,
+  "amountOut": null,
+  "transId": null,
+} satisfies InvoiceTransaction
+
+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 InvoiceTransaction
+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/ListInvoicesResponseContent.md

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

@@ -0,0 +1,37 @@
+
+# ListInvoicesResponseData
+
+Top-level data payload for the ListInvoices response
+
+## Properties
+
+Name | Type
+------------ | -------------
+`invoices` | [Array<InvoiceSummary>](InvoiceSummary.md)
+`totalCount` | number
+
+## Example
+
+```typescript
+import type { ListInvoicesResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "invoices": null,
+  "totalCount": null,
+} satisfies ListInvoicesResponseData
+
+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 ListInvoicesResponseData
+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/SelcomMetadata.md

@@ -0,0 +1,43 @@
+
+# SelcomMetadata
+
+Selcom alt-gateway payment details included on an invoice when configured
+
+## Properties
+
+Name | Type
+------------ | -------------
+`amount` | string
+`pesaAccount` | string
+`mobileReference` | string
+`ussdCode` | string
+`instructions` | string
+
+## Example
+
+```typescript
+import type { SelcomMetadata } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "amount": null,
+  "pesaAccount": null,
+  "mobileReference": null,
+  "ussdCode": null,
+  "instructions": null,
+} satisfies SelcomMetadata
+
+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 SelcomMetadata
+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)
+
+

package/docs/VpsVmInfo.md

@@ -11,7 +11,7 @@ Name | Type
 `uptime` | string
 `uptimeSeconds` | number
 `hostname` | string
-`bootDevices` | string
+`bootDevices` | Array<string>
 `vmid` | string
 `node` | string
 `virtualization` | string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hostafrica/ha-sdk-typescript",
-  "version": "1.1.3",
+  "version": "1.1.5",
   "description": "HostAfrica API TypeScript SDK",
   "author": "HostAfrica",
   "repository": {

package/src/apis/BillingApi.ts

@@ -0,0 +1,164 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 1.1.0 - 2026-07-16
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import * as runtime from '../runtime.js';
+import type {
+  BadRequestErrorResponseContent,
+  ForbiddenErrorResponseContent,
+  GetInvoiceDetailsRequestContent,
+  GetInvoiceDetailsResponseContent,
+  InternalServiceErrorResponseContent,
+  ListInvoicesResponseContent,
+  ResourceNotFoundErrorResponseContent,
+  ServiceUnavailableErrorResponseContent,
+  TooManyRequestsErrorResponseContent,
+  UnauthorizedErrorResponseContent,
+  ValidationErrorResponseContent,
+} from '../models/index.js';
+import {
+    BadRequestErrorResponseContentFromJSON,
+    BadRequestErrorResponseContentToJSON,
+    ForbiddenErrorResponseContentFromJSON,
+    ForbiddenErrorResponseContentToJSON,
+    GetInvoiceDetailsRequestContentFromJSON,
+    GetInvoiceDetailsRequestContentToJSON,
+    GetInvoiceDetailsResponseContentFromJSON,
+    GetInvoiceDetailsResponseContentToJSON,
+    InternalServiceErrorResponseContentFromJSON,
+    InternalServiceErrorResponseContentToJSON,
+    ListInvoicesResponseContentFromJSON,
+    ListInvoicesResponseContentToJSON,
+    ResourceNotFoundErrorResponseContentFromJSON,
+    ResourceNotFoundErrorResponseContentToJSON,
+    ServiceUnavailableErrorResponseContentFromJSON,
+    ServiceUnavailableErrorResponseContentToJSON,
+    TooManyRequestsErrorResponseContentFromJSON,
+    TooManyRequestsErrorResponseContentToJSON,
+    UnauthorizedErrorResponseContentFromJSON,
+    UnauthorizedErrorResponseContentToJSON,
+    ValidationErrorResponseContentFromJSON,
+    ValidationErrorResponseContentToJSON,
+} from '../models/index.js';
+
+export interface GetInvoiceDetailsRequest {
+    getInvoiceDetailsRequestContent: GetInvoiceDetailsRequestContent;
+}
+
+/**
+ * 
+ */
+export class BillingApi extends runtime.BaseAPI {
+
+    /**
+     * Creates request options for getInvoiceDetails without sending the request
+     */
+    async getInvoiceDetailsRequestOpts(requestParameters: GetInvoiceDetailsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['getInvoiceDetailsRequestContent'] == null) {
+            throw new runtime.RequiredError(
+                'getInvoiceDetailsRequestContent',
+                'Required parameter "getInvoiceDetailsRequestContent" was null or undefined when calling getInvoiceDetails().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/billing/get-invoice-details`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: GetInvoiceDetailsRequestContentToJSON(requestParameters['getInvoiceDetailsRequestContent']),
+        };
+    }
+
+    /**
+     * Gets details for a single invoice, including line items, payee information, and transactions
+     */
+    async getInvoiceDetailsRaw(requestParameters: GetInvoiceDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetInvoiceDetailsResponseContent>> {
+        const requestOptions = await this.getInvoiceDetailsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetInvoiceDetailsResponseContentFromJSON(jsonValue));
+    }
+
+    /**
+     * Gets details for a single invoice, including line items, payee information, and transactions
+     */
+    async getInvoiceDetails(requestParameters: GetInvoiceDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetInvoiceDetailsResponseContent> {
+        const response = await this.getInvoiceDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listInvoices without sending the request
+     */
+    async listInvoicesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("BearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/billing/list-invoices`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Lists invoices for the authenticated user
+     */
+    async listInvoicesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListInvoicesResponseContent>> {
+        const requestOptions = await this.listInvoicesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ListInvoicesResponseContentFromJSON(jsonValue));
+    }
+
+    /**
+     * Lists invoices for the authenticated user
+     */
+    async listInvoices(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListInvoicesResponseContent> {
+        const response = await this.listInvoicesRaw(initOverrides);
+        return await response.value();
+    }
+
+}