redis-cloud-api-sdk/lib/api/cloud-account.d.ts

This is a client for the Redislabs Cloud API

import { TaskResponse } from '../types/task';
import { CloudAccountCreationParameters, CloudAccountUpdateParameters } from '../types/parameters/cloud-account';
import { CloudAccountResponse, CloudAccountStatus } from '../types/responses/cloud-account';
import { Client } from './api.base';
export declare class CloudAccount {
    protected client: Client;
    private task;
    constructor(client: Client);
    /**
     * Returning a lookup list of cloud accounts owned by the account
     */
    getCloudAccounts(): Promise<CloudAccountResponse[] & {
        [key: string]: any;
    }>;
    /**
     * Creating a cloud account
     * @param createParameters The create parameters to create a cloud account
     */
    createCloudAccount(createParameters: CloudAccountCreationParameters): Promise<TaskResponse & {
        [key: string]: any;
    }>;
    /**
     * Returning a cloud account
     * @param cloudAccountId The id of the cloud account
     */
    getCloudAccount(cloudAccountId: number): Promise<CloudAccountResponse & {
        [key: string]: any;
    }>;
    /**
     * Updating a cloud account
     * @param cloudAccountId The id of the cloud account
     * @param updateParameters The update parameters to update a cloud account
     */
    updateCloudAccount(cloudAccountId: number, updateParameters: CloudAccountUpdateParameters): Promise<TaskResponse & {
        [key: string]: any;
    }>;
    /**
     * Deleting a cloud account
     * @param cloudAccountId The id of the cloud account
     */
    deleteCloudAccount(cloudAccountId: number): Promise<TaskResponse & {
        [key: string]: any;
    }>;
    /**
     * Waiting for cloud account status to change to a given status
     * @param cloudAccountId The id of the cloud account
     * @param expectedStatus The expected status
     * @param timeoutInSeconds The timeout of waiting for the status. Default: 5 minutes
     * @param sleepTimeInSeconds The sleep time between requests. Default: 5 seconds
     */
    waitForCloudAccountStatus(cloudAccountId: number, expectedStatus: CloudAccountStatus, timeoutInSeconds?: number, sleepTimeInSeconds?: number): Promise<CloudAccountResponse & {
        [key: string]: any;
    }>;
}