nomba-python 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

nomba/__init__.py

@@ -37,4 +37,4 @@ __all__ = [
     "check_timestamp_freshness",
 ]
 
-__version__ = "0.4.0"
+__version__ = "0.5.0"

nomba/data/nomba_openapi.json

@@ -9961,9 +9961,19 @@
                     },
                     "description": {
                       "type": "string",
-                      "example": "Success",
+                      "example": "SUCCESS",
                       "description": "Response description"
                     },
+                    "message": {
+                      "type": "string",
+                      "example": "SUCCESS",
+                      "description": "Response message"
+                    },
+                    "status": {
+                      "type": "boolean",
+                      "example": true,
+                      "description": "Request status"
+                    },
                     "data": {
                       "$ref": "#/components/schemas/DataPlanList"
                     }
@@ -9971,8 +9981,23 @@
                   "required": [
                     "code",
                     "description",
+                    "message",
+                    "status",
                     "data"
                   ]
+                },
+                "example": {
+                  "code": "00",
+                  "description": "SUCCESS",
+                  "message": "SUCCESS",
+                  "status": true,
+                  "data": [
+                    {"plan": "110MB Daily Plan", "amount": 100, "productId": "mtn1"},
+                    {"plan": "1GB + 1.5mins 1 day Plan", "amount": 500, "productId": "mtn16"},
+                    {"plan": "2.7GB+5mins Monthly Plan", "amount": 2000, "productId": "mtn6"},
+                    {"plan": "7GB Monthly Plan", "amount": 3500, "productId": "mtn30"},
+                    {"plan": "20GB Monthly Plan - 30days", "amount": 7500, "productId": "mtn5"}
+                  ]
                 }
               }
             },
@@ -12251,6 +12276,189 @@
         ]
       }
     },
+    "/v1/bill/cableTvProduct": {
+      "get": {
+        "description": "You can use this endpoint to fetch available cable TV subscription plans for a specific provider (DSTV, GOTV, Startimes, ShowMax)",
+        "operationId": "Fetch cable TV plans",
+        "parameters": [
+          {
+            "description": "The cable TV provider type",
+            "example": "dstv",
+            "in": "query",
+            "name": "cableTvType",
+            "required": true,
+            "schema": {
+              "type": "string",
+              "enum": ["dstv", "gotv", "startimes", "showmax"]
+            }
+          },
+          {
+            "description": "The parent accountId of the business.",
+            "in": "header",
+            "name": "accountId",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "890022ce-bae0-45c1-9b9d-ee7872e6ca27"
+            },
+            "required": true
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "example": "00",
+                      "description": "Response Code"
+                    },
+                    "description": {
+                      "type": "string",
+                      "example": "SUCCESS",
+                      "description": "Response description"
+                    },
+                    "message": {
+                      "type": "string",
+                      "example": "SUCCESS",
+                      "description": "Response message"
+                    },
+                    "data": {
+                      "$ref": "#/components/schemas/CableTvPlanList"
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "description",
+                    "message",
+                    "data"
+                  ]
+                },
+                "example": {
+                  "code": "00",
+                  "description": "SUCCESS",
+                  "message": "SUCCESS",
+                  "data": [
+                    {"subScriptionType": "PADI", "amount": 4400.0},
+                    {"subScriptionType": "YANGA", "amount": 6000.0},
+                    {"subScriptionType": "CONFAM", "amount": 11000.0},
+                    {"subScriptionType": "COMPACT", "amount": 19000.0},
+                    {"subScriptionType": "COMPACT_PLUS", "amount": 30000.0},
+                    {"subScriptionType": "PREMIUM", "amount": 44500.0}
+                  ]
+                }
+              }
+            },
+            "description": "OK - your request was successful.",
+            "headers": {
+              "X-Rate-Limit-Limit": {
+                "description": "The number of allowed requests in the current period",
+                "schema": {
+                  "type": "string",
+                  "example": "40"
+                }
+              },
+              "X-Rate-Limit-Remaining": {
+                "description": "The number of remaining requests in the current period",
+                "schema": {
+                  "type": "string",
+                  "example": "39"
+                }
+              },
+              "X-Rate-Limit-Window": {
+                "description": "The specified rate limit window",
+                "schema": {
+                  "type": "string",
+                  "example": "1s"
+                }
+              }
+            }
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RequestError"
+                }
+              }
+            },
+            "description": "The request body sent by merchant did not pass the validation checks"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthenticationError"
+                }
+              }
+            },
+            "description": "The access_token provided to access the resource is missing or invalid."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthorizationError"
+                }
+              }
+            },
+            "description": "The client does not have the permissions to access this resource"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RecordNotFoundError"
+                }
+              }
+            },
+            "description": "The record that the client is trying to access does not exist."
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitError"
+                }
+              }
+            },
+            "description": "The client has maxed out the number of calls within a time period on this resource."
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ServerError"
+                }
+              }
+            },
+            "description": "Downstream system error."
+          },
+          "default": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RequestError"
+                }
+              }
+            },
+            "description": "Resource not available"
+          }
+        },
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "summary": "Fetch cable TV plans",
+        "tags": [
+          "Cable & Bill Payments"
+        ]
+      }
+    },
     "/v1/bill/cabletv/lookup": {
       "get": {
         "description": "This endpoint is for fetching customer information data",
@@ -13497,9 +13705,19 @@
                     },
                     "description": {
                       "type": "string",
-                      "example": "Success",
+                      "example": "SUCCESS",
                       "description": "Response description"
                     },
+                    "message": {
+                      "type": "string",
+                      "example": "SUCCESS",
+                      "description": "Response message"
+                    },
+                    "status": {
+                      "type": "boolean",
+                      "example": true,
+                      "description": "Request status"
+                    },
                     "data": {
                       "$ref": "#/components/schemas/DiscoList"
                     }
@@ -13507,8 +13725,28 @@
                   "required": [
                     "code",
                     "description",
+                    "message",
+                    "status",
                     "data"
                   ]
+                },
+                "example": {
+                  "code": "00",
+                  "description": "SUCCESS",
+                  "message": "SUCCESS",
+                  "status": true,
+                  "data": [
+                    {"id": "phed", "name": "Port Harcourt (PHED)"},
+                    {"id": "jed", "name": "Jos Electric (JEDC)"},
+                    {"id": "kaduna", "name": "Kaduna Electric (KAEDCO)"},
+                    {"id": "ibedc", "name": "Ibadan Electric (IBEDC)"},
+                    {"id": "eko", "name": "Eko Electric (EKEDC)"},
+                    {"id": "benin", "name": "Benin Electric (BEDC)"},
+                    {"id": "abuja", "name": "Abuja Electric (AEDC)"},
+                    {"id": "kano", "name": "Kano Electric (KEDCO)"},
+                    {"id": "ikeja", "name": "Ikeja Electric (IKEDC)"},
+                    {"id": "enugu", "name": "Enugu Electric (EEDC)"}
+                  ]
                 }
               }
             },
@@ -13621,7 +13859,8 @@
     },
     "/v1/bill/electricity/lookup": {
       "get": {
-        "description": "This endpoint is for fetching customer information data from an electricity vending provider",
+        "description": "**Deprecated.** This endpoint is deprecated and will be removed in a future release. Use `GET /v2/bill/electricity/lookup` instead, which also returns the customer's address.",
+        "deprecated": true,
         "operationId": "ELECTRICITY_CUSTOMER_LOOKUP",
         "parameters": [
           {
@@ -13782,6 +14021,184 @@
         ]
       }
     },
+    "/v2/bill/electricity/lookup": {
+      "get": {
+        "description": "This endpoint is for fetching the customer's name and address from an electricity vending provider. Use it to confirm the customer's details before vending electricity.",
+        "operationId": "ELECTRICITY_CUSTOMER_LOOKUP_V2",
+        "parameters": [
+          {
+            "description": "disco",
+            "example": "phed",
+            "in": "query",
+            "name": "disco",
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "description": "The parent accountId of the business.",
+            "in": "header",
+            "name": "accountId",
+            "schema": {
+              "type": "string",
+              "format": "uuid",
+              "example": "890022ce-bae0-45c1-9b9d-ee7872e6ca27"
+            },
+            "required": true
+          },
+          {
+            "description": "customerId",
+            "example": "12347899",
+            "in": "query",
+            "name": "customerId",
+            "schema": {
+              "type": "string"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "code": {
+                      "type": "string",
+                      "example": "00",
+                      "description": "Response Code"
+                    },
+                    "description": {
+                      "type": "string",
+                      "example": "Success",
+                      "description": "Response description"
+                    },
+                    "data": {
+                      "type": "object",
+                      "description": "The customer's details as returned by the electricity provider",
+                      "properties": {
+                        "name": {
+                          "type": "string",
+                          "example": "John Doe",
+                          "description": "The name of the customer"
+                        },
+                        "address": {
+                          "type": "string",
+                          "example": "12 Adeola Odeku Street, Victoria Island, Lagos",
+                          "description": "The address of the customer. Returns `unknown` when the provider does not supply an address."
+                        }
+                      },
+                      "required": [
+                        "name",
+                        "address"
+                      ]
+                    }
+                  },
+                  "required": [
+                    "code",
+                    "description",
+                    "data"
+                  ]
+                }
+              }
+            },
+            "description": "OK - your request was successful.",
+            "headers": {
+              "X-Rate-Limit-Limit": {
+                "description": "The number of allowed requests in the current period",
+                "schema": {
+                  "type": "string",
+                  "example": "40"
+                }
+              },
+              "X-Rate-Limit-Remaining": {
+                "description": "The number of remaining requests in the current period",
+                "schema": {
+                  "type": "string",
+                  "example": "39"
+                }
+              },
+              "X-Rate-Limit-Window": {
+                "description": "The specified rate limit window",
+                "schema": {
+                  "type": "string",
+                  "example": "1s"
+                }
+              }
+            }
+          },
+          "400": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RequestError"
+                }
+              }
+            },
+            "description": "The request body sent by merchant did not pass the validation checks"
+          },
+          "401": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthenticationError"
+                }
+              }
+            },
+            "description": "The access_token provided to access the resource is missing or invalid."
+          },
+          "403": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/AuthorizationError"
+                }
+              }
+            },
+            "description": "The client does not have the permissions to access this resource"
+          },
+          "404": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RecordNotFoundError"
+                }
+              }
+            },
+            "description": "The record that the client is trying to access does not exist."
+          },
+          "429": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/RateLimitError"
+                }
+              }
+            },
+            "description": "The client has maxed out the number of calls within a time period on this resource."
+          },
+          "500": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ServerError"
+                }
+              }
+            },
+            "description": "Downstream system error."
+          }
+        },
+        "security": [
+          {
+            "BearerAuth": []
+          }
+        ],
+        "summary": "Fetch customer information from an electricity provider (v2)",
+        "tags": [
+          "Electricity Vending"
+        ]
+      }
+    },
     "/v1/bill/electricity": {
       "post": {
         "description": "**Deprecated.** This endpoint is deprecated and will be removed in a future release. Use `POST /v2/bill/electricity` instead.",
@@ -22528,25 +22945,33 @@
           "message"
         ]
       },
-      "DataPlanList": {
+      "DataPlan": {
         "type": "object",
         "properties": {
-          "amount": {
-            "type": "integer",
-            "format": "int64"
-          },
           "plan": {
             "type": "string",
-            "example": "40GB -> 30Days (N15,000)"
+            "example": "1GB + 1.5mins 1 day Plan"
+          },
+          "amount": {
+            "type": "integer",
+            "format": "int64",
+            "example": 500
           },
           "productId": {
             "type": "string",
             "description": "The unique identifier for this data plan. Pass this value as `productId` when purchasing to select this exact bundle.",
-            "example": "mtn47"
+            "example": "mtn16"
           }
         }
       },
-      "DiscoList": {
+      "DataPlanList": {
+        "type": "array",
+        "description": "List of available data plans for the telco",
+        "items": {
+          "$ref": "#/components/schemas/DataPlan"
+        }
+      },
+      "Disco": {
         "type": "object",
         "properties": {
           "id": {
@@ -22559,6 +22984,40 @@
           }
         }
       },
+      "DiscoList": {
+        "type": "array",
+        "description": "List of all electricity providers/discos",
+        "items": {
+          "$ref": "#/components/schemas/Disco"
+        }
+      },
+      "CableTvPlan": {
+        "type": "object",
+        "properties": {
+          "subScriptionType": {
+            "type": "string",
+            "description": "The subscription plan type (e.g., COMPACT, PREMIUM, YANGA)",
+            "example": "COMPACT"
+          },
+          "amount": {
+            "type": "number",
+            "format": "double",
+            "description": "The amount for the subscription plan",
+            "example": 19000.0
+          }
+        },
+        "required": [
+          "subScriptionType",
+          "amount"
+        ]
+      },
+      "CableTvPlanList": {
+        "type": "array",
+        "description": "List of available cable TV subscription plans",
+        "items": {
+          "$ref": "#/components/schemas/CableTvPlan"
+        }
+      },
       "BettingProvider": {
         "type": "object",
         "properties": {