vmoso-user-api

VmosoUserApi - JavaScript client for vmoso-user-api Description about User API This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2016-06-22T11:43:55.693Z
• Build package: class 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 vmoso-user-api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/vmoso-user-api then install it via:

    npm install YOUR_USERNAME/vmoso-user-api --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.

Getting Started

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

var VmosoUserApi = require('vmoso-user-api');

var defaultClient = VmosoUserApi.ApiClient.default;

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

var api = new VmosoUserApi.UserApi()

var index = "index_example"; // {String} From {@link SessionInfoRecord::$index}.


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

Documentation for API Endpoints

All URIs are relative to https://www.vmoso.com/svc

Class	Method	HTTP request	Description
VmosoUserApi.UserApi	deleteSession	DELETE /sessions/{index}
VmosoUserApi.UserApi	getFollowCounts	GET /followingAndFollowedUsers/counts
VmosoUserApi.UserApi	getInvitations	GET /invitations
VmosoUserApi.UserApi	getLandingPage	GET /landingPage
VmosoUserApi.UserApi	getMe	GET /users/me
VmosoUserApi.UserApi	getMeMwa	GET /users/me/mwa
VmosoUserApi.UserApi	getRequestAndPendingUsersCounts	GET /requestandpendingusers/counts
VmosoUserApi.UserApi	getSessions	GET /sessions
VmosoUserApi.UserApi	getSuggestFollowersCounts	GET /suggestfollowers/counts
VmosoUserApi.UserApi	getSuggestedUsersCounts	GET /suggestusers/counts
VmosoUserApi.UserApi	getUser	GET /users/{userKey}
VmosoUserApi.UserApi	getUserByEmail	GET /users/lookupByEmail/{userName}
VmosoUserApi.UserApi	getUserStatus	POST /users/status
VmosoUserApi.UserApi	getUsers	GET /users/lookup
VmosoUserApi.UserApi	getUsersByEmail	POST /users/lookupByEmails
VmosoUserApi.UserApi	login	POST /login
VmosoUserApi.UserApi	logout	POST /logout
VmosoUserApi.UserApi	requestPassword	POST /requestpassword
VmosoUserApi.UserApi	resetExpiredPassword	POST /resetExpiredPassword
VmosoUserApi.UserApi	resetPasswordaction	POST /resetpasswordaction
VmosoUserApi.UserApi	resetPasswordactionPhone	POST /resetpasswordaction/phone
VmosoUserApi.UserApi	sendSmsCode	POST /smscode/send
VmosoUserApi.UserApi	setPublic	POST /user/public/set
VmosoUserApi.UserApi	signup	POST /signUpAction
VmosoUserApi.UserApi	updatePassword	POST /settings/editUserPassWord
VmosoUserApi.UserApi	vmcRequestPassword	POST /vmc/requestpassword

Documentation for Models

• VmosoUserApi.AuthnInfoRecord
• VmosoUserApi.CsiTokenRecord
• VmosoUserApi.DeleteSessionResult
• VmosoUserApi.DisplayRecord
• VmosoUserApi.ErrorDetailRecord
• VmosoUserApi.GetFollowCountsResult
• VmosoUserApi.GetInvitationsResult
• VmosoUserApi.GetLandingPageResult
• VmosoUserApi.GetMeMwaResult
• VmosoUserApi.GetMeResult
• VmosoUserApi.GetRequestAndPendingUsersCountsResult
• VmosoUserApi.GetSessionsResult
• VmosoUserApi.GetSuggestFollowersCountsResult
• VmosoUserApi.GetSuggestedUsersCountsResult
• VmosoUserApi.GetUserByEmailResult
• VmosoUserApi.GetUserResult
• VmosoUserApi.GetUserStatusInput
• VmosoUserApi.GetUserStatusResult
• VmosoUserApi.GetUsersByEmailInput
• VmosoUserApi.GetUsersByEmailResult
• VmosoUserApi.GetUsersResult
• VmosoUserApi.InvitationRecordV2
• VmosoUserApi.ListPageRecord
• VmosoUserApi.LoginInput
• VmosoUserApi.LoginResult
• VmosoUserApi.LogoutResult
• VmosoUserApi.PageJumpRecord
• VmosoUserApi.PaginationRecord
• VmosoUserApi.RecordBase
• VmosoUserApi.RequestPasswordInput
• VmosoUserApi.RequestPasswordResult
• VmosoUserApi.ResetExpiredPasswordInput
• VmosoUserApi.ResetExpiredPasswordResult
• VmosoUserApi.ResetPasswordactionInput
• VmosoUserApi.ResetPasswordactionPhoneInput
• VmosoUserApi.ResetPasswordactionPhoneResult
• VmosoUserApi.ResetPasswordactionResult
• VmosoUserApi.ResponseHeaderRecord
• VmosoUserApi.SendSmsCodeInput
• VmosoUserApi.SendSmsCodeResult
• VmosoUserApi.SessionClientInfoRecord
• VmosoUserApi.SessionCredentialRecord
• VmosoUserApi.SessionInfoRecord
• VmosoUserApi.SetPublicInput
• VmosoUserApi.SetPublicResult
• VmosoUserApi.SignUpRecord
• VmosoUserApi.SignupInput
• VmosoUserApi.SignupResult
• VmosoUserApi.UpdatePasswordInput
• VmosoUserApi.UpdatePasswordResult
• VmosoUserApi.UserDisplayRecord
• VmosoUserApi.UserObjectRecord
• VmosoUserApi.UserStatusRecord
• VmosoUserApi.VmcRequestPasswordInput
• VmosoUserApi.VmcRequestPasswordResult

Documentation for Authorization

vmoso_auth

• Type: API key
• API key parameter name: X-CV-Authorization
• Location: HTTP header