@hostafrica/ha-sdk-typescript 1.0.14 → 1.1.3

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'],
+    };
+}
+

package/src/models/DomainSettingKey.ts

@@ -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.
+ */
+
+
+/**
+ * Allowed domain setting keys for update-domain-settings
+ * @export
+ */
+export const DomainSettingKey = {
+    Donotrenew: 'donotrenew',
+    Idprotection: 'idprotection',
+    Dnsmanagement: 'dnsmanagement',
+    Emailforwarding: 'emailforwarding'
+} as const;
+export type DomainSettingKey = typeof DomainSettingKey[keyof typeof DomainSettingKey];
+
+
+export function instanceOfDomainSettingKey(value: any): boolean {
+    for (const key in DomainSettingKey) {
+        if (Object.prototype.hasOwnProperty.call(DomainSettingKey, key)) {
+            if (DomainSettingKey[key as keyof typeof DomainSettingKey] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DomainSettingKeyFromJSON(json: any): DomainSettingKey {
+    return DomainSettingKeyFromJSONTyped(json, false);
+}
+
+export function DomainSettingKeyFromJSONTyped(json: any, ignoreDiscriminator: boolean): DomainSettingKey {
+    return json as DomainSettingKey;
+}
+
+export function DomainSettingKeyToJSON(value?: DomainSettingKey | null): any {
+    return value as any;
+}
+
+export function DomainSettingKeyToJSONTyped(value: any, ignoreDiscriminator: boolean): DomainSettingKey {
+    return value as DomainSettingKey;
+}
+

package/src/models/EditBackupScheduleRequestContent.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/EditBackupScheduleResponseContent.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/EditDnsRecordRequestContent.ts

@@ -0,0 +1,91 @@
+/* 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 { DnsRecordMutationRecord } from './DnsRecordMutationRecord.js';
+import {
+    DnsRecordMutationRecordFromJSON,
+    DnsRecordMutationRecordFromJSONTyped,
+    DnsRecordMutationRecordToJSON,
+    DnsRecordMutationRecordToJSONTyped,
+} from './DnsRecordMutationRecord.js';
+
+/**
+ * 
+ * @export
+ * @interface EditDnsRecordRequestContent
+ */
+export interface EditDnsRecordRequestContent {
+    /**
+     * DNS zone domain name (FQDN); optional when zone_id is provided
+     * @type {string}
+     * @memberof EditDnsRecordRequestContent
+     */
+    domainName?: string;
+    /**
+     * DNS zone identifier from list-dns-zones or get-dns-zone-details
+     * @type {string}
+     * @memberof EditDnsRecordRequestContent
+     */
+    zoneId: string;
+    /**
+     * 
+     * @type {DnsRecordMutationRecord}
+     * @memberof EditDnsRecordRequestContent
+     */
+    record: DnsRecordMutationRecord;
+}
+
+/**
+ * Check if a given object implements the EditDnsRecordRequestContent interface.
+ */
+export function instanceOfEditDnsRecordRequestContent(value: object): value is EditDnsRecordRequestContent {
+    if (!('zoneId' in value) || value['zoneId'] === undefined) return false;
+    if (!('record' in value) || value['record'] === undefined) return false;
+    return true;
+}
+
+export function EditDnsRecordRequestContentFromJSON(json: any): EditDnsRecordRequestContent {
+    return EditDnsRecordRequestContentFromJSONTyped(json, false);
+}
+
+export function EditDnsRecordRequestContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EditDnsRecordRequestContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'domainName': json['domain_name'] == null ? undefined : json['domain_name'],
+        'zoneId': json['zone_id'],
+        'record': DnsRecordMutationRecordFromJSON(json['record']),
+    };
+}
+
+export function EditDnsRecordRequestContentToJSON(json: any): EditDnsRecordRequestContent {
+    return EditDnsRecordRequestContentToJSONTyped(json, false);
+}
+
+export function EditDnsRecordRequestContentToJSONTyped(value?: EditDnsRecordRequestContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'domain_name': value['domainName'],
+        'zone_id': value['zoneId'],
+        'record': DnsRecordMutationRecordToJSON(value['record']),
+    };
+}
+

package/src/models/EditDnsRecordResponseContent.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 { DnsRecordMutationData } from './DnsRecordMutationData.js';
+import {
+    DnsRecordMutationDataFromJSON,
+    DnsRecordMutationDataFromJSONTyped,
+    DnsRecordMutationDataToJSON,
+    DnsRecordMutationDataToJSONTyped,
+} from './DnsRecordMutationData.js';
+import type { OperationStatus } from './OperationStatus.js';
+import {
+    OperationStatusFromJSON,
+    OperationStatusFromJSONTyped,
+    OperationStatusToJSON,
+    OperationStatusToJSONTyped,
+} from './OperationStatus.js';
+
+/**
+ * 
+ * @export
+ * @interface EditDnsRecordResponseContent
+ */
+export interface EditDnsRecordResponseContent {
+    /**
+     * 
+     * @type {OperationStatus}
+     * @memberof EditDnsRecordResponseContent
+     */
+    status: OperationStatus;
+    /**
+     * 
+     * @type {DnsRecordMutationData}
+     * @memberof EditDnsRecordResponseContent
+     */
+    data: DnsRecordMutationData;
+}
+
+
+
+/**
+ * Check if a given object implements the EditDnsRecordResponseContent interface.
+ */
+export function instanceOfEditDnsRecordResponseContent(value: object): value is EditDnsRecordResponseContent {
+    if (!('status' in value) || value['status'] === undefined) return false;
+    if (!('data' in value) || value['data'] === undefined) return false;
+    return true;
+}
+
+export function EditDnsRecordResponseContentFromJSON(json: any): EditDnsRecordResponseContent {
+    return EditDnsRecordResponseContentFromJSONTyped(json, false);
+}
+
+export function EditDnsRecordResponseContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): EditDnsRecordResponseContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'status': OperationStatusFromJSON(json['status']),
+        'data': DnsRecordMutationDataFromJSON(json['data']),
+    };
+}
+
+export function EditDnsRecordResponseContentToJSON(json: any): EditDnsRecordResponseContent {
+    return EditDnsRecordResponseContentToJSONTyped(json, false);
+}
+
+export function EditDnsRecordResponseContentToJSONTyped(value?: EditDnsRecordResponseContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'status': OperationStatusToJSON(value['status']),
+        'data': DnsRecordMutationDataToJSON(value['data']),
+    };
+}
+

package/src/models/FirewallListResponseData.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallMoveDirection.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallMoveResponseData.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallOption.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallRule.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallRuleAction.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/FirewallRuleType.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/ForbiddenErrorResponseContent.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/GetCatalogueRequestContent.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).

package/src/models/GetCatalogueResponseContent.ts

@@ -4,7 +4,7 @@
  * HostAfricaApi
  * HostAfrica API
  *
- * The version of the OpenAPI document: 2026-01-01
+ * 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).