@hostafrica/ha-sdk-typescript 1.1.3 → 1.1.5

package/docs/BillingApi.md

@@ -0,0 +1,159 @@
+# BillingApi
+
+All URIs are relative to *https://api.hostafrica.com*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getInvoiceDetails**](BillingApi.md#getinvoicedetails) | **POST** /billing/get-invoice-details |  |
+| [**listInvoices**](BillingApi.md#listinvoices) | **POST** /billing/list-invoices |  |
+
+
+
+## getInvoiceDetails
+
+> GetInvoiceDetailsResponseContent getInvoiceDetails(getInvoiceDetailsRequestContent)
+
+
+
+Gets details for a single invoice, including line items, payee information, and transactions
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { GetInvoiceDetailsRequest } 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 BillingApi(config);
+
+  const body = {
+    // GetInvoiceDetailsRequestContent
+    getInvoiceDetailsRequestContent: ...,
+  } satisfies GetInvoiceDetailsRequest;
+
+  try {
+    const data = await api.getInvoiceDetails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **getInvoiceDetailsRequestContent** | [GetInvoiceDetailsRequestContent](GetInvoiceDetailsRequestContent.md) |  | |
+
+### Return type
+
+[**GetInvoiceDetailsResponseContent**](GetInvoiceDetailsResponseContent.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** | GetInvoiceDetails 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)
+
+
+## listInvoices
+
+> ListInvoicesResponseContent listInvoices()
+
+
+
+Lists invoices for the authenticated user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BillingApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { ListInvoicesRequest } 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 BillingApi(config);
+
+  try {
+    const data = await api.listInvoices();
+    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
+
+[**ListInvoicesResponseContent**](ListInvoicesResponseContent.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** | ListInvoices 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)
+

package/docs/DNSApi.md

@@ -22,7 +22,7 @@ All URIs are relative to *https://api.hostafrica.com*
 
 
 
-Adds a DNS record to a zone via DNSManager.
+Adds a DNS record to a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
 
 ### Example
 
@@ -180,7 +180,7 @@ example().catch(console.error);
 
 
 
-Deletes a DNS record from a zone via DNSManager.
+Deletes a DNS record from a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
 
 ### Example
 
@@ -338,7 +338,7 @@ example().catch(console.error);
 
 
 
-Edits a DNS record in a zone via DNSManager.
+Edits a DNS record in a zone. Legacy callers pass zone_id only (DNS Manager v1). For DirectAdmin, pass backend=directadmin with domain_id; upstream v2 receives domain_id and record only.
 
 ### Example
 
@@ -417,7 +417,7 @@ example().catch(console.error);
 
 
 
-Retrieves DNS zone details and records for an owned domain.
+Retrieves DNS zone details and records for an owned domain. Omit backend for the legacy DNS Manager (v1) path; set backend from list-dns-zones to route DirectAdmin zones to v2.
 
 ### Example
 

package/docs/DeleteDnsRecordRequestContent.md

@@ -8,6 +8,9 @@ Name | Type
 ------------ | -------------
 `domainName` | string
 `zoneId` | string
+`domainId` | string
+`serviceId` | number
+`backend` | [DnsBackend](DnsBackend.md)
 `record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
 
 ## Example
@@ -19,6 +22,9 @@ import type { DeleteDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescrip
 const example = {
   "domainName": null,
   "zoneId": null,
+  "domainId": null,
+  "serviceId": null,
+  "backend": null,
   "record": null,
 } satisfies DeleteDnsRecordRequestContent
 

package/docs/DnsBackend.md

@@ -0,0 +1,33 @@
+
+# DnsBackend
+
+Upstream DNS management backend for a zone.  - `dns_manager` — WHMCS DNS Manager - `directadmin` — DirectAdmin DNS
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DnsBackend } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DnsBackend
+
+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 DnsBackend
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/DnsRecordMutationRecord.md

@@ -1,7 +1,7 @@
 
 # DnsRecordMutationRecord
 
-DNS record fields for add, edit, or delete via DNSManager.  See `DnsRecordInfo` for how `content` and structured fields map to upstream record data. Delete requires only `id`, `name`, and `type`.
+DNS record fields for add, edit, or delete via DNSManager.  See `DnsRecordInfo` for how `content` and structured fields map to upstream record data. Delete requires only `id`, `name`, and `type`. For edit and delete, `id` must be the numeric zone line from get-dns-zone-details (a positive integer string).
 
 ## Properties
 

package/docs/DnsZoneInfo.md

@@ -16,6 +16,7 @@ Name | Type
 `packageName` | string
 `hasHosting` | [DomainHostingLink](DomainHostingLink.md)
 `hasDnsManagerZone` | boolean
+`backend` | [DnsBackend](DnsBackend.md)
 
 ## Example
 
@@ -33,6 +34,7 @@ const example = {
   "packageName": null,
   "hasHosting": null,
   "hasDnsManagerZone": null,
+  "backend": null,
 } satisfies DnsZoneInfo
 
 console.log(example)

package/docs/EditDnsRecordRequestContent.md

@@ -8,6 +8,9 @@ Name | Type
 ------------ | -------------
 `domainName` | string
 `zoneId` | string
+`domainId` | string
+`serviceId` | number
+`backend` | [DnsBackend](DnsBackend.md)
 `record` | [DnsRecordMutationRecord](DnsRecordMutationRecord.md)
 
 ## Example
@@ -19,6 +22,9 @@ import type { EditDnsRecordRequestContent } from '@hostafrica/ha-sdk-typescript'
 const example = {
   "domainName": null,
   "zoneId": null,
+  "domainId": null,
+  "serviceId": null,
+  "backend": null,
   "record": null,
 } satisfies EditDnsRecordRequestContent
 

package/docs/EncryptedPasswordResponseData.md

@@ -0,0 +1,39 @@
+
+# EncryptedPasswordResponseData
+
+Response data for get-encrypted-password
+
+## Properties
+
+Name | Type
+------------ | -------------
+`username` | string
+`password` | string
+`encryption` | [PasswordEncryptionInfo](PasswordEncryptionInfo.md)
+
+## Example
+
+```typescript
+import type { EncryptedPasswordResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "username": null,
+  "password": null,
+  "encryption": null,
+} satisfies EncryptedPasswordResponseData
+
+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 EncryptedPasswordResponseData
+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/GetDnsZoneDetailsRequestContent.md

@@ -7,6 +7,7 @@
 Name | Type
 ------------ | -------------
 `domainId` | string
+`backend` | [DnsBackend](DnsBackend.md)
 
 ## Example
 
@@ -16,6 +17,7 @@ import type { GetDnsZoneDetailsRequestContent } from '@hostafrica/ha-sdk-typescr
 // TODO: Update the object below with actual values
 const example = {
   "domainId": null,
+  "backend": null,
 } satisfies GetDnsZoneDetailsRequestContent
 
 console.log(example)

package/docs/GetEncryptedPasswordRequestContent.md

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

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

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

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

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

@@ -0,0 +1,71 @@
+
+# InvoiceDetails
+
+Full invoice details
+
+## Properties
+
+Name | Type
+------------ | -------------
+`invoiceId` | string
+`invoiceNumber` | string
+`issuedTo` | [InvoiceIssuedTo](InvoiceIssuedTo.md)
+`date` | string
+`dueDate` | string
+`datePaid` | string
+`subtotal` | string
+`credit` | string
+`tax` | string
+`tax2` | string
+`total` | string
+`taxRate` | string
+`taxRate2` | string
+`status` | string
+`paymentMethod` | string
+`totalDue` | string
+`notes` | string
+`items` | [Array<InvoiceItem>](InvoiceItem.md)
+`transactions` | [Array<InvoiceTransaction>](InvoiceTransaction.md)
+
+## Example
+
+```typescript
+import type { InvoiceDetails } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "invoiceId": null,
+  "invoiceNumber": null,
+  "issuedTo": null,
+  "date": null,
+  "dueDate": null,
+  "datePaid": null,
+  "subtotal": null,
+  "credit": null,
+  "tax": null,
+  "tax2": null,
+  "total": null,
+  "taxRate": null,
+  "taxRate2": null,
+  "status": null,
+  "paymentMethod": null,
+  "totalDue": null,
+  "notes": null,
+  "items": null,
+  "transactions": null,
+} satisfies InvoiceDetails
+
+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 InvoiceDetails
+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/InvoiceIssuedTo.md

@@ -0,0 +1,47 @@
+
+# InvoiceIssuedTo
+
+Recipient / billed-to details on an invoice
+
+## Properties
+
+Name | Type
+------------ | -------------
+`companyName` | string
+`fullName` | string
+`address` | string
+`cityStateZip` | string
+`country` | string
+`countryName` | string
+`tax` | [InvoiceIssuedToTax](InvoiceIssuedToTax.md)
+
+## Example
+
+```typescript
+import type { InvoiceIssuedTo } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "companyName": null,
+  "fullName": null,
+  "address": null,
+  "cityStateZip": null,
+  "country": null,
+  "countryName": null,
+  "tax": null,
+} satisfies InvoiceIssuedTo
+
+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 InvoiceIssuedTo
+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/InvoiceIssuedToTax.md

@@ -0,0 +1,39 @@
+
+# InvoiceIssuedToTax
+
+Tax applied to the invoice recipient
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`rate` | number
+`level` | number
+
+## Example
+
+```typescript
+import type { InvoiceIssuedToTax } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "rate": null,
+  "level": null,
+} satisfies InvoiceIssuedToTax
+
+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 InvoiceIssuedToTax
+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)
+
+