baasic-sdk-javascript
Version:
JavaScript SDK provides core functionality for building web and mobile applications on [Baasic](http://www.baasic.com/).
346 lines (345 loc) • 22.4 kB
JavaScript
"use strict";
/* globals module */
/**
* @module articleInstanceCommentRepliesClient
* @description Article Instance Comment Replies Client provides an easy way to consume Article Comment Replies REST API end-points. `articleCommentRepliesService` functions enable performing standard CRUD operations directly on article comment reply resources, whereas the `articleClient` functions allow management between article and article comment reply. In order to obtain needed routes `articleCommentRepliesService` uses `articleCommentRepliesRoute`.
*/
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 ArticleInstanceCommentRepliesClient = /** @class */ (function () {
function ArticleInstanceCommentRepliesClient(articleInstanceCommentRepliesRoute, apiClient) {
this.articleInstanceCommentRepliesRoute = articleInstanceCommentRepliesRoute;
this.apiClient = apiClient;
/**
* Contains a reference to valid list of article comment reply states. It returns an object containing all article comment reply states.
* @method
* @example articleCommentRepliesClient.statuses.approved;
**/
this.statuses = __1.CommentStatus;
}
Object.defineProperty(ArticleInstanceCommentRepliesClient.prototype, "routeDefinition", {
/**
* Provides direct access to `articleCommentRepliesRoute`.
* @method
* @example articleInstanceCommentRepliesClient.routeDefinition.get();
**/
get: function () {
return this.articleInstanceCommentRepliesRoute;
},
enumerable: true,
configurable: true
});
/**
* Returns a promise that is resolved once the approve article comment reply action has been performed. This action sets the state of an article comment reply to "approved". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-approve').href;
* ```
* @method
* @param data Article Comment Reply object.
* @param options Notification configuration used to control the article comment recourse access when managing notification distribution.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.approve(articleCommentReply, commentOptions)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.approve = function (data, options) {
return this.apiClient.put(this.routeDefinition.approve(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the unapprove article comment reply action has been performed. This action sets the state of an article comment reply to "unapproved". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-unapprove').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns A promise that is resolved once the unapprove article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.unapprove(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.unapprove = function (data) {
return this.apiClient.put(this.routeDefinition.unapprove(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the create article comment reply action has been performed; this action creates a new comment reply for an article.
* @method
* @param articleId Article id which uniquely identifies article that needs to be updated with new comment reply resource.
* @param data An article comment reply object that needs to be inserted into the system.
* @returns A promise that is resolved once the create article comment reply action has been performed.
* @example articleInstanceCommentRepliesClient.create('<article-id>', {
commentId : '<comment-id>',
comment : <comment>,
userId : '<user-id>' })
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.create = function (articleId, data) {
return this.apiClient.post(this.routeDefinition.create(articleId, data), this.routeDefinition.createParams(data));
};
/**
* Returns a promise that is resolved once the find action has been performed. Success response returns a list of article comment reply resources matching the given criteria.
* @method
* @param articleId Article id which uniquely identifies article whose comment reply resources need to be retrieved.
* @param commentId Comment id which uniquely identifies comment whose reply resources need to be retrieved.
* @param options Query resource options.
* @returns A promise that is resolved once the find action has been performed.
* @example articleInstanceCommentRepliesClient.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
});
**/
ArticleInstanceCommentRepliesClient.prototype.find = function (articleId, commentId, options) {
return this.apiClient.get(this.articleInstanceCommentRepliesRoute.find(articleId, commentId, options));
};
/**
* Returns a promise that is resolved once the flag article comment reply action has been performed. This action sets the state of an article comment reply to "flagged". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-flag').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns A promise that is resolved once the flag article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.flag(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.flag = function (data) {
return this.apiClient.put(this.routeDefinition.flag(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the unflag article comment reply action has been performed. This action removes the "flagged" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-unflag').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns A promise that is resolved once the unflag article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.unflag(articleCommentReply)
.success(function (data) {
// perform success action here
}).error(function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.unflag = function (data) {
return this.apiClient.put(this.routeDefinition.unflag(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the get action has been performed. Success response returns the specified article comment reply resource.
* @method
* @param articleId Article id which uniquely identifies article whose comment reply resource needs to be retrieved.
* @param commentId Comment id which uniquely identifies comment whose reply resource needs to be retrieved.
* @param replyId Id which uniquely identifies article comment reply resource that needs to be retrieved.
* @param options Options object that contains embed data.
* @returns A promise that is resolved once the get action has been performed.
* @example articleInstanceCommentRepliesClient.get('<comment-reply-id>')
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.get = function (articleId, commentId, replyId, options) {
return this.apiClient.get(this.articleInstanceCommentRepliesRoute.get(articleId, commentId, replyId, options));
};
/**
* Returns a promise that is resolved once the remove article comment reply action has been performed. If the action is successfully completed, the article comment reply resource will be permanently removed from the system. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = apiClient.removeParams(articleCommentReply);
* let uri = params['model'].links('delete').href;
* ```
* @method
* @param data An article comment object used to delete specified article comment reply resource.
* @returns A promise that is resolved once the remove article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.remove(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.remove = function (data) {
return this.apiClient.delete(this.routeDefinition.delete(data));
};
/**
* Returns a promise that is resolved once the removeAll article comment reply action has been performed. This action will remove all comment replies from an article comment if successfully completed. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleInstanceCommentsRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.removeParams(articleCommentReply);
* let uri = params['model'].links('delete-comments-by-article').href;
* ```
* @method
* @param data Article object used to delete all article comments in the system.
* @returns a promise that is resolved once the removeAll article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.removeAll(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.removeAll = function (data) {
return this.apiClient.delete(this.routeDefinition.deleteAll(data));
};
/**
* Returns a promise that is resolved once the report article comment reply action has been performed. This action sets the state of an article comment reply to "reported". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-report').href;
* ```
* @method
* @param data Article Comment Reply object.
* @param options Notification configuration used to control the article comment recourse access when managing notification distribution.
* @returns A promise that is resolved once the report article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.report(articleCommentReply, commentOptions)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.report = function (data, options) {
return this.apiClient.put(this.routeDefinition.report(data), this.routeDefinition.updateParams(options));
};
/**
* Returns a promise that is resolved once the unreport article comment reply action has been performed. This action removes the "reported" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-unreport').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns A promise that is resolved once the unreport article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.unreport(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.unreport = function (data) {
return this.apiClient.put(this.routeDefinition.unreport(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the mark as spam article comment reply action has been performed. This action sets the state of an article comment reply to "spam". This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-spam').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns A promise that is resolved once the mark as spam article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.spam(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.spam = function (data) {
return this.apiClient.put(this.routeDefinition.spam(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the unspam article comment reply action has been performed. This action removes the "spam" comment reply state. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('comment-unspam').href;
* ```
* @method
* @param data Article Comment Reply object.
* @returns a promise that is resolved once the unspam article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.unspam(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.unspam = function (data) {
return this.apiClient.put(this.routeDefinition.unspam(data), this.routeDefinition.updateParams(data));
};
/**
* Returns a promise that is resolved once the update article comment reply action has been performed; this action updates an article comment reply resource. This route uses HAL enabled objects to obtain routes and therefore it doesn't apply `articleCommentRepliesRoute` route template. Here is an example of how a route can be obtained from HAL enabled objects:
* ```
* let params = modelMapper.updateParams(articleCommentReply);
* let uri = params['model'].links('put').href;
* ```
* @method
* @param data An article comment object used to update specified article comment reply resource.
* @returns A promise that is resolved once the update article comment reply action has been performed.
* @example // articleCommentReply is a resource previously fetched using get action.
articleInstanceCommentRepliesClient.update(articleCommentReply)
.then(function (data) {
// perform success action here
},
function (response, status, headers, config) {
// perform error handling here
});
**/
ArticleInstanceCommentRepliesClient.prototype.update = function (data) {
return this.apiClient.put(this.routeDefinition.update(data), this.routeDefinition.updateParams(data));
};
ArticleInstanceCommentRepliesClient = tslib_1.__decorate([
inversify_1.injectable(),
tslib_1.__param(0, inversify_1.inject(__1.TYPES.ArticleInstanceCommentRepliesRoute)),
tslib_1.__param(1, inversify_1.inject(httpApi_1.httpTYPES.ApiClient)),
tslib_1.__metadata("design:paramtypes", [__1.ArticleInstanceCommentRepliesRoute,
httpApi_1.ApiClient])
], ArticleInstanceCommentRepliesClient);
return ArticleInstanceCommentRepliesClient;
}());
exports.ArticleInstanceCommentRepliesClient = ArticleInstanceCommentRepliesClient;
/**
* @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.
*/