Module: index

JS API client generated by OpenAPI Generator.
The index module provides access to constructors for all the classes which comprise the public API.

An AMD (recommended!) or CommonJS application will generally do something equivalent to the following:

var OpenApiDefinition = require('index'); // See note below*.
var xxxSvc = new OpenApiDefinition.XxxApi(); // Allocate the API class we're going to use.
var yyyModel = new OpenApiDefinition.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...
*NOTE: For a top-level AMD script, use require(['index'], function(){...}) and put the application logic within the callback function.

A non-AMD browser application (discouraged) might do something like this:

var xxxSvc = new OpenApiDefinition.XxxApi(); // Allocate the API class we're going to use.
var yyy = new OpenApiDefinition.Yyy(); // Construct a model instance.
yyyModel.someProperty = 'someValue';
...
var zzz = xxxSvc.doSomething(yyyModel); // Invoke the service.
...

Version:
  • v0
Source:

Members

(static) ApiClient

The ApiClient constructor.
Properties:
Type Description
module:ApiClient
Source: