===========
Mercury SDK
===========
Mercury SDK can be used in projects that interface with the mercury service
that provides common internal functionality.
Initializing the client
-------------------------------
::
from mercuryclient import MercuryApi
# Setup connection parameters
conn_params = {'username': 'mercury_username', 'password':'password', 'url':'https://mercury-url.com'}
m = MercuryApi(conn_params)
m.send_mail(['recipent@email.com'],'Test mail', 'Mail body','ses','ses_profile')
Available APIs:
----------------------
- send_mail
- send_sms
- request_experian_report
- get_experian_response
- fetch_experian_report
- request_cibil_report
- get_cibil_response
- fetch_cibil_report
- request_highmark_report
- get_highmark_response
- fetch_highmark_report
- request_verify_id
- get_verify_id_result
- request_bank_statement
- get_bank_statement_result
- verify_webhook
- insurance
- secure_patyment_recharge
- get_operators_list
- make_recharge
- get_recharge_status
- get_recharge_wallet_balance
- get_recharge_ip
- get_recharge_plans
- bbps
- set_agent_on_board
- get_state
- get_district_by_state
- get_bill_categories
- get_biller_by_categories
- get_customer_params_by_biller_id
- get_amount
- send_bill_payment_request_transid
- send_bill_payment_request
- get_duplicate_payment_receipt
- register_trasaction_complaint
- register_service_complaint
- get_complaint_status
- get_bbpsid
- verify_bank_account
- verify_gstin
- get_verify_gst_result
- generate_okyc_otp
- verify_okyc_otp
- fetch_rc_details
- verify_udyog_aadhaar
- fetch_equifax_report
- generate_liveness_session_id
- get_liveness_session_result
- extract_itr_details
- fetch_itr_report
- generate_epfo_otp
- verify_epfo_otp
- get_epfo_details
- name_match
- check_e_sign
Types:
------
For complex requests like CIBIL, Experian or Highmark, you can construct the request
JSON using the provided pydantic models. The types are available at *mercury.types.<request_type>.request*.
Example using models for generating Highmark Request::
from mercuryclient.types.highmark.request import Applicant, HighmarkRequest
applicant = Applicant(name="Example Name" ...)
request_obj = HighmarkRequest(
applicant=applicant,
inquiry_reference_number="ABCDE",
...
)
# After generating your request, pass the object to the corresponding request
m.fetch_highmark_report(request_obj, profile="sample_profile)
Testing:
-------------
Tests are run under *tox*
You can install tox with
>>> pip install tox
If using pyenv - you can do the following steps before running tox
(patch version will depend on your installations - tox only considers the major version)
>>> pyenv local 3.7.3 3.6.8 3.8.1
Without this step - tox will not be able to find the interpreters
Run tests using the following command
>>> tox
Raw data
{
"_id": null,
"home_page": "https://bitbucket.org/esthenos/mercury",
"name": "mercuryclient",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "Esthenos Technologies Private Limited",
"author_email": "atul@esthenos.com",
"download_url": "https://files.pythonhosted.org/packages/88/bc/79f2157c2ffe89e73c1ad4f135bde3cf0147b1701ab23286674c17d2ffe0/mercuryclient-1.16.1.tar.gz",
"platform": null,
"description": "===========\nMercury SDK\n===========\n\nMercury SDK can be used in projects that interface with the mercury service\nthat provides common internal functionality.\n\nInitializing the client\n-------------------------------\n::\n\n from mercuryclient import MercuryApi\n # Setup connection parameters\n conn_params = {'username': 'mercury_username', 'password':'password', 'url':'https://mercury-url.com'}\n m = MercuryApi(conn_params)\n m.send_mail(['recipent@email.com'],'Test mail', 'Mail body','ses','ses_profile')\n\nAvailable APIs:\n----------------------\n- send_mail\n- send_sms\n- request_experian_report\n- get_experian_response\n- fetch_experian_report\n- request_cibil_report\n- get_cibil_response\n- fetch_cibil_report\n- request_highmark_report\n- get_highmark_response\n- fetch_highmark_report\n- request_verify_id\n- get_verify_id_result\n- request_bank_statement\n- get_bank_statement_result\n- verify_webhook\n- insurance\n- secure_patyment_recharge\n - get_operators_list\n - make_recharge\n - get_recharge_status\n - get_recharge_wallet_balance\n - get_recharge_ip\n - get_recharge_plans\n- bbps\n - set_agent_on_board\n - get_state\n - get_district_by_state\n - get_bill_categories\n - get_biller_by_categories\n - get_customer_params_by_biller_id\n - get_amount\n - send_bill_payment_request_transid\n - send_bill_payment_request\n - get_duplicate_payment_receipt\n - register_trasaction_complaint\n - register_service_complaint\n - get_complaint_status\n - get_bbpsid\n- verify_bank_account\n- verify_gstin\n- get_verify_gst_result\n- generate_okyc_otp\n- verify_okyc_otp\n- fetch_rc_details\n- verify_udyog_aadhaar\n- fetch_equifax_report\n- generate_liveness_session_id\n- get_liveness_session_result\n- extract_itr_details\n- fetch_itr_report\n- generate_epfo_otp\n- verify_epfo_otp\n- get_epfo_details\n- name_match\n- check_e_sign\n\nTypes:\n------\nFor complex requests like CIBIL, Experian or Highmark, you can construct the request\nJSON using the provided pydantic models. The types are available at *mercury.types.<request_type>.request*.\n\nExample using models for generating Highmark Request::\n\n from mercuryclient.types.highmark.request import Applicant, HighmarkRequest\n applicant = Applicant(name=\"Example Name\" ...)\n request_obj = HighmarkRequest(\n applicant=applicant,\n inquiry_reference_number=\"ABCDE\",\n ...\n )\n # After generating your request, pass the object to the corresponding request\n m.fetch_highmark_report(request_obj, profile=\"sample_profile)\n\nTesting:\n-------------\nTests are run under *tox*\n\nYou can install tox with\n\n>>> pip install tox\n\nIf using pyenv - you can do the following steps before running tox\n(patch version will depend on your installations - tox only considers the major version)\n\n>>> pyenv local 3.7.3 3.6.8 3.8.1\n\nWithout this step - tox will not be able to find the interpreters\n\nRun tests using the following command\n\n>>> tox\n\n\n",
"bugtrack_url": null,
"license": "Proprietary License",
"summary": "Python SDK for Mercury service",
"version": "1.16.1",
"project_urls": {
"Homepage": "https://bitbucket.org/esthenos/mercury"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e105fb01d6081de3ce50446980a07139ed28d8f6dc4d181b0f19094a18a8be9c",
"md5": "8f6b45fa1be7b2da8cc894983954c597",
"sha256": "b4fb0498cefa9f17fc15a1a1146c0b0609ffbb4bc74509a0915abf48dcdbc898"
},
"downloads": -1,
"filename": "mercuryclient-1.16.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f6b45fa1be7b2da8cc894983954c597",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 73760,
"upload_time": "2024-04-17T12:51:36",
"upload_time_iso_8601": "2024-04-17T12:51:36.331903Z",
"url": "https://files.pythonhosted.org/packages/e1/05/fb01d6081de3ce50446980a07139ed28d8f6dc4d181b0f19094a18a8be9c/mercuryclient-1.16.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "88bc79f2157c2ffe89e73c1ad4f135bde3cf0147b1701ab23286674c17d2ffe0",
"md5": "7b195e910ccfb67a7cd24646ed4d2624",
"sha256": "e69f8cc3a25a7b353445d00b179f945c6ae59a430642e54f3211dccacb234909"
},
"downloads": -1,
"filename": "mercuryclient-1.16.1.tar.gz",
"has_sig": false,
"md5_digest": "7b195e910ccfb67a7cd24646ed4d2624",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 32870,
"upload_time": "2024-04-17T12:51:37",
"upload_time_iso_8601": "2024-04-17T12:51:37.830209Z",
"url": "https://files.pythonhosted.org/packages/88/bc/79f2157c2ffe89e73c1ad4f135bde3cf0147b1701ab23286674c17d2ffe0/mercuryclient-1.16.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 12:51:37",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "esthenos",
"bitbucket_project": "mercury",
"lcname": "mercuryclient"
}
JSON