baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
34 lines (33 loc) • 1.84 kB
TypeScript
/**
* @module notificationsSettingsRoute
* @description Baasic Notifications Settings Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Notifications Settings 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 { IAppOptions } from '../../../core/contracts';
export declare class NotificationsSettingsRoute extends BaseRoute {
protected appOptions: IAppOptions;
readonly getRoute: string;
readonly updateRoute: string;
constructor(appOptions: IAppOptions);
/**
* Parses get notification settings route; this route should be expanded with the notification provider name.
* @method
* @param provider The notification provider name.
* @example notificationsSettingsRoute.get({ id: '<provider-name>' });
*/
get(provider: string): any;
/**
* Parses update notification settings route; this route should be expanded with the notification provider name.
* @method
* @param data The notification settings.
* @example notificationsSettingsRoute.update({ id: '<provider-name>' });
*/
update(data: Object): 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 service.
*/