feat: augment election endpoint

zikeji · Sep 15, 2024 · d3ee25f · d3ee25f
1 parent 47e15d8
commit d3ee25f
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 deletions.
diff --git a/src/methods/resources/skyblock.ts b/src/methods/resources/skyblock.ts
@@ -80,7 +80,7 @@ export class SkyBlockResources extends Method {
    * Returns the current items from the SkyBlock gamemode.
    * @example
    * ```typescript
-   * const bingo = await client.resources.skyblock.items();
+   * const items = await client.resources.skyblock.items();
    * ```
    * @category API
    */

diff --git a/src/types/Augmented/Resources/SkyBlock/Election.ts b/src/types/Augmented/Resources/SkyBlock/Election.ts
@@ -0,0 +1,42 @@
+export type ElectionMayor = {
+  key: string;
+  name: string;
+  perks: {
+    name: string;
+    description: string;
+  }[];
+  minister: {
+    key: string;
+    name: string;
+    perk: {
+      name: string;
+      description: string;
+      minister: boolean;
+    };
+  };
+  election?: {
+    year: number;
+    candidates: {
+      key: string;
+      name: string;
+      perks: {
+        name: string;
+        description: string;
+        minister: boolean;
+      }[];
+      votes: number;
+    }[];
+  };
+};
+export type ElectionCurrent = {
+  year: number;
+  candidates: {
+    key: string;
+    name: string;
+    perks: {
+      name: string;
+      description: string;
+      minister: boolean;
+    }[];
+  }[];
+};
diff --git a/src/types/AugmentedTypes.ts b/src/types/AugmentedTypes.ts
@@ -3,8 +3,12 @@
  */
 
 import type { Paths } from "./api";
-import { Guild } from "./Augmented/Guild";
+import type { Guild } from "./Augmented/Guild";
 import type { Player } from "./Augmented/Player";
+import type {
+  ElectionCurrent,
+  ElectionMayor,
+} from "./Augmented/Resources/SkyBlock/Election";
 import type { SkyBlockProfile } from "./Augmented/SkyBlock/Profile";
 
 export type BoostersResponse = Paths.V2Boosters.Get.Responses.$200 &
@@ -80,7 +84,10 @@ export type ResourcesSkyblockCollectionsResponse = Paths.V2ResourcesSkyblockColl
   };
 
 export type ResourcesSkyblockElectionResponse = Paths.V2ResourcesSkyblockElection.Get.Responses.$200 &
-  Record<string, unknown>;
+  Record<string, unknown> & {
+    mayor: ElectionMayor;
+    current: ElectionCurrent | null;
+  };
 
 export type ResourcesSkyblockItemsResponse = Paths.V2ResourcesSkyblockItems.Get.Responses.$200 &
   Record<string, unknown>;