checkbook.io-sdk/docs/index.html at master · Villa-Rentals/checkbook.io-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
<!DOCTYPE html>
<html>
<head>
  <meta charset="utf-8">
  <base data-ice="baseUrl">
  <title data-ice="title">Home | checkbook.io-sdk</title>
  <link type="text/css" rel="stylesheet" href="css/style.css">
  <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css">
  <script src="script/prettify/prettify.js"></script>
  <script src="script/manual.js"></script>
<meta name="description" content="Unofficial SDK to access the Checkbook.io API"><meta property="twitter:card" content="summary"><meta property="twitter:title" content="checkbook.io-sdk"><meta property="twitter:description" content="Unofficial SDK to access the Checkbook.io API"></head>
<body class="layout-container" data-ice="rootContainer">

<header>
  <a href="./">Home</a>

  <a href="identifiers.html">Reference</a>
  <a href="source.html">Source</a>

  <div class="search-box">
  <span>
    <img src="./image/search.png">
    <span class="search-input-edge"></span><input class="search-input"><span class="search-input-edge"></span>
  </span>
    <ul class="search-result"></ul>
  </div>
<a style="position:relative; top:3px;" href="https://github.com/Villa-Rentals/checkbook.io-sdk.git"><img width="20px" src="./image/github.png"></a></header>

<nav class="navigation" data-ice="nav"><div>
  <ul>

  <li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/index.js~Checkbook.html">Checkbook</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#controllers">controllers</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/bank.js~Bank.html">Bank</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/check.js~Check.html">Check</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/invoice.js~Invoice.html">Invoice</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/subscription.js~Subscription.html">Subscription</a></span></span></li>
<li data-ice="doc"><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/user.js~User.html">User</a></span></span></li>
<li data-ice="doc"><a data-ice="dirPath" class="nav-dir-path" href="identifiers.html#controllers-abstract">controllers/abstract</a><span data-ice="kind" class="kind-class">C</span><span data-ice="name"><span><a href="class/src/controllers/abstract/base.js~Base.html">Base</a></span></span></li>
</ul>
</div>
</nav>

<div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><h1 id="checkbook-io-api">Checkbook.io API</h1><p><a href="https://checkbook.io/">Checkbook.io</a> API for sending checks online and offline.</p>
<p>This module lets you send, query, charge, and interact with the checkbook.io API in your Node.js applications.</p>
<h2 id="install">Install</h2><pre><code class="lang-js"><code class="source-code prettyprint">$ npm i -s git+ssh://git@github.com:Villa-Rentals/checkbook.io-sdk.git</code>
</code></pre>
<h2 id="usage">Usage</h2><h4 id="configure-strategy">Configure Strategy</h4><p>The Checkbook.io sdk API authenticates using the a key and secret. These tokens are obtained through the <a href="https://checkbook.io/login">Checkbook.io portal</a>. The SDK requires the realm of the API (test, sandbox, live) and long with the previously mentioned tokens.</p>
<pre><code class="lang-js"><code class="source-code prettyprint">new Checkbook(&apos;stage&apos;, key, secret);</code>
</code></pre>
<h4 id="making-requests">Making Requests</h4><p>See the <a href="docs/index.html">documentation</a> for more information about the SDK.</p>
<h2 id="tests">Tests</h2><p>The key and secret are required for the tests to pass. These can be obtained through the <a href="https://checkbook.io/login">Checkbook.io portal</a>. Once these tokens have been acquired, create a .env file from the <a href=".env.example">.env.example</a> file and provide the tokens. These will be used to authenticate your requests.</p>
<pre><code class="lang-bash"><code class="source-code prettyprint">$ npm install --dev
$ npm test</code>
</code></pre>
<h2 id="license">License</h2><p><a href="http://opensource.org/licenses/MIT">The MIT License</a></p>
</div>
</div>

<footer class="footer">
  Generated by <a href="https://esdoc.org">ESDoc<span data-ice="esdocVersion">(1.0.4)</span><img src="./image/esdoc-logo-mini-black.png"></a>
</footer>

<script src="script/search_index.js"></script>
<script src="script/search.js"></script>
<script src="script/pretty-print.js"></script>
<script src="script/inherited-summary.js"></script>
<script src="script/test-summary.js"></script>
<script src="script/inner-link.js"></script>
<script src="script/patch-for-local.js"></script>
</body>
</html>