baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
68 lines (67 loc) • 3.54 kB
TypeScript
/**
* @module templatingRoute
* @description Baasic Templating Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Templating Route Definition to obtain a 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 { TemplatingBatchRoute } from './';
import { ITemplate } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class TemplatingRoute extends BaseRoute {
protected appOptions: IAppOptions;
protected templatingBatchRoute: TemplatingBatchRoute;
readonly findRoute: string;
readonly getRoute: string;
readonly createRoute: string;
readonly updateRoute: string;
readonly deleteRoute: string;
readonly batch: TemplatingBatchRoute;
constructor(appOptions: IAppOptions, templatingBatchRoute: TemplatingBatchRoute);
/**
* Parses find route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string value used to identify template resources using the phrase search.
* - `page` - A value used to set the page number, i.e. to retrieve certain template subset from the storage.
* - `rpp` - A value used to limit the size of result set per page.
* - `sort` - A string used to set the template 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.
* @example templatingRoute.find({searchQuery: '<search-phrase>'});
**/
find(options?: IOptions): any;
/**
* Parses get route which must be expanded with the Id of the previously created template resource in the system.
* @method
* @param id Template id which uniquely identifies Template resource that needs to be retrieved.
* @param options Query resource options object.
* @example templatingRoute.get({id: '<template-id>'});
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses create route; this URI template does not expose any additional options.
* @method
* @example templatingRoute.create();
**/
create(): any;
/**
* Parses update route; this URI template does not expose any additional options.
* @method
* @param data An template object used to update specified Template resource.
* @example templatingRoute.update(data);
**/
update(data: ITemplate): any;
/**
* Parses delete route; this URI template does not expose any additional options.
* @method
* @param data An template object used to delete specified Template resource.
* @example templatingRoute.update(data);
**/
delete(data: ITemplate): 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.
*/