@hostafrica/ha-sdk-typescript 1.1.2 → 1.1.4

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

@@ -0,0 +1,251 @@
+/**
+ * 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 { DomainExpiryCountdown } from './DomainExpiryCountdown.js';
+import type { DomainAvailableFeatures } from './DomainAvailableFeatures.js';
+import type { DomainHostingLink } from './DomainHostingLink.js';
+/**
+ * Full domain details returned by get-domain
+ * @export
+ * @interface DomainDetail
+ */
+export interface DomainDetail {
+    /**
+     * Domain service id
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    domainId: string;
+    /**
+     * Domain operation type (e.g. Register, Transfer)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    type: string;
+    /**
+     * Fully qualified domain name
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    domain: string;
+    /**
+     * Second-level domain label (e.g. dandelyn)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    sld?: string;
+    /**
+     * Top-level domain including dot (e.g. .co.za)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    tld?: string;
+    /**
+     * Domain status (e.g. Active, Expired, Cancelled)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    status: string;
+    /**
+     * Registration or billing period in years
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    period: number;
+    /**
+     * Registration timestamp from upstream (ISO 8601)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    registrationdate?: string;
+    /**
+     * Renewal flag: 0 = renew, 1 = do not renew
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    donotrenew: number;
+    /**
+     * WHOIS privacy enabled: 0 = off, 1 = on
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    idProtection: number;
+    /**
+     * Whether the TLD supports ID protection
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    idProtectionSupported: boolean;
+    /**
+     * First payment amount as a decimal string
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    firstpaymentamount?: string;
+    /**
+     * Recurring amount as a decimal string (e.g. "149.99")
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    recurringamount: string;
+    /**
+     * Whether DNS management addon is currently enabled
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    dnsmanagement?: boolean;
+    /**
+     * Whether email forwarding addon is currently enabled
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    emailforwarding?: boolean;
+    /**
+     * Whether the domain is premium
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    isPremium?: boolean;
+    /**
+     * Registrar lock status (e.g. locked, unlocked, unavailable)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    lockStatus?: string;
+    /**
+     * Grace period length in days
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    gracePeriod?: number;
+    /**
+     * Redemption period length in days
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    redemptionPeriod?: number;
+    /**
+     * Grace period renewal fee
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    gracePeriodFee?: number;
+    /**
+     * Redemption period renewal fee
+     * @type {number}
+     * @memberof DomainDetail
+     */
+    redemptionPeriodFee?: number;
+    /**
+     * Whether the domain is currently in grace period
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    inGrace?: boolean;
+    /**
+     * Whether the domain is currently in redemption period
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    inRedemption?: boolean;
+    /**
+     * Domain expiry date (YYYY-MM-DD or ISO 8601 from upstream)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    expirydate?: string;
+    /**
+     * Next invoice date (YYYY-MM-DD or ISO 8601 from upstream)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    nextinvoicedate?: string;
+    /**
+     * Next due date (YYYY-MM-DD or ISO 8601 from upstream)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    nextduedate?: string;
+    /**
+     *
+     * @type {DomainAvailableFeatures}
+     * @memberof DomainDetail
+     */
+    availableFeatures?: DomainAvailableFeatures;
+    /**
+     * Currently applied nameserver hostnames
+     * @type {Array<string>}
+     * @memberof DomainDetail
+     */
+    domainNameservers?: Array<string>;
+    /**
+     * Default nameserver hostnames for this domain/product
+     * @type {Array<string>}
+     * @memberof DomainDetail
+     */
+    defaultNameservers?: Array<string>;
+    /**
+     * Nameserver change state (e.g. own, pending)
+     * @type {string}
+     * @memberof DomainDetail
+     */
+    nsChanging?: string;
+    /**
+     *
+     * @type {DomainHostingLink}
+     * @memberof DomainDetail
+     */
+    hasHosting?: DomainHostingLink;
+    /**
+     * Whether a DNS Manager zone exists for this domain name
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    hasDnsManagerZone: boolean;
+    /**
+     *
+     * @type {DomainExpiryCountdown}
+     * @memberof DomainDetail
+     */
+    expiryCountdown?: DomainExpiryCountdown;
+    /**
+     * Domain evaluator result when enabled; null when unavailable
+     * @type {any}
+     * @memberof DomainDetail
+     */
+    evaluation?: any | null;
+    /**
+     * Whether domain evaluation is available for this domain/account
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    domainEvaluationAvailable?: boolean;
+    /**
+     * Configured redirect details when present; null when none
+     * @type {any}
+     * @memberof DomainDetail
+     */
+    hasRedirect?: any | null;
+    /**
+     * True when EPP/auth code retrieval is disabled for this domain
+     * @type {boolean}
+     * @memberof DomainDetail
+     */
+    noEpp?: boolean;
+}
+/**
+ * Check if a given object implements the DomainDetail interface.
+ */
+export declare function instanceOfDomainDetail(value: object): value is DomainDetail;
+export declare function DomainDetailFromJSON(json: any): DomainDetail;
+export declare function DomainDetailFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainDetail;
+export declare function DomainDetailToJSON(json: any): DomainDetail;
+export declare function DomainDetailToJSONTyped(value?: DomainDetail | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DomainDetail.js

@@ -0,0 +1,136 @@
+/* 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 { DomainExpiryCountdownFromJSON, DomainExpiryCountdownToJSON, } from './DomainExpiryCountdown.js';
+import { DomainAvailableFeaturesFromJSON, DomainAvailableFeaturesToJSON, } from './DomainAvailableFeatures.js';
+import { DomainHostingLinkFromJSON, DomainHostingLinkToJSON, } from './DomainHostingLink.js';
+/**
+ * Check if a given object implements the DomainDetail interface.
+ */
+export function instanceOfDomainDetail(value) {
+    if (!('domainId' in value) || value['domainId'] === undefined)
+        return false;
+    if (!('type' in value) || value['type'] === undefined)
+        return false;
+    if (!('domain' in value) || value['domain'] === undefined)
+        return false;
+    if (!('status' in value) || value['status'] === undefined)
+        return false;
+    if (!('period' in value) || value['period'] === undefined)
+        return false;
+    if (!('donotrenew' in value) || value['donotrenew'] === undefined)
+        return false;
+    if (!('idProtection' in value) || value['idProtection'] === undefined)
+        return false;
+    if (!('idProtectionSupported' in value) || value['idProtectionSupported'] === undefined)
+        return false;
+    if (!('recurringamount' in value) || value['recurringamount'] === undefined)
+        return false;
+    if (!('hasDnsManagerZone' in value) || value['hasDnsManagerZone'] === undefined)
+        return false;
+    return true;
+}
+export function DomainDetailFromJSON(json) {
+    return DomainDetailFromJSONTyped(json, false);
+}
+export function DomainDetailFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'domainId': json['domain_id'],
+        'type': json['type'],
+        'domain': json['domain'],
+        'sld': json['sld'] == null ? undefined : json['sld'],
+        'tld': json['tld'] == null ? undefined : json['tld'],
+        'status': json['status'],
+        'period': json['period'],
+        'registrationdate': json['registrationdate'] == null ? undefined : json['registrationdate'],
+        'donotrenew': json['donotrenew'],
+        'idProtection': json['id_protection'],
+        'idProtectionSupported': json['id_protection_supported'],
+        'firstpaymentamount': json['firstpaymentamount'] == null ? undefined : json['firstpaymentamount'],
+        'recurringamount': json['recurringamount'],
+        'dnsmanagement': json['dnsmanagement'] == null ? undefined : json['dnsmanagement'],
+        'emailforwarding': json['emailforwarding'] == null ? undefined : json['emailforwarding'],
+        'isPremium': json['is_premium'] == null ? undefined : json['is_premium'],
+        'lockStatus': json['lock_status'] == null ? undefined : json['lock_status'],
+        'gracePeriod': json['grace_period'] == null ? undefined : json['grace_period'],
+        'redemptionPeriod': json['redemption_period'] == null ? undefined : json['redemption_period'],
+        'gracePeriodFee': json['grace_period_fee'] == null ? undefined : json['grace_period_fee'],
+        'redemptionPeriodFee': json['redemption_period_fee'] == null ? undefined : json['redemption_period_fee'],
+        'inGrace': json['in_grace'] == null ? undefined : json['in_grace'],
+        'inRedemption': json['in_redemption'] == null ? undefined : json['in_redemption'],
+        'expirydate': json['expirydate'] == null ? undefined : json['expirydate'],
+        'nextinvoicedate': json['nextinvoicedate'] == null ? undefined : json['nextinvoicedate'],
+        'nextduedate': json['nextduedate'] == null ? undefined : json['nextduedate'],
+        'availableFeatures': json['available_features'] == null ? undefined : DomainAvailableFeaturesFromJSON(json['available_features']),
+        'domainNameservers': json['domain_nameservers'] == null ? undefined : json['domain_nameservers'],
+        'defaultNameservers': json['default_nameservers'] == null ? undefined : json['default_nameservers'],
+        'nsChanging': json['ns_changing'] == null ? undefined : json['ns_changing'],
+        'hasHosting': json['has_hosting'] == null ? undefined : DomainHostingLinkFromJSON(json['has_hosting']),
+        'hasDnsManagerZone': json['has_dns_manager_zone'],
+        'expiryCountdown': json['expiry_countdown'] == null ? undefined : DomainExpiryCountdownFromJSON(json['expiry_countdown']),
+        'evaluation': json['evaluation'] == null ? undefined : json['evaluation'],
+        'domainEvaluationAvailable': json['domain_evaluation_available'] == null ? undefined : json['domain_evaluation_available'],
+        'hasRedirect': json['has_redirect'] == null ? undefined : json['has_redirect'],
+        'noEpp': json['no_epp'] == null ? undefined : json['no_epp'],
+    };
+}
+export function DomainDetailToJSON(json) {
+    return DomainDetailToJSONTyped(json, false);
+}
+export function DomainDetailToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'domain_id': value['domainId'],
+        'type': value['type'],
+        'domain': value['domain'],
+        'sld': value['sld'],
+        'tld': value['tld'],
+        'status': value['status'],
+        'period': value['period'],
+        'registrationdate': value['registrationdate'],
+        'donotrenew': value['donotrenew'],
+        'id_protection': value['idProtection'],
+        'id_protection_supported': value['idProtectionSupported'],
+        'firstpaymentamount': value['firstpaymentamount'],
+        'recurringamount': value['recurringamount'],
+        'dnsmanagement': value['dnsmanagement'],
+        'emailforwarding': value['emailforwarding'],
+        'is_premium': value['isPremium'],
+        'lock_status': value['lockStatus'],
+        'grace_period': value['gracePeriod'],
+        'redemption_period': value['redemptionPeriod'],
+        'grace_period_fee': value['gracePeriodFee'],
+        'redemption_period_fee': value['redemptionPeriodFee'],
+        'in_grace': value['inGrace'],
+        'in_redemption': value['inRedemption'],
+        'expirydate': value['expirydate'],
+        'nextinvoicedate': value['nextinvoicedate'],
+        'nextduedate': value['nextduedate'],
+        'available_features': DomainAvailableFeaturesToJSON(value['availableFeatures']),
+        'domain_nameservers': value['domainNameservers'],
+        'default_nameservers': value['defaultNameservers'],
+        'ns_changing': value['nsChanging'],
+        'has_hosting': DomainHostingLinkToJSON(value['hasHosting']),
+        'has_dns_manager_zone': value['hasDnsManagerZone'],
+        'expiry_countdown': DomainExpiryCountdownToJSON(value['expiryCountdown']),
+        'evaluation': value['evaluation'],
+        'domain_evaluation_available': value['domainEvaluationAvailable'],
+        'has_redirect': value['hasRedirect'],
+        'no_epp': value['noEpp'],
+    };
+}

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

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+/**
+ * Countdown until domain expiry
+ * @export
+ * @interface DomainExpiryCountdown
+ */
+export interface DomainExpiryCountdown {
+    /**
+     *
+     * @type {number}
+     * @memberof DomainExpiryCountdown
+     */
+    years: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DomainExpiryCountdown
+     */
+    months: number;
+    /**
+     *
+     * @type {number}
+     * @memberof DomainExpiryCountdown
+     */
+    days: number;
+}
+/**
+ * Check if a given object implements the DomainExpiryCountdown interface.
+ */
+export declare function instanceOfDomainExpiryCountdown(value: object): value is DomainExpiryCountdown;
+export declare function DomainExpiryCountdownFromJSON(json: any): DomainExpiryCountdown;
+export declare function DomainExpiryCountdownFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainExpiryCountdown;
+export declare function DomainExpiryCountdownToJSON(json: any): DomainExpiryCountdown;
+export declare function DomainExpiryCountdownToJSONTyped(value?: DomainExpiryCountdown | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DomainExpiryCountdown.js

@@ -0,0 +1,51 @@
+/* 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 DomainExpiryCountdown interface.
+ */
+export function instanceOfDomainExpiryCountdown(value) {
+    if (!('years' in value) || value['years'] === undefined)
+        return false;
+    if (!('months' in value) || value['months'] === undefined)
+        return false;
+    if (!('days' in value) || value['days'] === undefined)
+        return false;
+    return true;
+}
+export function DomainExpiryCountdownFromJSON(json) {
+    return DomainExpiryCountdownFromJSONTyped(json, false);
+}
+export function DomainExpiryCountdownFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'years': json['years'],
+        'months': json['months'],
+        'days': json['days'],
+    };
+}
+export function DomainExpiryCountdownToJSON(json) {
+    return DomainExpiryCountdownToJSONTyped(json, false);
+}
+export function DomainExpiryCountdownToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'years': value['years'],
+        'months': value['months'],
+        'days': value['days'],
+    };
+}

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

@@ -16,17 +16,17 @@
  */
 export interface DomainHostingLink {
     /**
-     * Linked hosting service id
+     * Linked hosting service id; omitted when no hosting is linked
      * @type {number}
      * @memberof DomainHostingLink
      */
-    hostingId: number;
+    hostingId?: number;
     /**
-     * Hosting module name (e.g. cpanel)
+     * Hosting module name (e.g. cpanel); omitted when no hosting is linked
      * @type {string}
      * @memberof DomainHostingLink
      */
-    module: string;
+    module?: string;
 }
 /**
  * Check if a given object implements the DomainHostingLink interface.

package/dist/esm/models/DomainHostingLink.js

@@ -15,10 +15,6 @@
  * Check if a given object implements the DomainHostingLink interface.
  */
 export function instanceOfDomainHostingLink(value) {
-    if (!('hostingId' in value) || value['hostingId'] === undefined)
-        return false;
-    if (!('module' in value) || value['module'] === undefined)
-        return false;
     return true;
 }
 export function DomainHostingLinkFromJSON(json) {
@@ -29,8 +25,8 @@ export function DomainHostingLinkFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'hostingId': json['hosting_id'],
-        'module': json['module'],
+        'hostingId': json['hosting_id'] == null ? undefined : json['hosting_id'],
+        'module': json['module'] == null ? undefined : json['module'],
     };
 }
 export function DomainHostingLinkToJSON(json) {

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

@@ -106,6 +106,12 @@ export interface DomainInfo {
      * @memberof DomainInfo
      */
     evaluation?: any | null;
+    /**
+     * True when EPP/auth code retrieval is disabled for this domain
+     * @type {boolean}
+     * @memberof DomainInfo
+     */
+    noEpp?: boolean;
 }
 /**
  * Check if a given object implements the DomainInfo interface.

package/dist/esm/models/DomainInfo.js

@@ -61,6 +61,7 @@ export function DomainInfoFromJSONTyped(json, ignoreDiscriminator) {
         'hasHosting': json['has_hosting'] == null ? undefined : DomainHostingLinkFromJSON(json['has_hosting']),
         'hasDnsManagerZone': json['has_dns_manager_zone'],
         'evaluation': json['evaluation'] == null ? undefined : json['evaluation'],
+        'noEpp': json['no_epp'] == null ? undefined : json['no_epp'],
     };
 }
 export function DomainInfoToJSON(json) {
@@ -86,5 +87,6 @@ export function DomainInfoToJSONTyped(value, ignoreDiscriminator = false) {
         'has_hosting': DomainHostingLinkToJSON(value['hasHosting']),
         'has_dns_manager_zone': value['hasDnsManagerZone'],
         'evaluation': value['evaluation'],
+        'no_epp': value['noEpp'],
     };
 }

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

@@ -0,0 +1,56 @@
+/**
+ * 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.
+ */
+/**
+ * Nameserver hostnames applied to a domain
+ * @export
+ * @interface DomainNameservers
+ */
+export interface DomainNameservers {
+    /**
+     * Primary nameserver hostname
+     * @type {string}
+     * @memberof DomainNameservers
+     */
+    ns1?: string;
+    /**
+     * Secondary nameserver hostname
+     * @type {string}
+     * @memberof DomainNameservers
+     */
+    ns2?: string;
+    /**
+     * Optional tertiary nameserver hostname
+     * @type {string}
+     * @memberof DomainNameservers
+     */
+    ns3?: string;
+    /**
+     * Optional quaternary nameserver hostname
+     * @type {string}
+     * @memberof DomainNameservers
+     */
+    ns4?: string;
+    /**
+     * Optional fifth nameserver hostname
+     * @type {string}
+     * @memberof DomainNameservers
+     */
+    ns5?: string;
+}
+/**
+ * Check if a given object implements the DomainNameservers interface.
+ */
+export declare function instanceOfDomainNameservers(value: object): value is DomainNameservers;
+export declare function DomainNameserversFromJSON(json: any): DomainNameservers;
+export declare function DomainNameserversFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainNameservers;
+export declare function DomainNameserversToJSON(json: any): DomainNameservers;
+export declare function DomainNameserversToJSONTyped(value?: DomainNameservers | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/DomainNameservers.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 DomainNameservers interface.
+ */
+export function instanceOfDomainNameservers(value) {
+    return true;
+}
+export function DomainNameserversFromJSON(json) {
+    return DomainNameserversFromJSONTyped(json, false);
+}
+export function DomainNameserversFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ns1': json['ns1'] == null ? undefined : json['ns1'],
+        'ns2': json['ns2'] == null ? undefined : json['ns2'],
+        'ns3': json['ns3'] == null ? undefined : json['ns3'],
+        'ns4': json['ns4'] == null ? undefined : json['ns4'],
+        'ns5': json['ns5'] == null ? undefined : json['ns5'],
+    };
+}
+export function DomainNameserversToJSON(json) {
+    return DomainNameserversToJSONTyped(json, false);
+}
+export function DomainNameserversToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ns1': value['ns1'],
+        'ns2': value['ns2'],
+        'ns3': value['ns3'],
+        'ns4': value['ns4'],
+        'ns5': value['ns5'],
+    };
+}