nomba-python 0.1.0__py3-none-any.whl

nomba_python/resources/airtime_data.py

@@ -0,0 +1,252 @@
+# This file is auto-generated from Nomba's OpenAPI spec. Do not edit by hand;
+# regenerate via scripts/generate_resources.py instead.
+from __future__ import annotations
+
+
+from ..http import AsyncNombaClient, NombaClient
+from ..validation import validate_body
+from .. import models as _models
+
+
+class AirtimeData:
+    """Sync resource methods for the AirtimeData group."""
+
+    def __init__(self, client: NombaClient) -> None:
+        self._client = client
+
+    def fetch_data_plans_available_on_a_telco_network_provider(self, telco: str, **extra: object) -> _models.FetchDataPlansAvailableOnATelcoNetworkProviderResponse:
+        """
+        Fetch data plans available on a telco (network provider)
+
+        You can use this endpoint to fetch data plans available on a telco (network provider)
+        """
+        path = f"/v1/bill/data-plan/{telco}"
+        params = None
+        return self._client.get(path, params=params)  # type: ignore[return-value]
+
+    def make_airtime_purchases_via_parent_account(self, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.MakeAirtimePurchasesViaParentAccountResponse:
+        """
+        Make airtime purchases via parent account
+
+        You can use this endpoint to make airtime purchases via parent account
+
+        Body fields:
+            amount (required): The airtime amount to be purchased
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the airtime
+        """
+        path = "/v1/bill/topup"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/topup", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    def make_airtime_purchases_via_specific_or_sub_account(self, sub_account_id: str, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.MakeAirtimePurchasesViaSpecificOrSubAccountResponse:
+        """
+        Make airtime purchases via a sub account
+
+        You can use this endpoint to make airtime purchases via a sub account
+
+        Body fields:
+            amount (required): The airtime amount to be purchased
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the airtime
+        """
+        path = f"/v1/bill/topup/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/topup/{subAccountId}", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    def vend_data_bundles_via_parent_account(self, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.VendDataBundlesViaParentAccountResponse:
+        """
+        Vend data bundles via parent account
+
+        You can use this endpoint to vend data via parent account
+
+        Body fields:
+            amount (required): The data amount to be vended
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the data
+        """
+        path = "/v1/bill/data"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/data", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    def vend_data_bundles_via_specific_or_sub_account(self, sub_account_id: str, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.VendDataBundlesViaSpecificOrSubAccountResponse:
+        """
+        Vend data bundles via a sub account
+
+        You can use this endpoint to vend data via a sub account
+
+        Body fields:
+            amount (required): The data amount to be vended
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the data
+        """
+        path = f"/v1/bill/data/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/data/{subAccountId}", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+
+
+class AsyncAirtimeData:
+    """Async resource methods for the AirtimeData group."""
+
+    def __init__(self, client: AsyncNombaClient) -> None:
+        self._client = client
+
+    async def fetch_data_plans_available_on_a_telco_network_provider(self, telco: str, **extra: object) -> _models.FetchDataPlansAvailableOnATelcoNetworkProviderResponse:
+        """
+        Fetch data plans available on a telco (network provider)
+
+        You can use this endpoint to fetch data plans available on a telco (network provider)
+        """
+        path = f"/v1/bill/data-plan/{telco}"
+        params = None
+        return await self._client.get(path, params=params)  # type: ignore[return-value]
+
+    async def make_airtime_purchases_via_parent_account(self, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.MakeAirtimePurchasesViaParentAccountResponse:
+        """
+        Make airtime purchases via parent account
+
+        You can use this endpoint to make airtime purchases via parent account
+
+        Body fields:
+            amount (required): The airtime amount to be purchased
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the airtime
+        """
+        path = "/v1/bill/topup"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/topup", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    async def make_airtime_purchases_via_specific_or_sub_account(self, sub_account_id: str, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.MakeAirtimePurchasesViaSpecificOrSubAccountResponse:
+        """
+        Make airtime purchases via a sub account
+
+        You can use this endpoint to make airtime purchases via a sub account
+
+        Body fields:
+            amount (required): The airtime amount to be purchased
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the airtime
+        """
+        path = f"/v1/bill/topup/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/topup/{subAccountId}", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    async def vend_data_bundles_via_parent_account(self, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.VendDataBundlesViaParentAccountResponse:
+        """
+        Vend data bundles via parent account
+
+        You can use this endpoint to vend data via parent account
+
+        Body fields:
+            amount (required): The data amount to be vended
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the data
+        """
+        path = "/v1/bill/data"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/data", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    async def vend_data_bundles_via_specific_or_sub_account(self, sub_account_id: str, amount, phone_number, network, merchant_tx_ref, *, sender_name: object | None = None, **extra: object) -> _models.VendDataBundlesViaSpecificOrSubAccountResponse:
+        """
+        Vend data bundles via a sub account
+
+        You can use this endpoint to vend data via a sub account
+
+        Body fields:
+            amount (required): The data amount to be vended
+            phoneNumber (required): Recipient phone number
+            network (required): Recipient network (telco). It can also come as lowercased values e.g. glo, mtn etc.
+            merchantTxRef (required): Merchant Transaction Identifier reference (Unique to merchant)
+            senderName: A name to describe the sender of the data
+        """
+        path = f"/v1/bill/data/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        body["amount"] = amount
+        body["phoneNumber"] = phone_number
+        body["network"] = network
+        body["merchantTxRef"] = merchant_tx_ref
+        if sender_name is not None:
+            body["senderName"] = sender_name
+        body.update(extra)
+        validate_body("post", "/v1/bill/data/{subAccountId}", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+

nomba_python/resources/cabletv.py

@@ -0,0 +1,173 @@
+# This file is auto-generated from Nomba's OpenAPI spec. Do not edit by hand;
+# regenerate via scripts/generate_resources.py instead.
+from __future__ import annotations
+
+from typing import Any
+
+from ..http import AsyncNombaClient, NombaClient
+from ..validation import validate_body
+from .. import models as _models
+
+
+class CableTv:
+    """Sync resource methods for the CableTv group."""
+
+    def __init__(self, client: NombaClient) -> None:
+        self._client = client
+
+    def cabletv_lookup(self, *, customer_id: str | None = None, cable_tv_type: str | None = None, **extra: object) -> _models.CabletvLookupResponse:
+        """
+        Fetch customer information from a cable tv provider
+
+        This endpoint is for fetching customer information data
+        """
+        path = f"/v1/bill/cabletv/lookup"
+        params: dict[str, object] = {}
+        if customer_id is not None:
+            params["customerId"] = customer_id
+        if cable_tv_type is not None:
+            params["cableTvType"] = cable_tv_type
+        return self._client.get(path, params=params)  # type: ignore[return-value]
+
+    def cable_tv_subscription_via_parent_account(self, *, cable_tv_type: object | None = None, merchant_tx_ref: object | None = None, payer_name: object | None = None, amount: object | None = None, customer_id: object | None = None, **extra: object) -> _models.CableTvSubscriptionViaParentAccountResponse:
+        """
+        CableTv subscription via parent account
+
+        You can use this endpoint to make cable tv subscription via parent account
+
+        Body fields:
+            cableTvType: 
+            merchantTxRef: 
+            payerName: 
+            amount: 
+            customerId: 
+        """
+        path = f"/v1/bill/cabletv"
+        params = None
+        body: dict[str, object] = {}
+        if cable_tv_type is not None:
+            body["cableTvType"] = cable_tv_type
+        if merchant_tx_ref is not None:
+            body["merchantTxRef"] = merchant_tx_ref
+        if payer_name is not None:
+            body["payerName"] = payer_name
+        if amount is not None:
+            body["amount"] = amount
+        if customer_id is not None:
+            body["customerId"] = customer_id
+        body.update(extra)
+        validate_body("post", "/v1/bill/cabletv", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    def cable_tv_subscription_via_a_sub_account(self, sub_account_id: str, *, cable_tv_type: object | None = None, merchant_tx_ref: object | None = None, payer_name: object | None = None, amount: object | None = None, customer_id: object | None = None, **extra: object) -> _models.CableTvSubscriptionViaASubAccountResponse:
+        """
+        CableTv subscription via a sub account
+
+        You can use this endpoint to make cable tv subscription via a sub account
+
+        Body fields:
+            cableTvType: 
+            merchantTxRef: 
+            payerName: 
+            amount: 
+            customerId: 
+        """
+        path = f"/v1/bill/cabletv/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        if cable_tv_type is not None:
+            body["cableTvType"] = cable_tv_type
+        if merchant_tx_ref is not None:
+            body["merchantTxRef"] = merchant_tx_ref
+        if payer_name is not None:
+            body["payerName"] = payer_name
+        if amount is not None:
+            body["amount"] = amount
+        if customer_id is not None:
+            body["customerId"] = customer_id
+        body.update(extra)
+        validate_body("post", "/v1/bill/cabletv/{subAccountId}", body)
+        return self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+
+
+class AsyncCableTv:
+    """Async resource methods for the CableTv group."""
+
+    def __init__(self, client: AsyncNombaClient) -> None:
+        self._client = client
+
+    async def cabletv_lookup(self, *, customer_id: str | None = None, cable_tv_type: str | None = None, **extra: object) -> _models.CabletvLookupResponse:
+        """
+        Fetch customer information from a cable tv provider
+
+        This endpoint is for fetching customer information data
+        """
+        path = f"/v1/bill/cabletv/lookup"
+        params: dict[str, object] = {}
+        if customer_id is not None:
+            params["customerId"] = customer_id
+        if cable_tv_type is not None:
+            params["cableTvType"] = cable_tv_type
+        return await self._client.get(path, params=params)  # type: ignore[return-value]
+
+    async def cable_tv_subscription_via_parent_account(self, *, cable_tv_type: object | None = None, merchant_tx_ref: object | None = None, payer_name: object | None = None, amount: object | None = None, customer_id: object | None = None, **extra: object) -> _models.CableTvSubscriptionViaParentAccountResponse:
+        """
+        CableTv subscription via parent account
+
+        You can use this endpoint to make cable tv subscription via parent account
+
+        Body fields:
+            cableTvType: 
+            merchantTxRef: 
+            payerName: 
+            amount: 
+            customerId: 
+        """
+        path = f"/v1/bill/cabletv"
+        params = None
+        body: dict[str, object] = {}
+        if cable_tv_type is not None:
+            body["cableTvType"] = cable_tv_type
+        if merchant_tx_ref is not None:
+            body["merchantTxRef"] = merchant_tx_ref
+        if payer_name is not None:
+            body["payerName"] = payer_name
+        if amount is not None:
+            body["amount"] = amount
+        if customer_id is not None:
+            body["customerId"] = customer_id
+        body.update(extra)
+        validate_body("post", "/v1/bill/cabletv", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+
+    async def cable_tv_subscription_via_a_sub_account(self, sub_account_id: str, *, cable_tv_type: object | None = None, merchant_tx_ref: object | None = None, payer_name: object | None = None, amount: object | None = None, customer_id: object | None = None, **extra: object) -> _models.CableTvSubscriptionViaASubAccountResponse:
+        """
+        CableTv subscription via a sub account
+
+        You can use this endpoint to make cable tv subscription via a sub account
+
+        Body fields:
+            cableTvType: 
+            merchantTxRef: 
+            payerName: 
+            amount: 
+            customerId: 
+        """
+        path = f"/v1/bill/cabletv/{sub_account_id}"
+        params = None
+        body: dict[str, object] = {}
+        if cable_tv_type is not None:
+            body["cableTvType"] = cable_tv_type
+        if merchant_tx_ref is not None:
+            body["merchantTxRef"] = merchant_tx_ref
+        if payer_name is not None:
+            body["payerName"] = payer_name
+        if amount is not None:
+            body["amount"] = amount
+        if customer_id is not None:
+            body["customerId"] = customer_id
+        body.update(extra)
+        validate_body("post", "/v1/bill/cabletv/{subAccountId}", body)
+        return await self._client.post(path, json=body, params=params)  # type: ignore[return-value]
+