maximum_profile v1.0.4
profile
Profile - JavaScript client for profile Profile Api This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0
- Package version: 1.0
- Build package: io.swagger.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 profile --save
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
Finally, switch to the directory you want to use your profile from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('profile')
in javascript files from the directory you ran the last
command above from.
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, that's to say your javascript file where you actually
use this library):
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 Profile = require('profile');
var defaultClient = Profile.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 Profile.ProfileApi()
var addRemindRequest = new Profile.AddRemindRequest(); // {AddRemindRequest}
api.addRemind(addRemindRequest).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Documentation for API Endpoints
All URIs are relative to http://localhost:8802
Class | Method | HTTP request | Description |
---|---|---|---|
Profile.ProfileApi | addRemind | POST /api/v1/remind | Add remind token |
Profile.ProfileApi | addUser | POST /api/v1/user | Add user |
Profile.ProfileApi | deleteRemind | DELETE /api/v1/remind/{id} | Delete remind |
Profile.ProfileApi | deleteUser | DELETE /api/v1/user/{id} | Delete user |
Profile.ProfileApi | externalLogin | POST /api/v1/auth/login/external/{service} | Login with external service |
Profile.ProfileApi | externalUrl | GET /api/v1/auth/login/external/{service} | Login with external service |
Profile.ProfileApi | getAllreminds | GET /api/v1/remind | Get all remind tokens |
Profile.ProfileApi | getRemind | GET /api/v1/remind/{id} | Get one remind token |
Profile.ProfileApi | login | POST /api/v1/auth/login | Login with email and password |
Profile.ProfileApi | logout | GET /api/v1/auth/logout | Logout with mark token as blacklisted |
Profile.ProfileApi | privilegeCheckAccess | GET /api/v1/privilege/checkAccess/{privilege} | Get one or all remind tokens |
Profile.ProfileApi | refresh | GET /api/v1/auth/refresh | Get new token, blacklist old one. Like execute logout and login in one operation. |
Profile.ProfileApi | register | POST /api/v1/auth/register | Add user |
Profile.ProfileApi | remindPassword | GET /api/v1/auth/remindPassword | Remind password for user |
Profile.ProfileApi | updateRemind | PATCH /api/v1/remind/{id} | Update remind's fields |
Profile.ProfileApi | updateUser | PATCH /api/v1/user/{id} | Update user's fields |
Profile.ProfileApi | user | GET /api/v1/user/{id} | Get one user |
Profile.ProfileApi | users | GET /api/v1/user | Get one or all users |
Documentation for Models
- Profile.AddRemindRequest
- Profile.AddUserRequest
- Profile.CheckPrivilegeModel
- Profile.ErrorResponse
- Profile.ErrorWithMessageResponse
- Profile.ExternalLoginCode
- Profile.LoginRequest
- Profile.RemindModel
- Profile.Reminds
- Profile.SuccessWithMessageResponse
- Profile.TokenResponse
- Profile.UrlResponse
- Profile.UserModel
- Profile.Users
Documentation for Authorization
Bearer
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header