baasic-sdk-nodejs
Version:
NodeJS SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
118 lines (117 loc) • 6.53 kB
TypeScript
import { BaasicApp } from 'baasic-sdk-javascript';
import { IACLClient, IBaasicQueryModel, IHttpResponse, IOptions } from '../../infrastructure/common/contracts';
import { IMeteringBatchClient, IMeteringCategoryClient, IMeteringData, IMeteringSettingsClient, IMeteringStatisticsClient } from './contracts';
export declare class MeteringClient {
private baasicApp;
constructor(baasicApp: BaasicApp);
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of metering resources matching the given criteria.
* @method
* @param options Query resource options object.
* @returns A promise that is resolved once the find action has been performed.
* @example MeteringClient.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
categories: 'Storage,Requests,Bandwidth'
})
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
find(options?: IOptions): PromiseLike<IHttpResponse<IBaasicQueryModel<IMeteringData>>>;
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the metering resource.
* @method
* @param id MeteringData id which uniquely identifies MeteringData resource that needs to be retrieved.
* @param options Query resource options object.
* @returns A promise that is resolved once the get action has been performed.
* @example MeteringClient.get()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(id: string, options?: IOptions): PromiseLike<IHttpResponse<IMeteringData>>;
/**
* Returns a promise that is resolved once the create metering action has been performed; this action creates a new metering resource.
* @method
* @param data An MeteringData object that needs to be inserted into the system.
* @returns A promise that is resolved once the create metering action has been performed
* @example MeteringClient.create({
category : '<category-name>',
name : '<sub-category-name>',
value: '<value>'
})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
create(data: IMeteringData): PromiseLike<IHttpResponse<IMeteringData>>;
/**
* 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 `baasicMeteringRouteDefinition` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(meteringData);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data An metering data object used to update specified MeteringData resource.
* @returns A promise that is resolved once the update metering action has been performed.
* @example // meteringData is a resource previously fetched using get action.
meteringData.value = '<some-new-value>';
MeteringClient.update(meteringData)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IMeteringData): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a metering resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicMeteringRouteDefinition` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(meteringData);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @param data An metering data object used to remove specified MeteringData resource.
* @returns A promise that is resolved once the remove action has been performed.
* @example // meteringData is a resource previously fetched using get action.
MeteringClient.remove(meteringData)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(data: IMeteringData): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the purge action has been performed. This action will remove all metering resources from the system if successfully completed.
* @method
* @returns A promise that is resolved once the purge action has been performed.
* @example MeteringClient.purge()
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
purge(): PromiseLike<IHttpResponse<void>>;
readonly batch: IMeteringBatchClient;
readonly statistics: IMeteringStatisticsClient;
readonly acl: IACLClient;
readonly settings: IMeteringSettingsClient;
readonly category: IMeteringCategoryClient;
}