clone_cord_api v1.0.8
clone_cord_api
CloneCordApi - JavaScript client for clone_cord_api REST API to use CloneCord This SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.0.1
- Package version: 1.0.8
- Build package: org.openapitools.codegen.languages.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 clone_cord_api --save
Finally, you need to build the module:
npm run build
Local development
To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json
(and this README). Let's call this JAVASCRIPT_CLIENT_DIR
. Then run:
npm install
Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR
:
npm link
To use the link you just defined in your project, switch to the directory you want to use your clone_cord_api from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
Finally, you need to build the module:
npm run build
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 CloneCordApi = require('clone_cord_api');
var api = new CloneCordApi.AuthenticationApi()
var formLogin = new CloneCordApi.FormLogin(); // {FormLogin}
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.login(formLogin, callback);
Documentation for API Endpoints
All URIs are relative to http://localhost:8080
Class | Method | HTTP request | Description |
---|---|---|---|
CloneCordApi.AuthenticationApi | login | POST /auth/login | Log in |
CloneCordApi.AuthenticationApi | signUp | POST /auth/register | Create an account |
CloneCordApi.ChannelsApi | createChannel | POST /guilds/{guildId} | |
CloneCordApi.ChannelsApi | deleteChannel | DELETE /guilds/{guildId}/{channelId} | |
CloneCordApi.ChannelsApi | updateChannel | PUT /guilds/{guildId}/{channelId} | |
CloneCordApi.GuildsApi | createGuild | POST /guilds | |
CloneCordApi.GuildsApi | deleteGuild | DELETE /guilds/{guildId} | |
CloneCordApi.GuildsApi | getGuildInfo | GET /guilds/{guildId} | |
CloneCordApi.GuildsApi | kickMember | DELETE /guilds/{memberId} | |
CloneCordApi.GuildsApi | updateGuild | PUT /guilds/{guildId} | |
CloneCordApi.MemberRolesApi | addRole | PATCH /guilds/{guildId}/members/{memberId}/roles | |
CloneCordApi.MemberRolesApi | removeRole | DELETE /guilds/{guildId}/members/{memberId}/roles | |
CloneCordApi.MessagesApi | deleteMessage | DELETE /guilds/{guildId}/{channelId}/messages/{messageId} | |
CloneCordApi.MessagesApi | getMessages | GET /guilds/{guildId}/{channelId}/messages | |
CloneCordApi.MessagesApi | sendMessage | POST /guilds/{guildId}/{channelId}/messages | |
CloneCordApi.RolesApi | createRole | POST /guilds/{guildId}/roles | |
CloneCordApi.RolesApi | deleteRole | DELETE /guilds/{guildId}/roles/{roleId} | |
CloneCordApi.RolesApi | updateRole | PUT /guilds/{guildId}/roles/{roleId} | |
CloneCordApi.UsersApi | getSelf | GET /users/@self | |
CloneCordApi.UsersApi | getSelfGuilds | GET /users/@self/guilds | |
CloneCordApi.UsersApi | getUser | GET /users/{userId} | |
CloneCordApi.UsersApi | putSelf | PUT /users/@self |
Documentation for Models
- CloneCordApi.Channel
- CloneCordApi.FormChannel
- CloneCordApi.FormGuild
- CloneCordApi.FormLogin
- CloneCordApi.FormMessage
- CloneCordApi.FormRole
- CloneCordApi.FormUser
- CloneCordApi.Guild
- CloneCordApi.Member
- CloneCordApi.Message
- CloneCordApi.Reaction
- CloneCordApi.RegistrationUser
- CloneCordApi.Role
- CloneCordApi.User
Documentation for Authorization
user-auth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header