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 project:

• API version: 1.0.2
• Package version: 1.0.2
• 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 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:

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 reivew_and_markup_services from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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:

    npm install YOUR_USERNAME/reivew_and_markup_services --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 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 | OPTIONS /collaboration/conversation/addconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationAddconversationsPost | POST /collaboration/conversation/addconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationDeleteconversationsOptions | OPTIONS /collaboration/conversation/deleteconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationDeleteconversationsPost | POST /collaboration/conversation/deleteconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationGetconversationsOptions | OPTIONS /collaboration/conversation/getconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationGetconversationsPost | POST /collaboration/conversation/getconversations | ReivewAndMarkupServices.DefaultApi | collaborationConversationOptions | OPTIONS /collaboration/conversation | ReivewAndMarkupServices.DefaultApi | collaborationNotificationDeletenotificationsOptions | OPTIONS /collaboration/notification/deletenotifications | ReivewAndMarkupServices.DefaultApi | collaborationNotificationDeletenotificationsPost | POST /collaboration/notification/deletenotifications | ReivewAndMarkupServices.DefaultApi | collaborationNotificationGetnotificationsOptions | OPTIONS /collaboration/notification/getnotifications | ReivewAndMarkupServices.DefaultApi | collaborationNotificationGetnotificationsPost | POST /collaboration/notification/getnotifications | ReivewAndMarkupServices.DefaultApi | collaborationNotificationOptions | OPTIONS /collaboration/notification | ReivewAndMarkupServices.DefaultApi | collaborationNotificationUpdatereadstatusOptions | OPTIONS /collaboration/notification/updatereadstatus | ReivewAndMarkupServices.DefaultApi | collaborationNotificationUpdatereadstatusPost | POST /collaboration/notification/updatereadstatus | ReivewAndMarkupServices.DefaultApi | collaborationOptions | OPTIONS /collaboration | ReivewAndMarkupServices.DefaultApi | markupsAddmarkupsOptions | OPTIONS /markups/addmarkups | ReivewAndMarkupServices.DefaultApi | markupsAddmarkupsPost | POST /markups/addmarkups | ReivewAndMarkupServices.DefaultApi | markupsDeletemarkupsOptions | OPTIONS /markups/deletemarkups | ReivewAndMarkupServices.DefaultApi | markupsDeletemarkupsPost | POST /markups/deletemarkups | ReivewAndMarkupServices.DefaultApi | markupsGetmarkupsOptions | OPTIONS /markups/getmarkups | ReivewAndMarkupServices.DefaultApi | markupsGetmarkupsPost | POST /markups/getmarkups | ReivewAndMarkupServices.DefaultApi | markupsGetnxmarkupsOptions | OPTIONS /markups/getnxmarkups | ReivewAndMarkupServices.DefaultApi | markupsGetnxmarkupsPost | POST /markups/getnxmarkups | ReivewAndMarkupServices.DefaultApi | markupsOptions | OPTIONS /markups | ReivewAndMarkupServices.DefaultApi | modelsAddmodelsOptions | OPTIONS /models/addmodels | ReivewAndMarkupServices.DefaultApi | modelsAddmodelsPost | POST /models/addmodels | ReivewAndMarkupServices.DefaultApi | modelsAddrecentmodelsOptions | OPTIONS /models/addrecentmodels | ReivewAndMarkupServices.DefaultApi | modelsAddrecentmodelsPost | POST /models/addrecentmodels | ReivewAndMarkupServices.DefaultApi | modelsGetmodelpolicyOptions | OPTIONS /models/getmodelpolicy | ReivewAndMarkupServices.DefaultApi | modelsGetmodelpolicyPost | POST /models/getmodelpolicy | ReivewAndMarkupServices.DefaultApi | modelsGetmodelpreviewpolicyOptions | OPTIONS /models/getmodelpreviewpolicy | ReivewAndMarkupServices.DefaultApi | modelsGetmodelpreviewpolicyPost | POST /models/getmodelpreviewpolicy | ReivewAndMarkupServices.DefaultApi | modelsGetmymodelsOptions | OPTIONS /models/getmymodels | ReivewAndMarkupServices.DefaultApi | modelsGetmymodelsPost | POST /models/getmymodels | ReivewAndMarkupServices.DefaultApi | modelsGetrecentmodelsOptions | OPTIONS /models/getrecentmodels | ReivewAndMarkupServices.DefaultApi | modelsGetrecentmodelsPost | POST /models/getrecentmodels | ReivewAndMarkupServices.DefaultApi | modelsGetsharedmodelsOptions | OPTIONS /models/getsharedmodels | ReivewAndMarkupServices.DefaultApi | modelsGetsharedmodelsPost | POST /models/getsharedmodels | ReivewAndMarkupServices.DefaultApi | plcAddplcdataOptions | OPTIONS /plc/addplcdata | ReivewAndMarkupServices.DefaultApi | plcAddplcdataPost | POST /plc/addplcdata | ReivewAndMarkupServices.DefaultApi | plcGetplcdataOptions | OPTIONS /plc/getplcdata | ReivewAndMarkupServices.DefaultApi | plcGetplcdataPost | POST /plc/getplcdata | ReivewAndMarkupServices.DefaultApi | plcOptions | OPTIONS /plc | ReivewAndMarkupServices.DefaultApi | simAddsimdataOptions | OPTIONS /sim/addsimdata | ReivewAndMarkupServices.DefaultApi | simAddsimdataPost | POST /sim/addsimdata | ReivewAndMarkupServices.DefaultApi | simGetsimdataOptions | OPTIONS /sim/getsimdata | ReivewAndMarkupServices.DefaultApi | simGetsimdataPost | POST /sim/getsimdata | ReivewAndMarkupServices.DefaultApi | simOptions | OPTIONS /sim | ReivewAndMarkupServices.DefaultApi | usersGetprofileOptions | OPTIONS /users/getprofile | ReivewAndMarkupServices.DefaultApi | usersGetprofilePost | POST /users/getprofile | ReivewAndMarkupServices.DefaultApi | usersGetreviewersOptions | OPTIONS /users/getreviewers | ReivewAndMarkupServices.DefaultApi | usersGetreviewersPost | POST /users/getreviewers | ReivewAndMarkupServices.DefaultApi | usersOptions | OPTIONS /users |

Documentation for Models

• ReivewAndMarkupServices.AddConversationsInput
• ReivewAndMarkupServices.AddConversationsOutput
• ReivewAndMarkupServices.AddMarkupsInput
• ReivewAndMarkupServices.AddMarkupsOutput
• ReivewAndMarkupServices.AddModelsInput
• ReivewAndMarkupServices.AddModelsOutput
• ReivewAndMarkupServices.AddPlcDataInput
• ReivewAndMarkupServices.AddPlcDataOutput
• ReivewAndMarkupServices.AddRecentModelsInput
• ReivewAndMarkupServices.AddRecentModelsInputRecentModels
• ReivewAndMarkupServices.AddRecentModelsOutput
• ReivewAndMarkupServices.AddSimDataInput
• ReivewAndMarkupServices.AddSimDataOutput
• ReivewAndMarkupServices.Conversation
• ReivewAndMarkupServices.ConversationHistory
• ReivewAndMarkupServices.DeleteConversationsInput
• ReivewAndMarkupServices.DeleteConversationsInputConversations
• ReivewAndMarkupServices.DeleteConversationsOutput
• ReivewAndMarkupServices.DeleteMarkupsInput
• ReivewAndMarkupServices.DeleteMarkupsOutput
• ReivewAndMarkupServices.DeleteNotificationsInput
• ReivewAndMarkupServices.DeleteNotificationsOutput
• ReivewAndMarkupServices.Empty
• ReivewAndMarkupServices.FilePolicy
• ReivewAndMarkupServices.GetConversationsInput
• ReivewAndMarkupServices.GetConversationsOutput
• ReivewAndMarkupServices.GetMarkupsInput
• ReivewAndMarkupServices.GetModelPolicyInput
• ReivewAndMarkupServices.GetModelPolicyOutput
• ReivewAndMarkupServices.GetModelPreviewPolicyInput
• ReivewAndMarkupServices.GetModelPreviewPolicyOutput
• ReivewAndMarkupServices.GetMyModelsInput
• ReivewAndMarkupServices.GetMyModelsOutput
• ReivewAndMarkupServices.GetNXMarkupsInput
• ReivewAndMarkupServices.GetNXMarkupsOutput
• ReivewAndMarkupServices.GetNXMarkupsOutputMarkups
• ReivewAndMarkupServices.GetNotificationsInput
• ReivewAndMarkupServices.GetNotificationsOutput
• ReivewAndMarkupServices.GetPlcDataInput
• ReivewAndMarkupServices.GetPlcDataOutput
• ReivewAndMarkupServices.GetRecentModelsInput
• ReivewAndMarkupServices.GetRecentModelsOutput
• ReivewAndMarkupServices.GetReviewersInput
• ReivewAndMarkupServices.GetReviewersOutput
• ReivewAndMarkupServices.GetSharedModelsInput
• ReivewAndMarkupServices.GetSharedModelsOutput
• ReivewAndMarkupServices.GetSimDataInput
• ReivewAndMarkupServices.GetSimDataOutput
• ReivewAndMarkupServices.GetUserProfileInput
• ReivewAndMarkupServices.GetUserProfileOutput
• ReivewAndMarkupServices.Markup
• ReivewAndMarkupServices.MarkupCameraInfo
• ReivewAndMarkupServices.Model
• ReivewAndMarkupServices.Notification
• ReivewAndMarkupServices.PlcData
• ReivewAndMarkupServices.Reviewer
• ReivewAndMarkupServices.SimData
• ReivewAndMarkupServices.SimDataMovedParts
• ReivewAndMarkupServices.SimDataSimData
• ReivewAndMarkupServices.UpdateReadStatusInput
• ReivewAndMarkupServices.UpdateReadStatusInputNotifications
• ReivewAndMarkupServices.UpdateReadStatusOutput
• ReivewAndMarkupServices.UserProfile

Documentation for Authorization

All endpoints do not require authorization.