estuary_api v0.0.0

estuary_api

EstuaryApi - JavaScript client for estuary_api This is the API for the Estuary application. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.0
• Package version: 0.0.0
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://docs.estuary.tech/feedback

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

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install GIT_USER_ID/GIT_REPO_ID --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 EstuaryApi = require('estuary_api');

var defaultClient = EstuaryApi.ApiClient.instance;

// Configure API key authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearerAuth.apiKeyPrefix['Authorization'] = "Token"

var api = new EstuaryApi.AdminApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.adminPeeringPeersDelete(callback);

Documentation for API Endpoints

All URIs are relative to https://api.estuary.tech

Documentation for Models

• EstuaryApi.MainCollection
• EstuaryApi.MainCreateCollectionBody
• EstuaryApi.MainEstimateDealBody
• EstuaryApi.MainGetApiKeysResp
• EstuaryApi.MainImportDealBody
• EstuaryApi.MainUserStatsResponse
• EstuaryApi.UtilContentAddIpfsBody
• EstuaryApi.UtilContentAddResponse
• EstuaryApi.UtilHttpError

Documentation for Authorization

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header