delve_client_sdk

DelveClientSdk - JavaScript client for delve_client_sdk This is a Client SDK for Delve API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.2.0
• Package version: 1.2.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen For more information, please visit https://www.relational.ai/support

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 delve_client_sdk --save

Finally, you need to build the module:

npm run build

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

To use the link you just defined in your project, switch to the directory you want to use your delve_client_sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

You can install the library via git:

    npm install RelationalAI-oss/DelveJavaScriptClientSDK --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):

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
      }
    }
  ]
}

Running Tests

To run the tests, cd into one of the directories below (e.g. client), and then after running npm install per above, you can run:

    npm run test

Getting Started

Please follow the installation instruction and execute the following JS code:

var DelveClientSdk = require('delve_client_sdk');


var api = new DelveClientSdk.DefaultApi()
var transaction = new DelveClientSdk.Transaction(); // {Transaction} Optional description in *Markdown*
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.transactionPost(transaction, callback);

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:8010

Class	Method	HTTP request	Description
DelveClientSdk.DefaultApi	transactionPost	POST /transaction	Issues a transaction to be executed

Documentation for Models

• DelveClientSdk.AbstractProblem
• DelveClientSdk.Action
• DelveClientSdk.ActionResult
• DelveClientSdk.Appl
• DelveClientSdk.Area
• DelveClientSdk.ArityMismatchError
• DelveClientSdk.CSVFileSchema
• DelveClientSdk.CSVFileSyntax
• DelveClientSdk.CardinalityAction
• DelveClientSdk.CardinalityActionResult
• DelveClientSdk.ClientProblem
• DelveClientSdk.CollectProblemsAction
• DelveClientSdk.CollectProblemsActionResult
• DelveClientSdk.ComparisonChainError
• DelveClientSdk.Cons
• DelveClientSdk.ExceptionProblem
• DelveClientSdk.FileSchema
• DelveClientSdk.FileSyntax
• DelveClientSdk.FrontProblem
• DelveClientSdk.ICViolation
• DelveClientSdk.ImportAction
• DelveClientSdk.ImportActionResult
• DelveClientSdk.InfraError
• DelveClientSdk.InstallAction
• DelveClientSdk.InstallActionResult
• DelveClientSdk.IntegrityConstraintProblem
• DelveClientSdk.IntegrityConstraintViolation
• DelveClientSdk.JSONFileSchema
• DelveClientSdk.JSONFileSyntax
• DelveClientSdk.LabeledAction
• DelveClientSdk.LabeledActionResult
• DelveClientSdk.LinkedList
• DelveClientSdk.ListEdbAction
• DelveClientSdk.ListEdbActionResult
• DelveClientSdk.ListSourceAction
• DelveClientSdk.ListSourceActionResult
• DelveClientSdk.Literal
• DelveClientSdk.LoadData
• DelveClientSdk.LoadDataAction
• DelveClientSdk.LoadDataActionResult
• DelveClientSdk.ModifyWorkspaceAction
• DelveClientSdk.ModifyWorkspaceActionResult
• DelveClientSdk.Nil
• DelveClientSdk.OutputProblem
• DelveClientSdk.PairAnyValueAnyValue
• DelveClientSdk.ParseAction
• DelveClientSdk.ParseActionResult
• DelveClientSdk.PersistProblem
• DelveClientSdk.Point
• DelveClientSdk.QueryAction
• DelveClientSdk.QueryActionResult
• DelveClientSdk.Range
• DelveClientSdk.RelKey
• DelveClientSdk.Relation
• DelveClientSdk.SetOptionsAction
• DelveClientSdk.SetOptionsActionResult
• DelveClientSdk.Source
• DelveClientSdk.SyntaxError
• DelveClientSdk.SyntaxNode
• DelveClientSdk.Token
• DelveClientSdk.Transaction
• DelveClientSdk.TransactionResult
• DelveClientSdk.UndefinedError
• DelveClientSdk.UpdateAction
• DelveClientSdk.UpdateActionResult
• DelveClientSdk.WorkspaceLoadProblem

Documentation for Authorization

All endpoints do not require authorization.