baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
56 lines (55 loc) • 2.95 kB
TypeScript
/**
* @module meteringSettingsClient
* @description Metering Settings Client provides an easy way to consume Metering REST API end-points. In order to obtain a needed routes `meteringSettingsClient` uses `meteringSettingsRoute`.
*/
import { IGetRequestOptions } from '../../common/contracts';
import { ApiClient, IHttpResponse } from '../../httpApi';
import { MeteringSettingsRoute } from './';
import { IMeteringSettings } from './contracts';
export declare class MeteringSettingsClient {
protected meteringSettingsRoute: MeteringSettingsRoute;
protected apiClient: ApiClient;
readonly routeDefinition: MeteringSettingsRoute;
constructor(meteringSettingsRoute: MeteringSettingsRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the metering resource.
* @method
* @example meteringSettingsClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(options?: IGetRequestOptions): PromiseLike<IHttpResponse<IMeteringSettings>>;
/**
* Returns a promise that is resolved once the update metering action has been performed; this action updates a metering resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `meteringSettingsRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(meteringSettings);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data An meteringSetting object used to update specified MeteringSetting resource.
* @returns A promise that is resolved once the update metering action has been performed.
* @example // meteringSettings is a resource previously fetched using get action.
meteringSettings.dataRetentionPeriod = 60;
meteringSettingsClient.update(meteringSettings)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IMeteringSettings): PromiseLike<IHttpResponse<void>>;
}
/**
* @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.
- All end-point objects are transformed by the associated route service.
*/