zaun v2.7.1

zaun

Zaun - JavaScript client for zaun Zaun service - Q2 This SDK is automatically generated by the Swagger Codegen project:

• API version: 2.7.0
• Package version: 2.7.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 zaun --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 zaun from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('zaun') 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 Zaun = require('zaun');

var api = new Zaun.AuthApi()

var body = new Zaun.CLILogin(); // {CLILogin} CLI Login payload


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

Documentation for API Endpoints

All URIs are relative to https://virtserver.swaggerhub.com/kata.ai/zaun-q2/1.0.0

Documentation for Models

• Zaun.Body
• Zaun.Body1
• Zaun.Body2
• Zaun.Body3
• Zaun.Body4
• Zaun.Bot
• Zaun.BotFlows
• Zaun.CLILogin
• Zaun.Channel
• Zaun.Cms
• Zaun.CmsMeta
• Zaun.CmsMetaModules
• Zaun.CmsPages
• Zaun.CmsPagesLabelpage
• Zaun.CmsPagesLabelpageForms
• Zaun.CmsRevisionList
• Zaun.CmsSettings
• Zaun.CmsSettingsAppearance
• Zaun.Conversation
• Zaun.Deployment
• Zaun.Element
• Zaun.Environment
• Zaun.EnvironmentChannel
• Zaun.EnvironmentDashboard
• Zaun.ErrorLog
• Zaun.ErrorLogData
• Zaun.ExecActions
• Zaun.ExecFlow
• Zaun.ExecIntent
• Zaun.ExecStateMapper
• Zaun.Form
• Zaun.GeistEntity
• Zaun.InlineResponse200
• Zaun.InlineResponse2001
• Zaun.InlineResponse20010
• Zaun.InlineResponse20011
• Zaun.InlineResponse20012
• Zaun.InlineResponse20013
• Zaun.InlineResponse20013EntityName
• Zaun.InlineResponse20013Result
• Zaun.InlineResponse20014
• Zaun.InlineResponse20015
• Zaun.InlineResponse20016
• Zaun.InlineResponse20017
• Zaun.InlineResponse20018
• Zaun.InlineResponse20019
• Zaun.InlineResponse2002
• Zaun.InlineResponse2003
• Zaun.InlineResponse2004
• Zaun.InlineResponse2004Members
• Zaun.InlineResponse2005
• Zaun.InlineResponse2006
• Zaun.InlineResponse2007
• Zaun.InlineResponse2008
• Zaun.InlineResponse2009
• Zaun.Login
• Zaun.LoginImpersonate
• Zaun.Message
• Zaun.Module
• Zaun.Nlu
• Zaun.Page
• Zaun.ProcessedMessage
• Zaun.Project
• Zaun.Session
• Zaun.SessionHistory
• Zaun.Team
• Zaun.Token
• Zaun.TokenImpersonate
• Zaun.User

Documentation for Authorization

Bearer

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