@hostafrica/ha-sdk-typescript 1.0.13 → 1.0.14

package/src/models/SnapshotJobDeleteResponseData.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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 { SnapshotJobLimits } from './SnapshotJobLimits.js';
+import {
+    SnapshotJobLimitsFromJSON,
+    SnapshotJobLimitsFromJSONTyped,
+    SnapshotJobLimitsToJSON,
+    SnapshotJobLimitsToJSONTyped,
+} from './SnapshotJobLimits.js';
+
+/**
+ * Response data for snapshot job delete operation
+ * @export
+ * @interface SnapshotJobDeleteResponseData
+ */
+export interface SnapshotJobDeleteResponseData {
+    /**
+     * Status message indicating the result
+     * @type {string}
+     * @memberof SnapshotJobDeleteResponseData
+     */
+    message: string;
+    /**
+     * 
+     * @type {SnapshotJobLimits}
+     * @memberof SnapshotJobDeleteResponseData
+     */
+    limits: SnapshotJobLimits;
+}
+
+/**
+ * Check if a given object implements the SnapshotJobDeleteResponseData interface.
+ */
+export function instanceOfSnapshotJobDeleteResponseData(value: object): value is SnapshotJobDeleteResponseData {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('limits' in value) || value['limits'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotJobDeleteResponseDataFromJSON(json: any): SnapshotJobDeleteResponseData {
+    return SnapshotJobDeleteResponseDataFromJSONTyped(json, false);
+}
+
+export function SnapshotJobDeleteResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobDeleteResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'limits': SnapshotJobLimitsFromJSON(json['limits']),
+    };
+}
+
+export function SnapshotJobDeleteResponseDataToJSON(json: any): SnapshotJobDeleteResponseData {
+    return SnapshotJobDeleteResponseDataToJSONTyped(json, false);
+}
+
+export function SnapshotJobDeleteResponseDataToJSONTyped(value?: SnapshotJobDeleteResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'limits': SnapshotJobLimitsToJSON(value['limits']),
+    };
+}
+

package/src/models/SnapshotJobLimits.ts

@@ -0,0 +1,84 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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';
+/**
+ * Limits and quota information for snapshot jobs
+ * @export
+ * @interface SnapshotJobLimits
+ */
+export interface SnapshotJobLimits {
+    /**
+     * Maximum number of snapshot jobs allowed
+     * @type {number}
+     * @memberof SnapshotJobLimits
+     */
+    maxJobs: number;
+    /**
+     * Current number of snapshot jobs
+     * @type {number}
+     * @memberof SnapshotJobLimits
+     */
+    jobCount: number;
+    /**
+     * Whether more jobs can be added
+     * @type {boolean}
+     * @memberof SnapshotJobLimits
+     */
+    canAddMore: boolean;
+}
+
+/**
+ * Check if a given object implements the SnapshotJobLimits interface.
+ */
+export function instanceOfSnapshotJobLimits(value: object): value is SnapshotJobLimits {
+    if (!('maxJobs' in value) || value['maxJobs'] === undefined) return false;
+    if (!('jobCount' in value) || value['jobCount'] === undefined) return false;
+    if (!('canAddMore' in value) || value['canAddMore'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotJobLimitsFromJSON(json: any): SnapshotJobLimits {
+    return SnapshotJobLimitsFromJSONTyped(json, false);
+}
+
+export function SnapshotJobLimitsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobLimits {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'maxJobs': json['max_jobs'],
+        'jobCount': json['job_count'],
+        'canAddMore': json['can_add_more'],
+    };
+}
+
+export function SnapshotJobLimitsToJSON(json: any): SnapshotJobLimits {
+    return SnapshotJobLimitsToJSONTyped(json, false);
+}
+
+export function SnapshotJobLimitsToJSONTyped(value?: SnapshotJobLimits | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'max_jobs': value['maxJobs'],
+        'job_count': value['jobCount'],
+        'can_add_more': value['canAddMore'],
+    };
+}
+

package/src/models/SnapshotJobListResponseData.ts

@@ -0,0 +1,107 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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 { SnapshotJob } from './SnapshotJob.js';
+import {
+    SnapshotJobFromJSON,
+    SnapshotJobFromJSONTyped,
+    SnapshotJobToJSON,
+    SnapshotJobToJSONTyped,
+} from './SnapshotJob.js';
+import type { SnapshotJobLimits } from './SnapshotJobLimits.js';
+import {
+    SnapshotJobLimitsFromJSON,
+    SnapshotJobLimitsFromJSONTyped,
+    SnapshotJobLimitsToJSON,
+    SnapshotJobLimitsToJSONTyped,
+} from './SnapshotJobLimits.js';
+
+/**
+ * Response data for snapshot job list operation
+ * @export
+ * @interface SnapshotJobListResponseData
+ */
+export interface SnapshotJobListResponseData {
+    /**
+     * Status message indicating the result
+     * @type {string}
+     * @memberof SnapshotJobListResponseData
+     */
+    message: string;
+    /**
+     * List of snapshot jobs
+     * @type {Array<SnapshotJob>}
+     * @memberof SnapshotJobListResponseData
+     */
+    jobs: Array<SnapshotJob>;
+    /**
+     * 
+     * @type {SnapshotJobLimits}
+     * @memberof SnapshotJobListResponseData
+     */
+    limits: SnapshotJobLimits;
+    /**
+     * Allowed schedule periods for snapshot jobs
+     * @type {Array<string>}
+     * @memberof SnapshotJobListResponseData
+     */
+    allowedPeriods?: Array<string>;
+}
+
+/**
+ * Check if a given object implements the SnapshotJobListResponseData interface.
+ */
+export function instanceOfSnapshotJobListResponseData(value: object): value is SnapshotJobListResponseData {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('jobs' in value) || value['jobs'] === undefined) return false;
+    if (!('limits' in value) || value['limits'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotJobListResponseDataFromJSON(json: any): SnapshotJobListResponseData {
+    return SnapshotJobListResponseDataFromJSONTyped(json, false);
+}
+
+export function SnapshotJobListResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobListResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'jobs': ((json['jobs'] as Array<any>).map(SnapshotJobFromJSON)),
+        'limits': SnapshotJobLimitsFromJSON(json['limits']),
+        'allowedPeriods': json['allowed_periods'] == null ? undefined : json['allowed_periods'],
+    };
+}
+
+export function SnapshotJobListResponseDataToJSON(json: any): SnapshotJobListResponseData {
+    return SnapshotJobListResponseDataToJSONTyped(json, false);
+}
+
+export function SnapshotJobListResponseDataToJSONTyped(value?: SnapshotJobListResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'jobs': ((value['jobs'] as Array<any>).map(SnapshotJobToJSON)),
+        'limits': SnapshotJobLimitsToJSON(value['limits']),
+        'allowed_periods': value['allowedPeriods'],
+    };
+}
+

package/src/models/SnapshotJobMutationResponseData.ts

@@ -0,0 +1,99 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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 { SnapshotJob } from './SnapshotJob.js';
+import {
+    SnapshotJobFromJSON,
+    SnapshotJobFromJSONTyped,
+    SnapshotJobToJSON,
+    SnapshotJobToJSONTyped,
+} from './SnapshotJob.js';
+import type { SnapshotJobLimits } from './SnapshotJobLimits.js';
+import {
+    SnapshotJobLimitsFromJSON,
+    SnapshotJobLimitsFromJSONTyped,
+    SnapshotJobLimitsToJSON,
+    SnapshotJobLimitsToJSONTyped,
+} from './SnapshotJobLimits.js';
+
+/**
+ * Response data for snapshot job create operation
+ * @export
+ * @interface SnapshotJobMutationResponseData
+ */
+export interface SnapshotJobMutationResponseData {
+    /**
+     * Status message indicating the result
+     * @type {string}
+     * @memberof SnapshotJobMutationResponseData
+     */
+    message: string;
+    /**
+     * 
+     * @type {SnapshotJob}
+     * @memberof SnapshotJobMutationResponseData
+     */
+    job: SnapshotJob;
+    /**
+     * 
+     * @type {SnapshotJobLimits}
+     * @memberof SnapshotJobMutationResponseData
+     */
+    limits: SnapshotJobLimits;
+}
+
+/**
+ * Check if a given object implements the SnapshotJobMutationResponseData interface.
+ */
+export function instanceOfSnapshotJobMutationResponseData(value: object): value is SnapshotJobMutationResponseData {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('job' in value) || value['job'] === undefined) return false;
+    if (!('limits' in value) || value['limits'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotJobMutationResponseDataFromJSON(json: any): SnapshotJobMutationResponseData {
+    return SnapshotJobMutationResponseDataFromJSONTyped(json, false);
+}
+
+export function SnapshotJobMutationResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobMutationResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'job': SnapshotJobFromJSON(json['job']),
+        'limits': SnapshotJobLimitsFromJSON(json['limits']),
+    };
+}
+
+export function SnapshotJobMutationResponseDataToJSON(json: any): SnapshotJobMutationResponseData {
+    return SnapshotJobMutationResponseDataToJSONTyped(json, false);
+}
+
+export function SnapshotJobMutationResponseDataToJSONTyped(value?: SnapshotJobMutationResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'job': SnapshotJobToJSON(value['job']),
+        'limits': SnapshotJobLimitsToJSON(value['limits']),
+    };
+}
+

package/src/models/SnapshotJobPeriod.ts

@@ -0,0 +1,53 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+/**
+ * Schedule period for snapshot jobs
+ * @export
+ */
+export const SnapshotJobPeriod = {
+    Hourly: 'hourly',
+    Daily: 'daily'
+} as const;
+export type SnapshotJobPeriod = typeof SnapshotJobPeriod[keyof typeof SnapshotJobPeriod];
+
+
+export function instanceOfSnapshotJobPeriod(value: any): boolean {
+    for (const key in SnapshotJobPeriod) {
+        if (Object.prototype.hasOwnProperty.call(SnapshotJobPeriod, key)) {
+            if (SnapshotJobPeriod[key as keyof typeof SnapshotJobPeriod] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function SnapshotJobPeriodFromJSON(json: any): SnapshotJobPeriod {
+    return SnapshotJobPeriodFromJSONTyped(json, false);
+}
+
+export function SnapshotJobPeriodFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobPeriod {
+    return json as SnapshotJobPeriod;
+}
+
+export function SnapshotJobPeriodToJSON(value?: SnapshotJobPeriod | null): any {
+    return value as any;
+}
+
+export function SnapshotJobPeriodToJSONTyped(value: any, ignoreDiscriminator: boolean): SnapshotJobPeriod {
+    return value as SnapshotJobPeriod;
+}
+

package/src/models/SnapshotJobUpdateResponseData.ts

@@ -0,0 +1,83 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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 { SnapshotJob } from './SnapshotJob.js';
+import {
+    SnapshotJobFromJSON,
+    SnapshotJobFromJSONTyped,
+    SnapshotJobToJSON,
+    SnapshotJobToJSONTyped,
+} from './SnapshotJob.js';
+
+/**
+ * Response data for snapshot job update operation
+ * @export
+ * @interface SnapshotJobUpdateResponseData
+ */
+export interface SnapshotJobUpdateResponseData {
+    /**
+     * Status message indicating the result
+     * @type {string}
+     * @memberof SnapshotJobUpdateResponseData
+     */
+    message: string;
+    /**
+     * 
+     * @type {SnapshotJob}
+     * @memberof SnapshotJobUpdateResponseData
+     */
+    job: SnapshotJob;
+}
+
+/**
+ * Check if a given object implements the SnapshotJobUpdateResponseData interface.
+ */
+export function instanceOfSnapshotJobUpdateResponseData(value: object): value is SnapshotJobUpdateResponseData {
+    if (!('message' in value) || value['message'] === undefined) return false;
+    if (!('job' in value) || value['job'] === undefined) return false;
+    return true;
+}
+
+export function SnapshotJobUpdateResponseDataFromJSON(json: any): SnapshotJobUpdateResponseData {
+    return SnapshotJobUpdateResponseDataFromJSONTyped(json, false);
+}
+
+export function SnapshotJobUpdateResponseDataFromJSONTyped(json: any, ignoreDiscriminator: boolean): SnapshotJobUpdateResponseData {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'message': json['message'],
+        'job': SnapshotJobFromJSON(json['job']),
+    };
+}
+
+export function SnapshotJobUpdateResponseDataToJSON(json: any): SnapshotJobUpdateResponseData {
+    return SnapshotJobUpdateResponseDataToJSONTyped(json, false);
+}
+
+export function SnapshotJobUpdateResponseDataToJSONTyped(value?: SnapshotJobUpdateResponseData | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'message': value['message'],
+        'job': SnapshotJobToJSON(value['job']),
+    };
+}
+

package/src/models/UpdateSnapshotJobRequestContent.ts

@@ -0,0 +1,148 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * HostAfricaApi
+ * HostAfrica API
+ *
+ * The version of the OpenAPI document: 2026-01-01
+ * 
+ *
+ * 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 { DayOfWeek } from './DayOfWeek.js';
+import {
+    DayOfWeekFromJSON,
+    DayOfWeekFromJSONTyped,
+    DayOfWeekToJSON,
+    DayOfWeekToJSONTyped,
+} from './DayOfWeek.js';
+import type { SnapshotJobPeriod } from './SnapshotJobPeriod.js';
+import {
+    SnapshotJobPeriodFromJSON,
+    SnapshotJobPeriodFromJSONTyped,
+    SnapshotJobPeriodToJSON,
+    SnapshotJobPeriodToJSONTyped,
+} from './SnapshotJobPeriod.js';
+
+/**
+ * 
+ * @export
+ * @interface UpdateSnapshotJobRequestContent
+ */
+export interface UpdateSnapshotJobRequestContent {
+    /**
+     * Service ID - must be sent as a string
+     * @type {string}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    serviceId: string;
+    /**
+     * Snapshot job ID to update
+     * @type {string}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    jobId: string;
+    /**
+     * New name for the snapshot job
+     * @type {string}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    name?: string;
+    /**
+     * New description for the snapshot job
+     * @type {string}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    description?: string;
+    /**
+     * Whether to include VM state in the snapshot
+     * @type {boolean}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    vmstate?: boolean;
+    /**
+     * 
+     * @type {SnapshotJobPeriod}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    period?: SnapshotJobPeriod;
+    /**
+     * For hourly jobs: run every N hours (e.g. 6 = every 6 hours)
+     * @type {number}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    runEvery?: number;
+    /**
+     * For daily jobs: days of week when the job should run
+     * @type {Array<DayOfWeek>}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    days?: Array<DayOfWeek>;
+    /**
+     * For daily jobs: start time in HH:MM format (e.g. '02:30')
+     * @type {string}
+     * @memberof UpdateSnapshotJobRequestContent
+     */
+    startTime?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the UpdateSnapshotJobRequestContent interface.
+ */
+export function instanceOfUpdateSnapshotJobRequestContent(value: object): value is UpdateSnapshotJobRequestContent {
+    if (!('serviceId' in value) || value['serviceId'] === undefined) return false;
+    if (!('jobId' in value) || value['jobId'] === undefined) return false;
+    return true;
+}
+
+export function UpdateSnapshotJobRequestContentFromJSON(json: any): UpdateSnapshotJobRequestContent {
+    return UpdateSnapshotJobRequestContentFromJSONTyped(json, false);
+}
+
+export function UpdateSnapshotJobRequestContentFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateSnapshotJobRequestContent {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'serviceId': json['service_id'],
+        'jobId': json['job_id'],
+        'name': json['name'] == null ? undefined : json['name'],
+        'description': json['description'] == null ? undefined : json['description'],
+        'vmstate': json['vmstate'] == null ? undefined : json['vmstate'],
+        'period': json['period'] == null ? undefined : SnapshotJobPeriodFromJSON(json['period']),
+        'runEvery': json['run_every'] == null ? undefined : json['run_every'],
+        'days': json['days'] == null ? undefined : ((json['days'] as Array<any>).map(DayOfWeekFromJSON)),
+        'startTime': json['start_time'] == null ? undefined : json['start_time'],
+    };
+}
+
+export function UpdateSnapshotJobRequestContentToJSON(json: any): UpdateSnapshotJobRequestContent {
+    return UpdateSnapshotJobRequestContentToJSONTyped(json, false);
+}
+
+export function UpdateSnapshotJobRequestContentToJSONTyped(value?: UpdateSnapshotJobRequestContent | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'service_id': value['serviceId'],
+        'job_id': value['jobId'],
+        'name': value['name'],
+        'description': value['description'],
+        'vmstate': value['vmstate'],
+        'period': SnapshotJobPeriodToJSON(value['period']),
+        'run_every': value['runEvery'],
+        'days': value['days'] == null ? undefined : ((value['days'] as Array<any>).map(DayOfWeekToJSON)),
+        'start_time': value['startTime'],
+    };
+}
+