@hostafrica/ha-sdk-typescript 1.1.4 → 1.1.5

package/src/models/InvoiceSummary.ts

@@ -0,0 +1,163 @@
+/* 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 { mapValues } from '../runtime.js';
+/**
+ * Summary of an invoice in the list-invoices response
+ * @export
+ * @interface InvoiceSummary
+ */
+export interface InvoiceSummary {
+    /**
+     * Unique invoice identifier - must be sent as a string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    invoiceId: string;
+    /**
+     * Human-readable invoice number when assigned
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    invoiceNumber: string;
+    /**
+     * Invoice issue date (ISO 8601)
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    date: string;
+    /**
+     * Invoice due date (ISO 8601)
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    dueDate: string;
+    /**
+     * Invoice status (e.g. Paid, Unpaid, Cancelled, Refunded)
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    status: string;
+    /**
+     * Primary tax amount as a decimal string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    tax: string;
+    /**
+     * Secondary tax amount as a decimal string. Omitted when a second tax is not configured.
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    tax2?: string;
+    /**
+     * Primary tax rate as a decimal string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    taxRate: string;
+    /**
+     * Secondary tax rate as a decimal string. Omitted when a second tax is not configured.
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    taxRate2?: string;
+    /**
+     * Invoice total including tax as a decimal string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    total: string;
+    /**
+     * Invoice subtotal excluding tax as a decimal string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    subtotal: string;
+    /**
+     * Grand total as a decimal string
+     * @type {string}
+     * @memberof InvoiceSummary
+     */
+    grandTotal: string;
+}
+
+/**
+ * Check if a given object implements the InvoiceSummary interface.
+ */
+export function instanceOfInvoiceSummary(value: object): value is InvoiceSummary {
+    if (!('invoiceId' in value) || value['invoiceId'] === undefined) return false;
+    if (!('invoiceNumber' in value) || value['invoiceNumber'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('dueDate' in value) || value['dueDate'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('tax' in value) || value['tax'] === undefined) return false;
+    if (!('taxRate' in value) || value['taxRate'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('subtotal' in value) || value['subtotal'] === undefined) return false;
+    if (!('grandTotal' in value) || value['grandTotal'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceSummaryFromJSON(json: any): InvoiceSummary {
+    return InvoiceSummaryFromJSONTyped(json, false);
+}
+
+export function InvoiceSummaryFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceSummary {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'invoiceId': json['invoice_id'],
+        'invoiceNumber': json['invoice_number'],
+        'date': json['date'],
+        'dueDate': json['due_date'],
+        'status': json['status'],
+        'tax': json['tax'],
+        'tax2': json['tax2'] == null ? undefined : json['tax2'],
+        'taxRate': json['tax_rate'],
+        'taxRate2': json['tax_rate2'] == null ? undefined : json['tax_rate2'],
+        'total': json['total'],
+        'subtotal': json['subtotal'],
+        'grandTotal': json['grand_total'],
+    };
+}
+
+export function InvoiceSummaryToJSON(json: any): InvoiceSummary {
+    return InvoiceSummaryToJSONTyped(json, false);
+}
+
+export function InvoiceSummaryToJSONTyped(value?: InvoiceSummary | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'invoice_id': value['invoiceId'],
+        'invoice_number': value['invoiceNumber'],
+        'date': value['date'],
+        'due_date': value['dueDate'],
+        'status': value['status'],
+        'tax': value['tax'],
+        'tax2': value['tax2'],
+        'tax_rate': value['taxRate'],
+        'tax_rate2': value['taxRate2'],
+        'total': value['total'],
+        'subtotal': value['subtotal'],
+        'grand_total': value['grandTotal'],
+    };
+}
+

package/src/models/InvoiceTransaction.ts

@@ -0,0 +1,122 @@
+/* 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 { mapValues } from '../runtime.js';
+/**
+ * A payment or refund transaction recorded against an invoice
+ * @export
+ * @interface InvoiceTransaction
+ */
+export interface InvoiceTransaction {
+    /**
+     * Transaction identifier
+     * @type {number}
+     * @memberof InvoiceTransaction
+     */
+    id: number;
+    /**
+     * Payment gateway identifier
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    gateway?: string;
+    /**
+     * Transaction date (ISO 8601 or upstream date string)
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    date?: string;
+    /**
+     * Transaction description
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    description?: string;
+    /**
+     * Amount received as a decimal string
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    amountIn?: string;
+    /**
+     * Gateway fees as a decimal string
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    fees?: string;
+    /**
+     * Amount paid out (e.g. refund) as a decimal string
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    amountOut?: string;
+    /**
+     * Gateway transaction reference
+     * @type {string}
+     * @memberof InvoiceTransaction
+     */
+    transId?: string;
+}
+
+/**
+ * Check if a given object implements the InvoiceTransaction interface.
+ */
+export function instanceOfInvoiceTransaction(value: object): value is InvoiceTransaction {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceTransactionFromJSON(json: any): InvoiceTransaction {
+    return InvoiceTransactionFromJSONTyped(json, false);
+}
+
+export function InvoiceTransactionFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceTransaction {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'gateway': json['gateway'] == null ? undefined : json['gateway'],
+        'date': json['date'] == null ? undefined : json['date'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'amountIn': json['amount_in'] == null ? undefined : json['amount_in'],
+        'fees': json['fees'] == null ? undefined : json['fees'],
+        'amountOut': json['amount_out'] == null ? undefined : json['amount_out'],
+        'transId': json['trans_id'] == null ? undefined : json['trans_id'],
+    };
+}
+
+export function InvoiceTransactionToJSON(json: any): InvoiceTransaction {
+    return InvoiceTransactionToJSONTyped(json, false);
+}
+
+export function InvoiceTransactionToJSONTyped(value?: InvoiceTransaction | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'gateway': value['gateway'],
+        'date': value['date'],
+        'description': value['description'],
+        'amount_in': value['amountIn'],
+        'fees': value['fees'],
+        'amount_out': value['amountOut'],
+        'trans_id': value['transId'],
+    };
+}
+

package/src/models/ListInvoicesResponseContent.ts

@@ -0,0 +1,92 @@
+/* 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 { mapValues } from '../runtime.js';
+import type { ListInvoicesResponseData } from './ListInvoicesResponseData.js';
+import {
+    ListInvoicesResponseDataFromJSON,
+    ListInvoicesResponseDataFromJSONTyped,
+    ListInvoicesResponseDataToJSON,
+    ListInvoicesResponseDataToJSONTyped,
+} from './ListInvoicesResponseData.js';
+import type { OperationStatus } from './OperationStatus.js';
+import {
+    OperationStatusFromJSON,
+    OperationStatusFromJSONTyped,
+    OperationStatusToJSON,
+    OperationStatusToJSONTyped,
+} from './OperationStatus.js';
+
+/**
+ * 
+ * @export
+ * @interface ListInvoicesResponseContent
+ */
+export interface ListInvoicesResponseContent {
+    /**
+     * 
+     * @type {OperationStatus}
+     * @memberof ListInvoicesResponseContent
+     */
+    status: OperationStatus;
+    /**
+     * 
+     * @type {ListInvoicesResponseData}
+     * @memberof ListInvoicesResponseContent
+     */
+    data: ListInvoicesResponseData;
+}
+
+
+
+/**
+ * Check if a given object implements the ListInvoicesResponseContent interface.
+ */
+export function instanceOfListInvoicesResponseContent(value: object): value is ListInvoicesResponseContent {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function ListInvoicesResponseContentFromJSON(json: any): ListInvoicesResponseContent {
+    return ListInvoicesResponseContentFromJSONTyped(json, false);
+}
+
+export function ListInvoicesResponseContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListInvoicesResponseContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': OperationStatusFromJSON(json['status']),
+        'data': ListInvoicesResponseDataFromJSON(json['data']),
+    };
+}
+
+export function ListInvoicesResponseContentToJSON(json: any): ListInvoicesResponseContent {
+    return ListInvoicesResponseContentToJSONTyped(json, false);
+}
+
+export function ListInvoicesResponseContentToJSONTyped(value?: ListInvoicesResponseContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': OperationStatusToJSON(value['status']),
+        'data': ListInvoicesResponseDataToJSON(value['data']),
+    };
+}
+

package/src/models/ListInvoicesResponseData.ts

@@ -0,0 +1,83 @@
+/* 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 { mapValues } from '../runtime.js';
+import type { InvoiceSummary } from './InvoiceSummary.js';
+import {
+    InvoiceSummaryFromJSON,
+    InvoiceSummaryFromJSONTyped,
+    InvoiceSummaryToJSON,
+    InvoiceSummaryToJSONTyped,
+} from './InvoiceSummary.js';
+
+/**
+ * Top-level data payload for the ListInvoices response
+ * @export
+ * @interface ListInvoicesResponseData
+ */
+export interface ListInvoicesResponseData {
+    /**
+     * List of invoices for the authenticated user
+     * @type {Array<InvoiceSummary>}
+     * @memberof ListInvoicesResponseData
+     */
+    invoices: Array<InvoiceSummary>;
+    /**
+     * Total number of invoices returned
+     * @type {number}
+     * @memberof ListInvoicesResponseData
+     */
+    totalCount: number;
+}
+
+/**
+ * Check if a given object implements the ListInvoicesResponseData interface.
+ */
+export function instanceOfListInvoicesResponseData(value: object): value is ListInvoicesResponseData {
+    if (!('invoices' in value) || value['invoices'] === undefined) return false;
+    if (!('totalCount' in value) || value['totalCount'] === undefined) return false;
+    return true;
+}
+
+export function ListInvoicesResponseDataFromJSON(json: any): ListInvoicesResponseData {
+    return ListInvoicesResponseDataFromJSONTyped(json, false);
+}
+
+export function ListInvoicesResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): ListInvoicesResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'invoices': ((json['invoices'] as Array<any>).map(InvoiceSummaryFromJSON)),
+        'totalCount': json['total_count'],
+    };
+}
+
+export function ListInvoicesResponseDataToJSON(json: any): ListInvoicesResponseData {
+    return ListInvoicesResponseDataToJSONTyped(json, false);
+}
+
+export function ListInvoicesResponseDataToJSONTyped(value?: ListInvoicesResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'invoices': ((value['invoices'] as Array<any>).map(InvoiceSummaryToJSON)),
+        'total_count': value['totalCount'],
+    };
+}
+

package/src/models/SelcomMetadata.ts

@@ -0,0 +1,102 @@
+/* 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 { mapValues } from '../runtime.js';
+/**
+ * Selcom alt-gateway payment details included on an invoice when configured
+ * @export
+ * @interface SelcomMetadata
+ */
+export interface SelcomMetadata {
+    /**
+     * Due amount formatted for display (e.g. "TZS 29,000.00"). Non-TZS amounts are converted using the WHMCS currency rate.
+     * @type {string}
+     * @memberof SelcomMetadata
+     */
+    amount: string;
+    /**
+     * Selcom Pesa account: 5-digit padded client id plus 6-digit padded invoice id
+     * @type {string}
+     * @memberof SelcomMetadata
+     */
+    pesaAccount: string;
+    /**
+     * Mobile payment reference: 61107370 plus the same padded client and invoice ids
+     * @type {string}
+     * @memberof SelcomMetadata
+     */
+    mobileReference: string;
+    /**
+     * USSD shortcode for Selcom (always *150*50*1#)
+     * @type {string}
+     * @memberof SelcomMetadata
+     */
+    ussdCode: string;
+    /**
+     * WHMCS Selcom alt-gateway instructions HTML with placeholders filled
+     * @type {string}
+     * @memberof SelcomMetadata
+     */
+    instructions: string;
+}
+
+/**
+ * Check if a given object implements the SelcomMetadata interface.
+ */
+export function instanceOfSelcomMetadata(value: object): value is SelcomMetadata {
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('pesaAccount' in value) || value['pesaAccount'] === undefined) return false;
+    if (!('mobileReference' in value) || value['mobileReference'] === undefined) return false;
+    if (!('ussdCode' in value) || value['ussdCode'] === undefined) return false;
+    if (!('instructions' in value) || value['instructions'] === undefined) return false;
+    return true;
+}
+
+export function SelcomMetadataFromJSON(json: any): SelcomMetadata {
+    return SelcomMetadataFromJSONTyped(json, false);
+}
+
+export function SelcomMetadataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SelcomMetadata {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'amount': json['amount'],
+        'pesaAccount': json['pesa_account'],
+        'mobileReference': json['mobile_reference'],
+        'ussdCode': json['ussd_code'],
+        'instructions': json['instructions'],
+    };
+}
+
+export function SelcomMetadataToJSON(json: any): SelcomMetadata {
+    return SelcomMetadataToJSONTyped(json, false);
+}
+
+export function SelcomMetadataToJSONTyped(value?: SelcomMetadata | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'amount': value['amount'],
+        'pesa_account': value['pesaAccount'],
+        'mobile_reference': value['mobileReference'],
+        'ussd_code': value['ussdCode'],
+        'instructions': value['instructions'],
+    };
+}
+

package/src/models/index.ts

@@ -68,6 +68,7 @@ export * from './DeleteSnapshotJobRequestContent.js';
 export * from './DeleteSnapshotJobResponseContent.js';
 export * from './DeleteSnapshotRequestContent.js';
 export * from './DeleteSnapshotResponseContent.js';
+export * from './DnsBackend.js';
 export * from './DnsCreateCandidateInfo.js';
 export * from './DnsRecordInfo.js';
 export * from './DnsRecordMutationData.js';
@@ -119,6 +120,9 @@ export * from './GetDomainRequestContent.js';
 export * from './GetDomainResponseContent.js';
 export * from './GetEncryptedPasswordRequestContent.js';
 export * from './GetEncryptedPasswordResponseContent.js';
+export * from './GetInvoiceDetailsRequestContent.js';
+export * from './GetInvoiceDetailsResponseContent.js';
+export * from './GetInvoiceDetailsResponseData.js';
 export * from './GetNoVncConsoleRequestContent.js';
 export * from './GetNoVncConsoleResponseContent.js';
 export * from './GetVpsConfigRequestContent.js';
@@ -127,6 +131,12 @@ export * from './GetVpsDetailsRequestContent.js';
 export * from './GetVpsDetailsResponseContent.js';
 export * from './InternalServiceErrorResponseContent.js';
 export * from './InvalidStateErrorResponseContent.js';
+export * from './InvoiceDetails.js';
+export * from './InvoiceIssuedTo.js';
+export * from './InvoiceIssuedToTax.js';
+export * from './InvoiceItem.js';
+export * from './InvoiceSummary.js';
+export * from './InvoiceTransaction.js';
 export * from './ListBackupSchedulesRequestContent.js';
 export * from './ListBackupSchedulesResponseContent.js';
 export * from './ListBackupsRequestContent.js';
@@ -144,6 +154,8 @@ export * from './ListDomainsRequiringDataResponseContent.js';
 export * from './ListDomainsResponseContent.js';
 export * from './ListFirewallRulesRequestContent.js';
 export * from './ListFirewallRulesResponseContent.js';
+export * from './ListInvoicesResponseContent.js';
+export * from './ListInvoicesResponseData.js';
 export * from './ListIsosRequestContent.js';
 export * from './ListIsosResponseContent.js';
 export * from './ListIsosResponseData.js';
@@ -205,6 +217,7 @@ export * from './RollbackSnapshotResponseContent.js';
 export * from './SaveDomainRequiredDataData.js';
 export * from './SaveDomainRequiredDataRequestContent.js';
 export * from './SaveDomainRequiredDataResponseContent.js';
+export * from './SelcomMetadata.js';
 export * from './ServiceBackupsResponseData.js';
 export * from './ServiceSnapshotsResponseData.js';
 export * from './ServiceUnavailableErrorResponseContent.js';

package/src/retryablePaths.ts

@@ -22,6 +22,8 @@ export const RETRYABLE_PATHS = new Set<string>([
     "/vps/get-catalogue",
     "/vps/validate-pricing",
     "/vps/list-orders",
+    "/billing/list-invoices",
+    "/billing/get-invoice-details",
     "/dns/list-rdns-records",
     "/domain/check-availability",
     "/domain/suggest",