@hostafrica/ha-sdk-typescript 1.0.13 → 1.1.2

package/src/models/DomainInfo.ts

@@ -0,0 +1,195 @@
+/* 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 { DomainHostingLink } from './DomainHostingLink.js';
+import {
+    DomainHostingLinkFromJSON,
+    DomainHostingLinkFromJSONTyped,
+    DomainHostingLinkToJSON,
+    DomainHostingLinkToJSONTyped,
+} from './DomainHostingLink.js';
+
+/**
+ * Summary of an owned domain returned by list operations
+ * @export
+ * @interface DomainInfo
+ */
+export interface DomainInfo {
+    /**
+     * Domain service id
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    domainId: string;
+    /**
+     * Domain operation type (e.g. Register, Transfer)
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    type: string;
+    /**
+     * Fully qualified domain name
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    domain: string;
+    /**
+     * Domain status (e.g. Active, Expired, Cancelled)
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    status: string;
+    /**
+     * Registration or billing period in years
+     * @type {number}
+     * @memberof DomainInfo
+     */
+    period: number;
+    /**
+     * Renewal flag: 0 = renew, 1 = do not renew
+     * @type {number}
+     * @memberof DomainInfo
+     */
+    donotrenew: number;
+    /**
+     * WHOIS privacy enabled: 0 = off, 1 = on
+     * @type {number}
+     * @memberof DomainInfo
+     */
+    idProtection: number;
+    /**
+     * Whether the TLD supports ID protection
+     * @type {boolean}
+     * @memberof DomainInfo
+     */
+    idProtectionSupported: boolean;
+    /**
+     * Recurring amount as a decimal string (e.g. "149.99")
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    recurringamount: string;
+    /**
+     * Domain expiry date (YYYY-MM-DD)
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    expirydate?: string;
+    /**
+     * Next invoice date (YYYY-MM-DD)
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    nextinvoicedate?: string;
+    /**
+     * Next due date (YYYY-MM-DD)
+     * @type {string}
+     * @memberof DomainInfo
+     */
+    nextduedate?: string;
+    /**
+     * 
+     * @type {DomainHostingLink}
+     * @memberof DomainInfo
+     */
+    hasHosting?: DomainHostingLink;
+    /**
+     * Whether a DNS Manager zone exists for this domain name
+     * @type {boolean}
+     * @memberof DomainInfo
+     */
+    hasDnsManagerZone: boolean;
+    /**
+     * Domain evaluator result when enabled; null when unavailable
+     * @type {any}
+     * @memberof DomainInfo
+     */
+    evaluation?: any | null;
+}
+
+/**
+ * Check if a given object implements the DomainInfo interface.
+ */
+export function instanceOfDomainInfo(value: object): value is DomainInfo {
+    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 DomainInfoFromJSON(json: any): DomainInfo {
+    return DomainInfoFromJSONTyped(json, false);
+}
+
+export function DomainInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainId': json['domain_id'],
+        'type': json['type'],
+        'domain': json['domain'],
+        'status': json['status'],
+        'period': json['period'],
+        'donotrenew': json['donotrenew'],
+        'idProtection': json['id_protection'],
+        'idProtectionSupported': json['id_protection_supported'],
+        'recurringamount': json['recurringamount'],
+        'expirydate': json['expirydate'] == null ? undefined : json['expirydate'],
+        'nextinvoicedate': json['nextinvoicedate'] == null ? undefined : json['nextinvoicedate'],
+        'nextduedate': json['nextduedate'] == null ? undefined : json['nextduedate'],
+        'hasHosting': json['has_hosting'] == null ? undefined : DomainHostingLinkFromJSON(json['has_hosting']),
+        'hasDnsManagerZone': json['has_dns_manager_zone'],
+        'evaluation': json['evaluation'] == null ? undefined : json['evaluation'],
+    };
+}
+
+export function DomainInfoToJSON(json: any): DomainInfo {
+    return DomainInfoToJSONTyped(json, false);
+}
+
+export function DomainInfoToJSONTyped(value?: DomainInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domain_id': value['domainId'],
+        'type': value['type'],
+        'domain': value['domain'],
+        'status': value['status'],
+        'period': value['period'],
+        'donotrenew': value['donotrenew'],
+        'id_protection': value['idProtection'],
+        'id_protection_supported': value['idProtectionSupported'],
+        'recurringamount': value['recurringamount'],
+        'expirydate': value['expirydate'],
+        'nextinvoicedate': value['nextinvoicedate'],
+        'nextduedate': value['nextduedate'],
+        'has_hosting': DomainHostingLinkToJSON(value['hasHosting']),
+        'has_dns_manager_zone': value['hasDnsManagerZone'],
+        'evaluation': value['evaluation'],
+    };
+}
+

package/src/models/DomainPricing.ts

@@ -0,0 +1,89 @@
+/* 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 { DomainPricingEntry } from './DomainPricingEntry.js';
+import {
+    DomainPricingEntryFromJSON,
+    DomainPricingEntryFromJSONTyped,
+    DomainPricingEntryToJSON,
+    DomainPricingEntryToJSONTyped,
+} from './DomainPricingEntry.js';
+
+/**
+ * Registration, renewal and transfer pricing tiers for a domain
+ * @export
+ * @interface DomainPricing
+ */
+export interface DomainPricing {
+    /**
+     * 
+     * @type {Array<DomainPricingEntry>}
+     * @memberof DomainPricing
+     */
+    domainregister?: Array<DomainPricingEntry>;
+    /**
+     * 
+     * @type {Array<DomainPricingEntry>}
+     * @memberof DomainPricing
+     */
+    domainrenew?: Array<DomainPricingEntry>;
+    /**
+     * 
+     * @type {Array<DomainPricingEntry>}
+     * @memberof DomainPricing
+     */
+    domaintransfer?: Array<DomainPricingEntry>;
+}
+
+/**
+ * Check if a given object implements the DomainPricing interface.
+ */
+export function instanceOfDomainPricing(value: object): value is DomainPricing {
+    return true;
+}
+
+export function DomainPricingFromJSON(json: any): DomainPricing {
+    return DomainPricingFromJSONTyped(json, false);
+}
+
+export function DomainPricingFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainPricing {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainregister': json['domainregister'] == null ? undefined : ((json['domainregister'] as Array<any>).map(DomainPricingEntryFromJSON)),
+        'domainrenew': json['domainrenew'] == null ? undefined : ((json['domainrenew'] as Array<any>).map(DomainPricingEntryFromJSON)),
+        'domaintransfer': json['domaintransfer'] == null ? undefined : ((json['domaintransfer'] as Array<any>).map(DomainPricingEntryFromJSON)),
+    };
+}
+
+export function DomainPricingToJSON(json: any): DomainPricing {
+    return DomainPricingToJSONTyped(json, false);
+}
+
+export function DomainPricingToJSONTyped(value?: DomainPricing | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domainregister': value['domainregister'] == null ? undefined : ((value['domainregister'] as Array<any>).map(DomainPricingEntryToJSON)),
+        'domainrenew': value['domainrenew'] == null ? undefined : ((value['domainrenew'] as Array<any>).map(DomainPricingEntryToJSON)),
+        'domaintransfer': value['domaintransfer'] == null ? undefined : ((value['domaintransfer'] as Array<any>).map(DomainPricingEntryToJSON)),
+    };
+}
+

package/src/models/DomainPricingEntry.ts

@@ -0,0 +1,75 @@
+/* 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 period/price pair for domain pricing
+ * @export
+ * @interface DomainPricingEntry
+ */
+export interface DomainPricingEntry {
+    /**
+     * 
+     * @type {number}
+     * @memberof DomainPricingEntry
+     */
+    period: number;
+    /**
+     * Price as a decimal string with two decimal places
+     * @type {string}
+     * @memberof DomainPricingEntry
+     */
+    price: string;
+}
+
+/**
+ * Check if a given object implements the DomainPricingEntry interface.
+ */
+export function instanceOfDomainPricingEntry(value: object): value is DomainPricingEntry {
+    if (!('period' in value) || value['period'] === undefined) return false;
+    if (!('price' in value) || value['price'] === undefined) return false;
+    return true;
+}
+
+export function DomainPricingEntryFromJSON(json: any): DomainPricingEntry {
+    return DomainPricingEntryFromJSONTyped(json, false);
+}
+
+export function DomainPricingEntryFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainPricingEntry {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'period': json['period'],
+        'price': json['price'],
+    };
+}
+
+export function DomainPricingEntryToJSON(json: any): DomainPricingEntry {
+    return DomainPricingEntryToJSONTyped(json, false);
+}
+
+export function DomainPricingEntryToJSONTyped(value?: DomainPricingEntry | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'period': value['period'],
+        'price': value['price'],
+    };
+}
+

package/src/models/DomainRequiringDataAdditionalField.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';
+/**
+ * Additional registrar field required for a pending domain
+ * @export
+ * @interface DomainRequiringDataAdditionalField
+ */
+export interface DomainRequiringDataAdditionalField {
+    /**
+     * Field key to use when saving additional domain data
+     * @type {string}
+     * @memberof DomainRequiringDataAdditionalField
+     */
+    name: string;
+    /**
+     * Human-readable label for the field
+     * @type {string}
+     * @memberof DomainRequiringDataAdditionalField
+     */
+    displayname: string;
+    /**
+     * Input type (e.g. text)
+     * @type {string}
+     * @memberof DomainRequiringDataAdditionalField
+     */
+    type: string;
+    /**
+     * Whether the field must be provided
+     * @type {boolean}
+     * @memberof DomainRequiringDataAdditionalField
+     */
+    required: boolean;
+    /**
+     * Current value; empty when not yet supplied
+     * @type {string}
+     * @memberof DomainRequiringDataAdditionalField
+     */
+    value: string;
+}
+
+/**
+ * Check if a given object implements the DomainRequiringDataAdditionalField interface.
+ */
+export function instanceOfDomainRequiringDataAdditionalField(value: object): value is DomainRequiringDataAdditionalField {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('displayname' in value) || value['displayname'] === undefined) return false;
+    if (!('type' in value) || value['type'] === undefined) return false;
+    if (!('required' in value) || value['required'] === undefined) return false;
+    if (!('value' in value) || value['value'] === undefined) return false;
+    return true;
+}
+
+export function DomainRequiringDataAdditionalFieldFromJSON(json: any): DomainRequiringDataAdditionalField {
+    return DomainRequiringDataAdditionalFieldFromJSONTyped(json, false);
+}
+
+export function DomainRequiringDataAdditionalFieldFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainRequiringDataAdditionalField {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'displayname': json['displayname'],
+        'type': json['type'],
+        'required': json['required'],
+        'value': json['value'],
+    };
+}
+
+export function DomainRequiringDataAdditionalFieldToJSON(json: any): DomainRequiringDataAdditionalField {
+    return DomainRequiringDataAdditionalFieldToJSONTyped(json, false);
+}
+
+export function DomainRequiringDataAdditionalFieldToJSONTyped(value?: DomainRequiringDataAdditionalField | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'displayname': value['displayname'],
+        'type': value['type'],
+        'required': value['required'],
+        'value': value['value'],
+    };
+}
+

package/src/models/DomainRequiringDataInfo.ts

@@ -0,0 +1,119 @@
+/* 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 { DomainRequiringDataAdditionalField } from './DomainRequiringDataAdditionalField.js';
+import {
+    DomainRequiringDataAdditionalFieldFromJSON,
+    DomainRequiringDataAdditionalFieldFromJSONTyped,
+    DomainRequiringDataAdditionalFieldToJSON,
+    DomainRequiringDataAdditionalFieldToJSONTyped,
+} from './DomainRequiringDataAdditionalField.js';
+
+/**
+ * Pending domain requiring additional registrar or contact data
+ * @export
+ * @interface DomainRequiringDataInfo
+ */
+export interface DomainRequiringDataInfo {
+    /**
+     * Domain service id
+     * @type {string}
+     * @memberof DomainRequiringDataInfo
+     */
+    domainId: string;
+    /**
+     * Fully qualified domain name
+     * @type {string}
+     * @memberof DomainRequiringDataInfo
+     */
+    domain: string;
+    /**
+     * Domain status (e.g. Pending)
+     * @type {string}
+     * @memberof DomainRequiringDataInfo
+     */
+    status: string;
+    /**
+     * Domain operation type (e.g. Register)
+     * @type {string}
+     * @memberof DomainRequiringDataInfo
+     */
+    domainType: string;
+    /**
+     * Top-level domain suffix (e.g. .co.za)
+     * @type {string}
+     * @memberof DomainRequiringDataInfo
+     */
+    tld: string;
+    /**
+     * Additional registrar fields required for this TLD
+     * @type {Array<DomainRequiringDataAdditionalField>}
+     * @memberof DomainRequiringDataInfo
+     */
+    additionalFields: Array<DomainRequiringDataAdditionalField>;
+}
+
+/**
+ * Check if a given object implements the DomainRequiringDataInfo interface.
+ */
+export function instanceOfDomainRequiringDataInfo(value: object): value is DomainRequiringDataInfo {
+    if (!('domainId' in value) || value['domainId'] === undefined) return false;
+    if (!('domain' in value) || value['domain'] === undefined) return false;
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('domainType' in value) || value['domainType'] === undefined) return false;
+    if (!('tld' in value) || value['tld'] === undefined) return false;
+    if (!('additionalFields' in value) || value['additionalFields'] === undefined) return false;
+    return true;
+}
+
+export function DomainRequiringDataInfoFromJSON(json: any): DomainRequiringDataInfo {
+    return DomainRequiringDataInfoFromJSONTyped(json, false);
+}
+
+export function DomainRequiringDataInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainRequiringDataInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainId': json['domain_id'],
+        'domain': json['domain'],
+        'status': json['status'],
+        'domainType': json['domain_type'],
+        'tld': json['tld'],
+        'additionalFields': ((json['additionalFields'] as Array<any>).map(DomainRequiringDataAdditionalFieldFromJSON)),
+    };
+}
+
+export function DomainRequiringDataInfoToJSON(json: any): DomainRequiringDataInfo {
+    return DomainRequiringDataInfoToJSONTyped(json, false);
+}
+
+export function DomainRequiringDataInfoToJSONTyped(value?: DomainRequiringDataInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domain_id': value['domainId'],
+        'domain': value['domain'],
+        'status': value['status'],
+        'domain_type': value['domainType'],
+        'tld': value['tld'],
+        'additionalFields': ((value['additionalFields'] as Array<any>).map(DomainRequiringDataAdditionalFieldToJSON)),
+    };
+}
+

package/src/models/DomainSearchResponseData.ts

@@ -0,0 +1,117 @@
+/* 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 { DomainAvailabilityResult } from './DomainAvailabilityResult.js';
+import {
+    DomainAvailabilityResultFromJSON,
+    DomainAvailabilityResultFromJSONTyped,
+    DomainAvailabilityResultToJSON,
+    DomainAvailabilityResultToJSONTyped,
+} from './DomainAvailabilityResult.js';
+
+/**
+ * Response data for domain availability and suggestion operations
+ * @export
+ * @interface DomainSearchResponseData
+ */
+export interface DomainSearchResponseData {
+    /**
+     * Domain availability results
+     * @type {Array<DomainAvailabilityResult>}
+     * @memberof DomainSearchResponseData
+     */
+    domains: Array<DomainAvailabilityResult>;
+    /**
+     * Alternative domain suggestions (single-domain lookup only)
+     * @type {Array<string>}
+     * @memberof DomainSearchResponseData
+     */
+    suggestions?: Array<string>;
+    /**
+     * Upstream currency identifier
+     * @type {number}
+     * @memberof DomainSearchResponseData
+     */
+    currency: number;
+    /**
+     * ISO currency code for the quoted prices
+     * @type {string}
+     * @memberof DomainSearchResponseData
+     */
+    currencyCode: string;
+    /**
+     * Note that prices and register_url are valid only for currency_code
+     * @type {string}
+     * @memberof DomainSearchResponseData
+     */
+    currencyNote: string;
+    /**
+     * Non-fatal warnings the client should be aware of
+     * @type {Array<string>}
+     * @memberof DomainSearchResponseData
+     */
+    warnings?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the DomainSearchResponseData interface.
+ */
+export function instanceOfDomainSearchResponseData(value: object): value is DomainSearchResponseData {
+    if (!('domains' in value) || value['domains'] === undefined) return false;
+    if (!('currency' in value) || value['currency'] === undefined) return false;
+    if (!('currencyCode' in value) || value['currencyCode'] === undefined) return false;
+    if (!('currencyNote' in value) || value['currencyNote'] === undefined) return false;
+    return true;
+}
+
+export function DomainSearchResponseDataFromJSON(json: any): DomainSearchResponseData {
+    return DomainSearchResponseDataFromJSONTyped(json, false);
+}
+
+export function DomainSearchResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainSearchResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domains': ((json['domains'] as Array<any>).map(DomainAvailabilityResultFromJSON)),
+        'suggestions': json['suggestions'] == null ? undefined : json['suggestions'],
+        'currency': json['currency'],
+        'currencyCode': json['currency_code'],
+        'currencyNote': json['currency_note'],
+        'warnings': json['warnings'] == null ? undefined : json['warnings'],
+    };
+}
+
+export function DomainSearchResponseDataToJSON(json: any): DomainSearchResponseData {
+    return DomainSearchResponseDataToJSONTyped(json, false);
+}
+
+export function DomainSearchResponseDataToJSONTyped(value?: DomainSearchResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domains': ((value['domains'] as Array<any>).map(DomainAvailabilityResultToJSON)),
+        'suggestions': value['suggestions'],
+        'currency': value['currency'],
+        'currency_code': value['currencyCode'],
+        'currency_note': value['currencyNote'],
+        'warnings': value['warnings'],
+    };
+}
+