# reivew_and_markup_services ReivewAndMarkupServices - JavaScript client for reivew_and_markup_services Review and Markup Services This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project: - API version: 1.0.2 - Package version: 1.0.2 - Build package: 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 reivew_and_markup_services --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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` Finally, switch to the directory you want to use your reivew_and_markup_services from, and run: ```shell npm link /path/to/ ``` You should now be able to `require('reivew_and_markup_services')` 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/YOUR_USERNAME/reivew_and_markup_services then install it via: ```shell npm install YOUR_USERNAME/reivew_and_markup_services --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, that's to say your javascript file where you actually use this library): ```shell 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: ```javascript module: { rules: [ { parser: { amd: false } } ] } ``` ## Getting Started Please follow the [installation](#installation) instruction and execute the following JS code: ```javascript var ReivewAndMarkupServices = require('reivew_and_markup_services'); var api = new ReivewAndMarkupServices.DefaultApi() var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.collaborationConversationAddconversationsOptions(callback); ``` ## Documentation for API Endpoints All URIs are relative to *https://hbqj7m43u3.execute-api.us-east-1.amazonaws.com/dev* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationAddconversationsOptions**](docs/DefaultApi.md#collaborationConversationAddconversationsOptions) | **OPTIONS** /collaboration/conversation/addconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationAddconversationsPost**](docs/DefaultApi.md#collaborationConversationAddconversationsPost) | **POST** /collaboration/conversation/addconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationDeleteconversationsOptions**](docs/DefaultApi.md#collaborationConversationDeleteconversationsOptions) | **OPTIONS** /collaboration/conversation/deleteconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationDeleteconversationsPost**](docs/DefaultApi.md#collaborationConversationDeleteconversationsPost) | **POST** /collaboration/conversation/deleteconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationGetconversationsOptions**](docs/DefaultApi.md#collaborationConversationGetconversationsOptions) | **OPTIONS** /collaboration/conversation/getconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationGetconversationsPost**](docs/DefaultApi.md#collaborationConversationGetconversationsPost) | **POST** /collaboration/conversation/getconversations | *ReivewAndMarkupServices.DefaultApi* | [**collaborationConversationOptions**](docs/DefaultApi.md#collaborationConversationOptions) | **OPTIONS** /collaboration/conversation | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationDeletenotificationsOptions**](docs/DefaultApi.md#collaborationNotificationDeletenotificationsOptions) | **OPTIONS** /collaboration/notification/deletenotifications | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationDeletenotificationsPost**](docs/DefaultApi.md#collaborationNotificationDeletenotificationsPost) | **POST** /collaboration/notification/deletenotifications | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationGetnotificationsOptions**](docs/DefaultApi.md#collaborationNotificationGetnotificationsOptions) | **OPTIONS** /collaboration/notification/getnotifications | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationGetnotificationsPost**](docs/DefaultApi.md#collaborationNotificationGetnotificationsPost) | **POST** /collaboration/notification/getnotifications | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationOptions**](docs/DefaultApi.md#collaborationNotificationOptions) | **OPTIONS** /collaboration/notification | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationUpdatereadstatusOptions**](docs/DefaultApi.md#collaborationNotificationUpdatereadstatusOptions) | **OPTIONS** /collaboration/notification/updatereadstatus | *ReivewAndMarkupServices.DefaultApi* | [**collaborationNotificationUpdatereadstatusPost**](docs/DefaultApi.md#collaborationNotificationUpdatereadstatusPost) | **POST** /collaboration/notification/updatereadstatus | *ReivewAndMarkupServices.DefaultApi* | [**collaborationOptions**](docs/DefaultApi.md#collaborationOptions) | **OPTIONS** /collaboration | *ReivewAndMarkupServices.DefaultApi* | [**markupsAddmarkupsOptions**](docs/DefaultApi.md#markupsAddmarkupsOptions) | **OPTIONS** /markups/addmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsAddmarkupsPost**](docs/DefaultApi.md#markupsAddmarkupsPost) | **POST** /markups/addmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsDeletemarkupsOptions**](docs/DefaultApi.md#markupsDeletemarkupsOptions) | **OPTIONS** /markups/deletemarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsDeletemarkupsPost**](docs/DefaultApi.md#markupsDeletemarkupsPost) | **POST** /markups/deletemarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsGetmarkupsOptions**](docs/DefaultApi.md#markupsGetmarkupsOptions) | **OPTIONS** /markups/getmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsGetmarkupsPost**](docs/DefaultApi.md#markupsGetmarkupsPost) | **POST** /markups/getmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsGetnxmarkupsOptions**](docs/DefaultApi.md#markupsGetnxmarkupsOptions) | **OPTIONS** /markups/getnxmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsGetnxmarkupsPost**](docs/DefaultApi.md#markupsGetnxmarkupsPost) | **POST** /markups/getnxmarkups | *ReivewAndMarkupServices.DefaultApi* | [**markupsOptions**](docs/DefaultApi.md#markupsOptions) | **OPTIONS** /markups | *ReivewAndMarkupServices.DefaultApi* | [**modelsAddmodelsOptions**](docs/DefaultApi.md#modelsAddmodelsOptions) | **OPTIONS** /models/addmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsAddmodelsPost**](docs/DefaultApi.md#modelsAddmodelsPost) | **POST** /models/addmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsAddrecentmodelsOptions**](docs/DefaultApi.md#modelsAddrecentmodelsOptions) | **OPTIONS** /models/addrecentmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsAddrecentmodelsPost**](docs/DefaultApi.md#modelsAddrecentmodelsPost) | **POST** /models/addrecentmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmodelpolicyOptions**](docs/DefaultApi.md#modelsGetmodelpolicyOptions) | **OPTIONS** /models/getmodelpolicy | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmodelpolicyPost**](docs/DefaultApi.md#modelsGetmodelpolicyPost) | **POST** /models/getmodelpolicy | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmodelpreviewpolicyOptions**](docs/DefaultApi.md#modelsGetmodelpreviewpolicyOptions) | **OPTIONS** /models/getmodelpreviewpolicy | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmodelpreviewpolicyPost**](docs/DefaultApi.md#modelsGetmodelpreviewpolicyPost) | **POST** /models/getmodelpreviewpolicy | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmymodelsOptions**](docs/DefaultApi.md#modelsGetmymodelsOptions) | **OPTIONS** /models/getmymodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetmymodelsPost**](docs/DefaultApi.md#modelsGetmymodelsPost) | **POST** /models/getmymodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetrecentmodelsOptions**](docs/DefaultApi.md#modelsGetrecentmodelsOptions) | **OPTIONS** /models/getrecentmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetrecentmodelsPost**](docs/DefaultApi.md#modelsGetrecentmodelsPost) | **POST** /models/getrecentmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetsharedmodelsOptions**](docs/DefaultApi.md#modelsGetsharedmodelsOptions) | **OPTIONS** /models/getsharedmodels | *ReivewAndMarkupServices.DefaultApi* | [**modelsGetsharedmodelsPost**](docs/DefaultApi.md#modelsGetsharedmodelsPost) | **POST** /models/getsharedmodels | *ReivewAndMarkupServices.DefaultApi* | [**plcAddplcdataOptions**](docs/DefaultApi.md#plcAddplcdataOptions) | **OPTIONS** /plc/addplcdata | *ReivewAndMarkupServices.DefaultApi* | [**plcAddplcdataPost**](docs/DefaultApi.md#plcAddplcdataPost) | **POST** /plc/addplcdata | *ReivewAndMarkupServices.DefaultApi* | [**plcGetplcdataOptions**](docs/DefaultApi.md#plcGetplcdataOptions) | **OPTIONS** /plc/getplcdata | *ReivewAndMarkupServices.DefaultApi* | [**plcGetplcdataPost**](docs/DefaultApi.md#plcGetplcdataPost) | **POST** /plc/getplcdata | *ReivewAndMarkupServices.DefaultApi* | [**plcOptions**](docs/DefaultApi.md#plcOptions) | **OPTIONS** /plc | *ReivewAndMarkupServices.DefaultApi* | [**simAddsimdataOptions**](docs/DefaultApi.md#simAddsimdataOptions) | **OPTIONS** /sim/addsimdata | *ReivewAndMarkupServices.DefaultApi* | [**simAddsimdataPost**](docs/DefaultApi.md#simAddsimdataPost) | **POST** /sim/addsimdata | *ReivewAndMarkupServices.DefaultApi* | [**simGetsimdataOptions**](docs/DefaultApi.md#simGetsimdataOptions) | **OPTIONS** /sim/getsimdata | *ReivewAndMarkupServices.DefaultApi* | [**simGetsimdataPost**](docs/DefaultApi.md#simGetsimdataPost) | **POST** /sim/getsimdata | *ReivewAndMarkupServices.DefaultApi* | [**simOptions**](docs/DefaultApi.md#simOptions) | **OPTIONS** /sim | *ReivewAndMarkupServices.DefaultApi* | [**usersGetprofileOptions**](docs/DefaultApi.md#usersGetprofileOptions) | **OPTIONS** /users/getprofile | *ReivewAndMarkupServices.DefaultApi* | [**usersGetprofilePost**](docs/DefaultApi.md#usersGetprofilePost) | **POST** /users/getprofile | *ReivewAndMarkupServices.DefaultApi* | [**usersGetreviewersOptions**](docs/DefaultApi.md#usersGetreviewersOptions) | **OPTIONS** /users/getreviewers | *ReivewAndMarkupServices.DefaultApi* | [**usersGetreviewersPost**](docs/DefaultApi.md#usersGetreviewersPost) | **POST** /users/getreviewers | *ReivewAndMarkupServices.DefaultApi* | [**usersOptions**](docs/DefaultApi.md#usersOptions) | **OPTIONS** /users | ## Documentation for Models - [ReivewAndMarkupServices.AddConversationsInput](docs/AddConversationsInput.md) - [ReivewAndMarkupServices.AddConversationsOutput](docs/AddConversationsOutput.md) - [ReivewAndMarkupServices.AddMarkupsInput](docs/AddMarkupsInput.md) - [ReivewAndMarkupServices.AddMarkupsOutput](docs/AddMarkupsOutput.md) - [ReivewAndMarkupServices.AddModelsInput](docs/AddModelsInput.md) - [ReivewAndMarkupServices.AddModelsOutput](docs/AddModelsOutput.md) - [ReivewAndMarkupServices.AddPlcDataInput](docs/AddPlcDataInput.md) - [ReivewAndMarkupServices.AddPlcDataOutput](docs/AddPlcDataOutput.md) - [ReivewAndMarkupServices.AddRecentModelsInput](docs/AddRecentModelsInput.md) - [ReivewAndMarkupServices.AddRecentModelsInputRecentModels](docs/AddRecentModelsInputRecentModels.md) - [ReivewAndMarkupServices.AddRecentModelsOutput](docs/AddRecentModelsOutput.md) - [ReivewAndMarkupServices.AddSimDataInput](docs/AddSimDataInput.md) - [ReivewAndMarkupServices.AddSimDataOutput](docs/AddSimDataOutput.md) - [ReivewAndMarkupServices.Conversation](docs/Conversation.md) - [ReivewAndMarkupServices.ConversationHistory](docs/ConversationHistory.md) - [ReivewAndMarkupServices.DeleteConversationsInput](docs/DeleteConversationsInput.md) - [ReivewAndMarkupServices.DeleteConversationsInputConversations](docs/DeleteConversationsInputConversations.md) - [ReivewAndMarkupServices.DeleteConversationsOutput](docs/DeleteConversationsOutput.md) - [ReivewAndMarkupServices.DeleteMarkupsInput](docs/DeleteMarkupsInput.md) - [ReivewAndMarkupServices.DeleteMarkupsOutput](docs/DeleteMarkupsOutput.md) - [ReivewAndMarkupServices.DeleteNotificationsInput](docs/DeleteNotificationsInput.md) - [ReivewAndMarkupServices.DeleteNotificationsOutput](docs/DeleteNotificationsOutput.md) - [ReivewAndMarkupServices.Empty](docs/Empty.md) - [ReivewAndMarkupServices.FilePolicy](docs/FilePolicy.md) - [ReivewAndMarkupServices.GetConversationsInput](docs/GetConversationsInput.md) - [ReivewAndMarkupServices.GetConversationsOutput](docs/GetConversationsOutput.md) - [ReivewAndMarkupServices.GetMarkupsInput](docs/GetMarkupsInput.md) - [ReivewAndMarkupServices.GetModelPolicyInput](docs/GetModelPolicyInput.md) - [ReivewAndMarkupServices.GetModelPolicyOutput](docs/GetModelPolicyOutput.md) - [ReivewAndMarkupServices.GetModelPreviewPolicyInput](docs/GetModelPreviewPolicyInput.md) - [ReivewAndMarkupServices.GetModelPreviewPolicyOutput](docs/GetModelPreviewPolicyOutput.md) - [ReivewAndMarkupServices.GetMyModelsInput](docs/GetMyModelsInput.md) - [ReivewAndMarkupServices.GetMyModelsOutput](docs/GetMyModelsOutput.md) - [ReivewAndMarkupServices.GetNXMarkupsInput](docs/GetNXMarkupsInput.md) - [ReivewAndMarkupServices.GetNXMarkupsOutput](docs/GetNXMarkupsOutput.md) - [ReivewAndMarkupServices.GetNXMarkupsOutputMarkups](docs/GetNXMarkupsOutputMarkups.md) - [ReivewAndMarkupServices.GetNotificationsInput](docs/GetNotificationsInput.md) - [ReivewAndMarkupServices.GetNotificationsOutput](docs/GetNotificationsOutput.md) - [ReivewAndMarkupServices.GetPlcDataInput](docs/GetPlcDataInput.md) - [ReivewAndMarkupServices.GetPlcDataOutput](docs/GetPlcDataOutput.md) - [ReivewAndMarkupServices.GetRecentModelsInput](docs/GetRecentModelsInput.md) - [ReivewAndMarkupServices.GetRecentModelsOutput](docs/GetRecentModelsOutput.md) - [ReivewAndMarkupServices.GetReviewersInput](docs/GetReviewersInput.md) - [ReivewAndMarkupServices.GetReviewersOutput](docs/GetReviewersOutput.md) - [ReivewAndMarkupServices.GetSharedModelsInput](docs/GetSharedModelsInput.md) - [ReivewAndMarkupServices.GetSharedModelsOutput](docs/GetSharedModelsOutput.md) - [ReivewAndMarkupServices.GetSimDataInput](docs/GetSimDataInput.md) - [ReivewAndMarkupServices.GetSimDataOutput](docs/GetSimDataOutput.md) - [ReivewAndMarkupServices.GetUserProfileInput](docs/GetUserProfileInput.md) - [ReivewAndMarkupServices.GetUserProfileOutput](docs/GetUserProfileOutput.md) - [ReivewAndMarkupServices.Markup](docs/Markup.md) - [ReivewAndMarkupServices.MarkupCameraInfo](docs/MarkupCameraInfo.md) - [ReivewAndMarkupServices.Model](docs/Model.md) - [ReivewAndMarkupServices.Notification](docs/Notification.md) - [ReivewAndMarkupServices.PlcData](docs/PlcData.md) - [ReivewAndMarkupServices.Reviewer](docs/Reviewer.md) - [ReivewAndMarkupServices.SimData](docs/SimData.md) - [ReivewAndMarkupServices.SimDataMovedParts](docs/SimDataMovedParts.md) - [ReivewAndMarkupServices.SimDataSimData](docs/SimDataSimData.md) - [ReivewAndMarkupServices.UpdateReadStatusInput](docs/UpdateReadStatusInput.md) - [ReivewAndMarkupServices.UpdateReadStatusInputNotifications](docs/UpdateReadStatusInputNotifications.md) - [ReivewAndMarkupServices.UpdateReadStatusOutput](docs/UpdateReadStatusOutput.md) - [ReivewAndMarkupServices.UserProfile](docs/UserProfile.md) ## Documentation for Authorization All endpoints do not require authorization.