added list all states

lib/miscellaneous/miscellaneous.test.ts

@@ -22,3 +22,12 @@ test("list countries", async () => {
         expect(response.data).toBeInstanceOf(Array)
     }
 })
+
+test("list states", async () => {
+    const response = await paystack().miscellaneous.list_states("US")
+    expect(response.status).toBe(true)
+
+    if (response.status) {
+        expect(response.data).toBeInstanceOf(Array)
+    }
+})

lib/miscellaneous/miscellaneous.ts

@@ -1,4 +1,4 @@
-import type { ListBanksQuery, ListBanksResponse, ListCountryResponse } from "./types";
+import type { ListBanksQuery, ListBanksResponse, ListCountryResponse, ListStatesResponse } from "./types";
 
 export class Miscellaneous {
     private secret_key: string;
@@ -38,6 +38,19 @@ export class Miscellaneous {
         return response_data
     }
 
+
+    /** Get a list of states for a country for address verification */
+    async list_states(country: string): Promise<ListStatesResponse> {
+        const url = new URL("https://api.paystack.co/address_verification/states")
+        url.searchParams.set("country", country)
+
+        const response = await fetch(url, {
+            headers: this.get_headers(),
+            method: "GET"
+        })
+        const response_data = await response.json() as ListStatesResponse
+        return response_data
+    }
     private get_headers() {
         return {
             "Content-Type": "application/json",

lib/miscellaneous/types.ts

@@ -96,8 +96,16 @@ type CountryData = {
     relationships: Relationships;
 };
 
-export type ListCountryResponse = {
-    status: boolean;
-    message: string;
+export type ListCountryResponse = { message: string } & ({
+    status: true;
     data: CountryData[];
-};
+} | PaystackResponseError)
+
+export type ListStatesResponse = { message: string } & ({
+    status: true;
+    data: Array<{
+        name: string;
+        slug: string;
+        abbreviation: string;
+    }>
+} | PaystackResponseError)