@magic.batua/utility
Version:
The Utility module manages all the utility bills functionalities of the Magic Batua platform.
890 lines (242 loc) • 11.4 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Home - Postman Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Electricity.html">Electricity</a><ul class='methods'><li data-type='method'><a href="Electricity.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="Electricity.html#.GetProviders">GetProviders</a></li><li data-type='method'><a href="Electricity.html#Pay">Pay</a></li><li data-type='method'><a href="Electricity.html#Validate">Validate</a></li></ul></li><li><a href="Gas.html">Gas</a><ul class='methods'><li data-type='method'><a href="Gas.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="Gas.html#.GetProviders">GetProviders</a></li><li data-type='method'><a href="Gas.html#Pay">Pay</a></li></ul></li><li><a href="Insurance.html">Insurance</a><ul class='methods'><li data-type='method'><a href="Insurance.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="Insurance.html#.GetProviders">GetProviders</a></li><li data-type='method'><a href="Insurance.html#Pay">Pay</a></li></ul></li><li><a href="Provider.html">Provider</a><ul class='methods'><li data-type='method'><a href="Provider.html#.InitList">InitList</a></li><li data-type='method'><a href="Provider.html#.WithCode">WithCode</a></li></ul></li><li><a href="UtilityBill.html">UtilityBill</a></li></ul><h3>Modules</h3><ul><li><a href="module-UtilityError.html">UtilityError</a><ul class='methods'><li data-type='method'><a href="module-UtilityError.html#~Check">Check</a></li></ul></li></ul>
</nav>
<div id="main">
<section>
<header>
<h2>
index.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>UtilityBill</code> class</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Electricity.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Electricity</code> class</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_Electricity.js.html">Source/Electricity.js</a>, <a href="Source_Electricity.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Gas.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Gas</code> class</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_Gas.js.html">Source/Gas.js</a>, <a href="Source_Gas.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Insurance.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Insurance</code> class</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_Insurance.js.html">Source/Insurance.js</a>, <a href="Source_Insurance.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Provider.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the utility service <code>Provider</code> class</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_Provider.js.html">Source/Provider.js</a>, <a href="Source_Provider.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/RIPCreds.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the credentials required by the Rocket in Pocket API</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© 2018 Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_RIPCreds.js.html">Source/RIPCreds.js</a>, <a href="Source_RIPCreds.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/StatusResponse.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the interface for the response returned by
check payment status API.</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_StatusResponse.js.html">Source/StatusResponse.js</a>, <a href="Source_StatusResponse.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/UtilityError.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines methods that parse Rocket in Pocket response and look for errors.</p></div>
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li><a href="mailto:hello@animesh.ltd">Animesh Mishra</a></li>
</ul>
</dd>
<dt class="tag-copyright">Copyright:</dt>
<dd class="tag-copyright"><ul class="dummy"><li>© Animesh Ltd. All Rights Reserved.</li></ul></dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="Source_UtilityError.js.html">Source/UtilityError.js</a>, <a href="Source_UtilityError.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Documentation generated at Tue Mar 20 2018 03:29:29 GMT+0530 (IST)
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>