@hostafrica/ha-sdk-typescript 1.0.9 → 1.0.12

package/docs/SecurityApi.md

@@ -1,331 +0,0 @@
-# SecurityApi
-
-All URIs are relative to *https://api.hostafrica.com*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**changePassword**](SecurityApi.md#changepassword) | **POST** /vps/change-password |  |
-| [**getPrivateSshKey**](SecurityApi.md#getprivatesshkey) | **POST** /vps/get-private-ssh-keys |  |
-| [**getPublicSshKey**](SecurityApi.md#getpublicsshkey) | **POST** /vps/get-public-ssh-keys |  |
-| [**updateSshKeys**](SecurityApi.md#updatesshkeys) | **POST** /vps/update-ssh-keys |  |
-
-
-
-## changePassword
-
-> ChangePasswordResponseContent changePassword(changePasswordRequestContent)
-
-
-
-Change the root password for a VPS service
-
-### Example
-
-```ts
-import {
-  Configuration,
-  SecurityApi,
-} from '@hostafrica/ha-sdk-typescript';
-import type { ChangePasswordRequest } 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 SecurityApi(config);
-
-  const body = {
-    // ChangePasswordRequestContent
-    changePasswordRequestContent: ...,
-  } satisfies ChangePasswordRequest;
-
-  try {
-    const data = await api.changePassword(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **changePasswordRequestContent** | [ChangePasswordRequestContent](ChangePasswordRequestContent.md) |  | |
-
-### Return type
-
-[**ChangePasswordResponseContent**](ChangePasswordResponseContent.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** | ChangePassword 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)
-
-
-## getPrivateSshKey
-
-> GetPrivateSshKeyResponseContent getPrivateSshKey(getPrivateSshKeyRequestContent)
-
-
-
-Retrieves the private SSH key configured for a VPS service
-
-### Example
-
-```ts
-import {
-  Configuration,
-  SecurityApi,
-} from '@hostafrica/ha-sdk-typescript';
-import type { GetPrivateSshKeyRequest } 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 SecurityApi(config);
-
-  const body = {
-    // GetPrivateSshKeyRequestContent
-    getPrivateSshKeyRequestContent: ...,
-  } satisfies GetPrivateSshKeyRequest;
-
-  try {
-    const data = await api.getPrivateSshKey(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getPrivateSshKeyRequestContent** | [GetPrivateSshKeyRequestContent](GetPrivateSshKeyRequestContent.md) |  | |
-
-### Return type
-
-[**GetPrivateSshKeyResponseContent**](GetPrivateSshKeyResponseContent.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** | GetPrivateSshKey 200 response |  -  |
-| **400** | BadRequestError 400 response |  -  |
-| **401** | UnauthorizedError 401 response |  -  |
-| **403** | ForbiddenError 403 response |  -  |
-| **404** | ResourceNotFoundError 404 response |  -  |
-| **409** | InvalidStateError 409 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)
-
-
-## getPublicSshKey
-
-> GetPublicSshKeyResponseContent getPublicSshKey(getPublicSshKeyRequestContent)
-
-
-
-Retrieves the public SSH key configured for a VPS service
-
-### Example
-
-```ts
-import {
-  Configuration,
-  SecurityApi,
-} from '@hostafrica/ha-sdk-typescript';
-import type { GetPublicSshKeyRequest } 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 SecurityApi(config);
-
-  const body = {
-    // GetPublicSshKeyRequestContent
-    getPublicSshKeyRequestContent: ...,
-  } satisfies GetPublicSshKeyRequest;
-
-  try {
-    const data = await api.getPublicSshKey(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **getPublicSshKeyRequestContent** | [GetPublicSshKeyRequestContent](GetPublicSshKeyRequestContent.md) |  | |
-
-### Return type
-
-[**GetPublicSshKeyResponseContent**](GetPublicSshKeyResponseContent.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** | GetPublicSshKey 200 response |  -  |
-| **400** | BadRequestError 400 response |  -  |
-| **401** | UnauthorizedError 401 response |  -  |
-| **403** | ForbiddenError 403 response |  -  |
-| **404** | ResourceNotFoundError 404 response |  -  |
-| **409** | InvalidStateError 409 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)
-
-
-## updateSshKeys
-
-> UpdateSshKeysResponseContent updateSshKeys(updateSshKeysRequestContent)
-
-
-
-Updates SSH public keys for a VPS service for root access.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  SecurityApi,
-} from '@hostafrica/ha-sdk-typescript';
-import type { UpdateSshKeysRequest } 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 SecurityApi(config);
-
-  const body = {
-    // UpdateSshKeysRequestContent
-    updateSshKeysRequestContent: ...,
-  } satisfies UpdateSshKeysRequest;
-
-  try {
-    const data = await api.updateSshKeys(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **updateSshKeysRequestContent** | [UpdateSshKeysRequestContent](UpdateSshKeysRequestContent.md) |  | |
-
-### Return type
-
-[**UpdateSshKeysResponseContent**](UpdateSshKeysResponseContent.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** | UpdateSshKeys 200 response |  -  |
-| **400** | BadRequestError 400 response |  -  |
-| **401** | UnauthorizedError 401 response |  -  |
-| **403** | ForbiddenError 403 response |  -  |
-| **404** | ResourceNotFoundError 404 response |  -  |
-| **409** | InvalidStateError 409 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)
-

package/docs/ServiceUnavailableError.md

@@ -1,38 +0,0 @@
-
-# ServiceUnavailableError
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`message` | string
-`data` | object
-`retryAfter` | number
-
-## Example
-
-```typescript
-import type { ServiceUnavailableError } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "message": null,
-  "data": null,
-  "retryAfter": null,
-} satisfies ServiceUnavailableError
-
-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 ServiceUnavailableError
-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/ShutdownVpsInput.md

@@ -1,34 +0,0 @@
-
-# ShutdownVpsInput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`serviceId` | string
-
-## Example
-
-```typescript
-import type { ShutdownVpsInput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "serviceId": null,
-} satisfies ShutdownVpsInput
-
-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 ShutdownVpsInput
-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/ShutdownVpsOutput.md

@@ -1,36 +0,0 @@
-
-# ShutdownVpsOutput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`status` | [OperationStatus](OperationStatus.md)
-`data` | [VpsSimpleActionResponseData](VpsSimpleActionResponseData.md)
-
-## Example
-
-```typescript
-import type { ShutdownVpsOutput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "status": null,
-  "data": null,
-} satisfies ShutdownVpsOutput
-
-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 ShutdownVpsOutput
-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/SshKeyDetails.md

@@ -1,37 +0,0 @@
-
-# SshKeyDetails
-
-SSH key details
-
-## Properties
-
-Name | Type
------------- | -------------
-`publicKey` | string
-`type` | string
-
-## Example
-
-```typescript
-import type { SshKeyDetails } from '@hostafrica/ha-sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "publicKey": null,
-  "type": null,
-} satisfies SshKeyDetails
-
-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 SshKeyDetails
-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/StartVpsInput.md

@@ -1,34 +0,0 @@
-
-# StartVpsInput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`serviceId` | string
-
-## Example
-
-```typescript
-import type { StartVpsInput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "serviceId": null,
-} satisfies StartVpsInput
-
-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 StartVpsInput
-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/StartVpsOutput.md

@@ -1,36 +0,0 @@
-
-# StartVpsOutput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`status` | [OperationStatus](OperationStatus.md)
-`data` | [VpsSimpleActionResponseData](VpsSimpleActionResponseData.md)
-
-## Example
-
-```typescript
-import type { StartVpsOutput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "status": null,
-  "data": null,
-} satisfies StartVpsOutput
-
-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 StartVpsOutput
-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/StopVpsInput.md

@@ -1,34 +0,0 @@
-
-# StopVpsInput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`serviceId` | string
-
-## Example
-
-```typescript
-import type { StopVpsInput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "serviceId": null,
-} satisfies StopVpsInput
-
-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 StopVpsInput
-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/StopVpsOutput.md

@@ -1,36 +0,0 @@
-
-# StopVpsOutput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`status` | [OperationStatus](OperationStatus.md)
-`data` | [VpsSimpleActionResponseData](VpsSimpleActionResponseData.md)
-
-## Example
-
-```typescript
-import type { StopVpsOutput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "status": null,
-  "data": null,
-} satisfies StopVpsOutput
-
-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 StopVpsOutput
-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/SuspendVpsInput.md

@@ -1,36 +0,0 @@
-
-# SuspendVpsInput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`serviceId` | string
-`suspendReason` | string
-
-## Example
-
-```typescript
-import type { SuspendVpsInput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "serviceId": null,
-  "suspendReason": null,
-} satisfies SuspendVpsInput
-
-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 SuspendVpsInput
-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/SuspendVpsOutput.md

@@ -1,36 +0,0 @@
-
-# SuspendVpsOutput
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`status` | [OperationStatus](OperationStatus.md)
-`data` | [VpsSimpleActionResponseData](VpsSimpleActionResponseData.md)
-
-## Example
-
-```typescript
-import type { SuspendVpsOutput } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "status": null,
-  "data": null,
-} satisfies SuspendVpsOutput
-
-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 SuspendVpsOutput
-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)
-
-