@blizzard-api/classic-wow 2.1.2 → 2.1.3

package/dist/index.js

@@ -1,495 +1,1087 @@
-// ../wow/src/base.ts
-var base = "/data/wow";
-var mediaBase = `${base}/media`;
-var searchBase = `${base}/search`;
+//#region ../wow/src/base.ts
+/**
 
-// src/auction-house/auction-house.ts
+* @file base.ts
+
+* @module base
+
+* @description Contains base constants and interfaces for the Blizzard API.
+
+*/
+/**
+
+* The base request path for the Blizzard API for world of warcraft.
+
+*/
+const base = "/data/wow";
+/**
+
+* The base request path for media in the Blizzard API for world of warcraft.
+
+*/
+const mediaBase = `${base}/media`;
+/**
+
+* The base request path for search in the Blizzard API for world of warcraft.
+
+*/
+const searchBase = `${base}/search`;
+
+//#endregion
+//#region src/auction-house/auction-house.ts
+/**
+
+* Returns an index of auction houses for a connected realm.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param connectedRealmId The ID of the connected realm.
+
+* @returns The auction house index. See {@link AuctionHouseIndexResponse}.
+
+*/
 function auctionHouseIndex(namespace, connectedRealmId) {
-  return {
-    namespace,
-    path: `${base}/connected-realm/${connectedRealmId}/auctions/index`
-  };
+	return {
+		namespace,
+		path: `${base}/connected-realm/${connectedRealmId}/auctions/index`
+	};
 }
+/**
+
+* Returns all active auctions for a specific auction house on a connected realm.
+
+*
+
+* Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
+
+*
+
+* Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large, sometimes exceeding 10 MB.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param connectedRealmId The ID of the connected realm.
+
+* @param auctionHouseId The ID of the auction house.
+
+* @returns The auction house data. See {@link AuctionsResponse}.
+
+*/
 function auctions(namespace, connectedRealmId, auctionHouseId) {
-  return {
-    namespace,
-    path: `${base}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`
-  };
+	return {
+		namespace,
+		path: `${base}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`
+	};
 }
 
-// src/base.ts
-var characterBase = "profile/wow/character";
+//#endregion
+//#region src/base.ts
+/**
+* The base request path for the character API for Classic World of Warcraft.
+*/
+const characterBase = "profile/wow/character";
 
-// src/character-achievements/character-achievements.ts
+//#endregion
+//#region src/character-achievements/character-achievements.ts
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a summary of the achievements a character has completed.
+*/
 function characterAchievementsSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/achievements`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/achievements`
+	};
 }
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}. Note: This API is not supported for classic era realms.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a character's statistics as they pertain to achievements.
+*/
 function characterAchievementStatistics(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/achievements/statistics`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/achievements/statistics`
+	};
 }
 
-// src/character-equipment/character-equipment.ts
+//#endregion
+//#region src/character-equipment/character-equipment.ts
+/**
+* Returns a summary of the items equipped by a character.
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The realm slug.
+* @param characterName The character name.
+* @returns The character equipment summary.
+*/
 function characterEquipmentSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName}/equipment`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName}/equipment`
+	};
 }
 
-// src/character-hunter-pets/character-hunter-pets.ts
+//#endregion
+//#region src/character-hunter-pets/character-hunter-pets.ts
+/**
+* If the character is a hunter, returns a summary of the character's hunter pets. Otherwise, returns an HTTP 404 Not Found error.
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a summary of the character's hunter pets.
+*/
 function characterHunterPetsSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName}/hunter-pets`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName}/hunter-pets`
+	};
 }
 
-// src/character-media/character-media.ts
+//#endregion
+//#region src/character-media/character-media.ts
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a summary of the media assets available for a character (such as an avatar render).
+*/
 function characterMediaSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName}/character-media`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName}/character-media`
+	};
 }
 
-// src/character-profile/character-profile.ts
+//#endregion
+//#region src/character-profile/character-profile.ts
+/**
+* Returns the status and a unique ID for a character. A client should delete information about a character from their application if any of the following conditions occur:
+* - an HTTP 404 Not Found error is returned
+* - the is_valid value is false
+* - the returned character ID doesn't match the previously recorded value for the character
+*
+* The following example illustrates how to use this endpoint:
+*
+* 1. A client requests and stores information about a character, including its unique character ID and the timestamp of the request.
+* 2. After 30 days, the client makes a request to the status endpoint to verify if the character information is still valid.
+* 3. If character cannot be found, is not valid, or the characters IDs do not match, the client removes the information from their application.
+* 4. If the character is valid and the character IDs match, the client retains the data for another 30 days.
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns the status of the character profile for a character.
+*/
 function characterProfileStatus(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/status`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}/status`
+	};
 }
+/**
+* Returns a summary of the character profile for a character.
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a summary of the character profile for a character.
+*/
 function characterProfileSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName.toLowerCase()}`
+	};
 }
 
-// src/character-specialization/character-specialization.ts
+//#endregion
+//#region src/character-specialization/character-specialization.ts
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a summary of a character's specializations.
+*/
 function characterSpecializationsSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName}/specializations`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName}/specializations`
+	};
 }
 
-// src/character-statistics/character-statistics.ts
+//#endregion
+//#region src/character-statistics/character-statistics.ts
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param characterName The lowercase name of the character.
+* @returns a statistics summary for a character.
+*/
 function characterStatisticsSummary(namespace, realmSlug, characterName) {
-  return {
-    namespace,
-    path: `${characterBase}/${realmSlug}/${characterName}/statistics`
-  };
+	return {
+		namespace,
+		path: `${characterBase}/${realmSlug}/${characterName}/statistics`
+	};
 }
 
-// src/connected-realm/connected-realm.ts
+//#endregion
+//#region src/connected-realm/connected-realm.ts
+/**
+
+* Returns a connected realm by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param connectedRealmId The connected realm ID.
+
+* @returns The connected realm. See {@link ConnectedRealmResponse}.
+
+*/
 function connectedRealm(namespace, connectedRealmId) {
-  return {
-    namespace,
-    path: `${base}/connected-realm/${connectedRealmId}`
-  };
+	return {
+		namespace,
+		path: `${base}/connected-realm/${connectedRealmId}`
+	};
 }
+/**
+
+* Returns an index of connected realms.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
+
+*/
 function connectedRealmIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/connected-realm/index`
-  };
+	return {
+		namespace,
+		path: `${base}/connected-realm/index`
+	};
 }
+/**
+
+* Performs a search of connected realms.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param options The search parameters. See {@link ConnectedRealmSearchParameters}.
+
+* @returns The search results. See {@link SearchResponse} & {@link ConnectedRealmSearchResponseItem}.
+
+*/
 function connectedRealmSearch(namespace, options) {
-  return {
-    namespace,
-    parameters: {
-      _page: options._page,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      "realms.timezone": options["realms.timezone"],
-      "status.type": options["status.type"]
-    },
-    path: `${base}/search/connected-realm`
-  };
-}
-
-// src/creature/creature.ts
+	return {
+		namespace,
+		parameters: {
+			_page: options._page,
+			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+			"realms.timezone": options["realms.timezone"],
+			"status.type": options["status.type"]
+		},
+		path: `${base}/search/connected-realm`
+	};
+}
+
+//#endregion
+//#region src/creature/creature.ts
+/**
+
+* Returns a creature by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param creatureId The creature ID.
+
+* @returns The creature. See {@link CreatureResponse}.
+
+*/
 function creature(namespace, creatureId) {
-  return {
-    namespace,
-    path: `${base}/creature/${creatureId}`
-  };
+	return {
+		namespace,
+		path: `${base}/creature/${creatureId}`
+	};
 }
+/**
+
+* Returns media for a creature display by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param creatureDisplayId The creature display ID.
+
+* @returns The creature display media. See {@link CreatureDisplayMediaResponse}.
+
+*/
 function creatureDisplayMedia(namespace, creatureDisplayId) {
-  return {
-    namespace,
-    path: `${mediaBase}/creature-display/${creatureDisplayId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/creature-display/${creatureDisplayId}`
+	};
 }
+/**
+
+* Returns a creature family by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param creatureFamilyId The creature family ID.
+
+* @returns The creature family. See {@link CreatureFamilyResponse}.
+
+*/
 function creatureFamily(namespace, creatureFamilyId) {
-  return {
-    namespace,
-    path: `${base}/creature-family/${creatureFamilyId}`
-  };
+	return {
+		namespace,
+		path: `${base}/creature-family/${creatureFamilyId}`
+	};
 }
+/**
+
+* Returns an index of creature families.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
+
+*/
 function creatureFamilyIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/creature-family/index`
-  };
+	return {
+		namespace,
+		path: `${base}/creature-family/index`
+	};
 }
+/**
+
+* Returns media for a creature family by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param creatureFamilyId The creature family ID.
+
+* @returns The creature family media. See {@link CreatureFamilyMediaResponse}.
+
+*/
 function creatureFamilyMedia(namespace, creatureFamilyId) {
-  return {
-    namespace,
-    path: `${mediaBase}/creature-family/${creatureFamilyId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/creature-family/${creatureFamilyId}`
+	};
 }
+/**
+
+* Performs a search of creatures.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param options The creature search parameters. See {@link CreatureSearchParameters}.
+
+* @returns The creature search results. See {@link SearchResponse} & {@link CreatureSearchResponseItem}.
+
+*/
 function creatureSearch(namespace, options) {
-  return {
-    namespace,
-    parameters: {
-      _page: options._page,
-      [`name.${options.locale}`]: options.name,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
-    },
-    path: `${searchBase}/creature`
-  };
+	return {
+		namespace,
+		parameters: {
+			_page: options._page,
+			[`name.${options.locale}`]: options.name,
+			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
+		},
+		path: `${searchBase}/creature`
+	};
 }
+/**
+
+* Returns a creature type by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param creatureTypeId The creature type ID.
+
+* @returns The creature type. See {@link CreatureTypeResponse}.
+
+*/
 function creatureType(namespace, creatureTypeId) {
-  return {
-    namespace,
-    path: `${base}/creature-type/${creatureTypeId}`
-  };
+	return {
+		namespace,
+		path: `${base}/creature-type/${creatureTypeId}`
+	};
 }
+/**
+
+* Returns an index of creature types.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The creature type index. See {@link CreatureTypeIndexResponse}.
+
+*/
 function creatureTypeIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/creature-type/index`
-  };
+	return {
+		namespace,
+		path: `${base}/creature-type/index`
+	};
 }
 
-// src/guild-crest/guild-crest.ts
+//#endregion
+//#region src/guild-crest/guild-crest.ts
+/**
+
+* Returns media for a guild crest border by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param borderId The guild crest border ID.
+
+* @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+
+*/
 function guildCrestBorder(namespace, borderId) {
-  return {
-    namespace,
-    path: `${mediaBase}/guild-crest/border/${borderId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/guild-crest/border/${borderId}`
+	};
 }
+/**
+
+* Returns an index of guild crest media.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+
+*/
 function guildCrestComponentsIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/guild-crest/index`
-  };
+	return {
+		namespace,
+		path: `${base}/guild-crest/index`
+	};
 }
+/**
+
+* Returns media for a guild crest emblem by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param emblemId The guild crest emblem ID.
+
+* @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+
+*/
 function guildCrestEmblem(namespace, emblemId) {
-  return {
-    namespace,
-    path: `${mediaBase}/guild-crest/emblem/${emblemId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/guild-crest/emblem/${emblemId}`
+	};
 }
 
-// src/guild/guild.ts
-var basePath = "/data/wow/guild";
+//#endregion
+//#region src/guild/guild.ts
+const basePath = "/data/wow/guild";
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param nameSlug The lowercase name of the guild.
+* @returns a single guild by its name and realm.
+*/
 function guild(namespace, realmSlug, nameSlug) {
-  return {
-    namespace,
-    path: `${basePath}/${realmSlug}/${nameSlug}`
-  };
+	return {
+		namespace,
+		path: `${basePath}/${realmSlug}/${nameSlug}`
+	};
 }
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param nameSlug The lowercase name of the guild.
+* @returns a single guild's achievements by name and realm.
+*/
 function guildAchievements(namespace, realmSlug, nameSlug) {
-  return {
-    namespace,
-    path: `${basePath}/${realmSlug}/${nameSlug}/achievements`
-  };
+	return {
+		namespace,
+		path: `${basePath}/${realmSlug}/${nameSlug}/achievements`
+	};
 }
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param nameSlug The lowercase name of the guild.
+* @returns a single guild's activity by name and realm.
+*/
 function guildActivity(namespace, realmSlug, nameSlug) {
-  return {
-    namespace,
-    path: `${basePath}/${realmSlug}/${nameSlug}/activity`
-  };
+	return {
+		namespace,
+		path: `${basePath}/${realmSlug}/${nameSlug}/activity`
+	};
 }
+/**
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+* @param realmSlug The slug of the realm.
+* @param nameSlug The lowercase name of the guild.
+* @returns a single guild's roster by its name and realm.
+*/
 function guildRoster(namespace, realmSlug, nameSlug) {
-  return {
-    namespace,
-    path: `${basePath}/${realmSlug}/${nameSlug}/roster`
-  };
+	return {
+		namespace,
+		path: `${basePath}/${realmSlug}/${nameSlug}/roster`
+	};
 }
 
-// src/item/item.ts
+//#endregion
+//#region src/item/item.ts
+/**
+
+* Get an item by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param itemId The item ID.
+
+* @returns The item. See {@link ItemResponse}.
+
+*/
 function item(namespace, itemId) {
-  return {
-    namespace,
-    path: `${base}/item/${itemId}`
-  };
+	return {
+		namespace,
+		path: `${base}/item/${itemId}`
+	};
 }
+/**
+
+* Get an item class by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param itemClassId The item class ID.
+
+* @returns The item class. See {@link ItemClassResponse}.
+
+*/
 function itemClass(namespace, itemClassId) {
-  return {
-    namespace,
-    path: `${base}/item-class/${itemClassId}`
-  };
+	return {
+		namespace,
+		path: `${base}/item-class/${itemClassId}`
+	};
 }
+/**
+
+* Get an item class index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The item class index. See {@link ItemClassIndexResponse}.
+
+*/
 function itemClassIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/item-class/index`
-  };
+	return {
+		namespace,
+		path: `${base}/item-class/index`
+	};
 }
+/**
+
+* Get item media by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param itemId The item ID.
+
+* @returns The item media. See {@link ItemMediaResponse}.
+
+*/
 function itemMedia(namespace, itemId) {
-  return {
-    namespace,
-    path: `${mediaBase}/item/${itemId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/item/${itemId}`
+	};
 }
+/**
+
+* Search for items.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param options The search parameters. See {@link ItemSearchParameters}.
+
+* @returns The search results. See {@link SearchResponse}.
+
+*/
 function itemSearch(namespace, options) {
-  return {
-    namespace,
-    parameters: {
-      _page: options._page,
-      [`name.${options.locale}`]: options.name,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
-    },
-    path: `${searchBase}/item`
-  };
+	return {
+		namespace,
+		parameters: {
+			_page: options._page,
+			[`name.${options.locale}`]: options.name,
+			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
+		},
+		path: `${searchBase}/item`
+	};
 }
+/**
+
+* Get an item subclass by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param itemClassId The item class ID.
+
+* @param itemSubclassId The item subclass ID.
+
+* @returns The item subclass. See {@link ItemSubClassResponse}.
+
+*/
 function itemSubClass(namespace, itemClassId, itemSubclassId) {
-  return {
-    namespace,
-    path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
-  };
+	return {
+		namespace,
+		path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
+	};
 }
 
-// src/media-search/media-search.ts
+//#endregion
+//#region src/media-search/media-search.ts
+/**
+
+* Search for media.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param options The search parameters. See {@link MediaSearchParameters}.
+
+* @returns The search results. See {@link SearchResponse}.
+
+*/
 function mediaSearch(namespace, options) {
-  return {
-    namespace,
-    parameters: {
-      _page: options._page,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      tags: options.tags
-    },
-    path: `${searchBase}/media`
-  };
-}
-
-// src/playable-class/playable-class.ts
+	return {
+		namespace,
+		parameters: {
+			_page: options._page,
+			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+			tags: options.tags
+		},
+		path: `${searchBase}/media`
+	};
+}
+
+//#endregion
+//#region src/playable-class/playable-class.ts
+/**
+
+* Get a playable class by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param playableClassId The playable class ID.
+
+* @returns The playable class. See {@link PlayableClassResponse}.
+
+*/
 function playableClass(namespace, playableClassId) {
-  return {
-    namespace,
-    path: `${base}/playable-class/${playableClassId}`
-  };
+	return {
+		namespace,
+		path: `${base}/playable-class/${playableClassId}`
+	};
 }
+/**
+
+* Get a playable class index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The playable class index. See {@link PlayableClassIndexResponse}.
+
+*/
 function playableClassIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/playable-class/index`
-  };
+	return {
+		namespace,
+		path: `${base}/playable-class/index`
+	};
 }
+/**
+
+* Get playable class media by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param playableClassId The playable class ID.
+
+* @returns The playable class media. See {@link PlayableClassMediaResponse}.
+
+*/
 function playableClassMedia(namespace, playableClassId) {
-  return {
-    namespace,
-    path: `${mediaBase}/playable-class/${playableClassId}`
-  };
+	return {
+		namespace,
+		path: `${mediaBase}/playable-class/${playableClassId}`
+	};
 }
 
-// src/playable-race/playable-race.ts
+//#endregion
+//#region src/playable-race/playable-race.ts
+/**
+
+* Get a playable race by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param playableRaceId The playable race ID.
+
+* @returns The playable race. See {@link PlayableRaceResponse}.
+
+*/
 function playableRace(namespace, playableRaceId) {
-  return {
-    namespace,
-    path: `${base}/playable-race/${playableRaceId}`
-  };
+	return {
+		namespace,
+		path: `${base}/playable-race/${playableRaceId}`
+	};
 }
+/**
+
+* Get a playable race index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The playable race index. See {@link PlayableRaceIndexResponse}.
+
+*/
 function playableRaceIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/playable-race/index`
-  };
+	return {
+		namespace,
+		path: `${base}/playable-race/index`
+	};
 }
 
-// src/power-type/power-type.ts
+//#endregion
+//#region src/power-type/power-type.ts
+/**
+
+* Get a power type by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param powerTypeId The power type ID.
+
+* @returns The power type. See {@link PowerTypeResponse}.
+
+*/
 function powerType(namespace, powerTypeId) {
-  return {
-    namespace,
-    path: `${base}/power-type/${powerTypeId}`
-  };
+	return {
+		namespace,
+		path: `${base}/power-type/${powerTypeId}`
+	};
 }
+/**
+
+* Get a power type index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The power type index. See {@link PowerTypeIndexResponse}.
+
+*/
 function powerTypeIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/power-type/index`
-  };
+	return {
+		namespace,
+		path: `${base}/power-type/index`
+	};
 }
 
-// src/pvp-season/pvp-season.ts
+//#endregion
+//#region src/pvp-season/pvp-season.ts
+/**
+
+* Get a PvP leaderboard by PvP season ID and bracket.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpRegionId The PvP region ID.
+
+* @param pvpSeasonId The PvP season ID.
+
+* @param pvpBracket The PvP bracket.
+
+* @returns The PvP leaderboard.
+
+*/
 function pvpLeaderboard(namespace, pvpRegionId, pvpSeasonId, pvpBracket) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${pvpBracket}`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${pvpBracket}`
+	};
 }
+/**
+
+* Returns an index of PvP leaderboards for a PvP season in a given PvP region.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpRegionId The PvP region ID.
+
+* @param pvpSeasonId The PvP season ID.
+
+* @returns The PvP leaderboard index.
+
+*/
 function pvpLeaderboardIndex(namespace, pvpRegionId, pvpSeasonId) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
+	};
 }
+/**
+
+* Returns a PvP season by region ID and season ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpRegionId The PvP region ID.
+
+* @param pvpSeasonId The PvP season ID.
+
+* @returns The PvP season.
+
+*/
 function pvpRegionalSeason(namespace, pvpRegionId, pvpSeasonId) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}`
+	};
 }
+/**
+
+* Returns an index of PvP Seasons in a PvP region.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpRegionId The PvP region ID.
+
+* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+
+*/
 function pvpRegionalSeasonIndex(namespace, pvpRegionId) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/${pvpRegionId}/pvp-season/index`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/${pvpRegionId}/pvp-season/index`
+	};
 }
+/**
+
+* Returns an index of PvP Regions.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The PvP region index.
+
+*/
 function pvpRegionIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/index`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/index`
+	};
 }
+/**
+
+* Returns an index of PvP rewards for a PvP season in a given PvP region.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpRegionId The PvP region ID.
+
+* @param pvpSeasonId The PvP season ID.
+
+* @returns The PvP reward index.
+
+*/
 function pvpRewardsIndex(namespace, pvpRegionId, pvpSeasonId) {
-  return {
-    namespace,
-    path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-reward/index`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-reward/index`
+	};
 }
+/**
+
+* Get a PvP season by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param pvpSeasonId The PvP season ID.
+
+* @returns The PvP season. See {@link PvpSeasonResponse}.
+
+*/
 function pvpSeason(namespace, pvpSeasonId) {
-  return {
-    namespace,
-    path: `${base}/pvp-season/${pvpSeasonId}`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-season/${pvpSeasonId}`
+	};
 }
+/**
+
+* Get a PvP season index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+
+*/
 function pvpSeasonIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/pvp-season/index`
-  };
+	return {
+		namespace,
+		path: `${base}/pvp-season/index`
+	};
 }
 
-// src/realm/realm.ts
+//#endregion
+//#region src/realm/realm.ts
+/**
+
+* Get a realm by slug.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param realmSlug The realm slug.
+
+* @returns The realm. See {@link RealmResponse}.
+
+*/
 function realm(namespace, realmSlug) {
-  return {
-    namespace,
-    path: `${base}/realm/${realmSlug}`
-  };
+	return {
+		namespace,
+		path: `${base}/realm/${realmSlug}`
+	};
 }
+/**
+
+* Get a realm index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The realm index. See {@link RealmIndexResponse}.
+
+*/
 function realmIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/realm/index`
-  };
+	return {
+		namespace,
+		path: `${base}/realm/index`
+	};
 }
+/**
+
+* Search for realms.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param options The search parameters. See {@link RealmSearchParameters}.
+
+* @returns The search results. See {@link SearchResponse}.
+
+*/
 function realmSearch(namespace, options) {
-  return {
-    namespace,
-    parameters: {
-      _page: options._page,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      timezone: options.timezone
-    },
-    path: `${searchBase}/realm`
-  };
-}
-
-// src/region/region.ts
+	return {
+		namespace,
+		parameters: {
+			_page: options._page,
+			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+			timezone: options.timezone
+		},
+		path: `${searchBase}/realm`
+	};
+}
+
+//#endregion
+//#region src/region/region.ts
+/**
+
+* Get a region by ID.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @param regionId The region ID.
+
+* @returns The region. See {@link RegionResponse}.
+
+*/
 function region(namespace, regionId) {
-  return {
-    namespace,
-    path: `${base}/region/${regionId}`
-  };
+	return {
+		namespace,
+		path: `${base}/region/${regionId}`
+	};
 }
+/**
+
+* Get a region index.
+
+* @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+
+* @returns The region index. See {@link RegionIndexResponse}.
+
+*/
 function regionIndex(namespace) {
-  return {
-    namespace,
-    path: `${base}/region/index`
-  };
-}
-
-// src/index.ts
-var classicWow = {
-  //Auction House
-  auctionHouseIndex,
-  auctions,
-  //Character Achievements
-  characterAchievementsSummary,
-  characterAchievementStatistics,
-  //Character Equipment
-  characterEquipmentSummary,
-  //Character Hunter Pets
-  characterHunterPetsSummary,
-  //Character Media
-  characterMediaSummary,
-  //Character Profile
-  characterProfileStatus,
-  characterProfileSummary,
-  //Character Specialization
-  characterSpecializationsSummary,
-  //Character Statistics
-  characterStatisticsSummary,
-  //Connected Realm
-  connectedRealm,
-  connectedRealmIndex,
-  connectedRealmSearch,
-  //Creature
-  creature,
-  creatureDisplayMedia,
-  creatureFamily,
-  creatureFamilyIndex,
-  creatureFamilyMedia,
-  creatureSearch,
-  creatureType,
-  creatureTypeIndex,
-  //Guild
-  guild,
-  guildAchievements,
-  guildActivity,
-  guildRoster,
-  //Guild Crest
-  guildCrestBorder,
-  guildCrestComponentsIndex,
-  guildCrestEmblem,
-  //Item
-  item,
-  itemClass,
-  itemClassIndex,
-  itemMedia,
-  itemSearch,
-  itemSubClass,
-  //Media Search
-  mediaSearch,
-  //Playable Class
-  playableClass,
-  playableClassIndex,
-  playableClassMedia,
-  //Playable Race
-  playableRace,
-  playableRaceIndex,
-  //Power Type
-  powerType,
-  powerTypeIndex,
-  //Pvp Season
-  pvpLeaderboard,
-  pvpLeaderboardIndex,
-  pvpRegionalSeason,
-  pvpRegionalSeasonIndex,
-  pvpRegionIndex,
-  pvpRewardsIndex,
-  pvpSeason,
-  pvpSeasonIndex,
-  //Realm
-  realm,
-  realmIndex,
-  realmSearch,
-  //Region
-  region,
-  regionIndex
+	return {
+		namespace,
+		path: `${base}/region/index`
+	};
+}
+
+//#endregion
+//#region src/index.ts
+const classicWow = {
+	auctionHouseIndex,
+	auctions,
+	characterAchievementsSummary,
+	characterAchievementStatistics,
+	characterEquipmentSummary,
+	characterHunterPetsSummary,
+	characterMediaSummary,
+	characterProfileStatus,
+	characterProfileSummary,
+	characterSpecializationsSummary,
+	characterStatisticsSummary,
+	connectedRealm,
+	connectedRealmIndex,
+	connectedRealmSearch,
+	creature,
+	creatureDisplayMedia,
+	creatureFamily,
+	creatureFamilyIndex,
+	creatureFamilyMedia,
+	creatureSearch,
+	creatureType,
+	creatureTypeIndex,
+	guild,
+	guildAchievements,
+	guildActivity,
+	guildRoster,
+	guildCrestBorder,
+	guildCrestComponentsIndex,
+	guildCrestEmblem,
+	item,
+	itemClass,
+	itemClassIndex,
+	itemMedia,
+	itemSearch,
+	itemSubClass,
+	mediaSearch,
+	playableClass,
+	playableClassIndex,
+	playableClassMedia,
+	playableRace,
+	playableRaceIndex,
+	powerType,
+	powerTypeIndex,
+	pvpLeaderboard,
+	pvpLeaderboardIndex,
+	pvpRegionalSeason,
+	pvpRegionalSeasonIndex,
+	pvpRegionIndex,
+	pvpRewardsIndex,
+	pvpSeason,
+	pvpSeasonIndex,
+	realm,
+	realmIndex,
+	realmSearch,
+	region,
+	regionIndex
 };
 var src_default = classicWow;
 
+//#endregion
 export { auctionHouseIndex, auctions, characterAchievementStatistics, characterAchievementsSummary, characterEquipmentSummary, characterHunterPetsSummary, characterMediaSummary, characterProfileStatus, characterProfileSummary, characterSpecializationsSummary, characterStatisticsSummary, classicWow, connectedRealm, connectedRealmIndex, connectedRealmSearch, creature, creatureDisplayMedia, creatureFamily, creatureFamilyIndex, creatureFamilyMedia, creatureSearch, creatureType, creatureTypeIndex, src_default as default, guild, guildAchievements, guildActivity, guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem, guildRoster, item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSubClass, mediaSearch, playableClass, playableClassIndex, playableClassMedia, playableRace, playableRaceIndex, powerType, powerTypeIndex, pvpLeaderboard, pvpLeaderboardIndex, pvpRegionIndex, pvpRegionalSeason, pvpRegionalSeasonIndex, pvpRewardsIndex, pvpSeason, pvpSeasonIndex, realm, realmIndex, realmSearch, region, regionIndex };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map