@magic.batua/recharge

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Operator - Postman Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <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"> <h1 class="page-title">Operator</h1> <section> <header> <h2> Operator </h2> <div class="class-description"><p>The <code>Operator</code> class models a telecom operator and/or other service providers that offer products that can be recharged through the Magic Batua platform. So prepaid mobile companies, DTH operators and datacard companies all are instances of <code>Operator</code>.</p></div> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="Operator"><span class="type-signature"></span>new Operator<span class="signature">(json)</span><span class="type-signature"></span></h4> <div class="description"> <p>Initialises an <code>Operator</code> instance.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>json</code></td> <td class="type"> <span class="param-type">GetOperatorResponse</span> </td> <td class="description last"><p>The <code>GetOperatorResponse</code> is defined in <code>Source/Operator.ts</code>.</p></td> </tr> </tbody> </table> <dl class="details"> <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#line16">line 16</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".InitList"><span class="type-signature">(static) </span>InitList<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Given an array of provider responses from Rocket in Pocket, instantiates and returns a <code>Operator</code> array.</p> </div> <dl class="details"> <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#line33">line 33</a> </li></ul></dd> </dl> <h4 class="name" id=".WithCode"><span class="type-signature">(static) </span>WithCode<span class="signature">()</span><span class="type-signature"></span></h4> <div class="description"> <p>Returns an <code>Operator</code> with the given provider <code>code</code> amongst the list of <code>operators</code> given. If no match is found, returns <code>null</code>.</p> </div> <dl class="details"> <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#line44">line 44</a> </li></ul></dd> </dl> </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>