# vmoso-task-api VmosoTaskApi - JavaScript client for vmoso-task-api Description about Task API This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.0 - Package version: 1.0.0 - Build date: 2016-06-22T14:07:17.495Z - Build package: class io.swagger.codegen.languages.JavascriptClientCodegen ## Installation ### For [Node.js](https://nodejs.org/) #### npm To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: ```shell npm install vmoso-task-api --save ``` #### git # If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/vmoso-task-api then install it via: ```shell npm install YOUR_USERNAME/vmoso-task-api --save ``` ### For browser The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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): ```shell browserify main.js > bundle.js ``` Then include *bundle.js* in the HTML pages. ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var VmosoTaskApi = require('vmoso-task-api'); var defaultClient = VmosoTaskApi.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 VmosoTaskApi.TaskApi() var key = "key_example"; // {String} var input = new VmosoTaskApi.AddParticipantsInput(); // {AddParticipantsInput} AddParticipants Input var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.addParticipants(key, input, callback); ``` ## Documentation for API Endpoints All URIs are relative to *https://www.vmoso.com/svc* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *VmosoTaskApi.TaskApi* | [**addParticipants**](docs/TaskApi.md#addParticipants) | **PUT** /tasks/{key}/participants/add | *VmosoTaskApi.TaskApi* | [**checkAttachmentsInTask**](docs/TaskApi.md#checkAttachmentsInTask) | **GET** /tasks/{key}/checkAttachmentKeys | *VmosoTaskApi.TaskApi* | [**checkTemplateName**](docs/TaskApi.md#checkTemplateName) | **POST** /tasks/checktplname | *VmosoTaskApi.TaskApi* | [**cloneToDraft**](docs/TaskApi.md#cloneToDraft) | **POST** /tasks/{key}/saveAsDraft | *VmosoTaskApi.TaskApi* | [**cloneToTemplate**](docs/TaskApi.md#cloneToTemplate) | **POST** /tasks/{key}/saveAsTemplate | *VmosoTaskApi.TaskApi* | [**createChat**](docs/TaskApi.md#createChat) | **POST** /tasks/createChat | *VmosoTaskApi.TaskApi* | [**createDraft**](docs/TaskApi.md#createDraft) | **POST** /tasks/createDraft | *VmosoTaskApi.TaskApi* | [**createFromDraft**](docs/TaskApi.md#createFromDraft) | **POST** /tasks/createTaskByDraft/{key} | *VmosoTaskApi.TaskApi* | [**createTask**](docs/TaskApi.md#createTask) | **POST** /tasks | *VmosoTaskApi.TaskApi* | [**createTemplate**](docs/TaskApi.md#createTemplate) | **POST** /tasks/createTemplate | *VmosoTaskApi.TaskApi* | [**deleteTask**](docs/TaskApi.md#deleteTask) | **DELETE** /tasks/{key} | *VmosoTaskApi.TaskApi* | [**getChatBrief**](docs/TaskApi.md#getChatBrief) | **GET** /tasks/getChatBrief/{key} | *VmosoTaskApi.TaskApi* | [**getDraft**](docs/TaskApi.md#getDraft) | **GET** /tasks/viewDraft/{key} | *VmosoTaskApi.TaskApi* | [**getFeedbackTask**](docs/TaskApi.md#getFeedbackTask) | **GET** /tasks/feedback | *VmosoTaskApi.TaskApi* | [**getHistory**](docs/TaskApi.md#getHistory) | **GET** /tasks/{key}/history | *VmosoTaskApi.TaskApi* | [**getMembersForReminder**](docs/TaskApi.md#getMembersForReminder) | **GET** /tasks/{key}/remindableMember | *VmosoTaskApi.TaskApi* | [**getParticipants**](docs/TaskApi.md#getParticipants) | **GET** /tasks/{key}/participants/sort/{sortType} | *VmosoTaskApi.TaskApi* | [**getRelatedTasks**](docs/TaskApi.md#getRelatedTasks) | **GET** /tasks/{key}/getRelated/ | *VmosoTaskApi.TaskApi* | [**getTask**](docs/TaskApi.md#getTask) | **GET** /tasks/{key} | *VmosoTaskApi.TaskApi* | [**getTemplate**](docs/TaskApi.md#getTemplate) | **GET** /tasks/viewTemplate/{key} | *VmosoTaskApi.TaskApi* | [**getUserRolesInTask**](docs/TaskApi.md#getUserRolesInTask) | **GET** /tasks/{key}/checkUserKeys | *VmosoTaskApi.TaskApi* | [**rejectTask**](docs/TaskApi.md#rejectTask) | **PUT** /tasks/{key}/reject | *VmosoTaskApi.TaskApi* | [**removeParticipants**](docs/TaskApi.md#removeParticipants) | **PUT** /tasks/{key}/participants/remove | *VmosoTaskApi.TaskApi* | [**sendReminder**](docs/TaskApi.md#sendReminder) | **PUT** /tasks/{key}/remind | *VmosoTaskApi.TaskApi* | [**unsubscribeAlien**](docs/TaskApi.md#unsubscribeAlien) | **POST** /tasks/alienUnsubscribe | *VmosoTaskApi.TaskApi* | [**updateDraft**](docs/TaskApi.md#updateDraft) | **PUT** /tasks/updateDraft | *VmosoTaskApi.TaskApi* | [**updateState**](docs/TaskApi.md#updateState) | **PUT** /tasks/{key}/setState/{stateType} | *VmosoTaskApi.TaskApi* | [**updateStatus**](docs/TaskApi.md#updateStatus) | **PUT** /tasks/{key}/setStatus/{statusType} | *VmosoTaskApi.TaskApi* | [**updateTask**](docs/TaskApi.md#updateTask) | **PUT** /tasks/{key} | *VmosoTaskApi.TaskApi* | [**updateTemplate**](docs/TaskApi.md#updateTemplate) | **PUT** /tasks/updateTemplate | *VmosoTaskApi.TaskApi* | [**verifyParticipantEmails**](docs/TaskApi.md#verifyParticipantEmails) | **GET** /tasks/participants/checkEmails | ## Documentation for Models - [VmosoTaskApi.AddParticipantsInput](docs/AddParticipantsInput.md) - [VmosoTaskApi.AddParticipantsResult](docs/AddParticipantsResult.md) - [VmosoTaskApi.AttachmentsOpRecord](docs/AttachmentsOpRecord.md) - [VmosoTaskApi.BasicRecord](docs/BasicRecord.md) - [VmosoTaskApi.ChatBriefRecord](docs/ChatBriefRecord.md) - [VmosoTaskApi.ChatV2Record](docs/ChatV2Record.md) - [VmosoTaskApi.CheckAttachmentsInTaskResult](docs/CheckAttachmentsInTaskResult.md) - [VmosoTaskApi.CheckTemplateNameInput](docs/CheckTemplateNameInput.md) - [VmosoTaskApi.CheckTemplateNameResult](docs/CheckTemplateNameResult.md) - [VmosoTaskApi.CloneToDraftResult](docs/CloneToDraftResult.md) - [VmosoTaskApi.CloneToTemplateInput](docs/CloneToTemplateInput.md) - [VmosoTaskApi.CloneToTemplateResult](docs/CloneToTemplateResult.md) - [VmosoTaskApi.CreateChatInput](docs/CreateChatInput.md) - [VmosoTaskApi.CreateChatResult](docs/CreateChatResult.md) - [VmosoTaskApi.CreateDraftInput](docs/CreateDraftInput.md) - [VmosoTaskApi.CreateDraftResult](docs/CreateDraftResult.md) - [VmosoTaskApi.CreateFromDraftInput](docs/CreateFromDraftInput.md) - [VmosoTaskApi.CreateFromDraftResult](docs/CreateFromDraftResult.md) - [VmosoTaskApi.CreateTaskInput](docs/CreateTaskInput.md) - [VmosoTaskApi.CreateTaskResult](docs/CreateTaskResult.md) - [VmosoTaskApi.CreateTemplateInput](docs/CreateTemplateInput.md) - [VmosoTaskApi.CreateTemplateResult](docs/CreateTemplateResult.md) - [VmosoTaskApi.CsiTokenRecord](docs/CsiTokenRecord.md) - [VmosoTaskApi.DeleteTaskResult](docs/DeleteTaskResult.md) - [VmosoTaskApi.DisplayRecord](docs/DisplayRecord.md) - [VmosoTaskApi.EmailUserListRecord](docs/EmailUserListRecord.md) - [VmosoTaskApi.ErrorDetailRecord](docs/ErrorDetailRecord.md) - [VmosoTaskApi.FolderRecord](docs/FolderRecord.md) - [VmosoTaskApi.GetChatBriefResult](docs/GetChatBriefResult.md) - [VmosoTaskApi.GetDraftResult](docs/GetDraftResult.md) - [VmosoTaskApi.GetFeedbackTaskResult](docs/GetFeedbackTaskResult.md) - [VmosoTaskApi.GetHistoryResult](docs/GetHistoryResult.md) - [VmosoTaskApi.GetMembersForReminderResult](docs/GetMembersForReminderResult.md) - [VmosoTaskApi.GetParticipantsResult](docs/GetParticipantsResult.md) - [VmosoTaskApi.GetRelatedTasksResult](docs/GetRelatedTasksResult.md) - [VmosoTaskApi.GetTaskResult](docs/GetTaskResult.md) - [VmosoTaskApi.GetTemplateResult](docs/GetTemplateResult.md) - [VmosoTaskApi.GetUserRolesInTaskResult](docs/GetUserRolesInTaskResult.md) - [VmosoTaskApi.ListPageRecord](docs/ListPageRecord.md) - [VmosoTaskApi.ObjectReadInfoRecord](docs/ObjectReadInfoRecord.md) - [VmosoTaskApi.ObjectV2Record](docs/ObjectV2Record.md) - [VmosoTaskApi.PageJumpRecord](docs/PageJumpRecord.md) - [VmosoTaskApi.PaginationRecord](docs/PaginationRecord.md) - [VmosoTaskApi.RejectTaskResult](docs/RejectTaskResult.md) - [VmosoTaskApi.RemoveParticipantsInput](docs/RemoveParticipantsInput.md) - [VmosoTaskApi.RemoveParticipantsResult](docs/RemoveParticipantsResult.md) - [VmosoTaskApi.ResponseHeaderRecord](docs/ResponseHeaderRecord.md) - [VmosoTaskApi.SendReminderInput](docs/SendReminderInput.md) - [VmosoTaskApi.SendReminderResult](docs/SendReminderResult.md) - [VmosoTaskApi.SpaceACLRecord](docs/SpaceACLRecord.md) - [VmosoTaskApi.SpaceCountRecord](docs/SpaceCountRecord.md) - [VmosoTaskApi.SpaceRecord](docs/SpaceRecord.md) - [VmosoTaskApi.SpaceV2Record](docs/SpaceV2Record.md) - [VmosoTaskApi.TaskACLRecord](docs/TaskACLRecord.md) - [VmosoTaskApi.TaskDraftRecord](docs/TaskDraftRecord.md) - [VmosoTaskApi.TaskHistoryRecord](docs/TaskHistoryRecord.md) - [VmosoTaskApi.TaskMemberRecord](docs/TaskMemberRecord.md) - [VmosoTaskApi.TaskMemberRolesRecord](docs/TaskMemberRolesRecord.md) - [VmosoTaskApi.TaskParticipantRelationshipRecord](docs/TaskParticipantRelationshipRecord.md) - [VmosoTaskApi.TaskRecord](docs/TaskRecord.md) - [VmosoTaskApi.TaskRelatedRecord](docs/TaskRelatedRecord.md) - [VmosoTaskApi.TaskStepRecord](docs/TaskStepRecord.md) - [VmosoTaskApi.TaskTemplateRecord](docs/TaskTemplateRecord.md) - [VmosoTaskApi.UnsubscribeAlienInput](docs/UnsubscribeAlienInput.md) - [VmosoTaskApi.UnsubscribeAlienResult](docs/UnsubscribeAlienResult.md) - [VmosoTaskApi.UpdateDraftInput](docs/UpdateDraftInput.md) - [VmosoTaskApi.UpdateDraftResult](docs/UpdateDraftResult.md) - [VmosoTaskApi.UpdateStateResult](docs/UpdateStateResult.md) - [VmosoTaskApi.UpdateStatusResult](docs/UpdateStatusResult.md) - [VmosoTaskApi.UpdateTaskInput](docs/UpdateTaskInput.md) - [VmosoTaskApi.UpdateTaskResult](docs/UpdateTaskResult.md) - [VmosoTaskApi.UpdateTemplateInput](docs/UpdateTemplateInput.md) - [VmosoTaskApi.UpdateTemplateResult](docs/UpdateTemplateResult.md) - [VmosoTaskApi.UserDisplayRecord](docs/UserDisplayRecord.md) - [VmosoTaskApi.UserListRecord](docs/UserListRecord.md) - [VmosoTaskApi.UserObjectRecord](docs/UserObjectRecord.md) - [VmosoTaskApi.UserOptionRecord](docs/UserOptionRecord.md) - [VmosoTaskApi.VerifyParticipantEmailsResult](docs/VerifyParticipantEmailsResult.md) ## Documentation for Authorization ### vmoso_auth - **Type**: API key - **API key parameter name**: X-CV-Authorization - **Location**: HTTP header