ai-client

AiClient - JavaScript client for ai-client This is the rest API for sutoga AI 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 ai-client --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 ai-client from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

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

    npm install YOUR_USERNAME/ai-client --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 AiClient = require('ai-client');

var defaultClient = AiClient.ApiClient.instance;

// Configure HTTP basic authorization: basicAuth
var basicAuth = defaultClient.authentications['basicAuth'];
basicAuth.username = 'YOUR USERNAME'
basicAuth.password = 'YOUR PASSWORD'

var api = new AiClient.AiApi()

var opts = { 
  'body': new AiClient.Body() // {Body} 
};
api.aiRunPost(opts).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- AiClient.AiApi | aiRunPost | POST /ai_run | AiClient.CucumberFeaturesApi | createCucumberFeature | POST /api/{b2bPartnerId}/cucumber-features | AiClient.CucumberFeaturesApi | getCucumberFeature | GET /api/{b2bPartnerId}/cucumber-features/{CucumberFeatureId} | AiClient.CucumberFeaturesApi | getCucumberFeatures | GET /api/{b2bPartnerId}/cucumber-features | AiClient.CucumberFeaturesApi | updateCucumberFeature | PUT /api/{b2bPartnerId}/cucumber-features/{CucumberFeatureId} | AiClient.FactsApi | factsGet | GET /facts |

Documentation for Models

• AiClient.Body
• AiClient.Brick
• AiClient.Context
• AiClient.CucumberFeature
• AiClient.Fact
• AiClient.InlineResponse200
• AiClient.ItemOfComments
• AiClient.ItemOfEvents
• AiClient.ItemOfInputs
• AiClient.ItemOfOptionSwipe
• AiClient.ItemOfPostbackData
• AiClient.ItemOfProductSwipe
• AiClient.ItemOfRatings
• AiClient.ItemOfSuggestedOptions
• AiClient.ItemOfSuggestedProducts

Documentation for Authorization

basicAuth

• Type: HTTP basic authentication