baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
137 lines (136 loc) • 7.06 kB
JavaScript
"use strict";
/* globals module */
/**
* @module userEducationClient * @description User Education Client provides Baasic route templates which can be expanded to Baasic REST URIs. Various services can use Baasic User Education 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 httpApi_1 = require("../../../httpApi");
var _1 = require("./");
var UserEducationClient = /** @class */ (function () {
function UserEducationClient(userEducationRoute, apiClient) {
this.userEducationRoute = userEducationRoute;
this.apiClient = apiClient;
}
Object.defineProperty(UserEducationClient.prototype, "routeDefinition", {
get: function () {
return this.userEducationRoute;
},
enumerable: true,
configurable: true
});
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of user education resources matching the given criteria.
* @method
* @param options Query resource options object.
* @returns A promise that is resolved once the find action has been performed.
* @example userEducationClient.find({
pageNumber : 1,
pageSize : 10,
orderBy : '<field>',
orderDirection : '<asc|desc>',
search : '<search-phrase>'
})
.then(function (collection) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
UserEducationClient.prototype.find = function (options) {
return this.apiClient.get(this.routeDefinition.find(options));
};
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the user education resource.
* @method
* @example userEducationClient.get(id)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
UserEducationClient.prototype.get = function (id, options) {
return this.apiClient.get(this.userEducationRoute.get(id, options));
};
/**
* Returns a promise that is resolved once the create user education action has been performed; this action creates a new user education resource.
* @method
* @param data An user education object that needs to be inserted into the system.
* @returns A promise that is resolved once the create user education action has been performed.
* @example userEducationClient.create({
organizationName : '<organization-name>',
summary: '<summary>',
userId: '<user-id>'
})
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
UserEducationClient.prototype.create = function (data) {
return this.apiClient.post(this.routeDefinition.create(data), this.routeDefinition.createParams(data));
};
/**
* Returns a promise that is resolved once the update user education action has been performed; this action updates a user education resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `userEducationRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(education);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data An user education object used to update specified user education resource.
* @returns A promise that is resolved once the update user education action has been performed.
* @example // education is a resource previously fetched using get action.
education.degree = '<degree>';
userEducationClient.update(education)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
UserEducationClient.prototype.update = function (data) {
return this.apiClient.put(this.routeDefinition.update(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the remove action has been performed. This action will remove a user education resource from the system if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `baasicUserEducationRoutDefinition` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(education);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @example // education is a resource previously fetched using get action.
userEducationClient.remove(education)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
UserEducationClient.prototype.remove = function (data) {
return this.apiClient.delete(this.routeDefinition.delete(data));
};
UserEducationClient = tslib_1.__decorate([
inversify_1.injectable(),
tslib_1.__param(0, inversify_1.inject(_1.TYPES.UserEducationRoute)),
tslib_1.__param(1, inversify_1.inject(httpApi_1.httpTYPES.ApiClient)),
tslib_1.__metadata("design:paramtypes", [_1.UserEducationRoute,
httpApi_1.ApiClient])
], UserEducationClient);
return UserEducationClient;
}());
exports.UserEducationClient = UserEducationClient;
/**
* @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.
- All end-point objects are transformed by the associated route service.
*/