def __autoRefresh(self, response, url, data):
"""Refresh the token automatically after it expires
Args:
response (response object): Response object
url (string): HTTP URL
data (string): HTTP data
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
"""
#! If token is expired
if response.json(
)['responseHeader']['responseDescDisplay'] == 'LGN2001':
refreshResponse = self.refreshToken()
#! If token refreshed successfully, request with new token and return the response
if refreshResponse.responseHeader['responseCode'] == 200:
response = requests.post(url, headers=self.headers, data=data)
return NcellResponse(response)
#! If token refreshed failled, return the refreshToken response
else:
return refreshResponse
#! If token is not epired, return the response
else:
return NcellResponse(response)
def validateOtp(self, otp):
"""Send the OTP to the Ncell server for validation and get the token if correct
Args:
otp (string): OTP code
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> reg.validateOtp('123456')
<Response [OTP1000]>
>>> reg.token
'eyJt...'
"""
url = self.baseUrl + '/user/otp/validate'
data = f'{{"validateOTPRequest":{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","otpDetail":{{"action":"LOGIN","otp":"{otp}"}}}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"LOGIN","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
#! If ok, create a b64 encoded token in the format {"msisdn": msisdn, "accessToken": accessToken, "refreshToken": refreshToken}
if response.json()['responseHeader']['responseCode'] == '200':
accessToken = response.json()['validateOTPResponse']['accessToken']
refreshToken = response.json(
)['validateOTPResponse']['refreshToken']
self.token = b64encode(
f'{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","accessToken":"{accessToken}","refreshToken":"{refreshToken}"}}'
.encode()).decode()
return NcellResponse(response)
def sendSms(self, destination, text, schedule='null'):
"""Send SMS using current data plan
Args:
destination (string): MSISDN to send SMS
text (string): Text to send
schedule (str, optional): Schedule the SMS. Defaults to 'null'. (Currently Ncell don't support scheduling)
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> sms = account.sendSms('980*******', 'Hello World')
>>> print(sms.content)
"""
url = self.baseUrl + '/smsmgt/free/sms/send'
text = demojize(text).replace('\n', '')
data = f'{{"sendSMSFreeRequest":{{"source":"{self.msisdn}","destination":"{destination}","content":"{text}","schedule":{schedule},"isConfirm":1}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"MY_SERVICES","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def vasPlans(self, categoryId=None, keyword=''):
"""Get VAS plans and products
Args:
categoryId (string, optional): Category ID to get the plans of certain category. Defaults to None.
keyword (string, optional): Keywords to search the plans.
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> plans = account.vasPlans()
>>> print(plans.content)
"""
url = self.baseUrl + '/product/vas-plans'
if categoryId:
data = f'{{"languageCode":"{self.languageCode}","keyword":"{keyword}","pageableDto":{{"pageNumber":1,"pageSize":50}},"categoryId":{categoryId},"sortby":null,"msisdn":"{self.msisdn}","requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"SHOP","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
else:
data = f'{{"languageCode":"{self.languageCode}","keyword":"{keyword}","pageableDto":{{"pageNumber":1,"pageSize":50}},"sortby":null,"msisdn":"{self.msisdn}","requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"SHOP","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def refreshToken(self):
"""Refresh the token
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> account.refreshToken()
>>> print(f'The new token is {account.token}.')
"""
url = self.baseUrl + '/user/refresh/token'
data = f'{{"refreshTokenRequest":{{"refreshToken":"{self.__rToken}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"LOGOUT_ACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
#! If token refreshed successfully, change the token variable and update the header
if response.json()['responseHeader']['responseCode'] == '200':
self.__accessToken = response.json(
)['userAuthResponse']['accessToken']
self.__rToken = response.json()['userAuthResponse']['refreshToken']
self.token = b64encode(
f'{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","accessToken":"{self.__accessToken}","refreshToken":"{self.__rToken}"}}'
.encode()).decode()
self.headers.update({
'authorization':
f'Bearer {response.json()["userAuthResponse"]["accessToken"]}',
})
#! Call the afterRefresh function
if self.afterRefresh:
module = self.afterRefresh[0]
function = self.afterRefresh[1]
module = __import__(module)
function = getattr(module, function)
if self.args:
self.argsCopy = self.args.copy()
for i, j in enumerate(self.argsCopy):
if j == '__token__':
self.argsCopy[i] = self.token
function(*self.argsCopy)
else:
function()
return NcellResponse(response)
def generateOtp(self):
"""Request Ncell to send OTP to the given number for registration
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> reg.generateOtp()
<Response [OTP1000]>
"""
url = self.baseUrl + '/user/otp/generate'
data = f'{{"generateOTPRequest":{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","action":"LOGIN"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"LOGIN","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return NcellResponse(response)
def recommendation(self):
"""Get recommendations
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> recommendations = account.recommendation()
>>> print(recommendations.content)
"""
url = self.baseUrl + '/recommendationmgt/recommendation/details'
data = f'{{"recommendationDetailRequest":{{"deviceId":"{self.__deviceId}","msisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"TRAY_ACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def config(self):
"""Get the basic app configuration
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> config = account.config()
>>> print(config.content)
"""
url = self.baseUrl + '/utilitymgt/app-basic-config/view'
data = f'{{"basicAppInfo":{{"langCode":"en","osType":"{self.deviceType.upper()}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"BASIC_CONFIG_ACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def rechargeHistory(self):
"""Get the recharge history
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> history = account.rechargeHistory()
>>> print(history.content)
"""
url = self.baseUrl + '/accountmgt/history/recharge'
data = f'{{"queryRechargeLogRequest":{{"msisdn":"{self.msisdn}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"RECHARGE_LOG_ACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def subscribedProducts(self):
"""Get the subscribed products
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> subscribed = account.subscribedProducts()
>>> print(subscribed.content)
"""
url = self.baseUrl + '/billingmgt/vas/subscribedproducts/query'
data = f'{{"queryAllProductsRequest":{{"deviceId":"{self.__deviceId}","msisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"MY_SERVICES","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def balanceTransferHistory(self):
"""Get the balance transfer history
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> history = account.balanceTransferHistory()
>>> print(history.content)
"""
url = self.baseUrl + '/accountmgt/history/balance-transfer'
data = f'{{"balanceTransferHistoryRequest":{{"msisdn":"{self.msisdn}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"BALANCE_TRANSFER","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def takeLoan(self):
"""Apply for loan
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> loan = account.takeLoan()
>>> print(loan.content)
"""
url = self.baseUrl + '/accountmgt/apply-loan'
data = f'{{"creditLoanInfo":{{"msisdn":"{self.msisdn}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"LOAN_ACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def generateTransactionOtp(self):
"""Generate a transaction OTP
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> response = account.generateTransactionOtp()
>>> print(response.content)
"""
url = self.baseUrl + '/accountmgt/otp/generate'
data = f'{{"generateOTPRequest":{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","subId":"1044209462","action":"TRAN","null":null}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"TRANSACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def balance(self):
"""Get the user's balance
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> balance = account.balance()
>>> print(balance.content)
"""
url = self.baseUrl + '/accountmgt/balance/query'
data = f'{{"queryBalanceRequest":{{"deviceId":"{self.__deviceId}","msisdn":"{self.msisdn}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"MY_SERVICES","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def selfRecharge(self, rPin):
"""Self recharge with recharge pin
Args:
rPin (string): 16 digit recharge pin
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> recharge = account.selfRecharge('1548754256987456')
>>> print(recharge.content)
"""
url = self.baseUrl + '/accountmgt/manual-recharge'
data = f'{{"manualRechargeInfo":{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","cardPinNumber":"{rPin}","rechargeMode":"PIN"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"RECHARGE_SELF","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def selfOnlineRecharge(self, amount):
"""Self online recharge
Args:
amount (string): Amount to recharge
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> onlineRecharge = account.selfOnlineRecharge('1548754256987456', '100')
>>> print(onlineRecharge.content)
"""
url = self.baseUrl + '/paymentmgt/url-pin-request'
data = f'{{"paymentInfo":{{"transactionId":"{tranIdGen()}","msisdn":"{self.msisdn}","description":"Recharge Action","amount":"{amount}"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"ONLINE","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def unsubscribeProduct(self, subscriptionCode):
"""Unsubscribe a product
Args:
subscriptionCode (string): Subscription code of a product
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> response = account.unsubscribeProduct('125425')
>>> print(response.content)
"""
url = self.baseUrl + '/billingmgt/product/unsubscribe'
data = f'{{"productSubscriptionSummaryRequest":{{"deviceId":"{self.__deviceId}","msisdn":"{self.msisdn}","subscriptionCode":"{subscriptionCode}","productName":"N/A","languageCode":"{self.languageCode}","medium":"APP","linkId":"00000000000000000"}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"SUBSCRIBE","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def transactionSummary(self, fromDate, toDate):
"""Get the transaction summary
Args:
from (string): Date from when summary is to be returned in the format YY-MM-DDTHH:MM:SS
to (string): Date upto which summary is to be returned in the format YY-MM-DDTHH:MM:SS
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> history = account.transactionSummary('2021-02-06T00:00:00', '2021-02-12T00:00:00')
>>> print(history.content)
"""
url = self.baseUrl + '/accountmgt/transaction/history/summary'
data = f'{{"transactionSummaryRequest":{{"msisdn":"{self.msisdn}","deviceId":"{self.__deviceId}","subId":"1044209462","action":"TRAN","dateRange":{{"from":"{fromDate}.000Z","to":"{toDate}.000Z"}},"transactionType":"USAGE","timeZone":"America/New_York","null":null}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"TRANSACTION","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)
def confirmBalanceTransfer(self, destination, amount, otp):
"""Confirm the balance transfer
Args:
destination (string): MSISDN to transfer the balance
amount (string): Amount to transfer
otp (string): OTP code
Returns:
ncellapp.models.NcellResponse: Response from the Ncell server
Example:
>>> confirmation = account.confirmBalanceTransfer('980*******', '100', '123456')
>>> print(confirmation.content)
"""
url = self.baseUrl + '/accountmgt/balance-transfer'
data = f'{{"balanceTransferInfo":{{"sender":"{self.msisdn}","receiver":"{destination}","amount":"{amount}","deviceId":"{self.__deviceId}","otpDetails":{{"otpState":"VALIDATE","otp":"{otp}"}}}},"requestHeader":{{"requestId":"{reqIdGen()}","timestamp":"{tsGen()}","channel":"sca","deviceType":"{self.deviceType}","deviceId":"{self.__deviceId}","clientip":"N/A","action":"BALANCE_TRANSFER","connectionType":"{self.connectionType}","msisdn":"{self.msisdn}","deviceModel":"{self.deviceModel}","location":"N/A","primaryMsisdn":"{self.msisdn}","languageCode":"{self.languageCode}"}}}}'
response = requests.post(url, headers=self.headers, data=data)
return self.__autoRefresh(
response, url,
data) if self.autoRefresh else NcellResponse(response)