baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
47 lines (46 loc) • 2.55 kB
TypeScript
/**
* @module mediaVaultSettingsClient
* @description Media Vault Settings Client provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Media Vault Settings Route Service to obtain needed routes while other routes will be obtained through HAL. By convention, all route services use the same function names as their corresponding services.
*/
import { ApiClient, IHttpResponse } from '../../httpApi';
import { MediaVaultSettingsRoute } from './';
import { IMediaVaultSettings } from './contracts';
export declare class MediaVaultSettingsClient {
protected mediaVaultSettingsRoute: MediaVaultSettingsRoute;
protected apiClient: ApiClient;
readonly routeDefinition: MediaVaultSettingsRoute;
constructor(mediaVaultSettingsRoute: MediaVaultSettingsRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns media vault settings resource.
* @method
* @returns A promise that is resolved once the get action has been performed.
* @example mediaVaultSettingsClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(): PromiseLike<IHttpResponse<IMediaVaultSettings>>;
/**
* Returns a promise that is resolved once the update action has been performed; this action updates the media vault settings resource.
* @method
* @param data A media vault settings object used to update media vault settings in the system.
* @returns A promise that is resolved once the update action has been performed.
* @example mediaVaultSettingsClient.update(mediaVaultSettings)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IMediaVaultSettings): PromiseLike<IHttpResponse<void>>;
}
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- All end-point objects are transformed by the associated route service.
*/