baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
112 lines (111 loc) • 6.01 kB
TypeScript
import { IQueryModel, IGetRequestOptions, IOptions } from '../../common/contracts';
import { ApiClient, IHttpResponse } from '../../httpApi';
import { ValueSetItemRoute } from './';
import { IValueSetItem } from './contracts';
export declare class ValueSetItemClient {
protected valueSetItemRoute: ValueSetItemRoute;
protected apiClient: ApiClient;
readonly routeDefinition: ValueSetItemRoute;
constructor(valueSetItemRoute: ValueSetItemRoute, apiClient: ApiClient);
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of value set item resources matching given criteria.
* @param options Query resource options object.
* @returns A promise that is resolved once the find action has been performed.
* @method items.find
* @example valueSetItemClient.find({
setName: '<value-set-name>',
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>' })
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
find(options?: IOptions): PromiseLike<IHttpResponse<IQueryModel<IValueSetItem>>>;
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified value set item resource.
* @param setName value set name
* @param id unique identifier of value set resource
* @param options query resource options object
* @returns A promise that is resolved once the get action has been performed.
* @method items.get
* @example valueSetItemClient.get('<value-set-name>', '<set-item-id>')
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
get(setName: string, id: string, options?: IGetRequestOptions): PromiseLike<IHttpResponse<IValueSetItem>>;
/**
* Returns a promise that is resolved once the create value set item action has been performed; this action creates a new value set item resource.
* @method
* @param data A value set item object that needs to be inserted into the system.
* @returns A promise that is resolved once the create value set item action has been performed.
* @example valueSetItemClient.create({
setId: '<value-set-id>',
value: '<value>'
})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
create(data: IValueSetItem): PromiseLike<IHttpResponse<IValueSetItem>>;
/**
* Returns a promise that is resolved once the update value set item action has been performed; this action updates a value set item resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `valueSetClient` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(valueSetItem);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data A value set item object used to update specified value set resource.
* @returns A promise that is resolved once the update value set item action has been performed.
* @example // valueSetItem is a resource previously fetched using get action.
valueSetItem.value = '<new-value>';
valueSetItemClient.update(valueSetItem)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
update(data: IValueSetItem): PromiseLike<IHttpResponse<IValueSetItem>>;
/**
* Returns a promise that is resolved once the remove action has been performed. This action will delete a value set item if the action is completed successfully. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `valueSetClient` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(valueSetItem);
* let uri = params['model'].links('delete').href;
* ```
* @param data A value set item object used to delete specified value set resource.
* @returns A promise that is resolved once the remove action has been performed.
* @method
* @example // valueSetItem is a resource previously fetched using get action.
valueSetItemClient.remove(valueSetItem)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
remove(data: IValueSetItem): 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.
*/