baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
60 lines (59 loc) • 3.15 kB
TypeScript
/**
* @module userWorkRoute
* @description Baasic User Work Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic User Work Route Definition to obtain 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, IOptions } from '../../common/contracts';
import { IUserWork } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class UserWorkRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly findRoute: string;
readonly getRoute: string;
readonly createRoute: string;
readonly updateRoute: string;
readonly deleteRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses find route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string referencing user work properties using the phrase or BQL (Baasic Query Language) search.
* - `page` - A value used to set the page number, i.e. to retrieve certain user work subset from the storage.
* - `rpp` - A value used to limit the size of result set per page.
* - `sort` - A string used to set the user work property to sort the result collection by.
* - `embed` - Comma separated list of resources to be contained within the current representation.
* @method
* @param options Query resource options object.
* @example userWorkRoute.find({searchQuery: '<search-phrase>'});
**/
find(options?: IOptions): any;
/**
* Parses get route; this route doesn't expose any properties.
* @method
* @param id User work id which uniquely identifies resource that needs to be retrieved.
* @param options Query resource options object.
* @example userWorkRoute.get(id, options);
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses create route; this URI template does not expose any additional options.
* @method
* @param data An user work object that needs to be inserted into the system.
* @example userWorkRoute.create(data);
**/
create(data: IUserWork): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param data An user work object used to update specified user work resource.
* @example userWorkRoute.create(data);
**/
update(data: IUserWork): any;
delete(data: IUserWork): any;
}
/**
* @overview
***Notes:**
- Refer to the [REST API documentation](https://github.com/Baasic/baasic-rest-api/wiki) 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 definition.
*/