@hostafrica/ha-sdk-typescript 1.0.13 → 1.0.14

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)
+
+

package/docs/SnapshotsApi.md

@@ -5,10 +5,14 @@ All URIs are relative to *https://api.hostafrica.com*
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**createSnapshot**](SnapshotsApi.md#createsnapshot) | **POST** /vps/create-snapshot |  |
+| [**createSnapshotJob**](SnapshotsApi.md#createsnapshotjob) | **POST** /vps/create-snapshot-job |  |
 | [**deleteSnapshot**](SnapshotsApi.md#deletesnapshot) | **POST** /vps/delete-snapshot |  |
+| [**deleteSnapshotJob**](SnapshotsApi.md#deletesnapshotjob) | **POST** /vps/delete-snapshot-job |  |
+| [**listSnapshotJobs**](SnapshotsApi.md#listsnapshotjobs) | **POST** /vps/list-snapshot-jobs |  |
 | [**listSnapshots**](SnapshotsApi.md#listsnapshots) | **POST** /vps/list-snapshots |  |
 | [**rollbackSnapshot**](SnapshotsApi.md#rollbacksnapshot) | **POST** /vps/rollback-snapshot |  |
 | [**updateSnapshot**](SnapshotsApi.md#updatesnapshot) | **POST** /vps/update-snapshot |  |
+| [**updateSnapshotJob**](SnapshotsApi.md#updatesnapshotjob) | **POST** /vps/update-snapshot-job |  |
 
 
 
@@ -91,6 +95,85 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## createSnapshotJob
+
+> CreateSnapshotJobResponseContent createSnapshotJob(createSnapshotJobRequestContent)
+
+
+
+[Under development] Creates a new snapshot job for a VPS service. Use period=\'hourly\' with run_every, or period=\'daily\' with days and start_time.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SnapshotsApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { CreateSnapshotJobRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SnapshotsApi(config);
+
+  const body = {
+    // CreateSnapshotJobRequestContent
+    createSnapshotJobRequestContent: ...,
+  } satisfies CreateSnapshotJobRequest;
+
+  try {
+    const data = await api.createSnapshotJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createSnapshotJobRequestContent** | [CreateSnapshotJobRequestContent](CreateSnapshotJobRequestContent.md) |  | |
+
+### Return type
+
+[**CreateSnapshotJobResponseContent**](CreateSnapshotJobResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | CreateSnapshotJob 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteSnapshot
 
 > DeleteSnapshotResponseContent deleteSnapshot(deleteSnapshotRequestContent)
@@ -170,6 +253,164 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## deleteSnapshotJob
+
+> DeleteSnapshotJobResponseContent deleteSnapshotJob(deleteSnapshotJobRequestContent)
+
+
+
+[Under development]Deletes a snapshot job from a VPS service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SnapshotsApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { DeleteSnapshotJobRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SnapshotsApi(config);
+
+  const body = {
+    // DeleteSnapshotJobRequestContent
+    deleteSnapshotJobRequestContent: ...,
+  } satisfies DeleteSnapshotJobRequest;
+
+  try {
+    const data = await api.deleteSnapshotJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **deleteSnapshotJobRequestContent** | [DeleteSnapshotJobRequestContent](DeleteSnapshotJobRequestContent.md) |  | |
+
+### Return type
+
+[**DeleteSnapshotJobResponseContent**](DeleteSnapshotJobResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | DeleteSnapshotJob 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listSnapshotJobs
+
+> ListSnapshotJobsResponseContent listSnapshotJobs(listSnapshotJobsRequestContent)
+
+
+
+[Under development]Retrieves the list of snapshot jobs for a VPS service
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SnapshotsApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { ListSnapshotJobsRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SnapshotsApi(config);
+
+  const body = {
+    // ListSnapshotJobsRequestContent
+    listSnapshotJobsRequestContent: ...,
+  } satisfies ListSnapshotJobsRequest;
+
+  try {
+    const data = await api.listSnapshotJobs(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **listSnapshotJobsRequestContent** | [ListSnapshotJobsRequestContent](ListSnapshotJobsRequestContent.md) |  | |
+
+### Return type
+
+[**ListSnapshotJobsResponseContent**](ListSnapshotJobsResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | ListSnapshotJobs 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## listSnapshots
 
 > ListSnapshotsResponseContent listSnapshots(listSnapshotsRequestContent)
@@ -255,7 +496,7 @@ example().catch(console.error);
 
 
 
-[Under development] Rolls back a VPS to a previous snapshot state
+Rolls back a VPS to a previous snapshot state
 
 ### Example
 
@@ -406,3 +647,82 @@ example().catch(console.error);
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
+
+## updateSnapshotJob
+
+> UpdateSnapshotJobResponseContent updateSnapshotJob(updateSnapshotJobRequestContent)
+
+
+
+[Under development] Updates an existing snapshot job. Only provide fields you want to change.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SnapshotsApi,
+} from '@hostafrica/ha-sdk-typescript';
+import type { UpdateSnapshotJobRequest } from '@hostafrica/ha-sdk-typescript';
+
+async function example() {
+  console.log("🚀 Testing @hostafrica/ha-sdk-typescript SDK...");
+  const config = new Configuration({ 
+    // Configure HTTP bearer authorization: BearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new SnapshotsApi(config);
+
+  const body = {
+    // UpdateSnapshotJobRequestContent
+    updateSnapshotJobRequestContent: ...,
+  } satisfies UpdateSnapshotJobRequest;
+
+  try {
+    const data = await api.updateSnapshotJob(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **updateSnapshotJobRequestContent** | [UpdateSnapshotJobRequestContent](UpdateSnapshotJobRequestContent.md) |  | |
+
+### Return type
+
+[**UpdateSnapshotJobResponseContent**](UpdateSnapshotJobResponseContent.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | UpdateSnapshotJob 200 response |  -  |
+| **400** | BadRequestError 400 response |  -  |
+| **401** | UnauthorizedError 401 response |  -  |
+| **403** | ForbiddenError 403 response |  -  |
+| **404** | ResourceNotFoundError 404 response |  -  |
+| **422** | ValidationError 422 response |  -  |
+| **429** | TooManyRequestsError 429 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+| **500** | InternalServiceError 500 response |  -  |
+| **503** | ServiceUnavailableError 503 response |  * Retry-After - Number of seconds to wait before retrying <br>  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+