@magic.batua/recharge/Source/Mobile/TelecomCircle.ts

The Recharge module manages all the mobile prepaid, datacard and DTH recharge functionalities of the Magic Batua platform.

/**
 *  @module     Telecom
 *  @overview   Defines telecom circle related classes and interfaces.
 *  
 *  @author     Animesh Mishra <hello@animesh.ltd>
 *  @copyright  © Animesh Ltd. All Rights Reserved.
 */

/** @exports Telecom */
export var description = "Defines telecom circle related classes and interfaces."

/**
 *  Defines the shape of a telecom `Circle`
 */
export interface Circle {
    code: string,
    name: string,
    localisedName: string
}

/**
 *  Given Rocket in Pocket's circle code, returns a fully initialised `Circle`
 *  instance.
 *  
 *  @param {string} code    Circle code as per Rocket in Pocket API Manual
 *  
 *  @returns {Circle | null} `null` if no match is found. Otherwise, a `Circle`
 *                           instance.
 */
export function CircleWithCode(code: string): Circle | null {
    let allCircles = AllCircles()
    for (var circle of allCircles) {
        if(circle.code == code) { return circle }
    }
    return null
}

/**
 *  Returns all circles supported by the Rocket in Pocket API.
 *  
 *  @returns {Array<Circle>} All `Circle` supported by Rocket in Pocket API.
 */
export function AllCircles(): Array<Circle> {
    return [
        {
            code: "AP",
            name: "Andhra Pradesh & Telangana",
            localisedName: "ఆంధ్రప్రదేశ్ మరియు తెలంగాణ"
        },
        {
            code: "AS",
            name: "Assam",
            localisedName: "আসাম"
        },
        {
            code: "BR",
            name: "Bihar & Jharkhand",
            localisedName: "बिहार व झारखंड"
        },
        {
            code: "CH",
            name: "Chennai",
            localisedName: "சென்னை"
        },
        {
            code: "DL",
            name: "Delhi & NCR",
            localisedName: "दिल्ली व एन॰सी॰आर॰"
        },
        {
            code: "GJ",
            name: "Gujarat",
            localisedName: "ગુજરાત"
        },
        {
            code: "HP",
            name: "Himachal Pradesh",
            localisedName: "हिमाचल प्रदेश"
        },
        {
            code: "HR",
            name: "Haryana",
            localisedName: "हरियाणा"
        },
        {
            code: "JK",
            name: "Jammu & Kashmir",
            localisedName: "जम्मू व कश्मीर | جموں و کشمیر"
        },
        {
            code: "KA",
            name: "Karnataka",
            localisedName: "ಕರ್ನಾಟಕ"
        },
        {
            code: "KL",
            name: "Kerala",
            localisedName: "കേരളം"
        },
        {
            code: "KO",
            name: "Kolkata",
            localisedName: "কলকাতা"
        },
        {
            code: "MH",
            name: "Maharashtra & Goa",
            localisedName: "महाराष्ट्र आणि गोवा"
        },
        {
            code: "MP",
            name: "Madhya Pradesh & Chhattisgarh",
            localisedName: "मध्य प्रदेश व छत्तीसगढ़"
        },
        {
            code: "MU",
            name: "Mumbai",
            localisedName: "मुंबई"
        },
        {
            code: "NE",
            name: "North East",
            localisedName: "उत्तर-पूर्वी भारत"
        },
        {
            code: "OR",
            name: "Odisha",
            localisedName: ""
        },
        {
            code: "PB",
            name: "Punjab",
            localisedName: "ਪੰਜਾਬ"
        },
        {
            code: "RJ",
            name: "Rajasthan",
            localisedName: "राजस्थान"
        },
        {
            code: "TN",
            name: "Tamil Nadu",
            localisedName: "தமிழ்நாடு"
        },
        {
            code: "UE",
            name: "Eastern Uttar Pradesh",
            localisedName: "पूर्वी उत्तर प्रदेश"
        },
        {
            code: "UW",
            name: "Western Uttar Pradesh",
            localisedName: "पश्चिमी उत्तर प्रदेश"
        },
        {
            code: "WB",
            name: "West Bengal",
            localisedName: "পশ্চিমবঙ্গ"
        }
    ]
}