@hostafrica/ha-sdk-typescript 1.1.4 → 1.1.5

package/src/models/InvoiceDetails.ts

@@ -0,0 +1,247 @@
+/* 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 { InvoiceItem } from './InvoiceItem.js';
+import {
+    InvoiceItemFromJSON,
+    InvoiceItemFromJSONTyped,
+    InvoiceItemToJSON,
+    InvoiceItemToJSONTyped,
+} from './InvoiceItem.js';
+import type { InvoiceTransaction } from './InvoiceTransaction.js';
+import {
+    InvoiceTransactionFromJSON,
+    InvoiceTransactionFromJSONTyped,
+    InvoiceTransactionToJSON,
+    InvoiceTransactionToJSONTyped,
+} from './InvoiceTransaction.js';
+import type { InvoiceIssuedTo } from './InvoiceIssuedTo.js';
+import {
+    InvoiceIssuedToFromJSON,
+    InvoiceIssuedToFromJSONTyped,
+    InvoiceIssuedToToJSON,
+    InvoiceIssuedToToJSONTyped,
+} from './InvoiceIssuedTo.js';
+
+/**
+ * Full invoice details
+ * @export
+ * @interface InvoiceDetails
+ */
+export interface InvoiceDetails {
+    /**
+     * Unique invoice identifier - must be sent as a string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    invoiceId: string;
+    /**
+     * Human-readable invoice number when assigned
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    invoiceNumber: string;
+    /**
+     * 
+     * @type {InvoiceIssuedTo}
+     * @memberof InvoiceDetails
+     */
+    issuedTo: InvoiceIssuedTo;
+    /**
+     * Invoice issue date (ISO 8601)
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    date: string;
+    /**
+     * Invoice due date (ISO 8601)
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    dueDate: string;
+    /**
+     * Date the invoice was paid (ISO 8601), if paid
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    datePaid?: string;
+    /**
+     * Invoice subtotal excluding tax as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    subtotal: string;
+    /**
+     * Credit applied as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    credit: string;
+    /**
+     * Primary tax amount as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    tax: string;
+    /**
+     * Secondary tax amount as a decimal string. Omitted when a second tax is not configured.
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    tax2?: string;
+    /**
+     * Invoice total including tax as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    total: string;
+    /**
+     * Primary tax rate as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    taxRate: string;
+    /**
+     * Secondary tax rate as a decimal string. Omitted when a second tax is not configured.
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    taxRate2?: string;
+    /**
+     * Invoice status (e.g. Paid, Unpaid, Cancelled, Refunded)
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    status: string;
+    /**
+     * Payment method identifier
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    paymentMethod: string;
+    /**
+     * Amount still due as a decimal string
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    totalDue: string;
+    /**
+     * Invoice notes
+     * @type {string}
+     * @memberof InvoiceDetails
+     */
+    notes: string;
+    /**
+     * Invoice line items
+     * @type {Array<InvoiceItem>}
+     * @memberof InvoiceDetails
+     */
+    items: Array<InvoiceItem>;
+    /**
+     * Payment and refund transactions on the invoice
+     * @type {Array<InvoiceTransaction>}
+     * @memberof InvoiceDetails
+     */
+    transactions: Array<InvoiceTransaction>;
+}
+
+/**
+ * Check if a given object implements the InvoiceDetails interface.
+ */
+export function instanceOfInvoiceDetails(value: object): value is InvoiceDetails {
+    if (!('invoiceId' in value) || value['invoiceId'] === undefined) return false;
+    if (!('invoiceNumber' in value) || value['invoiceNumber'] === undefined) return false;
+    if (!('issuedTo' in value) || value['issuedTo'] === undefined) return false;
+    if (!('date' in value) || value['date'] === undefined) return false;
+    if (!('dueDate' in value) || value['dueDate'] === undefined) return false;
+    if (!('subtotal' in value) || value['subtotal'] === undefined) return false;
+    if (!('credit' in value) || value['credit'] === undefined) return false;
+    if (!('tax' in value) || value['tax'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    if (!('taxRate' in value) || value['taxRate'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('paymentMethod' in value) || value['paymentMethod'] === undefined) return false;
+    if (!('totalDue' in value) || value['totalDue'] === undefined) return false;
+    if (!('notes' in value) || value['notes'] === undefined) return false;
+    if (!('items' in value) || value['items'] === undefined) return false;
+    if (!('transactions' in value) || value['transactions'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceDetailsFromJSON(json: any): InvoiceDetails {
+    return InvoiceDetailsFromJSONTyped(json, false);
+}
+
+export function InvoiceDetailsFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceDetails {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'invoiceId': json['invoice_id'],
+        'invoiceNumber': json['invoice_number'],
+        'issuedTo': InvoiceIssuedToFromJSON(json['issued_to']),
+        'date': json['date'],
+        'dueDate': json['due_date'],
+        'datePaid': json['date_paid'] == null ? undefined : json['date_paid'],
+        'subtotal': json['subtotal'],
+        'credit': json['credit'],
+        'tax': json['tax'],
+        'tax2': json['tax2'] == null ? undefined : json['tax2'],
+        'total': json['total'],
+        'taxRate': json['tax_rate'],
+        'taxRate2': json['tax_rate2'] == null ? undefined : json['tax_rate2'],
+        'status': json['status'],
+        'paymentMethod': json['payment_method'],
+        'totalDue': json['total_due'],
+        'notes': json['notes'],
+        'items': ((json['items'] as Array<any>).map(InvoiceItemFromJSON)),
+        'transactions': ((json['transactions'] as Array<any>).map(InvoiceTransactionFromJSON)),
+    };
+}
+
+export function InvoiceDetailsToJSON(json: any): InvoiceDetails {
+    return InvoiceDetailsToJSONTyped(json, false);
+}
+
+export function InvoiceDetailsToJSONTyped(value?: InvoiceDetails | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'invoice_id': value['invoiceId'],
+        'invoice_number': value['invoiceNumber'],
+        'issued_to': InvoiceIssuedToToJSON(value['issuedTo']),
+        'date': value['date'],
+        'due_date': value['dueDate'],
+        'date_paid': value['datePaid'],
+        'subtotal': value['subtotal'],
+        'credit': value['credit'],
+        'tax': value['tax'],
+        'tax2': value['tax2'],
+        'total': value['total'],
+        'tax_rate': value['taxRate'],
+        'tax_rate2': value['taxRate2'],
+        'status': value['status'],
+        'payment_method': value['paymentMethod'],
+        'total_due': value['totalDue'],
+        'notes': value['notes'],
+        'items': ((value['items'] as Array<any>).map(InvoiceItemToJSON)),
+        'transactions': ((value['transactions'] as Array<any>).map(InvoiceTransactionToJSON)),
+    };
+}
+

package/src/models/InvoiceIssuedTo.ts

@@ -0,0 +1,127 @@
+/* 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 { InvoiceIssuedToTax } from './InvoiceIssuedToTax.js';
+import {
+    InvoiceIssuedToTaxFromJSON,
+    InvoiceIssuedToTaxFromJSONTyped,
+    InvoiceIssuedToTaxToJSON,
+    InvoiceIssuedToTaxToJSONTyped,
+} from './InvoiceIssuedToTax.js';
+
+/**
+ * Recipient / billed-to details on an invoice
+ * @export
+ * @interface InvoiceIssuedTo
+ */
+export interface InvoiceIssuedTo {
+    /**
+     * Company name on the invoice
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    companyName: string;
+    /**
+     * Full name of the billed contact
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    fullName: string;
+    /**
+     * Street address
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    address: string;
+    /**
+     * City, state/province, and postal code
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    cityStateZip: string;
+    /**
+     * ISO country code
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    country: string;
+    /**
+     * Country display name
+     * @type {string}
+     * @memberof InvoiceIssuedTo
+     */
+    countryName: string;
+    /**
+     * 
+     * @type {InvoiceIssuedToTax}
+     * @memberof InvoiceIssuedTo
+     */
+    tax?: InvoiceIssuedToTax;
+}
+
+/**
+ * Check if a given object implements the InvoiceIssuedTo interface.
+ */
+export function instanceOfInvoiceIssuedTo(value: object): value is InvoiceIssuedTo {
+    if (!('companyName' in value) || value['companyName'] === undefined) return false;
+    if (!('fullName' in value) || value['fullName'] === undefined) return false;
+    if (!('address' in value) || value['address'] === undefined) return false;
+    if (!('cityStateZip' in value) || value['cityStateZip'] === undefined) return false;
+    if (!('country' in value) || value['country'] === undefined) return false;
+    if (!('countryName' in value) || value['countryName'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceIssuedToFromJSON(json: any): InvoiceIssuedTo {
+    return InvoiceIssuedToFromJSONTyped(json, false);
+}
+
+export function InvoiceIssuedToFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceIssuedTo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'companyName': json['company_name'],
+        'fullName': json['full_name'],
+        'address': json['address'],
+        'cityStateZip': json['city_state_zip'],
+        'country': json['country'],
+        'countryName': json['country_name'],
+        'tax': json['tax'] == null ? undefined : InvoiceIssuedToTaxFromJSON(json['tax']),
+    };
+}
+
+export function InvoiceIssuedToToJSON(json: any): InvoiceIssuedTo {
+    return InvoiceIssuedToToJSONTyped(json, false);
+}
+
+export function InvoiceIssuedToToJSONTyped(value?: InvoiceIssuedTo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'company_name': value['companyName'],
+        'full_name': value['fullName'],
+        'address': value['address'],
+        'city_state_zip': value['cityStateZip'],
+        'country': value['country'],
+        'country_name': value['countryName'],
+        'tax': InvoiceIssuedToTaxToJSON(value['tax']),
+    };
+}
+

package/src/models/InvoiceIssuedToTax.ts

@@ -0,0 +1,84 @@
+/* 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';
+/**
+ * Tax applied to the invoice recipient
+ * @export
+ * @interface InvoiceIssuedToTax
+ */
+export interface InvoiceIssuedToTax {
+    /**
+     * Tax name or region label (e.g. SA)
+     * @type {string}
+     * @memberof InvoiceIssuedToTax
+     */
+    name: string;
+    /**
+     * Tax rate percentage
+     * @type {number}
+     * @memberof InvoiceIssuedToTax
+     */
+    rate: number;
+    /**
+     * Tax level
+     * @type {number}
+     * @memberof InvoiceIssuedToTax
+     */
+    level: number;
+}
+
+/**
+ * Check if a given object implements the InvoiceIssuedToTax interface.
+ */
+export function instanceOfInvoiceIssuedToTax(value: object): value is InvoiceIssuedToTax {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('rate' in value) || value['rate'] === undefined) return false;
+    if (!('level' in value) || value['level'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceIssuedToTaxFromJSON(json: any): InvoiceIssuedToTax {
+    return InvoiceIssuedToTaxFromJSONTyped(json, false);
+}
+
+export function InvoiceIssuedToTaxFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceIssuedToTax {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'rate': json['rate'],
+        'level': json['level'],
+    };
+}
+
+export function InvoiceIssuedToTaxToJSON(json: any): InvoiceIssuedToTax {
+    return InvoiceIssuedToTaxToJSONTyped(json, false);
+}
+
+export function InvoiceIssuedToTaxToJSONTyped(value?: InvoiceIssuedToTax | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'rate': value['rate'],
+        'level': value['level'],
+    };
+}
+

package/src/models/InvoiceItem.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';
+/**
+ * A single invoice line item
+ * @export
+ * @interface InvoiceItem
+ */
+export interface InvoiceItem {
+    /**
+     * Line item identifier
+     * @type {number}
+     * @memberof InvoiceItem
+     */
+    id: number;
+    /**
+     * Line item type (e.g. Hosting)
+     * @type {string}
+     * @memberof InvoiceItem
+     */
+    type: string;
+    /**
+     * Line item description
+     * @type {string}
+     * @memberof InvoiceItem
+     */
+    description: string;
+    /**
+     * Line item amount as a decimal string
+     * @type {string}
+     * @memberof InvoiceItem
+     */
+    amount: string;
+    /**
+     * Whether the line item is taxed (1 = taxed, 0 = not taxed)
+     * @type {number}
+     * @memberof InvoiceItem
+     */
+    taxed: number;
+}
+
+/**
+ * Check if a given object implements the InvoiceItem interface.
+ */
+export function instanceOfInvoiceItem(value: object): value is InvoiceItem {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('amount' in value) || value['amount'] === undefined) return false;
+    if (!('taxed' in value) || value['taxed'] === undefined) return false;
+    return true;
+}
+
+export function InvoiceItemFromJSON(json: any): InvoiceItem {
+    return InvoiceItemFromJSONTyped(json, false);
+}
+
+export function InvoiceItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): InvoiceItem {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'type': json['type'],
+        'description': json['description'],
+        'amount': json['amount'],
+        'taxed': json['taxed'],
+    };
+}
+
+export function InvoiceItemToJSON(json: any): InvoiceItem {
+    return InvoiceItemToJSONTyped(json, false);
+}
+
+export function InvoiceItemToJSONTyped(value?: InvoiceItem | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'type': value['type'],
+        'description': value['description'],
+        'amount': value['amount'],
+        'taxed': value['taxed'],
+    };
+}
+