@redbrick-sdk/service NPM

redbrick_service

RedbrickService - JavaScript client for redbrick_service Redbrick API Service This SDK is automatically generated by the Swagger Codegen project:

API version: 2.0.0-rc230317214906
Package version: 2.0.0-rc230317214906
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install redbrick_service --save

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false,
      },
    },
  ];
}

Getting Started

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

var RedbrickService = require("redbrick_service");
var defaultClient = RedbrickService.ApiClient.instance;

var api = new RedbrickService.AdminApi();
var opts = {
  body: new RedbrickService.CheckAdminPasswordRequest(), // {CheckAdminPasswordRequest}
};
var callback = function (error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log("API called successfully. Returned data: " + data);
  }
};
api.checkAdminPassword(opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8081/{version}

Class	Method	HTTP request
RedbrickService.AdminApi	checkAdminPassword	POST /admin/password
RedbrickService.AdminApi	getAdmin	GET /admin/{id}
RedbrickService.AdminApi	getRole	GET /admin/role/{id}
RedbrickService.AdminApi	listAdmin	GET /admin/list
RedbrickService.AdminApi	listRole	GET /admin/role/list
RedbrickService.AdminApi	listUser	GET /admin/user/list
RedbrickService.AdminApi	registerAdmin	POST /admin
RedbrickService.AdminApi	registerRole	POST /admin/role
RedbrickService.AdminApi	unregisterAdmin	DELETE /admin/{id}
RedbrickService.AdminApi	unregisterRole	DELETE /admin/role/{id}
RedbrickService.AdminApi	updateAdmin	PATCH /admin/{id}
RedbrickService.AdminApi	updateRole	PATCH /admin/role/{id}
RedbrickService.AssetApi	assetSearch	GET /asset/search
RedbrickService.AssetApi	createAssetLike	POST /assst/like
RedbrickService.AssetApi	createUserAsset	POST /asset
RedbrickService.AssetApi	deleteAssetLike	DELETE /assst/like
RedbrickService.AssetApi	destroyAsset	DELETE /asset/{id}
RedbrickService.AssetApi	getAssetCount	GET /asset/count
RedbrickService.AssetApi	getAssetLike	GET /assst/like
RedbrickService.AssetApi	getAssetRecommend	GET /asset/recommend
RedbrickService.AssetApi	getAssetSuggestionKeywordList	GET /asset/suggestion/keyword
RedbrickService.AssetApi	getUserAsset	GET /asset/{id}
RedbrickService.AssetApi	listUserAsset	GET /asset/list
RedbrickService.AssetApi	listUserAssetAdmin	GET /asset/list/admin
RedbrickService.AssetApi	updateAssetSuggestionKeyword	PUT /asset/suggestion/keyword
RedbrickService.AssetApi	updateUserAsset	PATCH /asset/{id}
RedbrickService.AvatarApi	createAvatar	POST /avatar
RedbrickService.AvatarApi	createAvatarPart	POST /avatar/part
RedbrickService.AvatarApi	createAvatarPreset	POST /avatar/preset
RedbrickService.AvatarApi	createAvatarTexture	POST /avatar/texture
RedbrickService.AvatarApi	destroyAvatar	DELETE /avatar/{id}
RedbrickService.AvatarApi	destroyAvatarPart	DELETE /avatar/part/{id}
RedbrickService.AvatarApi	destroyAvatarPreset	DELETE /avatar/preset/{id}
RedbrickService.AvatarApi	destroyAvatarTexture	DELETE /avatar/texture/{id}
RedbrickService.AvatarApi	getAvatar	GET /avatar/{id}
RedbrickService.AvatarApi	getAvatarPart	GET /avatar/part/{id}
RedbrickService.AvatarApi	getAvatarPreset	GET /avatar/preset/{id}
RedbrickService.AvatarApi	getAvatarTexture	GET /avatar/texture/{id}
RedbrickService.AvatarApi	listAvatar	GET /avatar/list
RedbrickService.AvatarApi	listAvatarPart	GET /avatar/part/list
RedbrickService.AvatarApi	listAvatarPreset	GET /avatar/preset/list
RedbrickService.AvatarApi	listAvatarTexture	GET /avatar/texture/list
RedbrickService.AvatarApi	updateAvatar	PATCH /avatar/{id}
RedbrickService.AvatarApi	updateAvatarPart	PATCH /avatar/part/{id}
RedbrickService.AvatarApi	updateAvatarPreset	PATCH /avatar/preset/{id}
RedbrickService.AvatarApi	updateAvatarTexture	PATCH /avatar/texture/{id}
RedbrickService.ClientApi	getClient	GET /client/{id}
RedbrickService.ClientApi	listClient	GET /client/list
RedbrickService.ClientApi	registerClient	POST /client
RedbrickService.ClientApi	unregisterClient	DELETE /client/{id}
RedbrickService.ClientApi	updateClient	PATCH /client/{id}
RedbrickService.EducationApi	getEducationWorldList	GET /education/world/list
RedbrickService.EventApi	deleteEventKbGameUser	DELETE /event/kb/game/user/{ci}
RedbrickService.EventApi	getEventGstarChallengeWorld	GET /event/gstar/challenge/world/{id}
RedbrickService.EventApi	getEventKbCouponCount	GET /event/kb/coupon/count
RedbrickService.EventApi	getEventKbCouponNew	GET /event/kb/coupon/new
RedbrickService.EventApi	getEventKbGameUser	GET /event/kb/game/user/{ci}
RedbrickService.EventApi	getEventKbGameUserRank	GET /event/kb/game/user/rank/{ci}
RedbrickService.EventApi	issueEventKbCoupon	POST /event/kb/coupon/issue
RedbrickService.EventApi	listEventGstarChallengeWorld	GET /event/gstar/challenge/world/list
RedbrickService.EventApi	listEventKbCoupon	GET /event/kb/coupon/list
RedbrickService.EventApi	listEventKbGameUser	GET /event/kb/game/user/list
RedbrickService.EventApi	updateEventGstarChallengeWorld	PATCH /event/gstar/challenge/world/{id}
RedbrickService.EventApi	updateEventKbGameUser	POST /event/kb/game/user
RedbrickService.IpxApi	getIpxUser	GET /ipx/user
RedbrickService.IpxApi	getIpxWorldUserRank	POST /ipx/world/user/rank
RedbrickService.IpxApi	listIpxWorld	GET /ipx/world
RedbrickService.IpxApi	listIpxWorldHistory	POST /ipx/world/history/list
RedbrickService.IpxApi	updateIpxUser	PATCH /ipx/user
RedbrickService.IpxApi	upsertIpxWorldHistory	POST /ipx/world/history
RedbrickService.MonitoringApi	createWorldMonitoring	POST /world/monitoring
RedbrickService.ProjectApi	countProject	GET /project/count
RedbrickService.ProjectApi	createProject	POST /project
RedbrickService.ProjectApi	destroyProject	DELETE /project/{id}
RedbrickService.ProjectApi	getProject	GET /project/{id}
RedbrickService.ProjectApi	getProjectTemplate	GET /project/template/{id}
RedbrickService.ProjectApi	getUploadProjectUrl	POST /project/thumbnail/upload/url
RedbrickService.ProjectApi	getUploadProjectUrl_0	POST /project/upload/url
RedbrickService.ProjectApi	listProject	GET /project/list
RedbrickService.ProjectApi	listProjectTemplate	GET /project/template/list
RedbrickService.ProjectApi	updateProject	PATCH /project/{id}
RedbrickService.ProjectApi	updateProjectTemplate	PUT /project/template/{id}
RedbrickService.SecretApi	createSecret	POST /secret/{id}
RedbrickService.SecretApi	destroySecret	DELETE /secret/{id}
RedbrickService.SecretApi	getSecret	GET /secret/{id}
RedbrickService.SecretApi	updateSecret	PATCH /secret/{id}
RedbrickService.ServiceApi	liveness	GET /liveness
RedbrickService.ServiceApi	ready	GET /ready
RedbrickService.SnsApi	connectSocialAccount	POST /sns/connect
RedbrickService.SnsApi	deleteUserSocialAccount	DELETE /sns
RedbrickService.SnsApi	getUserSocialAccountList	GET /sns/list
RedbrickService.SnsApi	loginSocialAccount	POST /sns/login
RedbrickService.SnsApi	registerSocialAccount	POST /sns/register
RedbrickService.SocialApi	createSocialArticle	POST /social/article
RedbrickService.SocialApi	createSocialArticleComment	POST /social/article/comment
RedbrickService.SocialApi	createSocialArticleReComment	POST /social/article/comment/re
RedbrickService.SocialApi	deleteSocialArticle	DELETE /social/article/{id}
RedbrickService.SocialApi	deleteSocialArticleComment	DELETE /social/article/comment/{id}
RedbrickService.SocialApi	deleteSocialArticleReComment	DELETE /social/article/comment/re/{id}
RedbrickService.SocialApi	getSocialArticle	GET /social/article/{id}
RedbrickService.SocialApi	getSocialArticleComment	GET /social/article/comment/{id}
RedbrickService.SocialApi	getSocialArticleReComment	GET /social/article/comment/re/{id}
RedbrickService.SocialApi	listSocialArticle	GET /social/article/list
RedbrickService.SocialApi	listSocialArticleComment	GET /social/article/comment/list
RedbrickService.SocialApi	listSocialArticleReComment	GET /social/article/comment/re/list
RedbrickService.SocialApi	updateSocialArticle	PATCH /social/article/{id}
RedbrickService.SocialApi	updateSocialArticleComment	PATCH /social/article/comment/{id}
RedbrickService.SocialApi	updateSocialArticleReComment	PATCH /social/article/comment/re/{id}
RedbrickService.SsafyApi	listSsafyWorld	GET /ssafy/world/list
RedbrickService.StorageApi	createStorageWorld	POST /storage/world
RedbrickService.StorageApi	deleteStorageWorld	DELETE /storage/world/{id}
RedbrickService.StorageApi	getStorageWorld	GET /storage/world/{id}
RedbrickService.StorageApi	listStorageWorld	GET /storage/world/list
RedbrickService.StorageApi	updateStorageWorld	PATCH /storage/world/{id}
RedbrickService.UserApi	countUser	GET /user/count
RedbrickService.UserApi	createUserBlock	POST /user/block
RedbrickService.UserApi	createUserLike	POST /user/like
RedbrickService.UserApi	deleteUserBlock	DELETE /user/block
RedbrickService.UserApi	deleteUserLike	DELETE /user/like
RedbrickService.UserApi	findUser	POST /user/find
RedbrickService.UserApi	getUploadUserIconUrl	POST /user/icon/upload/url
RedbrickService.UserApi	getUser	GET /user/{ci}
RedbrickService.UserApi	listUser	GET /user/list
RedbrickService.UserApi	registerUser	POST /user
RedbrickService.UserApi	unregisterUser	DELETE /user/{ci}
RedbrickService.UserApi	updateUser	PATCH /user/{ci}
RedbrickService.UserAvatarApi	createUserAvatar	POST /user/avatar
RedbrickService.UserAvatarApi	destroyUserAvatar	DELETE /user/avatar/{id}
RedbrickService.UserAvatarApi	getUserAvatar	GET /user/avatar/{id}
RedbrickService.UserAvatarApi	listUserAvatar	GET /user/avatar/list
RedbrickService.UserAvatarApi	updateUserAvatar	PATCH /user/avatar/{id}
RedbrickService.VarApi	getVar	GET /var
RedbrickService.VarApi	setVar	PATCH /var
RedbrickService.VerifyApi	verifyExistence	GET /verify/existence
RedbrickService.VerifyApi	verifyUser	POST /verify/user
RedbrickService.VerifyApi	verifyUserCode	POST /verify/user/code
RedbrickService.WalletApi	unlinkWallet	DELETE /wallet/unlink
RedbrickService.WorldApi	countWorld	GET /world/count
RedbrickService.WorldApi	createWorld	POST /world
RedbrickService.WorldApi	createWorldComment	POST /world/comment
RedbrickService.WorldApi	createWorldLike	POST /world/like
RedbrickService.WorldApi	createWorldReComment	POST /world/comment/re
RedbrickService.WorldApi	deleteWorldComment	DELETE /world/comment/{id}
RedbrickService.WorldApi	deleteWorldLike	DELETE /world/like
RedbrickService.WorldApi	deleteWorldReComment	DELETE /world/comment/re/{id}
RedbrickService.WorldApi	destroyWorld	DELETE /world/{id}
RedbrickService.WorldApi	getUploadWorldUrl	POST /world/thumbnail/upload/url
RedbrickService.WorldApi	getUploadWorldUrl_0	POST /world/upload/url
RedbrickService.WorldApi	getWorld	GET /world/{id}
RedbrickService.WorldApi	getWorldComment	GET /world/comment/{id}
RedbrickService.WorldApi	getWorldReComment	GET /world/comment/re/{id}
RedbrickService.WorldApi	listWorld	GET /world/list
RedbrickService.WorldApi	listWorldComment	GET /world/comment/list
RedbrickService.WorldApi	listWorldReComment	GET /world/comment/re/list
RedbrickService.WorldApi	updateWorld	PATCH /world/{id}
RedbrickService.WorldApi	updateWorldComment	PATCH /world/comment/{id}
RedbrickService.WorldApi	updateWorldReComment	PATCH /world/comment/re/{id}
RedbrickService.WorldApi	viewWorld	GET /world/view/{id}