community_service v1.0.1
community_service
CommunityService - JavaScript client for community_service Bizzbuzz development API 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 community_service --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 community_service from, and run:
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
You should now be able to require('community_service')
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/community_service then install it via:
npm install YOUR_USERNAME/community_service --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 CommunityService = require('community_service');
var api = new CommunityService.CompanyAPIApi()
var opts = {
'body': new CommunityService.Company() // {Company}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.addCompany(opts, callback);
Documentation for API Endpoints
All URIs are relative to http://bizzbuzz-uat.herokuapp.com/v1
Class | Method | HTTP request | Description |
---|---|---|---|
CommunityService.CompanyAPIApi | addCompany | POST /company | addCompany |
CommunityService.CompanyAPIApi | getCompany | GET /company | getCompany |
CommunityService.CompanyAPIApi | searchCompany | GET /company/search | searchCompany |
CommunityService.CompanyAPIApi | updateCompany | PATCH /company/{uuid} | updateCompany |
CommunityService.NetworkAPIApi | connectionDisconnected | DELETE /network/disconnect | Disconnect the the companies in connection |
CommunityService.NetworkAPIApi | createNetworkRequest | POST /network/request | Makes the request to join network |
CommunityService.NetworkAPIApi | incomingRequests | GET /network/request | Returns the list of incoming request |
CommunityService.NetworkAPIApi | isConnectionRequested | GET /network/request/check | checks whether a request is already sent or not |
CommunityService.NetworkAPIApi | networkCompanies | GET /network | Return the list of companies in the network |
CommunityService.NetworkAPIApi | networkRequestHandler | PATCH /network/request/{requestId} | Handling Acceptance and rejection of incoming network request |
Documentation for Models
- CommunityService.BusinessDomain
- CommunityService.BusinessType
- CommunityService.Company
- CommunityService.GenericResponseMessage
- CommunityService.IsRequested
- CommunityService.NetworkConnections
- CommunityService.NetworkRequest
Documentation for Authorization
All endpoints do not require authorization.