rzeassistant_client_api

v0.2.6

Published

4 years ago

RzeAssistant API client

0High
0Medium
0Low

jwytrzes

konradwrbl

pipistrelus

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

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

rzeassistant_client_api

Installation

Getting Started

Documentation for Authorization

bearer

Documentation for API Endpoints

Documentation for Models