@hostafrica/ha-sdk-typescript 1.1.4 → 1.1.5

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

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hostafrica/ha-sdk-typescript",
-  "version": "1.1.4",
+  "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();
+    }
+
+}

package/src/apis/DNSApi.ts

@@ -158,7 +158,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async addDnsRecordRaw(requestParameters: AddDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddDnsRecordResponseContent>> {
         const requestOptions = await this.addDnsRecordRequestOpts(requestParameters);
@@ -168,7 +168,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async addDnsRecord(requestParameters: AddDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddDnsRecordResponseContent> {
         const response = await this.addDnsRecordRaw(requestParameters, initOverrides);
@@ -268,7 +268,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async deleteDnsRecordRaw(requestParameters: DeleteDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteDnsRecordResponseContent>> {
         const requestOptions = await this.deleteDnsRecordRequestOpts(requestParameters);
@@ -278,7 +278,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async deleteDnsRecord(requestParameters: DeleteDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteDnsRecordResponseContent> {
         const response = await this.deleteDnsRecordRaw(requestParameters, initOverrides);
@@ -378,7 +378,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async editDnsRecordRaw(requestParameters: EditDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EditDnsRecordResponseContent>> {
         const requestOptions = await this.editDnsRecordRequestOpts(requestParameters);
@@ -388,7 +388,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async editDnsRecord(requestParameters: EditDnsRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EditDnsRecordResponseContent> {
         const response = await this.editDnsRecordRaw(requestParameters, initOverrides);
@@ -433,7 +433,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async getDnsZoneDetailsRaw(requestParameters: GetDnsZoneDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDnsZoneDetailsResponseContent>> {
         const requestOptions = await this.getDnsZoneDetailsRequestOpts(requestParameters);
@@ -443,7 +443,7 @@ export class DNSApi extends runtime.BaseAPI {
     }
 
     /**
-     * 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.
      */
     async getDnsZoneDetails(requestParameters: GetDnsZoneDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDnsZoneDetailsResponseContent> {
         const response = await this.getDnsZoneDetailsRaw(requestParameters, initOverrides);

package/src/apis/index.ts

@@ -1,6 +1,7 @@
 /* tslint:disable */
 /* eslint-disable */
 export * from './BackupsApi.js';
+export * from './BillingApi.js';
 export * from './ConsoleAccessApi.js';
 export * from './DNSApi.js';
 export * from './DomainsApi.js';