@highsystems/client/dist/client.d.ts

A lightweight, typed, promise-based High Systems API, autogenerated from the OpenAPI spec

import { AxiosRequestConfig, AxiosResponse } from 'axios';
export declare class HighSystems {
    readonly CLASS_NAME: string;
    static readonly CLASS_NAME: string;
    static readonly VERSION: string;
    /**
     * The default settings of a `HighSystems` instance
     */
    static defaults: Required<HighSystemsOptions>;
    /**
     * The internal numerical id for API calls.
     *
     * Increments by 1 with each request.
     */
    private _id;
    /**
     * The internal throttler for rate-limiting API calls
     */
    private throttle;
    /**
     * The `HighSystems` instance settings
     */
    settings: Required<HighSystemsOptions>;
    constructor(options?: HighSystemsOptions);
    private assignAuthorizationHeaders;
    private getBaseRequest;
    private request;
    private api;
    /**
     * Rebuild the HighSystems instance from serialized JSON
     *
     * @param json HighSystems class options
     */
    fromJSON(json: string | HighSystemsOptions): HighSystems;
    /**
     * Serialize the HighSystems instance into JSON
     */
    toJSON(): Required<HighSystemsOptions>;
    /**
     * Create a new HighSystems instance from serialized JSON
     *
     * @param json HighSystems class options
     */
    static fromJSON(json: string | HighSystemsOptions): HighSystems;
    /**
     * Test if a variable is a `highsystems` object
     *
     * @param obj A variable you'd like to test
     */
    static IsHighSystems(obj: any): obj is HighSystems;
    /**
     * getTransaction
     *
     * This endpoint allows you to start a new transaction.
     *
     * Transactions allow you to execute multiple API calls within the same, well, transaction. A transaction allows you to rollback or commit all the changes you've made attached to the transaction.
     *
     * This is useful for when you are creating multiple records and need to do any clean up if one of those records fails to be added.
     *
     * @param options getTransaction method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getTransaction({ requestOptions, returnAxios }: HighSystemsRequestGetTransaction & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetTransaction['results']>;
    getTransaction({ requestOptions, returnAxios }: HighSystemsRequestGetTransaction & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetTransaction>>;
    /**
     * deleteTransaction
     *
     * This endpoint allows you to rollback an existing transaction.
     *
     * @param options deleteTransaction method options object
     * @param options.id The Transaction ID of the transaction you want to commit.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteTransaction({ id, requestOptions, returnAxios }: HighSystemsRequestDeleteTransaction & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteTransaction['results']>;
    deleteTransaction({ id, requestOptions, returnAxios }: HighSystemsRequestDeleteTransaction & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteTransaction>>;
    /**
     * postTransaction
     *
     * This endpoint allows you to commit an existing transaction.
     *
     * @param options postTransaction method options object
     * @param options.id The Transaction ID of the transaction you want to commit.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postTransaction({ id, requestOptions, returnAxios }: HighSystemsRequestPostTransaction & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostTransaction['results']>;
    postTransaction({ id, requestOptions, returnAxios }: HighSystemsRequestPostTransaction & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostTransaction>>;
    /**
     * getInstanceSettings
     *
     * This endpoint allows you to retreive the settings for a given instance.
     *
     * @param options getInstanceSettings method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getInstanceSettings({ requestOptions, returnAxios }: HighSystemsRequestGetInstanceSettings & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetInstanceSettings['results']>;
    getInstanceSettings({ requestOptions, returnAxios }: HighSystemsRequestGetInstanceSettings & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetInstanceSettings>>;
    /**
     * putInstanceSettings
     *
     * This endpoint allows you to update the settings for a given instance.
     *
     * @param options putInstanceSettings method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putInstanceSettings({ requestOptions, returnAxios, ...body }: HighSystemsRequestPutInstanceSettings & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutInstanceSettings['results']>;
    putInstanceSettings({ requestOptions, returnAxios, ...body }: HighSystemsRequestPutInstanceSettings & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutInstanceSettings>>;
    /**
     * getUsers
     *
     * This endpoint allows you to query for all the users in the High Systems instance.
     *
     * @param options getUsers method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getUsers({ requestOptions, returnAxios }: HighSystemsRequestGetUsers & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetUsers['results']>;
    getUsers({ requestOptions, returnAxios }: HighSystemsRequestGetUsers & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetUsers>>;
    /**
     * postUser
     *
     * This endpoint allows you to create a new instance user.
     *
     * @param options postUser method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postUser({ requestOptions, returnAxios, ...body }: HighSystemsRequestPostUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostUser['results']>;
    postUser({ requestOptions, returnAxios, ...body }: HighSystemsRequestPostUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostUser>>;
    /**
     * deleteUser
     *
     * This endpoint allows you to delete an existing instance user. This will remove them from all applications they've been invited to.
     *
     * @param options deleteUser method options object
     * @param options.userid The User ID of the user you wish to delete.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteUser({ userid, requestOptions, returnAxios }: HighSystemsRequestDeleteUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteUser['results']>;
    deleteUser({ userid, requestOptions, returnAxios }: HighSystemsRequestDeleteUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteUser>>;
    /**
     * getUser
     *
     * This endpoint allows you to query for a specific user by their user id.
     *
     * @param options getUser method options object
     * @param options.userid The User ID of the user you wish to query for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getUser({ userid, requestOptions, returnAxios }: HighSystemsRequestGetUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetUser['results']>;
    getUser({ userid, requestOptions, returnAxios }: HighSystemsRequestGetUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetUser>>;
    /**
     * putUser
     *
     * This endpoint allows you to update an existing instance user.
     *
     * @param options putUser method options object
     * @param options.userid The User ID of the user you wish to update.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putUser({ userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutUser['results']>;
    putUser({ userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutUser>>;
    /**
     * getUserTokens
     *
     * This endpoint allows you to query for all the user tokens for a given user.
     *
     * @param options getUserTokens method options object
     * @param options.userid The User ID of the user you wish to get their user tokens of.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getUserTokens({ userid, requestOptions, returnAxios }: HighSystemsRequestGetUserTokens & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetUserTokens['results']>;
    getUserTokens({ userid, requestOptions, returnAxios }: HighSystemsRequestGetUserTokens & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetUserTokens>>;
    /**
     * postUserToken
     *
     * This endpoint allows you to create a new user token.
     *
     * @param options postUserToken method options object
     * @param options.userid The User ID of the user the token you wish to create belongs to.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postUserToken({ userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostUserToken & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostUserToken['results']>;
    postUserToken({ userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostUserToken & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostUserToken>>;
    /**
     * deleteUserToken
     *
     * This endpoint allows you to delete an existing user token.
     *
     * @param options deleteUserToken method options object
     * @param options.userid The User ID of the user the token you wish to delete belongs to.
     * @param options.tokenid The User Token ID of the token you wish to delete.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteUserToken({ userid, tokenid, requestOptions, returnAxios }: HighSystemsRequestDeleteUserToken & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteUserToken['results']>;
    deleteUserToken({ userid, tokenid, requestOptions, returnAxios }: HighSystemsRequestDeleteUserToken & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteUserToken>>;
    /**
     * getUserToken
     *
     * This endpoint allows you to query for a specific user token.
     *
     * @param options getUserToken method options object
     * @param options.userid The User ID of the user the token you are querying belongs to.
     * @param options.tokenid The User Token ID of the token you wish to query for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getUserToken({ userid, tokenid, requestOptions, returnAxios }: HighSystemsRequestGetUserToken & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetUserToken['results']>;
    getUserToken({ userid, tokenid, requestOptions, returnAxios }: HighSystemsRequestGetUserToken & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetUserToken>>;
    /**
     * putUserToken
     *
     * This endpoint allows you to update an existing user token.
     *
     * @param options putUserToken method options object
     * @param options.tokenid The User ID of the user the token you wish to update belongs to.
     * @param options.userid The User Token ID of the token you wish to update.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putUserToken({ tokenid, userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutUserToken & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutUserToken['results']>;
    putUserToken({ tokenid, userid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutUserToken & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutUserToken>>;
    /**
     * getApplications
     *
     * This endpoint allows you to query for all the applications you've been invited to.
     *
     * @param options getApplications method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplications({ requestOptions, returnAxios }: HighSystemsRequestGetApplications & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplications['results']>;
    getApplications({ requestOptions, returnAxios }: HighSystemsRequestGetApplications & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplications>>;
    /**
     * postApplication
     *
     * This endpoint allows you to create a new application.
     *
     * @param options postApplication method options object
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postApplication({ requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplication & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostApplication['results']>;
    postApplication({ requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplication & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostApplication>>;
    /**
     * deleteApplication
     *
     * This endpoint allows you to delete an existing application.
     *
     * @param options deleteApplication method options object
     * @param options.appid The Application ID of the application you wish to delete.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteApplication({ appid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplication & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteApplication['results']>;
    deleteApplication({ appid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplication & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteApplication>>;
    /**
     * getApplication
     *
     * This endpoint allows you to query for a specific application.
     *
     * @param options getApplication method options object
     * @param options.appid The Application ID you wish to query for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplication({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplication & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplication['results']>;
    getApplication({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplication & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplication>>;
    /**
     * putApplication
     *
     * This endpoint allows you to update an existing application.
     *
     * @param options putApplication method options object
     * @param options.appid The Application ID of the application you wish to update.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putApplication({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplication & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutApplication['results']>;
    putApplication({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplication & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutApplication>>;
    /**
     * getApplicationMenus
     *
     * This endpoint allows you to query for all the menus available for an application.
     *
     * @param options getApplicationMenus method options object
     * @param options.appid The Application ID of the application you wish to query all menus for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationMenus({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationMenus & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationMenus['results']>;
    getApplicationMenus({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationMenus & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationMenus>>;
    /**
     * postApplicationMenu
     *
     *
     *
     * @param options postApplicationMenu method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postApplicationMenu({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplicationMenu & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostApplicationMenu['results']>;
    postApplicationMenu({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplicationMenu & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostApplicationMenu>>;
    /**
     * deleteApplicationMenu
     *
     *
     *
     * @param options deleteApplicationMenu method options object
     * @param options.appid Application ID
     * @param options.menuid Menu ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteApplicationMenu({ appid, menuid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplicationMenu & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteApplicationMenu['results']>;
    deleteApplicationMenu({ appid, menuid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplicationMenu & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteApplicationMenu>>;
    /**
     * getApplicationMenu
     *
     * This endpoint allows you to query for a specific application menu.
     *
     * @param options getApplicationMenu method options object
     * @param options.appid The Application ID of the menu you wish to query for.
     * @param options.menuid The Menu ID of the menu you wish to query for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationMenu({ appid, menuid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationMenu & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationMenu['results']>;
    getApplicationMenu({ appid, menuid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationMenu & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationMenu>>;
    /**
     * putApplicationMenu
     *
     *
     *
     * @param options putApplicationMenu method options object
     * @param options.appid Application ID
     * @param options.menuid Menu ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putApplicationMenu({ appid, menuid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplicationMenu & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutApplicationMenu['results']>;
    putApplicationMenu({ appid, menuid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplicationMenu & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutApplicationMenu>>;
    /**
     * getApplicationUserMenu
     *
     * This endpoint allows you to query for the rendered application menu for the current user.
     *
     * @param options getApplicationUserMenu method options object
     * @param options.appid The Application ID of the menu you wish to query for.
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationUserMenu({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUserMenu & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationUserMenu['results']>;
    getApplicationUserMenu({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUserMenu & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationUserMenu>>;
    /**
     * getVariables
     *
     *
     *
     * @param options getVariables method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getVariables({ appid, requestOptions, returnAxios }: HighSystemsRequestGetVariables & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetVariables['results']>;
    getVariables({ appid, requestOptions, returnAxios }: HighSystemsRequestGetVariables & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetVariables>>;
    /**
     * postVariable
     *
     *
     *
     * @param options postVariable method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postVariable({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostVariable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostVariable['results']>;
    postVariable({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostVariable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostVariable>>;
    /**
     * deleteVariable
     *
     *
     *
     * @param options deleteVariable method options object
     * @param options.appid Application ID
     * @param options.variableid Variable ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteVariable({ appid, variableid, requestOptions, returnAxios }: HighSystemsRequestDeleteVariable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteVariable['results']>;
    deleteVariable({ appid, variableid, requestOptions, returnAxios }: HighSystemsRequestDeleteVariable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteVariable>>;
    /**
     * getVariable
     *
     *
     *
     * @param options getVariable method options object
     * @param options.appid Application ID
     * @param options.variableid Variable ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getVariable({ appid, variableid, requestOptions, returnAxios }: HighSystemsRequestGetVariable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetVariable['results']>;
    getVariable({ appid, variableid, requestOptions, returnAxios }: HighSystemsRequestGetVariable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetVariable>>;
    /**
     * putVariable
     *
     *
     *
     * @param options putVariable method options object
     * @param options.variableid Variable ID
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putVariable({ variableid, appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutVariable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutVariable['results']>;
    putVariable({ variableid, appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutVariable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutVariable>>;
    /**
     * getRoles
     *
     *
     *
     * @param options getRoles method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getRoles({ appid, requestOptions, returnAxios }: HighSystemsRequestGetRoles & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetRoles['results']>;
    getRoles({ appid, requestOptions, returnAxios }: HighSystemsRequestGetRoles & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetRoles>>;
    /**
     * postRole
     *
     *
     *
     * @param options postRole method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postRole({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostRole & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostRole['results']>;
    postRole({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostRole & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostRole>>;
    /**
     * deleteRole
     *
     *
     *
     * @param options deleteRole method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteRole({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestDeleteRole & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteRole['results']>;
    deleteRole({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestDeleteRole & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteRole>>;
    /**
     * getRole
     *
     *
     *
     * @param options getRole method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getRole({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRole & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetRole['results']>;
    getRole({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRole & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetRole>>;
    /**
     * putRole
     *
     *
     *
     * @param options putRole method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putRole({ appid, roleid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutRole & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutRole['results']>;
    putRole({ appid, roleid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutRole & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutRole>>;
    /**
     * getRolePermissions
     *
     *
     *
     * @param options getRolePermissions method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getRolePermissions({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRolePermissions & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetRolePermissions['results']>;
    getRolePermissions({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRolePermissions & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetRolePermissions>>;
    /**
     * getRoleTablePermissions
     *
     *
     *
     * @param options getRoleTablePermissions method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getRoleTablePermissions({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRoleTablePermissions & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetRoleTablePermissions['results']>;
    getRoleTablePermissions({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRoleTablePermissions & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetRoleTablePermissions>>;
    /**
     * getRoleDefaults
     *
     *
     *
     * @param options getRoleDefaults method options object
     * @param options.appid Application ID
     * @param options.roleid Role ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getRoleDefaults({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRoleDefaults & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetRoleDefaults['results']>;
    getRoleDefaults({ appid, roleid, requestOptions, returnAxios }: HighSystemsRequestGetRoleDefaults & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetRoleDefaults>>;
    /**
     * getApplicationUsers
     *
     *
     *
     * @param options getApplicationUsers method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationUsers({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUsers & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationUsers['results']>;
    getApplicationUsers({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUsers & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationUsers>>;
    /**
     * postApplicationUser
     *
     *
     *
     * @param options postApplicationUser method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postApplicationUser({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplicationUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostApplicationUser['results']>;
    postApplicationUser({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostApplicationUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostApplicationUser>>;
    /**
     * deleteApplicationUser
     *
     *
     *
     * @param options deleteApplicationUser method options object
     * @param options.appid Application ID
     * @param options.userid User ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteApplicationUser({ appid, userid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplicationUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteApplicationUser['results']>;
    deleteApplicationUser({ appid, userid, requestOptions, returnAxios }: HighSystemsRequestDeleteApplicationUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteApplicationUser>>;
    /**
     * getApplicationUser
     *
     *
     *
     * @param options getApplicationUser method options object
     * @param options.appid Application ID
     * @param options.userid User ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationUser({ appid, userid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationUser['results']>;
    getApplicationUser({ appid, userid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationUser>>;
    /**
     * putApplicationUser
     *
     *
     *
     * @param options putApplicationUser method options object
     * @param options.appid Application ID
     * @param options.applicationUserId Application User ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putApplicationUser({ appid, applicationUserId, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplicationUser & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutApplicationUser['results']>;
    putApplicationUser({ appid, applicationUserId, requestOptions, returnAxios, ...body }: HighSystemsRequestPutApplicationUser & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutApplicationUser>>;
    /**
     * getTables
     *
     *
     *
     * @param options getTables method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getTables({ appid, requestOptions, returnAxios }: HighSystemsRequestGetTables & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetTables['results']>;
    getTables({ appid, requestOptions, returnAxios }: HighSystemsRequestGetTables & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetTables>>;
    /**
     * postTable
     *
     *
     *
     * @param options postTable method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postTable({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostTable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostTable['results']>;
    postTable({ appid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostTable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostTable>>;
    /**
     * deleteTable
     *
     *
     *
     * @param options deleteTable method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteTable({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestDeleteTable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteTable['results']>;
    deleteTable({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestDeleteTable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteTable>>;
    /**
     * getTable
     *
     *
     *
     * @param options getTable method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getTable({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetTable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetTable['results']>;
    getTable({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetTable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetTable>>;
    /**
     * putTable
     *
     *
     *
     * @param options putTable method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putTable({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutTable & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutTable['results']>;
    putTable({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutTable & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutTable>>;
    /**
     * getApplicationRelationships
     *
     *
     *
     * @param options getApplicationRelationships method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationRelationships({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationRelationships & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationRelationships['results']>;
    getApplicationRelationships({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationRelationships & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationRelationships>>;
    /**
     * getTableRelationships
     *
     *
     *
     * @param options getTableRelationships method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getTableRelationships({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetTableRelationships & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetTableRelationships['results']>;
    getTableRelationships({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetTableRelationships & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetTableRelationships>>;
    /**
     * getApplicationFields
     *
     *
     *
     * @param options getApplicationFields method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationFields({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationFields & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationFields['results']>;
    getApplicationFields({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationFields & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationFields>>;
    /**
     * getFields
     *
     *
     *
     * @param options getFields method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getFields({ appid, tableid, clist, requestOptions, returnAxios }: HighSystemsRequestGetFields & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetFields['results']>;
    getFields({ appid, tableid, clist, requestOptions, returnAxios }: HighSystemsRequestGetFields & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetFields>>;
    /**
     * postField
     *
     *
     *
     * @param options postField method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postField({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostField & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostField['results']>;
    postField({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostField & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostField>>;
    /**
     * deleteField
     *
     *
     *
     * @param options deleteField method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.fieldid Field ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteField({ appid, tableid, fieldid, requestOptions, returnAxios }: HighSystemsRequestDeleteField & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteField['results']>;
    deleteField({ appid, tableid, fieldid, requestOptions, returnAxios }: HighSystemsRequestDeleteField & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseDeleteField>>;
    /**
     * getField
     *
     *
     *
     * @param options getField method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.fieldid Field ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getField({ appid, tableid, fieldid, requestOptions, returnAxios }: HighSystemsRequestGetField & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetField['results']>;
    getField({ appid, tableid, fieldid, requestOptions, returnAxios }: HighSystemsRequestGetField & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetField>>;
    /**
     * putField
     *
     *
     *
     * @param options putField method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.fieldid Field ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    putField({ appid, tableid, fieldid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutField & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePutField['results']>;
    putField({ appid, tableid, fieldid, requestOptions, returnAxios, ...body }: HighSystemsRequestPutField & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePutField>>;
    /**
     * getApplicationReports
     *
     *
     *
     * @param options getApplicationReports method options object
     * @param options.appid Application ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getApplicationReports({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationReports & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetApplicationReports['results']>;
    getApplicationReports({ appid, requestOptions, returnAxios }: HighSystemsRequestGetApplicationReports & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetApplicationReports>>;
    /**
     * getReports
     *
     *
     *
     * @param options getReports method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    getReports({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetReports & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseGetReports['results']>;
    getReports({ appid, tableid, requestOptions, returnAxios }: HighSystemsRequestGetReports & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponseGetReports>>;
    /**
     * postReport
     *
     *
     *
     * @param options postReport method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    postReport({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostReport & {
        returnAxios?: false;
    }): Promise<HighSystemsResponsePostReport['results']>;
    postReport({ appid, tableid, requestOptions, returnAxios, ...body }: HighSystemsRequestPostReport & {
        returnAxios: true;
    }): Promise<AxiosResponse<HighSystemsResponsePostReport>>;
    /**
     * deleteReport
     *
     *
     *
     * @param options deleteReport method options object
     * @param options.appid Application ID
     * @param options.tableid Table ID
     * @param options.reportid Report ID
     * @param options.requestOptions Override axios request configuration
     * @param options.returnAxios If `true`, the returned object will be the entire `AxiosResponse` object
     */
    deleteReport({ appid, tableid, reportid, requestOptions, returnAxios }: HighSystemsRequestDeleteReport & {
        returnAxios?: false;
    }): Promise<HighSystemsResponseDeleteReport['results']>;
    deleteReport({ appid, tableid, reportid, requestOptions, returnAxios }: HighSystemsRequestDeleteReport & {
        returnAxios: true;
    }): Promise