baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
97 lines (96 loc) • 5.42 kB
TypeScript
/**
* @module meteringACLClient
* @description Metering ACL Client provides an easy way to consume Metering REST API end-points. In order to obtain a needed routes `meteringACLClient` uses `meteringACLRoute`.
*/
import { IACLOptions, IACLPolicy } from '../../common/contracts';
import { ApiClient, IHttpResponse } from '../../httpApi';
import { MeteringACLRoute } from './';
export declare class MeteringACLClient {
protected meteringACLRoute: MeteringACLRoute;
protected apiClient: ApiClient;
readonly routeDefinition: MeteringACLRoute;
constructor(meteringACLRoute: MeteringACLRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns a list of ACL policies established for the specified metering resource.
* @method
* @param options Query resource options object.
* @returns A promise that is resolved once the get action has been performed.
* @example meteringClient.get({id: '<id>'})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(options?: IACLOptions): PromiseLike<IHttpResponse<IACLPolicy[]>>;
/**
* Returns a promise that is resolved once the update acl action has been performed, this action creates new ACL policy for the specified metering resource.
* @method
* @param options ACL options object.
* @example let options = {id : '<id>'};
let aclObj = { actionId: '<action-id'>, roleId: '<roleId>', userId: '<userId>' };
options[baasicConstants.modelPropertyName] = aclObj;
meteringACLClient.update(options)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(options: IACLOptions): PromiseLike<IHttpResponse<IACLPolicy[]>>;
/**
* Returns a promise that is resolved once the removeByUser action has been performed. This action deletes ACL policy assigned to the specified user and metering resource.
* @method
* @param id User metering data id which uniquely identifies user metering data resource whose security privileges need to be retrieved and updated.
* @param action Action abbreviation which identifies ACL policy assigned to the specified user and user metering data resource.
* Supported Values:
* "Create"
* "Delete"
* "Read"
* "Update"
* @param user A value that uniquely identifies user for which ACL policy needs to be removed.
* @param data ACL Policy object used to delete specified item in the system.
* @returns A promise that is resolved once the removeByUser action has been performed.
* @example meteringACLClient.removeByUser('<id>', '<access-action>', '<username>')
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
removeByUser(id: string, action: string, user: string, data: IACLPolicy): PromiseLike<IHttpResponse<void>>;
/**
* Returns a promise that is resolved once the removeByRole action has been performed. This action deletes ACL policy assigned to the specified role and metering resource.
* @method
* @param id User metering data id which uniquely identifies user metering data resource whose security privileges need to be retrieved and updated.
* @param action Action abbreviation which identifies ACL policy assigned to the specified user and user metering data resource.
* Supported Values:
* "Create"
* "Delete"
* "Read"
* "Update"
* @param role A value that uniquely identifies role for which ACL policy needs to be removed.
* @param data ACL Policy object used to delete specified item in the system.
* @returns A promise that is resolved once the removeByRole action has been performed.
* @example meteringACLClient.removeByRole('<id>', '<access-action>', '<role-name>')
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
removeByRole(id: string, action: string, role: string, data: IACLPolicy): 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.
*/