baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
104 lines (103 loc) • 6.19 kB
JavaScript
;
/* globals module */
/**
* @module notificationsRegistrationsAnonymousRoute
* @description Baasic Notifications Registrations Anonymous Route Definition provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic Notifications Registrations Anonymous 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.
*/
Object.defineProperty(exports, "__esModule", { value: true });
var tslib_1 = require("tslib");
var inversify_1 = require("inversify");
var common_1 = require("../../common");
;
var contracts_1 = require("../../core/contracts");
var _1 = require("./");
var NotificationsRegistrationsAnonymousRoute = /** @class */ (function (_super) {
tslib_1.__extends(NotificationsRegistrationsAnonymousRoute, _super);
function NotificationsRegistrationsAnonymousRoute(appOptions, notificationsRegistrationsAnonymousBatchRoute) {
var _this = _super.call(this, appOptions) || this;
_this.appOptions = appOptions;
_this.notificationsRegistrationsAnonymousBatchRoute = notificationsRegistrationsAnonymousBatchRoute;
_this.createRoute = 'notifications/registrations/anonymous';
_this.findRoute = 'notifications/registrations/anonymous/{?searchQuery,providers,page,rpp,sort,embed,fields}';
_this.getRoute = 'notifications/registrations/anonymous/{id}/{?embed}';
_this.updateRoute = 'notifications/registrations/anonymous/{id}';
_this.deleteRoute = 'notifications/registrations/anonymous/{id}';
return _this;
}
Object.defineProperty(NotificationsRegistrationsAnonymousRoute.prototype, "batch", {
get: function () {
return this.notificationsRegistrationsAnonymousBatchRoute;
},
enumerable: true,
configurable: true
});
/**
* Parses create anonymous registrations route; this route does not expose any additional options
* @method
* @example notificationsRegistrationsAnonymousRoute.create();
*/
NotificationsRegistrationsAnonymousRoute.prototype.create = function () {
return _super.prototype.baseCreate.call(this, this.createRoute, {});
};
/**
* Parses find anonymous registrations route which can be expanded with additional options. Supported items are:
* - `searchQuery` - A string referencing user subscription properties using the phrase search.
* - `providers` - Comma separated list of notification providers.
* - `page` - A value used to set the page number, i.e. to retrieve certain user subscription 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 subscription 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 notificationsRegistrationsAnonymousRoute.find({
searchQuery: '<search-phrase>',
providers: '<provider-name>,<provider-name>'
});
*/
NotificationsRegistrationsAnonymousRoute.prototype.find = function (options) {
return _super.prototype.baseFind.call(this, this.findRoute, options);
};
/**
* Parses get anonymous registrations route; this route should be expanded with the Id of anonymous registrations resource.
* @method
* @param id The registration identifier which uniquely identifies AnonymousRegistration resource that needs to be retrieved.
* @param options Query resource options object.
* @example notificationsRegistrationsAnonymousRoute.get({ id: '<registration-id>' });
*/
NotificationsRegistrationsAnonymousRoute.prototype.get = function (id, options) {
return _super.prototype.baseGet.call(this, this.getRoute, id, options);
};
/**
* Parses update anonymous registrations route; this route should be expanded with the Id of anonymous registrations resource.
* @method
* @param data An object used to update specified AnonymousRegistration resource.
* @example notificationsRegistrationsAnonymousRoute.update(data);
*/
NotificationsRegistrationsAnonymousRoute.prototype.update = function (data) {
return _super.prototype.baseUpdate.call(this, this.updateRoute, data);
};
/**
* Parses delete anonymous registrations route; this route should be expanded with the Id of anonymous registrations resource.
* @method
* @param data An object used to delete specified AnonymousRegistration resource.
* @example notificationsRegistrationsAnonymousRoute.delete(data);
*/
NotificationsRegistrationsAnonymousRoute.prototype.delete = function (data) {
return _super.prototype.baseDelete.call(this, this.deleteRoute, data);
};
NotificationsRegistrationsAnonymousRoute = tslib_1.__decorate([
inversify_1.injectable(),
tslib_1.__param(0, inversify_1.inject(contracts_1.TYPES.IAppOptions)),
tslib_1.__param(1, inversify_1.inject(_1.TYPES.NotificationsRegistrationsAnonymousBatchRoute)),
tslib_1.__metadata("design:paramtypes", [Object, _1.NotificationsRegistrationsAnonymousBatchRoute])
], NotificationsRegistrationsAnonymousRoute);
return NotificationsRegistrationsAnonymousRoute;
}(common_1.BaseRoute));
exports.NotificationsRegistrationsAnonymousRoute = NotificationsRegistrationsAnonymousRoute;
/**
* @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.
*/