@magic.batua/recharge
Version:
The Recharge module manages all the mobile prepaid, datacard and DTH recharge functionalities of the Magic Batua platform.
1,302 lines (346 loc) • 16.9 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="Datacard.html">Datacard</a><ul class='methods'><li data-type='method'><a href="Datacard.html#.AllOperators">AllOperators</a></li><li data-type='method'><a href="Datacard.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="Datacard.html#Recharge">Recharge</a></li></ul></li><li><a href="DTH.html">DTH</a><ul class='methods'><li data-type='method'><a href="DTH.html#.AllOperators">AllOperators</a></li><li data-type='method'><a href="DTH.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="DTH.html#Recharge">Recharge</a></li></ul></li><li><a href="Fixedline.html">Fixedline</a><ul class='methods'><li data-type='method'><a href="Fixedline.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="Fixedline.html#.GetOperators">GetOperators</a></li><li data-type='method'><a href="Fixedline.html#Pay">Pay</a></li></ul></li><li><a href="MobilePlan.html">MobilePlan</a></li><li><a href="MobilePostpaid.html">MobilePostpaid</a><ul class='methods'><li data-type='method'><a href="MobilePostpaid.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="MobilePostpaid.html#.GetOperators">GetOperators</a></li><li data-type='method'><a href="MobilePostpaid.html#Pay">Pay</a></li></ul></li><li><a href="MobilePrepaid.html">MobilePrepaid</a><ul class='methods'><li data-type='method'><a href="MobilePrepaid.html#.AllOperators">AllOperators</a></li><li data-type='method'><a href="MobilePrepaid.html#.CheckStatus">CheckStatus</a></li><li data-type='method'><a href="MobilePrepaid.html#.FindOperator">FindOperator</a></li><li data-type='method'><a href="MobilePrepaid.html#.GetPlans">GetPlans</a></li><li data-type='method'><a href="MobilePrepaid.html#Recharge">Recharge</a></li></ul></li><li><a href="Operator.html">Operator</a><ul class='methods'><li data-type='method'><a href="Operator.html#.InitList">InitList</a></li><li data-type='method'><a href="Operator.html#.WithCode">WithCode</a></li></ul></li></ul><h3>Modules</h3><ul><li><a href="module-RechargeError.html">RechargeError</a><ul class='methods'><li data-type='method'><a href="module-RechargeError.html#~Check">Check</a></li></ul></li><li><a href="module-Telecom.html">Telecom</a><ul class='methods'><li data-type='method'><a href="module-Telecom.html#~AllCircles">AllCircles</a></li><li data-type='method'><a href="module-Telecom.html#~CircleWithCode">CircleWithCode</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 model for a <code>RechargeBill</code></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="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/Datacard.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Datacard</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>© 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_Datacard.js.html">Source/Datacard.js</a>, <a href="Source_Datacard.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/DTH.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>DTH</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>© 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_DTH.js.html">Source/DTH.js</a>, <a href="Source_DTH.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Fixedline.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Fixedline</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>© 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_Fixedline.js.html">Source/Fixedline.js</a>, <a href="Source_Fixedline.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Mobile/MobilePlan.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>MobilePlan</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>© 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_Mobile_MobilePlan.js.html">Source/Mobile/MobilePlan.js</a>, <a href="Source_Mobile_MobilePlan.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Mobile/MobilePostpaid.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>MobilePostpaid</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>© 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_Mobile_MobilePostpaid.js.html">Source/Mobile/MobilePostpaid.js</a>, <a href="Source_Mobile_MobilePostpaid.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Mobile/MobilePrepaid.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>MobilePrepaid</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>© 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_Mobile_MobilePrepaid.js.html">Source/Mobile/MobilePrepaid.js</a>, <a href="Source_Mobile_MobilePrepaid.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Mobile/TelecomCircle.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines telecom circle related classes and interfaces.</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_Mobile_TelecomCircle.js.html">Source/Mobile/TelecomCircle.js</a>, <a href="Source_Mobile_TelecomCircle.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/Operator.js
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Defines the <code>Operator</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>© 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_Operator.js.html">Source/Operator.js</a>, <a href="Source_Operator.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
<section>
<header>
<h2>
Source/RechargeError.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_RechargeError.js.html">Source/RechargeError.js</a>, <a href="Source_RechargeError.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>© 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 the
<code>MobileRecharge.CheckStatus()</code> method.</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>
</div>
<br class="clear">
<footer>
Documentation generated at Tue Mar 20 2018 03:11:49 GMT+0530 (IST)
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>