yellowgrid-api-ts 3.2.39-dev.0 → 3.2.40-dev.0

package/dist/src/apis/Class3CXInstallationsApi.d.ts

@@ -0,0 +1,253 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * 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';
+import type { RootAccessModel, TcxInstallationDetailsModel, TcxInstallationsModel } from '../models/index';
+export interface GetGetDetailsRequest {
+    wizardId: number;
+}
+export interface GetGetInstallationsRequest {
+    pageSize?: number;
+    page?: number;
+    customerId?: string;
+    search?: string;
+    status?: GetGetInstallationsStatusEnum;
+    hosting?: GetGetInstallationsHostingEnum;
+    installType?: GetGetInstallationsInstallTypeEnum;
+}
+export interface PatchUpdateAutoFailoverRequest {
+    instanceId: string;
+    enable: boolean;
+}
+export interface PostAddDiskRequest {
+    instanceId: string;
+    gigabytes: number;
+}
+export interface PostCreateSshUserRequest {
+    instanceId: string;
+    expiryDate: string;
+    ipAddress: string;
+}
+export interface PostDeleteInstanceRequest {
+    instanceId: string;
+}
+export interface PostExtendDiskRequest {
+    instanceId: string;
+    gigabytes: number;
+    schedule: string;
+}
+export interface PostFailoverInstanceRequest {
+    instanceId: string;
+    type: PostFailoverInstanceTypeEnum;
+}
+export interface PostRebootInstanceRequest {
+    instanceId: string;
+}
+export interface PostResizeInstanceRequest {
+    instanceId: string;
+    size: PostResizeInstanceSizeEnum;
+    schedule?: string;
+}
+export interface PostSuspendInstanceRequest {
+    instanceId: string;
+    schedule?: string;
+}
+export interface PostUnsuspendInstanceRequest {
+    instanceId: string;
+}
+export interface PostUpgradeDebianRequest {
+    instanceId: string;
+    schedule: string;
+}
+/**
+ *
+ */
+export declare class Class3CXInstallationsApi extends runtime.BaseAPI {
+    /**
+     * Get 3CX Installation Details
+     * Get 3CX Installation Details
+     */
+    getGetDetailsRaw(requestParameters: GetGetDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TcxInstallationDetailsModel>>;
+    /**
+     * Get 3CX Installation Details
+     * Get 3CX Installation Details
+     */
+    getGetDetails(requestParameters: GetGetDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TcxInstallationDetailsModel>;
+    /**
+     * Get 3CX Installations
+     * Get 3CX Installations
+     */
+    getGetInstallationsRaw(requestParameters: GetGetInstallationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TcxInstallationsModel>>;
+    /**
+     * Get 3CX Installations
+     * Get 3CX Installations
+     */
+    getGetInstallations(requestParameters?: GetGetInstallationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TcxInstallationsModel>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * Update 3CX Instance Auto Failover
+     */
+    patchUpdateAutoFailoverRaw(requestParameters: PatchUpdateAutoFailoverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Update 3CX Instance Auto Failover
+     * Update 3CX Instance Auto Failover
+     */
+    patchUpdateAutoFailover(requestParameters: PatchUpdateAutoFailoverRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Add additional disk on 3CX Instance
+     * Add additional disk on 3CX Instance
+     */
+    postAddDiskRaw(requestParameters: PostAddDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add additional disk on 3CX Instance
+     * Add additional disk on 3CX Instance
+     */
+    postAddDisk(requestParameters: PostAddDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a root user
+     * Create a root user
+     */
+    postCreateSshUserRaw(requestParameters: PostCreateSshUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RootAccessModel>>;
+    /**
+     * Create a root user
+     * Create a root user
+     */
+    postCreateSshUser(requestParameters: PostCreateSshUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RootAccessModel>;
+    /**
+     * Delete 3CX Instance
+     * Delete 3CX Instance
+     */
+    postDeleteInstanceRaw(requestParameters: PostDeleteInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete 3CX Instance
+     * Delete 3CX Instance
+     */
+    postDeleteInstance(requestParameters: PostDeleteInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Extend additional disk on 3CX Instance
+     * Extend additional disk on 3CX Instance
+     */
+    postExtendDiskRaw(requestParameters: PostExtendDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Extend additional disk on 3CX Instance
+     * Extend additional disk on 3CX Instance
+     */
+    postExtendDisk(requestParameters: PostExtendDiskRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Failover 3CX Instance
+     * Failover 3CX Instance
+     */
+    postFailoverInstanceRaw(requestParameters: PostFailoverInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Failover 3CX Instance
+     * Failover 3CX Instance
+     */
+    postFailoverInstance(requestParameters: PostFailoverInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Reboot 3CX Instance
+     * Reboot 3CX Instance
+     */
+    postRebootInstanceRaw(requestParameters: PostRebootInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Reboot 3CX Instance
+     * Reboot 3CX Instance
+     */
+    postRebootInstance(requestParameters: PostRebootInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Resize 3CX Instance
+     * Resize 3CX Instance
+     */
+    postResizeInstanceRaw(requestParameters: PostResizeInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Resize 3CX Instance
+     * Resize 3CX Instance
+     */
+    postResizeInstance(requestParameters: PostResizeInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Suspend 3CX Instance
+     * Suspend 3CX Instance
+     */
+    postSuspendInstanceRaw(requestParameters: PostSuspendInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Suspend 3CX Instance
+     * Suspend 3CX Instance
+     */
+    postSuspendInstance(requestParameters: PostSuspendInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Unsuspend 3CX Instance
+     * Unsuspend 3CX Instance
+     */
+    postUnsuspendInstanceRaw(requestParameters: PostUnsuspendInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Unsuspend 3CX Instance
+     * Unsuspend 3CX Instance
+     */
+    postUnsuspendInstance(requestParameters: PostUnsuspendInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Install OS update on 3CX Instance
+     * Install OS update on 3CX Instance
+     */
+    postUpgradeDebianRaw(requestParameters: PostUpgradeDebianRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Install OS update on 3CX Instance
+     * Install OS update on 3CX Instance
+     */
+    postUpgradeDebian(requestParameters: PostUpgradeDebianRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+}
+/**
+ * @export
+ */
+export declare const GetGetInstallationsStatusEnum: {
+    readonly Completed: "Completed";
+    readonly Outstanding: "Outstanding";
+    readonly Offline: "Offline";
+    readonly FailedOver: "Failed Over";
+};
+export type GetGetInstallationsStatusEnum = typeof GetGetInstallationsStatusEnum[keyof typeof GetGetInstallationsStatusEnum];
+/**
+ * @export
+ */
+export declare const GetGetInstallationsHostingEnum: {
+    readonly Yellowgrid: "yellowgrid";
+    readonly MultiTenant: "multi-tenant";
+    readonly Onprem: "onprem";
+    readonly All: "all";
+};
+export type GetGetInstallationsHostingEnum = typeof GetGetInstallationsHostingEnum[keyof typeof GetGetInstallationsHostingEnum];
+/**
+ * @export
+ */
+export declare const GetGetInstallationsInstallTypeEnum: {
+    readonly New: "new";
+    readonly Restore: "restore";
+    readonly Failover: "failover";
+    readonly MultiTenant: "multi-tenant";
+};
+export type GetGetInstallationsInstallTypeEnum = typeof GetGetInstallationsInstallTypeEnum[keyof typeof GetGetInstallationsInstallTypeEnum];
+/**
+ * @export
+ */
+export declare const PostFailoverInstanceTypeEnum: {
+    readonly Config: "config";
+    readonly Image: "image";
+};
+export type PostFailoverInstanceTypeEnum = typeof PostFailoverInstanceTypeEnum[keyof typeof PostFailoverInstanceTypeEnum];
+/**
+ * @export
+ */
+export declare const PostResizeInstanceSizeEnum: {
+    readonly D24: "d2-4";
+    readonly D28: "d2-8";
+    readonly B230: "b2-30";
+    readonly S2vcpu4gb: "s-2vcpu-4gb";
+    readonly S4vcpu8gb: "s-4vcpu-8gb";
+};
+export type PostResizeInstanceSizeEnum = typeof PostResizeInstanceSizeEnum[keyof typeof PostResizeInstanceSizeEnum];