designreview_api

DesignreviewApi - JavaScript client for designreview_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 2017-07-27T22:03:05Z
• Package version: 2017-07-27T22:03:05Z
• 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 designreview_api --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 designreview_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('designreview_api') 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/designreview_api then install it via:

    npm install YOUR_USERNAME/designreview_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, 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 DesignreviewApi = require('designreview_api');

var api = new DesignreviewApi.DefaultApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collaborationMessagingOptions(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 ------------ | ------------- | ------------- | ------------- DesignreviewApi.DefaultApi | collaborationMessagingOptions | OPTIONS /collaboration/messaging | DesignreviewApi.DefaultApi | collaborationNotificationDeletenotificationsOptions | OPTIONS /collaboration/notification/deletenotifications | DesignreviewApi.DefaultApi | collaborationNotificationDeletenotificationsPost | POST /collaboration/notification/deletenotifications | DesignreviewApi.DefaultApi | collaborationNotificationGetnotificationsOptions | OPTIONS /collaboration/notification/getnotifications | DesignreviewApi.DefaultApi | collaborationNotificationGetnotificationsPost | POST /collaboration/notification/getnotifications | DesignreviewApi.DefaultApi | collaborationNotificationOptions | OPTIONS /collaboration/notification | DesignreviewApi.DefaultApi | collaborationNotificationUpdatereadstatusOptions | OPTIONS /collaboration/notification/updatereadstatus | DesignreviewApi.DefaultApi | collaborationNotificationUpdatereadstatusPost | POST /collaboration/notification/updatereadstatus | DesignreviewApi.DefaultApi | collaborationOptions | OPTIONS /collaboration | DesignreviewApi.DefaultApi | markupsAddmarkupsOptions | OPTIONS /markups/addmarkups | DesignreviewApi.DefaultApi | markupsAddmarkupsPost | POST /markups/addmarkups | DesignreviewApi.DefaultApi | markupsDeletemarkupsOptions | OPTIONS /markups/deletemarkups | DesignreviewApi.DefaultApi | markupsDeletemarkupsPost | POST /markups/deletemarkups | DesignreviewApi.DefaultApi | markupsGetmarkupsOptions | OPTIONS /markups/getmarkups | DesignreviewApi.DefaultApi | markupsGetmarkupsPost | POST /markups/getmarkups | DesignreviewApi.DefaultApi | markupsGetnxmarkupsOptions | OPTIONS /markups/getnxmarkups | DesignreviewApi.DefaultApi | markupsGetnxmarkupsPost | POST /markups/getnxmarkups | DesignreviewApi.DefaultApi | markupsOptions | OPTIONS /markups | DesignreviewApi.DefaultApi | modelsAddmodelsOptions | OPTIONS /models/addmodels | DesignreviewApi.DefaultApi | modelsAddmodelsPost | POST /models/addmodels | DesignreviewApi.DefaultApi | modelsGetmodelpolicyOptions | OPTIONS /models/getmodelpolicy | DesignreviewApi.DefaultApi | modelsGetmodelpolicyPost | POST /models/getmodelpolicy | DesignreviewApi.DefaultApi | modelsGetmodelpreviewpolicyOptions | OPTIONS /models/getmodelpreviewpolicy | DesignreviewApi.DefaultApi | modelsGetmodelpreviewpolicyPost | POST /models/getmodelpreviewpolicy | DesignreviewApi.DefaultApi | modelsGetmymodelsOptions | OPTIONS /models/getmymodels | DesignreviewApi.DefaultApi | modelsGetmymodelsPost | POST /models/getmymodels | DesignreviewApi.DefaultApi | modelsGetrecentmodelsOptions | OPTIONS /models/getrecentmodels | DesignreviewApi.DefaultApi | modelsGetrecentmodelsPost | POST /models/getrecentmodels | DesignreviewApi.DefaultApi | modelsGetsharedmodelsOptions | OPTIONS /models/getsharedmodels | DesignreviewApi.DefaultApi | modelsGetsharedmodelsPost | POST /models/getsharedmodels | DesignreviewApi.DefaultApi | simAddsimdataOptions | OPTIONS /sim/addsimdata | DesignreviewApi.DefaultApi | simAddsimdataPost | POST /sim/addsimdata | DesignreviewApi.DefaultApi | simGetsimdataOptions | OPTIONS /sim/getsimdata | DesignreviewApi.DefaultApi | simGetsimdataPost | POST /sim/getsimdata | DesignreviewApi.DefaultApi | simOptions | OPTIONS /sim | DesignreviewApi.DefaultApi | usersGetprofileOptions | OPTIONS /users/getprofile | DesignreviewApi.DefaultApi | usersGetprofilePost | POST /users/getprofile | DesignreviewApi.DefaultApi | usersGetreviewersOptions | OPTIONS /users/getreviewers | DesignreviewApi.DefaultApi | usersGetreviewersPost | POST /users/getreviewers | DesignreviewApi.DefaultApi | usersOptions | OPTIONS /users |

Documentation for Models

• DesignreviewApi.AddMarkupsInput
• DesignreviewApi.AddMarkupsOutput
• DesignreviewApi.AddModelsInput
• DesignreviewApi.AddModelsOutput
• DesignreviewApi.AddSimDataInput
• DesignreviewApi.AddSimDataOutput
• DesignreviewApi.DeleteMarkupsInput
• DesignreviewApi.DeleteMarkupsInputMarkups
• DesignreviewApi.DeleteMarkupsOutput
• DesignreviewApi.DeleteNotificationsInput
• DesignreviewApi.DeleteNotificationsOutput
• DesignreviewApi.Empty
• DesignreviewApi.FilePolicy
• DesignreviewApi.GetMarkupsInput
• DesignreviewApi.GetModelPolicyInput
• DesignreviewApi.GetModelPolicyOutput
• DesignreviewApi.GetModelPreviewPolicyInput
• DesignreviewApi.GetModelPreviewPolicyOutput
• DesignreviewApi.GetMyModelsInput
• DesignreviewApi.GetMyModelsOutput
• DesignreviewApi.GetNXMarkupsInput
• DesignreviewApi.GetNXMarkupsOutput
• DesignreviewApi.GetNXMarkupsOutputMarkups
• DesignreviewApi.GetNotificationsInput
• DesignreviewApi.GetNotificationsOutput
• DesignreviewApi.GetRecentModelsInput
• DesignreviewApi.GetRecentModelsOutput
• DesignreviewApi.GetReviewersInput
• DesignreviewApi.GetReviewersOutput
• DesignreviewApi.GetSharedModelsInput
• DesignreviewApi.GetSharedModelsOutput
• DesignreviewApi.GetSimDataInput
• DesignreviewApi.GetSimDataOutput
• DesignreviewApi.GetUserProfileInput
• DesignreviewApi.GetUserProfileOutput
• DesignreviewApi.Markup
• DesignreviewApi.MarkupCameraInfo
• DesignreviewApi.Model
• DesignreviewApi.Notification
• DesignreviewApi.Reviewer
• DesignreviewApi.SimData
• DesignreviewApi.SimDataMovedParts
• DesignreviewApi.SimDataSimData
• DesignreviewApi.UpdateReadStatusInput
• DesignreviewApi.UpdateReadStatusInputNotifications
• DesignreviewApi.UserProfile

Documentation for Authorization

All endpoints do not require authorization.