baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
71 lines (70 loc) • 3.68 kB
TypeScript
/**
* @module userProfileRoute
* @description Baasic User Profile Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic User Profile 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 { UserProfileACLRoute } from './';
import { IUserProfile } from './contracts';
import { IAppOptions } from '../../core/contracts';
export declare class UserProfileRoute extends BaseRoute {
protected appOptions: IAppOptions;
protected userProfileACLRoute: UserProfileACLRoute;
readonly findRoute: string;
readonly getRoute: string;
readonly createRoute: string;
readonly updateRoute: string;
readonly deleteRoute: string;
readonly acl: UserProfileACLRoute;
constructor(appOptions: IAppOptions, userProfileACLRoute: UserProfileACLRoute);
/**
* Parses find user profile route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string value used to identify user profile resources using the phrase search.
* - `page` - A value used to set the page number, i.e. to retrieve certain user profile 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 profile 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 userProfileRoute.find.({searchQuery: '<search-phrase>'});
**/
find(options?: IOptions): any;
/**
* Parses get route; this route doesn't expose any properties.
* @method
* @param id User profile id which uniquely identifies user profile resource that needs to be retrieved.
* @param options Query resource options object.
* @example userProfileRoute.get(id, options);
**/
get(id: string, options?: IGetRequestOptions): any;
/**
* Parses create user profile route; this URI template does not expose any additional options.
* @method
* @example baasicUserProfileRouteService.create();
**/
create(): any;
/**
* Parses update user profile route; this URI template does not expose any additional options.
* @method
* @param data An user profile object used to update specified user profile resource.
* @example baasicUserProfileRouteService.update(data);
**/
update(data: IUserProfile): any;
/**
* Parses update user profile route; this URI template does not expose any additional options.
* @method
* @param data An user profile object used to delete specified user profile resource.
* @example baasicUserProfileRouteService.delete(data);
**/
delete(data: IUserProfile): any;
}
/**
* @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.
- [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.
*/