@blizzard-api/classic-wow 0.1.0

package/dist/index.js

@@ -0,0 +1,606 @@
+// ../wow/src/base.ts
+var base = "/data/wow";
+var mediaBase = `${base}/media`;
+var searchBase = `${base}/search`;
+
+// src/auction-house/auction-house.ts
+var classicAuctionHouseApi = {
+  /**
+   * 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}.
+   */
+  auctionHouseIndex: (namespace, connectedRealmId) => {
+    return {
+      path: `${base}/connected-realm/${connectedRealmId}/auctions/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  auctions: (namespace, connectedRealmId, auctionHouseId) => {
+    return {
+      path: `${base}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`,
+      namespace
+    };
+  }
+};
+
+// src/connected-realm/connected-realm.ts
+var classicConnectedRealmApi = {
+  /**
+   * Returns an index of connected realms.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The connected realm index. See {@link ConnectedRealmIndexResponse}.
+   */
+  connectedRealmIndex: (namespace) => {
+    return {
+      path: `${base}/connected-realm/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  connectedRealm: (namespace, connectedRealmId) => {
+    return {
+      path: `${base}/connected-realm/${connectedRealmId}`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  connectedRealmSearch: (namespace, options) => {
+    return {
+      namespace,
+      parameters: {
+        _page: options._page,
+        orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+        "status.type": options["status.type"],
+        "realms.timezone": options["realms.timezone"]
+      },
+      path: `${base}/search/connected-realm`
+    };
+  }
+};
+
+// src/creature/creature.ts
+var classicCreatureApi = {
+  /**
+   * 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}.
+   */
+  creature: (namespace, creatureId) => {
+    return {
+      path: `${base}/creature/${creatureId}`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  creatureDisplayMedia: (namespace, creatureDisplayId) => {
+    return {
+      path: `${mediaBase}/creature-display/${creatureDisplayId}`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  creatureFamily: (namespace, creatureFamilyId) => {
+    return {
+      path: `${base}/creature-family/${creatureFamilyId}`,
+      namespace
+    };
+  },
+  /**
+   * Returns an index of creature families.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The creature family index. See {@link CreatureFamilyIndexResponse}.
+   */
+  creatureFamilyIndex: (namespace) => {
+    return {
+      path: `${base}/creature-family/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  creatureFamilyMedia: (namespace, creatureFamilyId) => {
+    return {
+      path: `${mediaBase}/creature-family/${creatureFamilyId}`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  creatureType: (namespace, creatureTypeId) => {
+    return {
+      path: `${base}/creature-type/${creatureTypeId}`,
+      namespace
+    };
+  },
+  /**
+   * Returns an index of creature types.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The creature type index. See {@link CreatureTypeIndexResponse}.
+   */
+  creatureTypeIndex: (namespace) => {
+    return {
+      path: `${base}/creature-type/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  creatureSearch: (namespace, options) => {
+    return {
+      namespace,
+      parameters: {
+        _page: options._page,
+        orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+        [`name.${options.locale}`]: options.name
+      },
+      path: `${searchBase}/creature`
+    };
+  }
+};
+
+// src/guild-crest/guild-crest.ts
+var classicGuildCrestApi = {
+  /**
+   * 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}.
+   */
+  guildCrestComponentsIndex: (namespace) => {
+    return {
+      path: `${base}/guild-crest/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  guildCrestBorder: (namespace, borderId) => {
+    return {
+      path: `${mediaBase}/guild-crest/border/${borderId}`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  guildCrestEmblem: (namespace, emblemId) => {
+    return {
+      path: `${mediaBase}/guild-crest/emblem/${emblemId}`,
+      namespace
+    };
+  }
+};
+
+// src/item/item.ts
+var classicItemApi = {
+  /**
+   * Get an item class index.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The item class index. See {@link ItemClassIndexResponse}.
+   */
+  itemClassIndex: (namespace) => {
+    return {
+      path: `${base}/item-class/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  itemClass: (namespace, itemClassId) => {
+    return {
+      namespace,
+      path: `${base}/item-class/${itemClassId}`
+    };
+  },
+  /**
+   * 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}.
+   */
+  itemSubClass: (namespace, itemClassId, itemSubclassId) => {
+    return {
+      namespace,
+      path: `${base}/item-class/${itemClassId}/item-subclass/${itemSubclassId}`
+    };
+  },
+  /**
+   * 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}.
+   */
+  item: (namespace, itemId) => {
+    return {
+      namespace,
+      path: `${base}/item/${itemId}`
+    };
+  },
+  /**
+   * 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}.
+   */
+  itemMedia: (namespace, 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}.
+   */
+  itemSearch: (namespace, options) => {
+    return {
+      namespace,
+      parameters: {
+        _page: options._page,
+        orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
+        [`name.${options.locale}`]: options.name
+      },
+      path: `${searchBase}/item`
+    };
+  }
+};
+
+// src/media-search/media-search.ts
+var classicMediaSearchApi = {
+  /**
+   * Search for media.
+   * @param options The search parameters. See {@link MediaSearchParameters}.
+   * @returns The search results. See {@link SearchResponse}.
+   */
+  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
+var classicPlayableClassApi = {
+  /**
+   * 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}.
+   */
+  playableClass: (namespace, 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}.
+   */
+  playableClassIndex: (namespace) => {
+    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}.
+   */
+  playableClassMedia: (namespace, playableClassId) => {
+    return {
+      namespace,
+      path: `${mediaBase}/playable-class/${playableClassId}`
+    };
+  }
+};
+
+// src/playable-race/playable-race.ts
+var classicPlayableRaceApi = {
+  /**
+   * 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}.
+   */
+  playableRace: (namespace, 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}.
+   */
+  playableRaceIndex: (namespace) => {
+    return {
+      namespace,
+      path: `${base}/playable-race/index`
+    };
+  }
+};
+
+// src/power-type/power-type.ts
+var classicPowerTypeApi = {
+  /**
+   * 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}.
+   */
+  powerType: (namespace, 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}.
+   */
+  powerTypeIndex: (namespace) => {
+    return {
+      namespace,
+      path: `${base}/power-type/index`
+    };
+  }
+};
+
+// src/pvp-season/pvp-season.ts
+var classicPvpSeasonApi = {
+  /**
+   * Get a PvP season index.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The PvP season index. See {@link PvpSeasonIndexResponse}.
+   */
+  pvpSeasonIndex: (namespace) => {
+    return {
+      namespace,
+      path: `${base}/pvp-season/index`
+    };
+  },
+  /**
+   * Get a PvP season by ID.
+   * @param pvpSeasonId The PvP season ID.
+   * @returns The PvP season. See {@link PvpSeasonResponse}.
+   */
+  pvpSeason: (namespace, pvpSeasonId) => {
+    return {
+      namespace,
+      path: `${base}/pvp-season/${pvpSeasonId}`
+    };
+  },
+  /**
+   * Returns an index of PvP Regions.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   */
+  pvpRegionIndex: (namespace) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/index`
+    };
+  },
+  /**
+   * 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}.
+   */
+  pvpRegionalSeasonIndex: (namespace, pvpRegionId) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/${pvpRegionId}/pvp-season/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.
+   */
+  pvpRegionalSeason: (namespace, pvpRegionId, pvpSeasonId) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}`
+    };
+  },
+  /**
+   * 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.
+   */
+  pvpLeaderboardIndex: (namespace, pvpRegionId, pvpSeasonId) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/index`
+    };
+  },
+  /**
+   * 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.
+   */
+  pvpLeaderboard: (namespace, pvpRegionId, pvpSeasonId, pvpBracket) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-leaderboard/${pvpBracket}`
+    };
+  },
+  /**
+   * 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.
+   */
+  pvpRewardsIndex: (namespace, pvpRegionId, pvpSeasonId) => {
+    return {
+      namespace,
+      path: `${base}/pvp-region/${pvpRegionId}/pvp-season/${pvpSeasonId}/pvp-reward/index`
+    };
+  }
+};
+
+// src/realm/realm.ts
+var classicRealmApi = {
+  /**
+   * 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}.
+   */
+  realm: (namespace, realmSlug) => {
+    return {
+      path: `${base}/realm/${realmSlug}`,
+      namespace
+    };
+  },
+  /**
+   * Get a realm index.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The realm index. See {@link RealmIndexResponse}.
+   */
+  realmIndex: (namespace) => {
+    return {
+      path: `${base}/realm/index`,
+      namespace
+    };
+  },
+  /**
+   * 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}.
+   */
+  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
+var classicRegionApi = {
+  /**
+   * 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}.
+   */
+  region: (namespace, regionId) => {
+    return {
+      path: `${base}/region/${regionId}`,
+      namespace
+    };
+  },
+  /**
+   * Get a region index.
+   * @param namespace The namespace to use. See {@link BlizzardNamespaces}.
+   * @returns The region index. See {@link RegionIndexResponse}.
+   */
+  regionIndex: (namespace) => {
+    return {
+      path: `${base}/region/index`,
+      namespace
+    };
+  }
+};
+
+// src/index.ts
+var classicWow = {
+  ...classicAuctionHouseApi,
+  ...classicConnectedRealmApi,
+  ...classicCreatureApi,
+  ...classicGuildCrestApi,
+  ...classicItemApi,
+  ...classicMediaSearchApi,
+  ...classicPlayableClassApi,
+  ...classicPlayableRaceApi,
+  ...classicPowerTypeApi,
+  ...classicPvpSeasonApi,
+  ...classicRealmApi,
+  ...classicRegionApi
+};
+export {
+  classicWow
+};
+//# sourceMappingURL=index.js.map