Vmoso-api NPM | npm.io

vmoso-api

VmosoApi - JavaScript client for vmoso-api Vmoso API description This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build date: 2016-04-11T15:09:08.282Z
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-api --save

git

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

npm install YOUR_USERNAME/vmoso-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 VmosoApi = require('vmoso-api');

var defaultClient = VmosoApi.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 VmosoApi.AlienApi()

var input = new VmosoApi.AlienLoginInput(); // {AlienLoginInput} 


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

Documentation for API Endpoints

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

Class	Method	HTTP request
VmosoApi.AlienApi	alienLogin	POST /alienLogin
VmosoApi.AnalyticsApi	getActivity	GET /analytics/activity
VmosoApi.AnalyticsApi	getConnectivity	GET /analytics/connectivity
VmosoApi.AttachmentApi	getAttachments	GET /attachmentsV2/{objectID}
VmosoApi.AttachmentApi	getAttachmentsByName	GET /attachmentsV2/getByName
VmosoApi.AttachmentApi	getDuplicates	POST /attachmentsV2/duplicate
VmosoApi.CommentApi	commentRecordAction	POST /commenting/action
VmosoApi.CommentApi	createComment	POST /comments/create
VmosoApi.CommentApi	createCommentFromDraft	POST /comments/draftTOComment
VmosoApi.CommentApi	deleteComment	DELETE /comments/delete
VmosoApi.CommentApi	deleteDraft	DELETE /comments/deleteDraft
VmosoApi.CommentApi	getComment	GET /comments/view
VmosoApi.CommentApi	getCommentCounts	GET /comment/counts
VmosoApi.CommentApi	getCommentReaders	GET /comment/readerList
VmosoApi.CommentApi	getComments	GET /comments
VmosoApi.CommentApi	getCount	GET /comment/count
VmosoApi.CommentApi	getDrafts	GET /comments/drafts
VmosoApi.CommentApi	markAllRead	POST /comment/markAllRead
VmosoApi.CommentApi	markRead	POST /comment/markRead
VmosoApi.CommentApi	markReadByEmail	GET /comment/markReadByEmail
VmosoApi.CommentApi	markUnread	POST /comment/markUnRead
VmosoApi.CommentApi	undeleteComment	POST /comments/undelete
VmosoApi.CommentApi	updateComment	PUT /comments/update
VmosoApi.ContactApi	acceptNewUserInvitation	POST /contacts/newUserAcceptInvitation
VmosoApi.ContactApi	acceptRegisteredUserInvitation	POST /contacts/registeredUserAcceptInvitation
VmosoApi.ContactApi	confirmRegistrationEmail	POST /contacts/registrationEmailConfirmation
VmosoApi.ContactApi	deleteContacts	POST /contacts/delete
VmosoApi.ContactApi	deleteRequest	POST /contacts/cancelRequest
VmosoApi.ContactApi	downgradeContacts	POST /contacts/downgrade
VmosoApi.ContactApi	getExistingTasks	POST /contacts/checkExistingChats
VmosoApi.ContactApi	getGoogleConnectionData	GET /contacts/getGoogleConnectionData
VmosoApi.ContactApi	getMutualTypes	GET /contacts/mutual/types
VmosoApi.ContactApi	getProfile	GET /contacts/{key}
VmosoApi.ContactApi	importAcquaintances	POST /contacts/importAsAcquaintance
VmosoApi.ContactApi	importContacts	GET /contacts/importContacts
VmosoApi.ContactApi	inviteEmailAddress	POST /contacts/inviteByEmailAddress
VmosoApi.ContactApi	inviteUsers	POST /contacts/inviteByKeys
VmosoApi.ContactApi	processAction	POST /contacts/processRequestAction
VmosoApi.ContactcardApi	createContactCard	POST /contactCards
VmosoApi.ContactcardApi	deleteContactCard	POST /contactCards/delete
VmosoApi.ContactcardApi	getContactCard	GET /contactCards/{key}
VmosoApi.ContentApi	getLocalList	GET /content/locallist
VmosoApi.ContentApi	setSyncToLocal	POST /content/markSyncToLocal
VmosoApi.ContentApi	unsetSyncToLocal	POST /content/unmarkSyncToLocal
VmosoApi.DeviceApi	checkUrl	GET /device/checkUrl
VmosoApi.DeviceApi	registerCVDevice	POST /cv/device/set
VmosoApi.DeviceApi	registerDevice	POST /device/set
VmosoApi.DeviceApi	unregisterCVDevice	POST /cv/device/unset
VmosoApi.DeviceApi	unregisterDevice	POST /device/unset
VmosoApi.DocumentApi	createDocument	POST /documentsV2
VmosoApi.DocumentApi	deleteDocuments	PUT /documentsV2/multipleDelete
VmosoApi.DocumentApi	getDocument	GET /documentsV2/{key}
VmosoApi.FavoriteApi	markFavorites	POST /favorites
VmosoApi.FeatureApi	getFeatures	GET /feature/{key}
VmosoApi.FileApi	addAttachment	PUT /files/{objectKey}/addFileAsAttachment
VmosoApi.FileApi	createFile	POST /files
VmosoApi.FileApi	deleteFiles	POST /files/delete
VmosoApi.FileApi	fileRecordAction	POST /files/{key}/stream
VmosoApi.FileApi	getCloudConnectionData	GET /files/getCloudConnectionData
VmosoApi.FileApi	getContainerHistory	GET /files/{key}/history
VmosoApi.FileApi	getContainerPermissions	GET /files/{key}/getpermissions/{containerKey}
VmosoApi.FileApi	getDownloadToken	POST /files/token
VmosoApi.FileApi	getFiles	GET /files/lookup
VmosoApi.FileApi	getPreviewInfo	GET /files/{key}/pre
VmosoApi.FileApi	getPreviewStatus	GET /files/{key}/pre/status
VmosoApi.FileApi	getThumbnailInfo	GET /files/{key}/thumbnails
VmosoApi.FileApi	removeAttachments	POST /files/{objectKey}/removeFileAsAttachment
VmosoApi.FileApi	removeCSIPermissions	POST /files/csiRemovePermissions
VmosoApi.FileApi	setCSIAccess	GET /files/{key}/csi/setAccess
VmosoApi.FileApi	setCSIToken	POST /files/csiSetUserToken
VmosoApi.FileApi	setContainerPermissions	PUT /files/{key}/setpermissions/{containerKey}
VmosoApi.FileApi	setFavorite	POST /files/favorite
VmosoApi.FileApi	setImportant	POST /files/important
VmosoApi.FileApi	viewFile	GET /files/{key}
VmosoApi.FollowApi	setFollows	PUT /follows
VmosoApi.HelpTipsApi	getTipsStatus	GET /helpTips
VmosoApi.HistoryApi	pinHistoryEntry	POST /history/pin
VmosoApi.HistoryApi	recordHistoryEntry	POST /history
VmosoApi.HistoryApi	unpinHistoryEntry	POST /history/unpin
VmosoApi.InstallationApi	getInstallationDetails	GET /installationinfo
VmosoApi.InstallationApi	getLastUpdate	GET /resources/lastUpdate/info
VmosoApi.LandingApi	page	GET /landingPage
VmosoApi.LinkApi	createLink	POST /links
VmosoApi.LinkApi	deleteLink	DELETE /links/{key}
VmosoApi.NewApi	setnewforchatlist	POST /new/setNewTimeForList/chat
VmosoApi.ObjectApi	changeOwner	PUT /changeOwner/{objectKey}/{userKey}
VmosoApi.ObjectApi	changeOwnerObsolete	PUT /changeOnwer/{objectKey}/{userKey}
VmosoApi.ObjectApi	clearAllForList	POST /objects/read/clearAll
VmosoApi.ObjectApi	getAssignmentReadState	GET /assignment/readState
VmosoApi.ObjectApi	getFollowers	GET /{objectKey}/followers
VmosoApi.ObjectApi	getObjectReaders	GET /objects/read/getReaderList
VmosoApi.ObjectApi	markAllTilesRead	POST /objects/read/{key}/markAllTilesRead
VmosoApi.ObjectApi	markTilesRead	POST /objects/read/markTilesRead
VmosoApi.ObjectApi	searchAutocomplete	GET /search/autocomplete
VmosoApi.ObjectApi	searchObjects	GET /search/objectpicker
VmosoApi.ObjectApi	setActionNewTime	POST /new/setActionNewTime
VmosoApi.ObjectApi	setActionNewTimeForList	POST /new/setActionNewTimeForList
VmosoApi.ObjectApi	updateReadInfo	POST /objects/read/updateReadInfo
VmosoApi.ObjectApi	updateReadInfoByEmail	GET /objects/read/updateReadInfoByEmail
VmosoApi.OnBoardingApi	getOnBoardingInfo	GET /onboarding
VmosoApi.PingApi	performAction	POST /ping
VmosoApi.PostApi	createPost	POST /postsV2
VmosoApi.PostApi	deletePost	DELETE /postsV2/{key}
VmosoApi.PostApi	getPost	GET /postsV2/{key}
VmosoApi.PostApi	getUsers	GET /postsV2/{postKey}/{segment}
VmosoApi.PostApi	updatePost	PUT /postsV2/{key}
VmosoApi.PushApi	getLegacyConfig	GET /resources/push/config
VmosoApi.PushApi	getPushConfig	GET /push/getconfig
VmosoApi.PushApi	getToken	GET /push/token
VmosoApi.PushApi	getTokens	GET /push/tokens
VmosoApi.RatingsApi	getRatings	GET /ratings/lookup
VmosoApi.RatingsApi	rateDown	POST /ratings/ratedown
VmosoApi.RatingsApi	rateUp	POST /ratings/rateup
VmosoApi.RecorderApi	getConfig	GET /resources/recorder/config
VmosoApi.ReferenceApi	getObjectReferences	GET /reference/{key}
VmosoApi.ReferenceApi	getReferences	GET /reference/list
VmosoApi.ReferenceApi	updateReferences	PUT /references/{parentKey}/update
VmosoApi.ResourceApi	getCountries	GET /resources/countries
VmosoApi.ResourceApi	getDateFormats	GET /resources/dateformats
VmosoApi.ResourceApi	getDepartments	GET /resources/departments
VmosoApi.ResourceApi	getLanguages	GET /resources/languages
VmosoApi.ResourceApi	getTimezones	GET /resources/timezones
VmosoApi.ResourceApi	getTranslations	GET /resources/messages/{key}
VmosoApi.RuleApi	deleteRule	DELETE /rules/{key}
VmosoApi.RuleApi	getAttributes	GET /rulesv2/metadata/get
VmosoApi.RuleApi	getByName	GET /rules/name
VmosoApi.RuleApi	getDefaultPresetRules	GET /rules/defaultpreset
VmosoApi.RuleApi	getFilters	GET /rulesv2/filters/get
VmosoApi.RuleApi	getLocationsDefaultRules	GET /rules/locations/default/get
VmosoApi.RuleApi	getMetaData	GET /rules/metadata/get
VmosoApi.RuleApi	getPresetRules	GET /rules/preset
VmosoApi.RuleApi	getPushMetaData	GET /rules/pushmetadata/get
VmosoApi.RuleApi	getRedNutDefaultRules	GET /rules/rednut/default/get
VmosoApi.RuleApi	getRuleMetaData	GET /rules/rulemetadata/get
VmosoApi.RuleApi	getRules	GET /rules
VmosoApi.RuleApi	getTypesMetaData	GET /rules/typesmetadata/get
VmosoApi.SettingsApi	bindloignids	POST /settings/bindLoginIDs
VmosoApi.SettingsApi	checkSecondaryEmail	GET /settings/checkSecondaryEmail
VmosoApi.SettingsApi	confirmBindEmailID	POST /settings/confirmBindEmailID
VmosoApi.SettingsApi	confirmSecondaryEmail	POST /settings/confirmSecondaryEmail
VmosoApi.SettingsApi	loignids	POST /settings/loginIDs
VmosoApi.SettingsApi	registerAPPInfo	POST /settings/app/register
VmosoApi.SettingsApi	saveSettings	POST /setting
VmosoApi.SettingsApi	unbindloignids	POST /settings/unbindLoginIDs
VmosoApi.SmscodeApi	send	POST /smscode/send
VmosoApi.SpaceApi	addContacts	POST /folders/contacts/{contactType}/add
VmosoApi.SpaceApi	addItems	POST /folders/{folderKey}/contents
VmosoApi.SpaceApi	addParticipants	PUT /folders/{key}/participants/add
VmosoApi.SpaceApi	categorizeObjects	POST /folders/{key}/categorize
VmosoApi.SpaceApi	checkUserEmails	GET /folders/hotspots/participants/checkEmails
VmosoApi.SpaceApi	createSpace	POST /folders
VmosoApi.SpaceApi	deleteSpace	DELETE /folders/{folderKey}
VmosoApi.SpaceApi	deleteSpaces	POST /folders/delete
VmosoApi.SpaceApi	getContentsRef	GET /folders/contents/ref
VmosoApi.SpaceApi	getCorporateSpaces	GET /folders/corporate
VmosoApi.SpaceApi	getFullPath	GET /folders/{key}/getpath
VmosoApi.SpaceApi	getItems	GET /folders/{folderKey}/contents/{contentType}
VmosoApi.SpaceApi	getMarks	GET /folders/type/{itemKey}
VmosoApi.SpaceApi	getParents	GET /folders/{folderKey}/parents
VmosoApi.SpaceApi	getPublicSpace	GET /folders/{folderKey}/public
VmosoApi.SpaceApi	getSharedSpaces	GET /space/{key}/sharedspaces
VmosoApi.SpaceApi	getSpaces	GET /folders/{tag}/spaces
VmosoApi.SpaceApi	getSubspaces	GET /folders/{key}/folders
VmosoApi.SpaceApi	getUserRolesInSpace	GET /folders/{key}/checkUserKeys
VmosoApi.SpaceApi	leaveSpace	PUT /folders/{key}/leave
VmosoApi.SpaceApi	listAssociationItem	GET /association/{key}/{association}
VmosoApi.SpaceApi	markItems	POST /folders/mark/{markType}
VmosoApi.SpaceApi	moveItems	POST /folders/{fromFolderKey}/contents/move
VmosoApi.SpaceApi	multishare	POST /folders/multishare
VmosoApi.SpaceApi	removeItems	POST /folders/{folderKey}/contents/remove
VmosoApi.SpaceApi	removeParticipants	PUT /folders/{key}/participants/remove
VmosoApi.SpaceApi	share	POST /space/share
VmosoApi.SpaceApi	shareObject	POST /folders/{key}/sharetouserspace
VmosoApi.SpaceApi	unmarkAllItems	POST /folders/removeAll/{markType}
VmosoApi.SpaceApi	unmarkItems	POST /folders/unmark/{markType}
VmosoApi.SpaceApi	unshare	POST /space/unshare
VmosoApi.SpaceApi	unshareObject	POST /folders/{key}/unshareitem
VmosoApi.SparcApi	getASCCounts	GET /sparc/ASC/counts
VmosoApi.SparcApi	getASCUnreadCounts	GET /sparc/ASC/unread/count
VmosoApi.SparcApi	getAttachmentUnreadCounts	GET /sparc/ASC/counts/attachment
VmosoApi.SparcApi	getChatNUTCount	GET /sparc/getNUTCount/chat
VmosoApi.SparcApi	getLMBCount	GET /sparc/LMB/count/{objectKey}
VmosoApi.SparcApi	getLatestAction	GET /sparc/lastAction
VmosoApi.SparcApi	getNUTCount	GET /sparc/getNUTCount
VmosoApi.SparcApi	getSkinnyData	GET /sparc/tiny/{type}/{key}/{sparcType}
VmosoApi.SparcApi	getSparcActions	GET /sparc/view
VmosoApi.StreamApi	checkRule	GET /stream/rule/check
VmosoApi.StreamApi	getCounts	GET /stream/count
VmosoApi.StreamApi	getItem	GET /stream/{key}/get
VmosoApi.StreamApi	getLastActionsNoACL	GET /stream/lastActions/get
VmosoApi.StreamApi	getNUTcount	GET /stream/nut/count
VmosoApi.StreamApi	getRuleCounts	GET /stream/rule/count
VmosoApi.StreamApi	getTileCounts	GET /stream/{key}/badgecounts/get
VmosoApi.StreamApi	getVutCounts	GET /stream/vut/count
VmosoApi.StreamApi	getVutCountsV2	GET /stream/vut/countv2
VmosoApi.StreamApi	search	GET /stream/search
VmosoApi.StreamvApi	getStreamCounts	GET /streamv2/counts
VmosoApi.StreamvApi	search	GET /streamv2/search
VmosoApi.SwitchboardApi	getMembers	GET /switchboard/{contentKey}/members
VmosoApi.SwitchboardApi	joinSwitchboard	POST /switchboard/join
VmosoApi.SwitchboardApi	leaveSwitchboard	POST /switchboard/leave
VmosoApi.TaskApi	addParticipants	PUT /tasks/{key}/participants/add
VmosoApi.TaskApi	checkAttachmentsInTask	GET /tasks/{key}/checkAttachmentKeys
VmosoApi.TaskApi	checkTemplateName	POST /tasks/checktplname
VmosoApi.TaskApi	cloneToDraft	POST /tasks/{key}/saveAsDraft
VmosoApi.TaskApi	cloneToTemplate	POST /tasks/{key}/saveAsTemplate
VmosoApi.TaskApi	createChat	POST /tasks/createChat
VmosoApi.TaskApi	createDraft	POST /tasks/createDraft
VmosoApi.TaskApi	createFromDraft	POST /tasks/createTaskByDraft/{key}
VmosoApi.TaskApi	createTask	POST /tasks
VmosoApi.TaskApi	createTemplate	POST /tasks/createTemplate
VmosoApi.TaskApi	deleteTasks	POST /tasks/delete
VmosoApi.TaskApi	getChatBrief	GET /tasks/getChatBrief/{key}
VmosoApi.TaskApi	getDraft	GET /tasks/viewDraft/{key}
VmosoApi.TaskApi	getFeedbackTask	GET /tasks/feedback
VmosoApi.TaskApi	getHistory	GET /tasks/{key}/history
VmosoApi.TaskApi	getMembersForReminder	GET /tasks/{key}/remindableMember
VmosoApi.TaskApi	getParticipants	GET /tasks/{key}/participants/sort/{sortType}
VmosoApi.TaskApi	getRelatedTasks	GET /tasks/{key}/getRelated/
VmosoApi.TaskApi	getTemplate	GET /tasks/viewTemplate/{key}
VmosoApi.TaskApi	getUserRolesInTask	GET /tasks/{key}/checkUserKeys
VmosoApi.TaskApi	rejectTask	PUT /tasks/{key}/reject
VmosoApi.TaskApi	removeParticipants	PUT /tasks/{key}/participants/remove
VmosoApi.TaskApi	sendReminder	PUT /tasks/{key}/remind
VmosoApi.TaskApi	unsubscribeAlien	POST /tasks/alienUnsubscribe
VmosoApi.TaskApi	updateDraft	PUT /tasks/updateDraft
VmosoApi.TaskApi	updateState	PUT /tasks/{key}/setState/{stateType}
VmosoApi.TaskApi	updateStatus	PUT /tasks/{key}/setStatus/{statusType}
VmosoApi.TaskApi	updateTask	PUT /tasks/{key}
VmosoApi.TaskApi	updateTemplate	PUT /tasks/updateTemplate
VmosoApi.TaskApi	verifyParticipantEmails	GET /tasks/participants/checkEmails
VmosoApi.TutorialApi	getState	POST /tut/gs
VmosoApi.UserApi	getFollowCounts	GET /followingAndFollowedUsers/counts
VmosoApi.UserApi	getInvitations	GET /invitations
VmosoApi.UserApi	getMe	GET /users/me
VmosoApi.UserApi	getRequestAndPendingUsersCounts	GET /requestandpendingusers/counts
VmosoApi.UserApi	getSuggestFollowersCounts	GET /suggestfollowers/counts
VmosoApi.UserApi	getSuggestedUsersCounts	GET /suggestusers/counts
VmosoApi.UserApi	getUser	GET /users/{userKey}
VmosoApi.UserApi	getUserByEmail	GET /users/lookupByEmail/{userName}
VmosoApi.UserApi	getUserStatus	POST /users/status
VmosoApi.UserApi	getUsers	GET /users/lookup
VmosoApi.UserApi	getUsersByEmail	POST /users/lookupByEmails
VmosoApi.UserApi	login	POST /login
VmosoApi.UserApi	logout	POST /logout
VmosoApi.UserApi	requestPassword	POST /requestpassword
VmosoApi.UserApi	resetExpiredPassword	POST /resetExpiredPassword
VmosoApi.UserApi	resetPasswordaction	POST /resetpasswordaction
VmosoApi.UserApi	resetPasswordactionPhone	POST /resetpasswordaction/phone
VmosoApi.UserApi	setPublic	POST /user/public/set
VmosoApi.UserApi	signup	POST /signUpAction
VmosoApi.UserApi	updatePassword	POST /settings/editUserPassWord
VmosoApi.UsergroupApi	removeUsers	DELETE /usergroupsV2/{containerID}/{segment}
VmosoApi.UsergroupApi	removeUsers2	POST /usergroupsV2/{containerID}/removeUsers
VmosoApi.ValidationApi	validateUrl	GET /exlink/check
VmosoApi.VcrApi	save	POST /vcr/save
VmosoApi.VrlApi	createVrl	POST /vrls
VmosoApi.VutApi	get	GET /vut/{parent}
VmosoApi.WechatApi	addAudio	POST /wechat/audio
VmosoApi.WechatApi	getJsapiSignature	GET /wechat/jssignature
VmosoApi.WidgetApi	deleteWidget	DELETE /widgets/{key}
VmosoApi.WidgetApi	getMutualCounts	GET /profile/mutualCounts
VmosoApi.WidgetApi	getWidgets	GET /widgets

Documentation for Models

superagent

@everything-registry/sub-chunk-3065

1.0.0

9 years ago