@hostafrica/ha-sdk-typescript 1.0.11 → 1.0.13

package/docs/UserManagementApi.md

@@ -1,87 +0,0 @@
-# UserManagementApi
-
-All URIs are relative to *https://api.hostafrica.com*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**userChangePassword**](UserManagementApi.md#userchangepassword) | **POST** /user/change-password |  |
-
-
-
-## userChangePassword
-
-> UserChangePasswordResponseContent userChangePassword(userChangePasswordRequestContent)
-
-
-
-Changes the authenticated user\'s password. All active sessions will be revoked and the user must login again.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  UserManagementApi,
-} from '@hostafrica/ha-sdk-typescript';
-import type { UserChangePasswordRequest } 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 UserManagementApi(config);
-
-  const body = {
-    // UserChangePasswordRequestContent
-    userChangePasswordRequestContent: ...,
-  } satisfies UserChangePasswordRequest;
-
-  try {
-    const data = await api.userChangePassword(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **userChangePasswordRequestContent** | [UserChangePasswordRequestContent](UserChangePasswordRequestContent.md) |  | |
-
-### Return type
-
-[**UserChangePasswordResponseContent**](UserChangePasswordResponseContent.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** | UserChangePassword 200 response |  -  |
-| **400** | BadRequestError 400 response |  -  |
-| **401** | UnauthorizedError 401 response |  -  |
-| **403** | ForbiddenError 403 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/ValidatePricingInput.md

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

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

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

@@ -1,41 +0,0 @@
-
-# VpsBandwidthInfo
-
-Bandwidth usage information
-
-## Properties
-
-Name | Type
------------- | -------------
-`usageMb` | number
-`limitMb` | number
-`unlimited` | boolean
-`percent` | number
-
-## Example
-
-```typescript
-import type { VpsBandwidthInfo } from '@hostafrica/ha-sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "usageMb": null,
-  "limitMb": null,
-  "unlimited": null,
-  "percent": null,
-} satisfies VpsBandwidthInfo
-
-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 VpsBandwidthInfo
-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/VpsCancelDetails.md

@@ -1,39 +0,0 @@
-
-# VpsCancelDetails
-
-Nested details within a VPS cancellation response
-
-## Properties
-
-Name | Type
------------- | -------------
-`serviceId` | number
-`cancellationType` | string
-`status` | string
-
-## Example
-
-```typescript
-import type { VpsCancelDetails } from '@hostafrica/sdk-typescript'
-
-// TODO: Update the object below with actual values
-const example = {
-  "serviceId": null,
-  "cancellationType": null,
-  "status": null,
-} satisfies VpsCancelDetails
-
-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 VpsCancelDetails
-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/src/apis/SecurityApi.ts

@@ -1,314 +0,0 @@
-/* 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 * as runtime from '../runtime.js';
-import type {
-  BadRequestErrorResponseContent,
-  ChangePasswordRequestContent,
-  ChangePasswordResponseContent,
-  ForbiddenErrorResponseContent,
-  GetPrivateSshKeyRequestContent,
-  GetPrivateSshKeyResponseContent,
-  GetPublicSshKeyRequestContent,
-  GetPublicSshKeyResponseContent,
-  InternalServiceErrorResponseContent,
-  InvalidStateErrorResponseContent,
-  ResourceNotFoundErrorResponseContent,
-  ServiceUnavailableErrorResponseContent,
-  TooManyRequestsErrorResponseContent,
-  UnauthorizedErrorResponseContent,
-  UpdateSshKeysRequestContent,
-  UpdateSshKeysResponseContent,
-  ValidationErrorResponseContent,
-} from '../models/index.js';
-import {
-    BadRequestErrorResponseContentFromJSON,
-    BadRequestErrorResponseContentToJSON,
-    ChangePasswordRequestContentFromJSON,
-    ChangePasswordRequestContentToJSON,
-    ChangePasswordResponseContentFromJSON,
-    ChangePasswordResponseContentToJSON,
-    ForbiddenErrorResponseContentFromJSON,
-    ForbiddenErrorResponseContentToJSON,
-    GetPrivateSshKeyRequestContentFromJSON,
-    GetPrivateSshKeyRequestContentToJSON,
-    GetPrivateSshKeyResponseContentFromJSON,
-    GetPrivateSshKeyResponseContentToJSON,
-    GetPublicSshKeyRequestContentFromJSON,
-    GetPublicSshKeyRequestContentToJSON,
-    GetPublicSshKeyResponseContentFromJSON,
-    GetPublicSshKeyResponseContentToJSON,
-    InternalServiceErrorResponseContentFromJSON,
-    InternalServiceErrorResponseContentToJSON,
-    InvalidStateErrorResponseContentFromJSON,
-    InvalidStateErrorResponseContentToJSON,
-    ResourceNotFoundErrorResponseContentFromJSON,
-    ResourceNotFoundErrorResponseContentToJSON,
-    ServiceUnavailableErrorResponseContentFromJSON,
-    ServiceUnavailableErrorResponseContentToJSON,
-    TooManyRequestsErrorResponseContentFromJSON,
-    TooManyRequestsErrorResponseContentToJSON,
-    UnauthorizedErrorResponseContentFromJSON,
-    UnauthorizedErrorResponseContentToJSON,
-    UpdateSshKeysRequestContentFromJSON,
-    UpdateSshKeysRequestContentToJSON,
-    UpdateSshKeysResponseContentFromJSON,
-    UpdateSshKeysResponseContentToJSON,
-    ValidationErrorResponseContentFromJSON,
-    ValidationErrorResponseContentToJSON,
-} from '../models/index.js';
-
-export interface ChangePasswordRequest {
-    changePasswordRequestContent: ChangePasswordRequestContent;
-}
-
-export interface GetPrivateSshKeyRequest {
-    getPrivateSshKeyRequestContent: GetPrivateSshKeyRequestContent;
-}
-
-export interface GetPublicSshKeyRequest {
-    getPublicSshKeyRequestContent: GetPublicSshKeyRequestContent;
-}
-
-export interface UpdateSshKeysRequest {
-    updateSshKeysRequestContent: UpdateSshKeysRequestContent;
-}
-
-/**
- * 
- */
-export class SecurityApi extends runtime.BaseAPI {
-
-    /**
-     * Creates request options for changePassword without sending the request
-     */
-    async changePasswordRequestOpts(requestParameters: ChangePasswordRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['changePasswordRequestContent'] == null) {
-            throw new runtime.RequiredError(
-                'changePasswordRequestContent',
-                'Required parameter "changePasswordRequestContent" was null or undefined when calling changePassword().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("BearerAuth", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-
-        let urlPath = `/vps/change-password`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: ChangePasswordRequestContentToJSON(requestParameters['changePasswordRequestContent']),
-        };
-    }
-
-    /**
-     * Change the root password for a VPS service
-     */
-    async changePasswordRaw(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChangePasswordResponseContent>> {
-        const requestOptions = await this.changePasswordRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => ChangePasswordResponseContentFromJSON(jsonValue));
-    }
-
-    /**
-     * Change the root password for a VPS service
-     */
-    async changePassword(requestParameters: ChangePasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChangePasswordResponseContent> {
-        const response = await this.changePasswordRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for getPrivateSshKey without sending the request
-     */
-    async getPrivateSshKeyRequestOpts(requestParameters: GetPrivateSshKeyRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['getPrivateSshKeyRequestContent'] == null) {
-            throw new runtime.RequiredError(
-                'getPrivateSshKeyRequestContent',
-                'Required parameter "getPrivateSshKeyRequestContent" was null or undefined when calling getPrivateSshKey().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("BearerAuth", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-
-        let urlPath = `/vps/get-private-ssh-keys`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GetPrivateSshKeyRequestContentToJSON(requestParameters['getPrivateSshKeyRequestContent']),
-        };
-    }
-
-    /**
-     * Retrieves the private SSH key configured for a VPS service
-     */
-    async getPrivateSshKeyRaw(requestParameters: GetPrivateSshKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPrivateSshKeyResponseContent>> {
-        const requestOptions = await this.getPrivateSshKeyRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GetPrivateSshKeyResponseContentFromJSON(jsonValue));
-    }
-
-    /**
-     * Retrieves the private SSH key configured for a VPS service
-     */
-    async getPrivateSshKey(requestParameters: GetPrivateSshKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPrivateSshKeyResponseContent> {
-        const response = await this.getPrivateSshKeyRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for getPublicSshKey without sending the request
-     */
-    async getPublicSshKeyRequestOpts(requestParameters: GetPublicSshKeyRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['getPublicSshKeyRequestContent'] == null) {
-            throw new runtime.RequiredError(
-                'getPublicSshKeyRequestContent',
-                'Required parameter "getPublicSshKeyRequestContent" was null or undefined when calling getPublicSshKey().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("BearerAuth", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-
-        let urlPath = `/vps/get-public-ssh-keys`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: GetPublicSshKeyRequestContentToJSON(requestParameters['getPublicSshKeyRequestContent']),
-        };
-    }
-
-    /**
-     * Retrieves the public SSH key configured for a VPS service
-     */
-    async getPublicSshKeyRaw(requestParameters: GetPublicSshKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicSshKeyResponseContent>> {
-        const requestOptions = await this.getPublicSshKeyRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => GetPublicSshKeyResponseContentFromJSON(jsonValue));
-    }
-
-    /**
-     * Retrieves the public SSH key configured for a VPS service
-     */
-    async getPublicSshKey(requestParameters: GetPublicSshKeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicSshKeyResponseContent> {
-        const response = await this.getPublicSshKeyRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-    /**
-     * Creates request options for updateSshKeys without sending the request
-     */
-    async updateSshKeysRequestOpts(requestParameters: UpdateSshKeysRequest): Promise<runtime.RequestOpts> {
-        if (requestParameters['updateSshKeysRequestContent'] == null) {
-            throw new runtime.RequiredError(
-                'updateSshKeysRequestContent',
-                'Required parameter "updateSshKeysRequestContent" was null or undefined when calling updateSshKeys().'
-            );
-        }
-
-        const queryParameters: any = {};
-
-        const headerParameters: runtime.HTTPHeaders = {};
-
-        headerParameters['Content-Type'] = 'application/json';
-
-        if (this.configuration && this.configuration.accessToken) {
-            const token = this.configuration.accessToken;
-            const tokenString = await token("BearerAuth", []);
-
-            if (tokenString) {
-                headerParameters["Authorization"] = `Bearer ${tokenString}`;
-            }
-        }
-
-        let urlPath = `/vps/update-ssh-keys`;
-
-        return {
-            path: urlPath,
-            method: 'POST',
-            headers: headerParameters,
-            query: queryParameters,
-            body: UpdateSshKeysRequestContentToJSON(requestParameters['updateSshKeysRequestContent']),
-        };
-    }
-
-    /**
-     * Updates SSH public keys for a VPS service for root access.
-     */
-    async updateSshKeysRaw(requestParameters: UpdateSshKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UpdateSshKeysResponseContent>> {
-        const requestOptions = await this.updateSshKeysRequestOpts(requestParameters);
-        const response = await this.request(requestOptions, initOverrides);
-
-        return new runtime.JSONApiResponse(response, (jsonValue) => UpdateSshKeysResponseContentFromJSON(jsonValue));
-    }
-
-    /**
-     * Updates SSH public keys for a VPS service for root access.
-     */
-    async updateSshKeys(requestParameters: UpdateSshKeysRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UpdateSshKeysResponseContent> {
-        const response = await this.updateSshKeysRaw(requestParameters, initOverrides);
-        return await response.value();
-    }
-
-}