baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
38 lines (37 loc) • 1.85 kB
TypeScript
/**
* @module meteringSettingsRoute
* @description Baasic Metering Settings Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Metering Settings Route Definition to obtain a 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 { IGetRequestOptions } from '../../common/contracts';
import { IMeteringSettings } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class MeteringSettingsRoute 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
* @example meteringSettingsRoute.get();
**/
get(options?: IGetRequestOptions): any;
/**
* Parses updatea route; this route doesn't expose any properties.
* @method
* @param data An meteringSetting object used to update specified MeteringSetting resource.
* @example meteringSettingsRoute.update(data);
**/
update(data: IMeteringSettings): 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.
*/