RetailCRM-Mirror/mg-bot-api-client-js
1
0
Fork 0
mirror of synced 2024-11-22 04:26:02 +03:00
Code Issues Projects Releases Wiki Activity

Deploy retailcrm/mg-bot-api-client-js to github.com/retailcrm/mg-bot-api-client-js.git:gh-pages

Browse Source
This commit is contained in:
Deployment Bot (from Travis CI) 2020-08-18 11:34:59 +00:00
parent e0f026248f
commit 5a10fa2a24
8 changed files with 79 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
Client.html
View File

@ -117,6 +117,8 @@
</div>
@ -288,6 +290,8 @@
<h5>Throws:</h5>
@ -456,6 +460,8 @@
<h5>Throws:</h5>
@ -624,6 +630,8 @@
<h5>Throws:</h5>
@ -792,6 +800,8 @@
<h5>Throws:</h5>
@ -983,6 +993,8 @@
<h5>Throws:</h5>
@ -1174,6 +1186,8 @@
<h5>Throws:</h5>
@ -1344,6 +1358,8 @@
<h5>Returns:</h5>
@ -1497,6 +1513,8 @@
<h5>Returns:</h5>
@ -1650,6 +1668,8 @@
<h5>Returns:</h5>
@ -1803,6 +1823,8 @@
<h5>Returns:</h5>
@ -1956,6 +1978,8 @@
<h5>Returns:</h5>
@ -2109,6 +2133,8 @@
<h5>Returns:</h5>
@ -2262,6 +2288,8 @@
<h5>Returns:</h5>
@ -2415,6 +2443,8 @@
<h5>Returns:</h5>
@ -2568,6 +2598,8 @@
<h5>Returns:</h5>
@ -2719,6 +2751,8 @@
<h5>Throws:</h5>
@ -2889,6 +2923,8 @@
<h5>Returns:</h5>
@ -3042,6 +3078,8 @@
<h5>Returns:</h5>
@ -3087,7 +3125,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:12:08 GMT+0000 (UTC)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Tue Aug 18 2020 11:34:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>

1
_config.yml
View File

@ -1 +0,0 @@
theme: jekyll-theme-cayman

2
consts.js.html
View File

@ -254,7 +254,7 @@ export const msgTypeImage = 'image';
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:12:08 GMT+0000 (UTC)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Tue Aug 18 2020 11:34:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>

2
global.html
View File

@ -2122,7 +2122,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:12:08 GMT+0000 (UTC)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Tue Aug 18 2020 11:34:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>

33
index.html
View File

@ -46,9 +46,21 @@
<article><p><a href="https://travis-ci.org/retailcrm/mg-bot-api-client-js"><img src="https://img.shields.io/travis/retailcrm/mg-bot-api-client-js/master.svg?logo=travis&amp;style=flat-square" alt="Build Status"></a>
<a href="https://github.com/retailcrm/mg-bot-api-client-js/releases"><img src="https://img.shields.io/github/release/retailcrm/mg-bot-api-client-js.svg?style=flat-square" alt="GitHub release"></a>
<a href="https://www.npmjs.com/package/mg-api-client"><img src="https://img.shields.io/node/v/mg-api-client.svg?style=flat-square" alt="Node version"></a></p>
<h1>retailCRM Message Gateway Bot API JS client</h1><p>This is js retailCRM bot API client.</p>
<h1>Installation</h1><pre class="prettyprint source"><code>npm install --save mg-api-client</code></pre><p>In your file</p>
<h6>CommonJS</h6><pre class="prettyprint source"><code>var MgBotApiClient = require('mg-api-client');</code></pre><h6>es6</h6><pre class="prettyprint source"><code>import MgBotApiClient from 'mg-api-client';</code></pre><h1>Usage</h1><h4>Get users</h4><pre class="prettyprint source lang-javascript"><code>const api = new MgBotApiClient({
<h1>retailCRM Message Gateway Bot API JS client</h1>
<p>This is js retailCRM bot API client.</p>
<h1>Installation</h1>
<pre class="prettyprint source"><code>npm install --save mg-api-client
</code></pre>
<p>In your file</p>
<h6>CommonJS</h6>
<pre class="prettyprint source"><code>var MgBotApiClient = require('mg-api-client');
</code></pre>
<h6>es6</h6>
<pre class="prettyprint source"><code>import MgBotApiClient from 'mg-api-client';
</code></pre>
<h1>Usage</h1>
<h4>Get users</h4>
<pre class="prettyprint source lang-javascript"><code>const api = new MgBotApiClient({
host: 'https://api.example.com',
token: 'your bot token',
apiVersion: 'v1' // optional
@ -60,7 +72,10 @@ api.getUsers()
})
.catch(function (e) {
console.log(e);
});</code></pre><h4>Send message</h4><pre class="prettyprint source lang-javascript"><code>const api = new MgBotApiClient({
});
</code></pre>
<h4>Send message</h4>
<pre class="prettyprint source lang-javascript"><code>const api = new MgBotApiClient({
host: 'https://api.example.com',
token: 'your bot token',
apiVersion: 'v1' // optional
@ -79,7 +94,10 @@ api.sendMessage(message)
})
.catch(function (e) {
console.log(e);
});</code></pre><h4>Websocket Example</h4><pre class="prettyprint source lang-javascript"><code>const WebSocket = require('ws');
});
</code></pre>
<h4>Websocket Example</h4>
<pre class="prettyprint source lang-javascript"><code>const WebSocket = require('ws');
const api = new MgBotApiClient({
host: 'https://api.example.com',
@ -110,7 +128,8 @@ ws.on('message', function (content) {
console.log(e);
})
}
});</code></pre></article>
});
</code></pre></article>
</section>
@ -127,7 +146,7 @@ ws.on('message', function (content) {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:12:08 GMT+0000 (UTC)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Tue Aug 18 2020 11:34:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>

18
scripts/linenumber.js
View File

@ -1,12 +1,12 @@
/*global document */
(function() {
var source = document.getElementsByClassName('prettyprint source linenums');
var i = 0;
var lineNumber = 0;
var lineId;
var lines;
var totalLines;
var anchorHash;
(() => {
const source = document.getElementsByClassName('prettyprint source linenums');
let i = 0;
let lineNumber = 0;
let lineId;
let lines;
let totalLines;
let anchorHash;
if (source && source[0]) {
anchorHash = document.location.hash.substring(1);
@ -15,7 +15,7 @@
for (; i < totalLines; i++) {
lineNumber++;
lineId = 'line' + lineNumber;
lineId = `line${lineNumber}`;
lines[i].id = lineId;
if (lineId === anchorHash) {
lines[i].className += ' selected';

4
styles/jsdoc-default.css
View File

@ -273,7 +273,7 @@ tr > th:last-child { border-right: 1px solid #ddd; }
margin: 0;
}
.prettyprint
.source
{
border: 1px solid #ddd;
width: 80%;
@ -284,7 +284,7 @@ tr > th:last-child { border-right: 1px solid #ddd; }
width: inherit;
}
.prettyprint code
.source code
{
font-size: 100%;
line-height: 18px;

2
v1_client.js.html
View File

@ -283,7 +283,7 @@ export default class Client {
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Mar 07 2019 08:12:08 GMT+0000 (UTC)
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.5</a> on Tue Aug 18 2020 11:34:54 GMT+0000 (Coordinated Universal Time)
</footer>
<script> prettyPrint(); </script>