@dolbyio/dolbyio-rest-apis-client
Version:
Node.JS wrapper for the Dolby OptiView REST APIs
23 lines (22 loc) • 955 B
TypeScript
import { ClusterResponse } from './types/cluster';
/**
* Gets the default cluster and list the available onces.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/cluster-get-clusters-info/}
*
* @param apiSecret The API Secret used to authenticate this request.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link ClusterResponse} object.
*/
export declare const read: (apiSecret: string) => Promise<ClusterResponse>;
/**
* Updates the default cluster for the account.
*
* @see {@link https://optiview.dolby.com/docs/millicast/api/cluster-update-cluster-info/}
*
* @param apiSecret The API Secret used to authenticate this request.
* @param defaultCluster The new default cluster.
*
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link ClusterResponse} object.
*/
export declare const update: (apiSecret: string, defaultCluster: string) => Promise<ClusterResponse>;