Classes

GraphApi

Experimental chatbot API

Functions

postBackApi(processor, [acl]) ⇒ PostBackAPI

Create a postback API

validate(bot, validationRequestBody, postBackTest, textTest)

validateBotApi(botFactory, [postBackTest], [textTest], [acl]) ⇒ ValidateBotAPI

Test the bot configuration

conversationsApi(stateStorage, chatLogStorage, notifications, [acl], options) ⇒ ConversationsAPI

Create a conversations API for retrieving conversations and it's history

apiAuthorizer(args, ctx, acl) ⇒ boolean

If API call is authorized - use for own implementations of API endpoints

Typedefs

GraphQlResponse : object

RequestParams : object

PostBackAPI : object

ValidateBotAPI : object

conversation : object

StateStorage : object

ChatLogStorage : object

TextFilter ⇒ any

Function for filtration of string output

GraphApi

Experimental chatbot API

Kind: global class

• GraphApi
  • new GraphApi(apis, options)
  • .auditLog : AuditLog
  • ._gql ⇒ GqlLib
  • .request(body, headers, [wingbotToken], [params]) ⇒ Promise.<GraphQlResponse>

new GraphApi(apis, options)

graphApi.auditLog : AuditLog

Kind: instance property of GraphApi

graphApi._gql ⇒ GqlLib

Kind: instance property of GraphApi

graphApi.request(body, headers, [wingbotToken], [params]) ⇒ Promise.<GraphQlResponse>

Kind: instance method of GraphApi

postBackApi(processor, [acl]) ⇒ PostBackAPI

Create a postback API

Kind: global function

Example

const { GraphApi, postBackApi } = require('wingbot');

const api = new GraphApi([
    postBackApi(channel)
], {
    appToken: 'API-will-be-accessible-with-this-token-in-Authorization-header'
})

validate(bot, validationRequestBody, postBackTest, textTest)

Kind: global function

validateBotApi(botFactory, [postBackTest], [textTest], [acl]) ⇒ ValidateBotAPI

Test the bot configuration

Kind: global function

Example

const { GraphApi, validateBotApi, Tester } = require('wingbot');

const api = new GraphApi([
    validateBotApi(botFactory, 'start', 'hello')
], {
    token: 'wingbot-token'
})

// OR WITH FUNCTION

const api = new GraphApi([
    validateBotApi(botFactory, async (t, bot) => {
        const tester = new Tester(bot);

        tester.postBack('start');
    })
], {
    token: 'wingbot-token'
})

conversationsApi(stateStorage, chatLogStorage, notifications, [acl], options) ⇒ ConversationsAPI

Create a conversations API for retrieving conversations and it's history

Kind: global function

Example

const { GraphApi, conversationsApi } = require('wingbot');
const BOT_UPDATE_GROUPS = ['botEditor', 'botAdmin', 'botUser'];

function stateTextFilter (value, key) {
    if (key === 'credentials.password') {
        return '****';
    }
    return value;
}

const api = new GraphApi([
    conversationsApi(
        stateStorage, chatLogStorage, notifications, BOT_UPDATE_GROUPS,
        { stateTextFilter }
    )
], {
    token: 'my-secret-token'
});

apiAuthorizer(args, ctx, acl) ⇒ boolean

If API call is authorized - use for own implementations of API endpoints

Kind: global function

Example

const { apiAuthorizer } = require('wingbot');

function createApi (acl = null) {
    return {
         gqlEndpoint (args, ctx) {
             if (!apiAuthorizer(args, ctx, acl)) {
                 return null;
             }
         }
    }
}

GraphQlResponse : object

Kind: global typedef

RequestParams : object

Kind: global typedef

PostBackAPI : object

Kind: global typedef
Properties

ValidateBotAPI : object

Kind: global typedef
Properties

conversation : object

Kind: global typedef

StateStorage : object

Kind: global typedef
Properties

ChatLogStorage : object

Kind: global typedef
Properties

TextFilter ⇒ any

Function for filtration of string output

Kind: global typedef