@valpro-labs/valorant-api 1.1.0 → 1.3.0

package/dist/ValorantApi.d.ts

@@ -19,27 +19,72 @@ import { GameModesEndpoints } from './endpoints/GameModesEndpoints';
 import { ContractsEndpoints } from './endpoints/ContractsEndpoints';
 import { EventsEndpoints } from './endpoints/EventsEndpoints';
 import { SeasonsEndpoints } from './endpoints/SeasonsEndpoints';
+import { CeremoniesEndpoints } from './endpoints/CeremoniesEndpoints';
+import { GearEndpoints } from './endpoints/GearEndpoints';
+import { ThemesEndpoints } from './endpoints/ThemesEndpoints';
+/**
+ * Main client for the Valorant API.
+ * Provides access to all available API endpoints through dedicated endpoint properties.
+ *
+ * @example
+ * ```ts
+ * import { ValorantApi } from '@valpro-labs/valorant-api';
+ *
+ * const api = new ValorantApi({ language: 'en-US' });
+ * const agents = await api.agentsEndpoints.getAgentsV1();
+ * ```
+ */
 declare class ValorantApi {
+    /** Endpoint for retrieving the current Valorant build version. */
     versionEndpoint: VersionEndpoint;
+    /** Endpoints for retrieving map data. */
     mapsEndpoints: MapsEndpoints;
+    /** Endpoints for retrieving agent data. */
     agentsEndpoints: AgentsEndpoints;
+    /** Endpoints for retrieving weapon, skin, chroma, and level data. */
     weaponsEndpoints: WeaponsEndpoints;
+    /** Endpoints for retrieving content tier (rarity) data. */
     contentTierEndpoints: ContentTierEndpoints;
+    /** Endpoints for retrieving in-game currency data. */
     currenciesEndpoints: CurrenciesEndpoints;
+    /** Endpoints for retrieving store bundle data. */
     bundlesEndpoints: BundlesEndpoints;
+    /** Endpoints for retrieving mission data. */
     missionsEndpoints: MissionsEndpoints;
+    /** Endpoints for retrieving objective data. */
     objectivesEndpoints: ObjectivesEndpoints;
+    /** Endpoints for retrieving player card data. */
     playerCardsEndpoints: PlayerCardsEndpoints;
+    /** Endpoints for retrieving player title data. */
     playerTitlesEndpoints: PlayerTitlesEndpoints;
+    /** Endpoints for retrieving level border data. */
     levelBordersEndpoints: LevelBordersEndpoints;
+    /** Endpoints for retrieving buddy (gun charm) data. */
     buddiesEndpoints: BuddiesEndpoints;
+    /** Endpoints for retrieving spray data. */
     spraysEndpoints: SpraysEndpoints;
+    /** Endpoints for retrieving competitive tier data. */
     competitiveTiersEndpoints: CompetitiveTiersEndpoints;
+    /** Endpoints for retrieving flex data. */
     flexEndpoints: FlexEndpoints;
+    /** Endpoints for retrieving game mode and equippable data. */
     gameModesEndpoints: GameModesEndpoints;
+    /** Endpoints for retrieving contract data. */
     contractsEndpoints: ContractsEndpoints;
+    /** Endpoints for retrieving event data. */
     eventsEndpoints: EventsEndpoints;
+    /** Endpoints for retrieving season and competitive season data. */
     seasonsEndpoints: SeasonsEndpoints;
+    /** Endpoints for retrieving ceremony data. */
+    ceremoniesEndpoints: CeremoniesEndpoints;
+    /** Endpoints for retrieving gear (armor) data. */
+    gearEndpoints: GearEndpoints;
+    /** Endpoints for retrieving theme data. */
+    themesEndpoints: ThemesEndpoints;
+    /**
+     * Creates a new Valorant API client.
+     * @param config - Optional configuration for the API client.
+     */
     constructor(config?: ValorantApiConfig);
 }
 export { ValorantApi };

package/dist/ValorantApi.js

@@ -21,27 +21,72 @@ const GameModesEndpoints_1 = require("./endpoints/GameModesEndpoints");
 const ContractsEndpoints_1 = require("./endpoints/ContractsEndpoints");
 const EventsEndpoints_1 = require("./endpoints/EventsEndpoints");
 const SeasonsEndpoints_1 = require("./endpoints/SeasonsEndpoints");
+const CeremoniesEndpoints_1 = require("./endpoints/CeremoniesEndpoints");
+const GearEndpoints_1 = require("./endpoints/GearEndpoints");
+const ThemesEndpoints_1 = require("./endpoints/ThemesEndpoints");
+/**
+ * Main client for the Valorant API.
+ * Provides access to all available API endpoints through dedicated endpoint properties.
+ *
+ * @example
+ * ```ts
+ * import { ValorantApi } from '@valpro-labs/valorant-api';
+ *
+ * const api = new ValorantApi({ language: 'en-US' });
+ * const agents = await api.agentsEndpoints.getAgentsV1();
+ * ```
+ */
 class ValorantApi {
+    /** Endpoint for retrieving the current Valorant build version. */
     versionEndpoint;
+    /** Endpoints for retrieving map data. */
     mapsEndpoints;
+    /** Endpoints for retrieving agent data. */
     agentsEndpoints;
+    /** Endpoints for retrieving weapon, skin, chroma, and level data. */
     weaponsEndpoints;
+    /** Endpoints for retrieving content tier (rarity) data. */
     contentTierEndpoints;
+    /** Endpoints for retrieving in-game currency data. */
     currenciesEndpoints;
+    /** Endpoints for retrieving store bundle data. */
     bundlesEndpoints;
+    /** Endpoints for retrieving mission data. */
     missionsEndpoints;
+    /** Endpoints for retrieving objective data. */
     objectivesEndpoints;
+    /** Endpoints for retrieving player card data. */
     playerCardsEndpoints;
+    /** Endpoints for retrieving player title data. */
     playerTitlesEndpoints;
+    /** Endpoints for retrieving level border data. */
     levelBordersEndpoints;
+    /** Endpoints for retrieving buddy (gun charm) data. */
     buddiesEndpoints;
+    /** Endpoints for retrieving spray data. */
     spraysEndpoints;
+    /** Endpoints for retrieving competitive tier data. */
     competitiveTiersEndpoints;
+    /** Endpoints for retrieving flex data. */
     flexEndpoints;
+    /** Endpoints for retrieving game mode and equippable data. */
     gameModesEndpoints;
+    /** Endpoints for retrieving contract data. */
     contractsEndpoints;
+    /** Endpoints for retrieving event data. */
     eventsEndpoints;
+    /** Endpoints for retrieving season and competitive season data. */
     seasonsEndpoints;
+    /** Endpoints for retrieving ceremony data. */
+    ceremoniesEndpoints;
+    /** Endpoints for retrieving gear (armor) data. */
+    gearEndpoints;
+    /** Endpoints for retrieving theme data. */
+    themesEndpoints;
+    /**
+     * Creates a new Valorant API client.
+     * @param config - Optional configuration for the API client.
+     */
     constructor(config) {
         this.versionEndpoint = new VersionEndpoint_1.VersionEndpoint(config);
         this.mapsEndpoints = new MapsEndpoints_1.MapsEndpoints(config);
@@ -63,6 +108,9 @@ class ValorantApi {
         this.contractsEndpoints = new ContractsEndpoints_1.ContractsEndpoints(config);
         this.eventsEndpoints = new EventsEndpoints_1.EventsEndpoints(config);
         this.seasonsEndpoints = new SeasonsEndpoints_1.SeasonsEndpoints(config);
+        this.ceremoniesEndpoints = new CeremoniesEndpoints_1.CeremoniesEndpoints(config);
+        this.gearEndpoints = new GearEndpoints_1.GearEndpoints(config);
+        this.themesEndpoints = new ThemesEndpoints_1.ThemesEndpoints(config);
     }
 }
 exports.ValorantApi = ValorantApi;

package/dist/endpoints/AgentsEndpoints.d.ts

@@ -1,8 +1,21 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { AgentResponse, AgentsResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API agents endpoints.
+ */
 declare class AgentsEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all agents.
+     * @param isPlayableCharacter - Filter to only playable characters. Defaults to `true`.
+     * @returns An array of {@link AgentResponse} objects.
+     */
     getAgentsV1(isPlayableCharacter?: boolean): Promise<AgentsResponse>;
+    /**
+     * Get an agent by UUID.
+     * @param uuid - The UUID of the agent.
+     * @returns The {@link AgentResponse} matching the given UUID.
+     */
     getAgentsByUuidV1(uuid: string): Promise<AgentResponse>;
 }
 export { AgentsEndpoints };

package/dist/endpoints/AgentsEndpoints.js

@@ -2,10 +2,18 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AgentsEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API agents endpoints.
+ */
 class AgentsEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all agents.
+     * @param isPlayableCharacter - Filter to only playable characters. Defaults to `true`.
+     * @returns An array of {@link AgentResponse} objects.
+     */
     async getAgentsV1(isPlayableCharacter = true) {
         let endpointUrl = 'v1/agents';
         if (isPlayableCharacter) {
@@ -13,6 +21,11 @@ class AgentsEndpoints extends BaseEndpoint_1.BaseEndpoint {
         }
         return this.requestValorantApi(endpointUrl);
     }
+    /**
+     * Get an agent by UUID.
+     * @param uuid - The UUID of the agent.
+     * @returns The {@link AgentResponse} matching the given UUID.
+     */
     async getAgentsByUuidV1(uuid) {
         return this.requestValorantApi(`v1/agents/${uuid}`);
     }

package/dist/endpoints/BaseEndpoint.d.ts

@@ -1,10 +1,32 @@
+/**
+ * Supported locale codes for the Valorant API.
+ * Controls the language of localized strings in API responses.
+ */
 export type ValorantLocale = 'ar-AE' | 'de-DE' | 'en-US' | 'es-ES' | 'es-MX' | 'fr-FR' | 'id-ID' | 'it-IT' | 'ja-JP' | 'ko-KR' | 'pl-PL' | 'pt-BR' | 'ru-RU' | 'th-TH' | 'tr-TR' | 'vi-VN' | 'zh-CN' | 'zh-TW';
+/**
+ * Configuration options for the Valorant API client.
+ */
 export interface ValorantApiConfig {
+    /** The language/locale for API responses. Defaults to `'en-US'`. */
     language?: ValorantLocale;
 }
+/**
+ * Base class for all Valorant API endpoint classes.
+ * Provides shared HTTP request logic and locale configuration.
+ */
 declare class BaseEndpoint {
+    /** The configured locale for API requests. */
     protected language: ValorantLocale;
+    /**
+     * @param config - Optional configuration for the API client.
+     */
     constructor(config?: ValorantApiConfig);
+    /**
+     * Sends a GET request to the Valorant API.
+     * @typeParam T - The expected shape of the response data.
+     * @param endpointUrl - The API endpoint path (e.g. `v1/agents`).
+     * @returns The parsed response data.
+     */
     requestValorantApi<T>(endpointUrl: string): Promise<T>;
 }
 export { BaseEndpoint };

package/dist/endpoints/BaseEndpoint.js

@@ -5,11 +5,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BaseEndpoint = void 0;
 const axios_1 = __importDefault(require("axios"));
+/**
+ * Base class for all Valorant API endpoint classes.
+ * Provides shared HTTP request logic and locale configuration.
+ */
 class BaseEndpoint {
+    /** The configured locale for API requests. */
     language;
+    /**
+     * @param config - Optional configuration for the API client.
+     */
     constructor(config) {
         this.language = config?.language || 'en-US';
     }
+    /**
+     * Sends a GET request to the Valorant API.
+     * @typeParam T - The expected shape of the response data.
+     * @param endpointUrl - The API endpoint path (e.g. `v1/agents`).
+     * @returns The parsed response data.
+     */
     async requestValorantApi(endpointUrl) {
         const baseUrl = 'https://valorant-api.com/';
         const url = new URL(endpointUrl, baseUrl);

package/dist/endpoints/BuddiesEndpoints.d.ts

@@ -1,9 +1,26 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { BuddyResponse, BuddiesResponse, BuddyLevelResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API buddies (gun charms) endpoints.
+ */
 declare class BuddiesEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all buddies.
+     * @returns An array of {@link BuddyResponse} objects.
+     */
     getBuddiesV1(): Promise<BuddiesResponse>;
+    /**
+     * Get a buddy by UUID.
+     * @param uuid - The UUID of the buddy.
+     * @returns The {@link BuddyResponse} matching the given UUID.
+     */
     getBuddyByUuidV1(uuid: string): Promise<BuddyResponse>;
+    /**
+     * Get a buddy level by UUID.
+     * @param uuid - The UUID of the buddy level.
+     * @returns The {@link BuddyLevelResponse} matching the given UUID.
+     */
     getBuddyLevelByUuidV1(uuid: string): Promise<BuddyLevelResponse>;
 }
 export { BuddiesEndpoints };

package/dist/endpoints/BuddiesEndpoints.js

@@ -2,16 +2,33 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuddiesEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API buddies (gun charms) endpoints.
+ */
 class BuddiesEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all buddies.
+     * @returns An array of {@link BuddyResponse} objects.
+     */
     async getBuddiesV1() {
         return this.requestValorantApi('v1/buddies');
     }
+    /**
+     * Get a buddy by UUID.
+     * @param uuid - The UUID of the buddy.
+     * @returns The {@link BuddyResponse} matching the given UUID.
+     */
     async getBuddyByUuidV1(uuid) {
         return this.requestValorantApi(`v1/buddies/${uuid}`);
     }
+    /**
+     * Get a buddy level by UUID.
+     * @param uuid - The UUID of the buddy level.
+     * @returns The {@link BuddyLevelResponse} matching the given UUID.
+     */
     async getBuddyLevelByUuidV1(uuid) {
         return this.requestValorantApi(`v1/buddies/levels/${uuid}`);
     }

package/dist/endpoints/BundlesEndpoints.d.ts

@@ -1,8 +1,20 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { BundleResponse, BundlesResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API bundles endpoints.
+ */
 declare class BundlesEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all store bundles.
+     * @returns An array of {@link BundleResponse} objects.
+     */
     getBundlesV1(): Promise<BundlesResponse>;
+    /**
+     * Get a store bundle by UUID.
+     * @param uuid - The UUID of the bundle.
+     * @returns The {@link BundleResponse} matching the given UUID.
+     */
     getBundleByUuidV1(uuid: string): Promise<BundleResponse>;
 }
 export { BundlesEndpoints };

package/dist/endpoints/BundlesEndpoints.js

@@ -2,13 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BundlesEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API bundles endpoints.
+ */
 class BundlesEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all store bundles.
+     * @returns An array of {@link BundleResponse} objects.
+     */
     async getBundlesV1() {
         return this.requestValorantApi('v1/bundles');
     }
+    /**
+     * Get a store bundle by UUID.
+     * @param uuid - The UUID of the bundle.
+     * @returns The {@link BundleResponse} matching the given UUID.
+     */
     async getBundleByUuidV1(uuid) {
         return this.requestValorantApi(`v1/bundles/${uuid}`);
     }

package/dist/endpoints/CeremoniesEndpoints.d.ts

@@ -0,0 +1,20 @@
+import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
+import { CeremonyResponse, CeremoniesResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API ceremonies endpoints.
+ */
+declare class CeremoniesEndpoints extends BaseEndpoint {
+    constructor(config?: ValorantApiConfig);
+    /**
+     * Get all ceremonies.
+     * @returns An array of {@link CeremonyResponse} objects.
+     */
+    getCeremoniesV1(): Promise<CeremoniesResponse>;
+    /**
+     * Get a ceremony by UUID.
+     * @param uuid - The UUID of the ceremony.
+     * @returns The {@link CeremonyResponse} matching the given UUID.
+     */
+    getCeremonyByUuidV1(uuid: string): Promise<CeremonyResponse>;
+}
+export { CeremoniesEndpoints };

package/dist/endpoints/CeremoniesEndpoints.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CeremoniesEndpoints = void 0;
+const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API ceremonies endpoints.
+ */
+class CeremoniesEndpoints extends BaseEndpoint_1.BaseEndpoint {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Get all ceremonies.
+     * @returns An array of {@link CeremonyResponse} objects.
+     */
+    async getCeremoniesV1() {
+        return this.requestValorantApi('v1/ceremonies');
+    }
+    /**
+     * Get a ceremony by UUID.
+     * @param uuid - The UUID of the ceremony.
+     * @returns The {@link CeremonyResponse} matching the given UUID.
+     */
+    async getCeremonyByUuidV1(uuid) {
+        return this.requestValorantApi(`v1/ceremonies/${uuid}`);
+    }
+}
+exports.CeremoniesEndpoints = CeremoniesEndpoints;

package/dist/endpoints/CompetitiveTiersEndpoints.d.ts

@@ -1,8 +1,20 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { CompetitiveTierSetResponse, CompetitiveTiersResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API competitive tiers endpoints.
+ */
 declare class CompetitiveTiersEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all competitive tier sets.
+     * @returns An array of {@link CompetitiveTierSetResponse} objects.
+     */
     getCompetitiveTiersV1(): Promise<CompetitiveTiersResponse>;
+    /**
+     * Get a competitive tier set by UUID.
+     * @param uuid - The UUID of the competitive tier set.
+     * @returns The {@link CompetitiveTierSetResponse} matching the given UUID.
+     */
     getCompetitiveTiersByUuidV1(uuid: string): Promise<CompetitiveTierSetResponse>;
 }
 export { CompetitiveTiersEndpoints };

package/dist/endpoints/CompetitiveTiersEndpoints.js

@@ -2,13 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompetitiveTiersEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API competitive tiers endpoints.
+ */
 class CompetitiveTiersEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all competitive tier sets.
+     * @returns An array of {@link CompetitiveTierSetResponse} objects.
+     */
     async getCompetitiveTiersV1() {
         return this.requestValorantApi('v1/competitivetiers');
     }
+    /**
+     * Get a competitive tier set by UUID.
+     * @param uuid - The UUID of the competitive tier set.
+     * @returns The {@link CompetitiveTierSetResponse} matching the given UUID.
+     */
     async getCompetitiveTiersByUuidV1(uuid) {
         return this.requestValorantApi(`v1/competitivetiers/${uuid}`);
     }

package/dist/endpoints/ContentTierEndpoints.d.ts

@@ -1,8 +1,20 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { ContentTierResponse, ContentTiersResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API content tiers (rarities) endpoints.
+ */
 declare class ContentTierEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all content tiers.
+     * @returns An array of {@link ContentTierResponse} objects.
+     */
     getContentTiersV1(): Promise<ContentTiersResponse>;
+    /**
+     * Get a content tier by UUID.
+     * @param uuid - The UUID of the content tier.
+     * @returns The {@link ContentTierResponse} matching the given UUID.
+     */
     getContentTierByUuidV1(uuid: string): Promise<ContentTierResponse>;
 }
 export { ContentTierEndpoints };

package/dist/endpoints/ContentTierEndpoints.js

@@ -2,13 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContentTierEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API content tiers (rarities) endpoints.
+ */
 class ContentTierEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all content tiers.
+     * @returns An array of {@link ContentTierResponse} objects.
+     */
     async getContentTiersV1() {
         return this.requestValorantApi('v1/contenttiers');
     }
+    /**
+     * Get a content tier by UUID.
+     * @param uuid - The UUID of the content tier.
+     * @returns The {@link ContentTierResponse} matching the given UUID.
+     */
     async getContentTierByUuidV1(uuid) {
         return this.requestValorantApi(`v1/contenttiers/${uuid}`);
     }

package/dist/endpoints/ContractsEndpoints.d.ts

@@ -1,16 +1,19 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { ContractResponse, ContractsResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API contracts endpoints.
+ */
 declare class ContractsEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
     /**
-     * Get all contracts
-     * @returns Promise<ContractsResponse>
+     * Get all contracts.
+     * @returns An array of {@link ContractResponse} objects.
      */
     getContractsV1(): Promise<ContractsResponse>;
     /**
-     * Get contract by UUID
-     * @param uuid Contract UUID
-     * @returns Promise<ContractResponse>
+     * Get a contract by UUID.
+     * @param uuid - The UUID of the contract.
+     * @returns The {@link ContractResponse} matching the given UUID.
      */
     getContractByUuidV1(uuid: string): Promise<ContractResponse>;
 }

package/dist/endpoints/ContractsEndpoints.js

@@ -3,21 +3,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContractsEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
 // Types already defined above
+/**
+ * Provides access to the Valorant API contracts endpoints.
+ */
 class ContractsEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
     /**
-     * Get all contracts
-     * @returns Promise<ContractsResponse>
+     * Get all contracts.
+     * @returns An array of {@link ContractResponse} objects.
      */
     async getContractsV1() {
         return this.requestValorantApi('v1/contracts');
     }
     /**
-     * Get contract by UUID
-     * @param uuid Contract UUID
-     * @returns Promise<ContractResponse>
+     * Get a contract by UUID.
+     * @param uuid - The UUID of the contract.
+     * @returns The {@link ContractResponse} matching the given UUID.
      */
     async getContractByUuidV1(uuid) {
         return this.requestValorantApi(`v1/contracts/${uuid}`);

package/dist/endpoints/CurrenciesEndpoints.d.ts

@@ -1,8 +1,20 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { CurrencyResponse, CurrenciesResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API currencies endpoints.
+ */
 declare class CurrenciesEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
+    /**
+     * Get all currencies.
+     * @returns An array of {@link CurrencyResponse} objects.
+     */
     getCurrenciesV1(): Promise<CurrenciesResponse>;
+    /**
+     * Get a currency by UUID.
+     * @param uuid - The UUID of the currency.
+     * @returns The {@link CurrencyResponse} matching the given UUID.
+     */
     getCurrencyByUuidV1(uuid: string): Promise<CurrencyResponse>;
 }
 export { CurrenciesEndpoints };

package/dist/endpoints/CurrenciesEndpoints.js

@@ -2,13 +2,25 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CurrenciesEndpoints = void 0;
 const BaseEndpoint_1 = require("./BaseEndpoint");
+/**
+ * Provides access to the Valorant API currencies endpoints.
+ */
 class CurrenciesEndpoints extends BaseEndpoint_1.BaseEndpoint {
     constructor(config) {
         super(config);
     }
+    /**
+     * Get all currencies.
+     * @returns An array of {@link CurrencyResponse} objects.
+     */
     async getCurrenciesV1() {
         return this.requestValorantApi('v1/currencies');
     }
+    /**
+     * Get a currency by UUID.
+     * @param uuid - The UUID of the currency.
+     * @returns The {@link CurrencyResponse} matching the given UUID.
+     */
     async getCurrencyByUuidV1(uuid) {
         return this.requestValorantApi(`v1/currencies/${uuid}`);
     }

package/dist/endpoints/EventsEndpoints.d.ts

@@ -1,16 +1,19 @@
 import { BaseEndpoint, ValorantApiConfig } from './BaseEndpoint';
 import { EventResponse, EventsResponse } from '../schemas';
+/**
+ * Provides access to the Valorant API events endpoints.
+ */
 declare class EventsEndpoints extends BaseEndpoint {
     constructor(config?: ValorantApiConfig);
     /**
-     * Get all events
-     * @returns Promise<EventsResponse>
+     * Get all events.
+     * @returns An array of {@link EventResponse} objects.
      */
     getEventsV1(): Promise<EventsResponse>;
     /**
-     * Get event by UUID
-     * @param uuid Event UUID
-     * @returns Promise<EventResponse>
+     * Get an event by its UUID.
+     * @param uuid - The UUID of the event.
+     * @returns The {@link EventResponse} matching the given UUID.
      */
     getEventByUuidV1(uuid: string): Promise<EventResponse>;
 }