@hostafrica/ha-sdk-typescript 1.0.12 → 1.0.14

package/docs/ListSnapshotJobsRequestContent.md

@@ -0,0 +1,34 @@
+
+# ListSnapshotJobsRequestContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`serviceId` | string
+
+## Example
+
+```typescript
+import type { ListSnapshotJobsRequestContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "serviceId": null,
+} satisfies ListSnapshotJobsRequestContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListSnapshotJobsRequestContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ListSnapshotJobsResponseContent.md

@@ -0,0 +1,36 @@
+
+# ListSnapshotJobsResponseContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | [OperationStatus](OperationStatus.md)
+`data` | [SnapshotJobListResponseData](SnapshotJobListResponseData.md)
+
+## Example
+
+```typescript
+import type { ListSnapshotJobsResponseContent } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "data": null,
+} satisfies ListSnapshotJobsResponseContent
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ListSnapshotJobsResponseContent
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJob.md

@@ -0,0 +1,53 @@
+
+# SnapshotJob
+
+Individual snapshot job item
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | number
+`hostingId` | number
+`vmId` | number
+`name` | string
+`description` | string
+`vmstate` | boolean
+`period` | [SnapshotJobPeriod](SnapshotJobPeriod.md)
+`runEvery` | number
+`days` | [Array<DayOfWeek>](DayOfWeek.md)
+`startTime` | string
+
+## Example
+
+```typescript
+import type { SnapshotJob } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "hostingId": null,
+  "vmId": null,
+  "name": null,
+  "description": null,
+  "vmstate": null,
+  "period": null,
+  "runEvery": null,
+  "days": null,
+  "startTime": null,
+} satisfies SnapshotJob
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJob
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobDeleteResponseData.md

@@ -0,0 +1,37 @@
+
+# SnapshotJobDeleteResponseData
+
+Response data for snapshot job delete operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`limits` | [SnapshotJobLimits](SnapshotJobLimits.md)
+
+## Example
+
+```typescript
+import type { SnapshotJobDeleteResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "limits": null,
+} satisfies SnapshotJobDeleteResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobDeleteResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobLimits.md

@@ -0,0 +1,39 @@
+
+# SnapshotJobLimits
+
+Limits and quota information for snapshot jobs
+
+## Properties
+
+Name | Type
+------------ | -------------
+`maxJobs` | number
+`jobCount` | number
+`canAddMore` | boolean
+
+## Example
+
+```typescript
+import type { SnapshotJobLimits } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "maxJobs": null,
+  "jobCount": null,
+  "canAddMore": null,
+} satisfies SnapshotJobLimits
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobLimits
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobListResponseData.md

@@ -0,0 +1,41 @@
+
+# SnapshotJobListResponseData
+
+Response data for snapshot job list operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`jobs` | [Array<SnapshotJob>](SnapshotJob.md)
+`limits` | [SnapshotJobLimits](SnapshotJobLimits.md)
+`allowedPeriods` | Array<string>
+
+## Example
+
+```typescript
+import type { SnapshotJobListResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "jobs": null,
+  "limits": null,
+  "allowedPeriods": null,
+} satisfies SnapshotJobListResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobListResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobMutationResponseData.md

@@ -0,0 +1,39 @@
+
+# SnapshotJobMutationResponseData
+
+Response data for snapshot job create operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`job` | [SnapshotJob](SnapshotJob.md)
+`limits` | [SnapshotJobLimits](SnapshotJobLimits.md)
+
+## Example
+
+```typescript
+import type { SnapshotJobMutationResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "job": null,
+  "limits": null,
+} satisfies SnapshotJobMutationResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobMutationResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobPeriod.md

@@ -0,0 +1,33 @@
+
+# SnapshotJobPeriod
+
+Schedule period for snapshot jobs
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { SnapshotJobPeriod } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies SnapshotJobPeriod
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobPeriod
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/SnapshotJobUpdateResponseData.md

@@ -0,0 +1,37 @@
+
+# SnapshotJobUpdateResponseData
+
+Response data for snapshot job update operation
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`job` | [SnapshotJob](SnapshotJob.md)
+
+## Example
+
+```typescript
+import type { SnapshotJobUpdateResponseData } from '@hostafrica/ha-sdk-typescript'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "job": null,
+} satisfies SnapshotJobUpdateResponseData
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as SnapshotJobUpdateResponseData
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+