@blizzard-api/wow/dist/journal/index.js

A series of helpers to interact with the World of Warcraft Blizzard API

import { wowBasePath, wowMediaBasePath, wowSearchBasePath } from "@blizzard-api/core";
//#region src/journal/index.ts
/**
* Get a journal encounter by ID.
* @param journalEncounterId The journal encounter ID.
* @returns The journal encounter. See {@link JournalEncounterResponse}.
*/
function journalEncounter(journalEncounterId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-encounter/${journalEncounterId}`
	};
}
/**
* Get the journal encounter index.
* @returns The journal encounter index. See {@link JournalEncounterIndexResponse}.
*/
function journalEncounterIndex() {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-encounter/index`
	};
}
/**
* Search for journal encounters.
* @param options The search parameters. See {@link JournalEncounterSearchParameters}.
* @returns The search results. See {@link JournalEncounterSearchResponse}.
*/
function journalEncounterSearch(options) {
	return {
		namespace: "static",
		parameters: {
			_page: options._page,
			[`instance.name.${options.locale}`]: options.instanceName,
			orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
		},
		path: `${wowSearchBasePath}/journal-encounter`
	};
}
/**
* Get a journal expansion by ID.
* @param journalExpansionId The journal expansion ID.
* @returns The journal expansion. See {@link JournalExpansionResponse}.
*/
function journalExpansion(journalExpansionId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-expansion/${journalExpansionId}`
	};
}
/**
* Get the journal expansion index.
* @returns The journal expansion index. See {@link JournalExpansionIndexResponse}.
*/
function journalExpansionIndex() {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-expansion/index`
	};
}
/**
* Get a journal instance by ID.
* @param journalInstanceId The journal instance ID.
* @returns The journal instance. See {@link JournalInstanceResponse}.
*/
function journalInstance(journalInstanceId) {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-instance/${journalInstanceId}`
	};
}
/**
* Get the journal instance index.
* @returns The journal instance index. See {@link JournalInstanceIndexResponse}.
*/
function journalInstanceIndex() {
	return {
		namespace: "static",
		path: `${wowBasePath}/journal-instance/index`
	};
}
/**
* Get journal instance media by ID.
* @param journalInstanceId The journal instance ID.
* @returns The journal instance media. See {@link JournalInstanceMediaResponse}.
*/
function journalInstanceMedia(journalInstanceId) {
	return {
		namespace: "static",
		path: `${wowMediaBasePath}/journal-instance/${journalInstanceId}`
	};
}
//#endregion
export { journalEncounter, journalEncounterIndex, journalEncounterSearch, journalExpansion, journalExpansionIndex, journalInstance, journalInstanceIndex, journalInstanceMedia };

//# sourceMappingURL=index.js.map