design_review_app_gateway

DesignReviewAppGateway - JavaScript client for design_review_app_gateway Design Review App Gateway This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• 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 design_review_app_gateway --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 design_review_app_gateway from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install YOUR_USERNAME/design_review_app_gateway --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 DesignReviewAppGateway = require('design_review_app_gateway');

var api = new DesignReviewAppGateway.MarkupManagementApi()

var sessionId = "sessionId_example"; // {String} The unique identifier of one session.

var partId = "partId_example"; // {String} The part ID.


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

Documentation for API Endpoints

All URIs are relative to http://localhost/v1

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- DesignReviewAppGateway.MarkupManagementApi | markupPartIdGet | GET /markup/{partId} | DesignReviewAppGateway.MarkupManagementApi | markupPartIdPut | PUT /markup/{partId} | DesignReviewAppGateway.PartManagementApi | partsAttrsPartIdGet | GET /parts/attrs/{partId} | DesignReviewAppGateway.PartManagementApi | partsCreatedbymeGet | GET /parts/createdbyme | DesignReviewAppGateway.PartManagementApi | partsGet | GET /parts | DesignReviewAppGateway.PartManagementApi | partsPartIdGet | GET /parts/{partId} | DesignReviewAppGateway.PartManagementApi | partsRecentGet | GET /parts/recent | DesignReviewAppGateway.SessionManagementApi | usersLoginPost | POST /users/login | DesignReviewAppGateway.SessionManagementApi | usersLogoutPost | POST /users/logout | DesignReviewAppGateway.SessionManagementApi | usersRegisterPut | PUT /users/register | DesignReviewAppGateway.SimulationManagementApi | simPartIdGet | GET /sim/{partId} |

Documentation for Models

• DesignReviewAppGateway.IPart
• DesignReviewAppGateway.IPartAttribute
• DesignReviewAppGateway.IPartMarkupData
• DesignReviewAppGateway.IPartMetadata
• DesignReviewAppGateway.IPartSimData
• DesignReviewAppGateway.IServiceData
• DesignReviewAppGateway.ISession
• DesignReviewAppGateway.IUser

Documentation for Authorization

All endpoints do not require authorization.