Rzeassistant_client_api NPM

rzeassistant_client_api

KnowYourPlaceApi - JavaScript client for rzeassistant_client_api API do 'Aplikacja dla studentów zagranicznych'. This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 0.2.6
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

Install it via:

npm install rzeassistant_client_api --save

Getting Started

Please follow the installation instruction and execute the following JS code:

var KnowYourPlaceApi = require('rzeassistant_client_api');
var defaultClient = KnowYourPlaceApi.ApiClient.instance;

// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"

var api = new KnowYourPlaceApi.ArticlesApi();
var body = new KnowYourPlaceApi.CreateArticleDto(); // {CreateArticleDto}

var callback = function (error, data, response) {
	if (error) {
		console.error(error);
	} else {
		console.log('API called successfully. Returned data: ' + data);
	}
};
api.articleControllerCreate(body, callback);

Documentation for Authorization

bearer

Type: API key
API key parameter name: Authorization
Location: HTTP header

Documentation for API Endpoints

All URIs are relative to /

Class	Method	HTTP request	Description
KnowYourPlaceApi.ArticlesApi	articleControllerCreate	POST /api/v1/articles	Creates a new article
KnowYourPlaceApi.ArticlesApi	articleControllerFindAll	GET /api/v1/articles	Returns a list of articles containing phrase in the title, content, author or category, ordered by orderBy and limited to limit.If the phrase and the limit are empty, returns all articles.
KnowYourPlaceApi.ArticlesApi	articleControllerFindById	GET /api/v1/articles/{id}	Returns an article by id
KnowYourPlaceApi.ArticlesApi	articleControllerUpdate	POST /api/v1/articles/{id}	Updates an article by id
KnowYourPlaceApi.ArticlesApi	articleControllerUpdateDislikesById	POST /api/v1/articles/{id}/dislikes	Updates dislike count of the article
KnowYourPlaceApi.ArticlesApi	articleControllerUpdateLikesById	POST /api/v1/articles/{id}/likes	Updates like count of the article
KnowYourPlaceApi.BannedArticleApi	bannedArticleControllerBanArticle	POST /api/v1/bannedArticle	Creates a new banned article
KnowYourPlaceApi.BannedArticleApi	bannedArticleControllerFindBannedArticle	GET /api/v1/bannedArticle/{id}	Returns banned article details
KnowYourPlaceApi.BannedUserApi	bannedUserControllerBanUser	POST /api/v1/bannedUser	Creates a new banned user
KnowYourPlaceApi.BannedUserApi	bannedUserControllerFindBannedUser	GET /api/v1/bannedUser/{id}	Returns banned user details
KnowYourPlaceApi.CategoriesApi	categoryControllerCreate	POST /api/v1/categories	Creates a new category
KnowYourPlaceApi.CategoriesApi	categoryControllerFindAll	GET /api/v1/categories	Returns all categories
KnowYourPlaceApi.CategoriesApi	categoryControllerFindById	GET /api/v1/categories/{id}	Returns a category with the given id
KnowYourPlaceApi.CategoriesApi	categoryControllerRemoveById	DELETE /api/v1/categories/{id}	Removes a category by the given id
KnowYourPlaceApi.ClipboardsApi	clipboardControllerAddArticleById	POST /api/v1/clipboards/{id}/add	Adds a article to the clipboard
KnowYourPlaceApi.ClipboardsApi	clipboardControllerCreate	POST /api/v1/clipboards	Creates a new clipboard
KnowYourPlaceApi.ClipboardsApi	clipboardControllerFindById	GET /api/v1/clipboards/{id}	Returns a clipboard by id
KnowYourPlaceApi.ClipboardsApi	clipboardControllerFindClipboardByUserId	GET /api/v1/clipboards/user/{id}	Returns clipboard associated with the given user
KnowYourPlaceApi.ClipboardsApi	clipboardControllerRemoveArticleById	POST /api/v1/clipboards/{id}/remove	Removes a article from the clipboard
KnowYourPlaceApi.ClipboardsApi	clipboardControllerRemoveById	DELETE /api/v1/clipboards/{id}	Removes a clipboard by id
KnowYourPlaceApi.ClipboardsApi	clipboardControllerUserClipboardContainsArticleId	GET /api/v1/clipboards/user/{id}/contains	Checks if user's clipboard contains the given article
KnowYourPlaceApi.CommentsApi	commentControllerCreate	POST /api/v1/comments	Creates a new comment
KnowYourPlaceApi.CommentsApi	commentControllerFindByArticleId	GET /api/v1/comments/article/{id}	Returns all comments by the given article id
KnowYourPlaceApi.CommentsApi	commentControllerFindByAuthorId	GET /api/v1/comments/user/{id}	Returns all comments by the given user id
KnowYourPlaceApi.ImagesApi	imageControllerCreate	POST /api/v1/images	Uploads a new image
KnowYourPlaceApi.ImagesApi	imageControllerFindAllUploadedBy	GET /api/v1/images/user/{id}	Returns all images by user id
KnowYourPlaceApi.ImagesApi	imageControllerRemoveByLink	DELETE /api/v1/images/{id}	Removes an image
KnowYourPlaceApi.ImagesApi	imageDataControllerFindByLink	GET /files/images/{id}	Returns an image
KnowYourPlaceApi.InterestsApi	interestControllerCreate	POST /api/v1/interests	Creates a new interest
KnowYourPlaceApi.InterestsApi	interestControllerFindAll	GET /api/v1/interests	Returns all interests
KnowYourPlaceApi.NotificationsApi	notificationControllerCreate	POST /api/v1/notifications	Creates a new notification
KnowYourPlaceApi.NotificationsApi	notificationControllerFindByUserId	GET /api/v1/notifications/user/{id}	Returns a list of all notifications by the given user id
KnowYourPlaceApi.UsersApi	userControllerCreate	POST /api/v1/users	Creates new user
KnowYourPlaceApi.UsersApi	userControllerFindById	GET /api/v1/users/{id}	Returns user details by id
KnowYourPlaceApi.UsersApi	userControllerLogin	POST /api/v1/users/login	Returns user details by password hash