@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.4

package/dist/esm/models/DnsCreateCandidateInfo.js

@@ -0,0 +1,49 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DnsCreateCandidateInfo interface.
+ */
+export function instanceOfDnsCreateCandidateInfo(value) {
+    return true;
+}
+export function DnsCreateCandidateInfoFromJSON(json) {
+    return DnsCreateCandidateInfoFromJSONTyped(json, false);
+}
+export function DnsCreateCandidateInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'domainName': json['domain_name'] == null ? undefined : json['domain_name'],
+        'domainId': json['domain_id'] == null ? undefined : json['domain_id'],
+        'relid': json['relid'] == null ? undefined : json['relid'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'name': json['name'] == null ? undefined : json['name'],
+    };
+}
+export function DnsCreateCandidateInfoToJSON(json) {
+    return DnsCreateCandidateInfoToJSONTyped(json, false);
+}
+export function DnsCreateCandidateInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'domain_name': value['domainName'],
+        'domain_id': value['domainId'],
+        'relid': value['relid'],
+        'type': value['type'],
+        'name': value['name'],
+    };
+}

package/dist/esm/models/DnsRecordInfo.d.ts

@@ -0,0 +1,89 @@
+/**
+ * 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.
+ */
+/**
+ * A DNS record within a zone.
+ *
+ * Record values are normalized to a flat `content` string. Structured record types use
+ * additional top-level fields; the proxy maps these to upstream `data` / `rdata_raw` shapes:
+ *
+ * - **A / AAAA**: `content` is the IP address (`data.address`).
+ * - **CNAME**: `content` is the target hostname (`data.cname`).
+ * - **TXT**: `content` is the text value (`data.txtdata`).
+ * - **NS**: `content` is the nameserver hostname (`data.nsdname`).
+ * - **MX**: `content` is the mail exchange hostname; `priority` is the MX preference
+ *   (`data.exchange`, `data.preference`).
+ * - **SRV**: `content` is the target hostname; `priority`, `weight`, and `port` are the
+ *   SRV parameters (`data.target`, `data.priority`, `data.weight`, `data.port`).
+ *
+ * When upstream returns structured `rdata_raw` without a string `rdata` value, `content`
+ * and the type-specific fields are derived from `rdata_raw`.
+ * @export
+ * @interface DnsRecordInfo
+ */
+export interface DnsRecordInfo {
+    /**
+     * Record identifier
+     * @type {string}
+     * @memberof DnsRecordInfo
+     */
+    id?: string;
+    /**
+     * Record host/name (e.g. @, www, mail)
+     * @type {string}
+     * @memberof DnsRecordInfo
+     */
+    name?: string;
+    /**
+     * Record type (e.g. A, AAAA, CNAME, MX, TXT, NS, SRV)
+     * @type {string}
+     * @memberof DnsRecordInfo
+     */
+    type?: string;
+    /**
+     * Primary record value: IP address (A/AAAA), hostname (CNAME/NS/MX/SRV), or text (TXT)
+     * @type {string}
+     * @memberof DnsRecordInfo
+     */
+    content?: string;
+    /**
+     * Time-to-live in seconds
+     * @type {number}
+     * @memberof DnsRecordInfo
+     */
+    ttl?: number;
+    /**
+     * MX preference when type is MX; SRV priority when type is SRV
+     * @type {number}
+     * @memberof DnsRecordInfo
+     */
+    priority?: number;
+    /**
+     * SRV weight when type is SRV
+     * @type {number}
+     * @memberof DnsRecordInfo
+     */
+    weight?: number;
+    /**
+     * SRV port when type is SRV
+     * @type {number}
+     * @memberof DnsRecordInfo
+     */
+    port?: number;
+}
+/**
+ * Check if a given object implements the DnsRecordInfo interface.
+ */
+export declare function instanceOfDnsRecordInfo(value: object): value is DnsRecordInfo;
+export declare function DnsRecordInfoFromJSON(json: any): DnsRecordInfo;
+export declare function DnsRecordInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnsRecordInfo;
+export declare function DnsRecordInfoToJSON(json: any): DnsRecordInfo;
+export declare function DnsRecordInfoToJSONTyped(value?: DnsRecordInfo | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DnsRecordInfo.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DnsRecordInfo interface.
+ */
+export function instanceOfDnsRecordInfo(value) {
+    return true;
+}
+export function DnsRecordInfoFromJSON(json) {
+    return DnsRecordInfoFromJSONTyped(json, false);
+}
+export function DnsRecordInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'content': json['content'] == null ? undefined : json['content'],
+        'ttl': json['ttl'] == null ? undefined : json['ttl'],
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'weight': json['weight'] == null ? undefined : json['weight'],
+        'port': json['port'] == null ? undefined : json['port'],
+    };
+}
+export function DnsRecordInfoToJSON(json) {
+    return DnsRecordInfoToJSONTyped(json, false);
+}
+export function DnsRecordInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'type': value['type'],
+        'content': value['content'],
+        'ttl': value['ttl'],
+        'priority': value['priority'],
+        'weight': value['weight'],
+        'port': value['port'],
+    };
+}

package/dist/esm/models/DnsRecordMutationData.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 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 type { DnsRecordInfo } from './DnsRecordInfo.js';
+/**
+ *
+ * @export
+ * @interface DnsRecordMutationData
+ */
+export interface DnsRecordMutationData {
+    /**
+     *
+     * @type {string}
+     * @memberof DnsRecordMutationData
+     */
+    message: string;
+    /**
+     * Updated DNS records when returned by upstream
+     * @type {Array<DnsRecordInfo>}
+     * @memberof DnsRecordMutationData
+     */
+    records?: Array<DnsRecordInfo>;
+}
+/**
+ * Check if a given object implements the DnsRecordMutationData interface.
+ */
+export declare function instanceOfDnsRecordMutationData(value: object): value is DnsRecordMutationData;
+export declare function DnsRecordMutationDataFromJSON(json: any): DnsRecordMutationData;
+export declare function DnsRecordMutationDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnsRecordMutationData;
+export declare function DnsRecordMutationDataToJSON(json: any): DnsRecordMutationData;
+export declare function DnsRecordMutationDataToJSONTyped(value?: DnsRecordMutationData | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DnsRecordMutationData.js

@@ -0,0 +1,46 @@
+/* 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 { DnsRecordInfoFromJSON, DnsRecordInfoToJSON, } from './DnsRecordInfo.js';
+/**
+ * Check if a given object implements the DnsRecordMutationData interface.
+ */
+export function instanceOfDnsRecordMutationData(value) {
+    if (!('message' in value) || value['message'] === undefined)
+        return false;
+    return true;
+}
+export function DnsRecordMutationDataFromJSON(json) {
+    return DnsRecordMutationDataFromJSONTyped(json, false);
+}
+export function DnsRecordMutationDataFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'message': json['message'],
+        'records': json['records'] == null ? undefined : (json['records'].map(DnsRecordInfoFromJSON)),
+    };
+}
+export function DnsRecordMutationDataToJSON(json) {
+    return DnsRecordMutationDataToJSONTyped(json, false);
+}
+export function DnsRecordMutationDataToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'message': value['message'],
+        'records': value['records'] == null ? undefined : (value['records'].map(DnsRecordInfoToJSON)),
+    };
+}

package/dist/esm/models/DnsRecordMutationRecord.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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.
+ */
+/**
+ * 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`.
+ * @export
+ * @interface DnsRecordMutationRecord
+ */
+export interface DnsRecordMutationRecord {
+    /**
+     * Record line/id from get-dns-zone-details; required for edit and delete
+     * @type {string}
+     * @memberof DnsRecordMutationRecord
+     */
+    id?: string;
+    /**
+     * Record host/name (e.g. @, www, mail); required for add
+     * @type {string}
+     * @memberof DnsRecordMutationRecord
+     */
+    name?: string;
+    /**
+     * Record type (e.g. A, AAAA, CNAME, MX, TXT, NS, SRV); required for add
+     * @type {string}
+     * @memberof DnsRecordMutationRecord
+     */
+    type?: string;
+    /**
+     * Primary record value; required for add and edit. Meaning depends on type — see DnsRecordInfo
+     * @type {string}
+     * @memberof DnsRecordMutationRecord
+     */
+    content?: string;
+    /**
+     * Time-to-live in seconds; defaults to 3600 on add when omitted
+     * @type {number}
+     * @memberof DnsRecordMutationRecord
+     */
+    ttl?: number;
+    /**
+     * MX preference when type is MX; SRV priority when type is SRV
+     * @type {number}
+     * @memberof DnsRecordMutationRecord
+     */
+    priority?: number;
+    /**
+     * SRV weight when type is SRV
+     * @type {number}
+     * @memberof DnsRecordMutationRecord
+     */
+    weight?: number;
+    /**
+     * SRV port when type is SRV; required for add and edit when type is SRV
+     * @type {number}
+     * @memberof DnsRecordMutationRecord
+     */
+    port?: number;
+}
+/**
+ * Check if a given object implements the DnsRecordMutationRecord interface.
+ */
+export declare function instanceOfDnsRecordMutationRecord(value: object): value is DnsRecordMutationRecord;
+export declare function DnsRecordMutationRecordFromJSON(json: any): DnsRecordMutationRecord;
+export declare function DnsRecordMutationRecordFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnsRecordMutationRecord;
+export declare function DnsRecordMutationRecordToJSON(json: any): DnsRecordMutationRecord;
+export declare function DnsRecordMutationRecordToJSONTyped(value?: DnsRecordMutationRecord | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DnsRecordMutationRecord.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DnsRecordMutationRecord interface.
+ */
+export function instanceOfDnsRecordMutationRecord(value) {
+    return true;
+}
+export function DnsRecordMutationRecordFromJSON(json) {
+    return DnsRecordMutationRecordFromJSONTyped(json, false);
+}
+export function DnsRecordMutationRecordFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'] == null ? undefined : json['id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'content': json['content'] == null ? undefined : json['content'],
+        'ttl': json['ttl'] == null ? undefined : json['ttl'],
+        'priority': json['priority'] == null ? undefined : json['priority'],
+        'weight': json['weight'] == null ? undefined : json['weight'],
+        'port': json['port'] == null ? undefined : json['port'],
+    };
+}
+export function DnsRecordMutationRecordToJSON(json) {
+    return DnsRecordMutationRecordToJSONTyped(json, false);
+}
+export function DnsRecordMutationRecordToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'type': value['type'],
+        'content': value['content'],
+        'ttl': value['ttl'],
+        'priority': value['priority'],
+        'weight': value['weight'],
+        'port': value['port'],
+    };
+}

package/dist/esm/models/DnsZoneInfo.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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 type { DomainHostingLink } from './DomainHostingLink.js';
+/**
+ * A DNS zone owned by the authenticated client
+ * @export
+ * @interface DnsZoneInfo
+ */
+export interface DnsZoneInfo {
+    /**
+     * DNS zone identifier
+     * @type {string}
+     * @memberof DnsZoneInfo
+     */
+    zoneId?: string;
+    /**
+     * Domain service id when the zone is tied to a domain
+     * @type {string}
+     * @memberof DnsZoneInfo
+     */
+    domainId?: string;
+    /**
+     * Zone domain name (FQDN)
+     * @type {string}
+     * @memberof DnsZoneInfo
+     */
+    domainName?: string;
+    /**
+     * Linked hosting service id; omitted when no hosting is linked
+     * @type {number}
+     * @memberof DnsZoneInfo
+     */
+    hostingId?: number;
+    /**
+     * Zone type: 0=OTHER, 1=DOMAIN, 2=HOSTING, 3=ADDON
+     * @type {number}
+     * @memberof DnsZoneInfo
+     */
+    type?: number;
+    /**
+     * Zone type key (e.g. other, domain, hosting, addon)
+     * @type {string}
+     * @memberof DnsZoneInfo
+     */
+    typeKey?: string;
+    /**
+     * Product or package name for the zone
+     * @type {string}
+     * @memberof DnsZoneInfo
+     */
+    packageName?: string;
+    /**
+     *
+     * @type {DomainHostingLink}
+     * @memberof DnsZoneInfo
+     */
+    hasHosting?: DomainHostingLink;
+    /**
+     * Whether a DNS Manager zone exists for this domain name
+     * @type {boolean}
+     * @memberof DnsZoneInfo
+     */
+    hasDnsManagerZone: boolean;
+}
+/**
+ * Check if a given object implements the DnsZoneInfo interface.
+ */
+export declare function instanceOfDnsZoneInfo(value: object): value is DnsZoneInfo;
+export declare function DnsZoneInfoFromJSON(json: any): DnsZoneInfo;
+export declare function DnsZoneInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnsZoneInfo;
+export declare function DnsZoneInfoToJSON(json: any): DnsZoneInfo;
+export declare function DnsZoneInfoToJSONTyped(value?: DnsZoneInfo | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DnsZoneInfo.js

@@ -0,0 +1,60 @@
+/* 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 { DomainHostingLinkFromJSON, DomainHostingLinkToJSON, } from './DomainHostingLink.js';
+/**
+ * Check if a given object implements the DnsZoneInfo interface.
+ */
+export function instanceOfDnsZoneInfo(value) {
+    if (!('hasDnsManagerZone' in value) || value['hasDnsManagerZone'] === undefined)
+        return false;
+    return true;
+}
+export function DnsZoneInfoFromJSON(json) {
+    return DnsZoneInfoFromJSONTyped(json, false);
+}
+export function DnsZoneInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'zoneId': json['zone_id'] == null ? undefined : json['zone_id'],
+        'domainId': json['domain_id'] == null ? undefined : json['domain_id'],
+        'domainName': json['domain_name'] == null ? undefined : json['domain_name'],
+        'hostingId': json['hosting_id'] == null ? undefined : json['hosting_id'],
+        'type': json['type'] == null ? undefined : json['type'],
+        'typeKey': json['type_key'] == null ? undefined : json['type_key'],
+        'packageName': json['package_name'] == null ? undefined : json['package_name'],
+        'hasHosting': json['has_hosting'] == null ? undefined : DomainHostingLinkFromJSON(json['has_hosting']),
+        'hasDnsManagerZone': json['has_dns_manager_zone'],
+    };
+}
+export function DnsZoneInfoToJSON(json) {
+    return DnsZoneInfoToJSONTyped(json, false);
+}
+export function DnsZoneInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'zone_id': value['zoneId'],
+        'domain_id': value['domainId'],
+        'domain_name': value['domainName'],
+        'hosting_id': value['hostingId'],
+        'type': value['type'],
+        'type_key': value['typeKey'],
+        'package_name': value['packageName'],
+        'has_hosting': DomainHostingLinkToJSON(value['hasHosting']),
+        'has_dns_manager_zone': value['hasDnsManagerZone'],
+    };
+}

package/dist/esm/models/DnssecRecordInfo.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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.
+ */
+/**
+ * A DNSSEC DS record
+ * @export
+ * @interface DnssecRecordInfo
+ */
+export interface DnssecRecordInfo {
+    /**
+     * DNSSEC key tag (0-65535)
+     * @type {number}
+     * @memberof DnssecRecordInfo
+     */
+    keyTag: number;
+    /**
+     * DNSSEC algorithm (1-255)
+     * @type {number}
+     * @memberof DnssecRecordInfo
+     */
+    alg: number;
+    /**
+     * DNSSEC digest type (1-255)
+     * @type {number}
+     * @memberof DnssecRecordInfo
+     */
+    digestType: number;
+    /**
+     * Hex digest
+     * @type {string}
+     * @memberof DnssecRecordInfo
+     */
+    digest: string;
+}
+/**
+ * Check if a given object implements the DnssecRecordInfo interface.
+ */
+export declare function instanceOfDnssecRecordInfo(value: object): value is DnssecRecordInfo;
+export declare function DnssecRecordInfoFromJSON(json: any): DnssecRecordInfo;
+export declare function DnssecRecordInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DnssecRecordInfo;
+export declare function DnssecRecordInfoToJSON(json: any): DnssecRecordInfo;
+export declare function DnssecRecordInfoToJSONTyped(value?: DnssecRecordInfo | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DnssecRecordInfo.js

@@ -0,0 +1,55 @@
+/* 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.
+ */
+/**
+ * Check if a given object implements the DnssecRecordInfo interface.
+ */
+export function instanceOfDnssecRecordInfo(value) {
+    if (!('keyTag' in value) || value['keyTag'] === undefined)
+        return false;
+    if (!('alg' in value) || value['alg'] === undefined)
+        return false;
+    if (!('digestType' in value) || value['digestType'] === undefined)
+        return false;
+    if (!('digest' in value) || value['digest'] === undefined)
+        return false;
+    return true;
+}
+export function DnssecRecordInfoFromJSON(json) {
+    return DnssecRecordInfoFromJSONTyped(json, false);
+}
+export function DnssecRecordInfoFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'keyTag': json['key_tag'],
+        'alg': json['alg'],
+        'digestType': json['digest_type'],
+        'digest': json['digest'],
+    };
+}
+export function DnssecRecordInfoToJSON(json) {
+    return DnssecRecordInfoToJSONTyped(json, false);
+}
+export function DnssecRecordInfoToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'key_tag': value['keyTag'],
+        'alg': value['alg'],
+        'digest_type': value['digestType'],
+        'digest': value['digest'],
+    };
+}