flock_api

FlockApi - JavaScript client for flock_api Integrate your apps with flock using this API This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.4
• Package version: 0.0.4
• Build date: 2016-09-22T16:01:36.449Z
• Build package: class 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 flock_api --save

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/flock_api then install it via:

    npm install YOUR_USERNAME/flock_api --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.

Getting Started

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

var FlockApi = require('flock_api');

var api = new FlockApi.AppApi()

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

Documentation for API Endpoints

All URIs are relative to https://api.flock-staging.co/v1

Class	Method	HTTP request	Description
FlockApi.AppApi	rosterListContactsPost	POST /roster.listContacts	Lists all users
FlockApi.ChatApi	chatSendMessagePost	POST /chat.sendMessage	Send Message
FlockApi.GroupsApi	groupsGetInfoPost	POST /groups.getInfo	Get group info
FlockApi.UsersApi	usersGetInfoPost	POST /users.getInfo	get user info

Documentation for Models

• FlockApi.Group
• FlockApi.GroupId
• FlockApi.Groups
• FlockApi.Message
• FlockApi.MessageDetails
• FlockApi.PublicProfile
• FlockApi.User

Documentation for Authorization

key

• Type: API key
• API key parameter name: X-Flock-User-Token
• Location: HTTP header