baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
39 lines (38 loc) • 1.91 kB
TypeScript
/**
* @module applicationSettingsRoute
* @description Baasic Application Settings Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Application 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 { BaseRoute } from '../../common';
import { IOptions } from '../../common/contracts';
import { IApplication } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class ApplicationSettingsRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly getRoute: string;
readonly updateRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get route; this route doesn't expose any properties.
* @method
* @param options Query resource options object.
* @example applicationSettingsRoute.get();
**/
get(options: IOptions): any;
/**
* Parses update route; this route doesn't expose any properties.
* @method
* @param data An application object used to update application settings of the specified application resource.
* @example applicationSettingsRoute.update();
**/
update(data: IApplication): any;
}
/**
* @copyright (c) 2017 Mono Ltd
* @license MIT
* @author Mono Ltd
* @overview
***Notes:**
- Refer to the [Baasic REST API](http://dev.baasic.com/api/reference/home) for detailed information about available Baasic REST API end-points.
- [URI Template](https://github.com/Baasic/uritemplate-js) syntax enables expanding the Baasic route templates to Baasic REST URIs providing it with an object that contains URI parameters.
- All end-point objects are transformed by the associated route service.
*/