docs: add jsdocs to public api classes and methods

lib/Typesense/Alias.d.ts

@@ -4,7 +4,23 @@ export default class Alias {
     private name;
     private apiCall;
     constructor(name: string, apiCall: ApiCall);
+    /**
+     * Find out which collection an alias points to by fetching it
+     *
+     * @example
+     * await client.aliases("my-alias").retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#retrieve-an-alias
+     */
     retrieve(): Promise<CollectionAliasSchema>;
+    /**
+     * Delete an alias
+     *
+     * @example
+     * await client.aliases("my-alias").delete()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#delete-an-alias
+     */
     delete(): Promise<CollectionAliasSchema>;
     private endpointPath;
 }

lib/Typesense/Aliases.d.ts

@@ -11,7 +11,23 @@ export interface CollectionAliasesResponseSchema {
 export default class Aliases {
     private apiCall;
     constructor(apiCall: ApiCall);
+    /**
+     * Create or update a collection alias.
+     *
+     * @example
+     * await client.aliases().upsert("my-alias", { collection_name: "products" })
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#create-or-update-an-alias
+     */
     upsert(name: string, mapping: CollectionAliasCreateSchema): Promise<CollectionAliasSchema>;
+    /**
+     * List all aliases and the corresponding collections that they map to.
+     *
+     * @example
+     * await client.aliases().retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/collection-alias.html#list-all-aliases
+     */
     retrieve(): Promise<CollectionAliasesResponseSchema>;
     private endpointPath;
     static get RESOURCEPATH(): string;

lib/Typesense/Analytics.d.ts

@@ -8,8 +8,34 @@ export default class Analytics {
     private readonly individualAnalyticsRules;
     private readonly _analyticsEvents;
     constructor(apiCall: ApiCall);
+    /**
+     * Access the analytics rules resource. Call without arguments to list or create rules, or pass an ID to access a single rule.
+     *
+     * @example
+     * await client.analytics.rules().retrieve()
+     * @example
+     * await client.analytics.rules("rule-1").retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     rules(): AnalyticsRules;
+    /**
+     * Access an individual analytics rule by ID.
+     *
+     * @example
+     * await client.analytics.rules("rule-1").retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     rules(id: string): AnalyticsRule;
+    /**
+     * Access the analytics events resource to send analytics events.
+     *
+     * @example
+     * await client.analytics.events().create({ type: "click", name: "products_click", data: {} })
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     events(): AnalyticsEvents;
     static get RESOURCEPATH(): string;
 }

lib/Typesense/AnalyticsEvents.d.ts

@@ -15,7 +15,23 @@ export interface AnalyticsEventsRetrieveSchema {
 export default class AnalyticsEvents {
     private readonly apiCall;
     constructor(apiCall: ApiCall);
+    /**
+     * Submit a single analytics event. The event must correspond to an existing analytics rule by name.
+     *
+     * @example
+     * await client.analytics.events().create({ type: "click", name: "products_click", data: {} })
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     create(params: AnalyticsEventCreateSchema): Promise<AnalyticsEventCreateSchema>;
+    /**
+     * Retrieve the most recent events for a user and rule.
+     *
+     * @example
+     * await client.analytics.events().retrieve({ user_id: "u1", name: "products_click", n: 10 })
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     retrieve(params: {
         user_id: string;
         name: string;

lib/Typesense/AnalyticsRule.d.ts

@@ -41,7 +41,23 @@ export default class AnalyticsRule {
     private name;
     private apiCall;
     constructor(name: string, apiCall: ApiCall);
+    /**
+     * Retrieve the details of an analytics rule, given it's name
+     *
+     * @example
+     * await client.analytics.rules("rule-1").retrieve()
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     retrieve(): Promise<AnalyticsRuleSchema>;
+    /**
+     * Permanently deletes an analytics rule, given it's name
+     *
+     * @example
+     * await client.analytics.rules("rule-1").delete()
+     *
+     * @see https://typesense.org/docs/latest/api/analytics-query-suggestions.html
+     */
     delete(): Promise<AnalyticsRuleDeleteSchema>;
     private endpointPath;
 }

lib/Typesense/AnalyticsRuleV1.d.ts

@@ -29,7 +29,23 @@ export default class AnalyticsRuleV1 {
     private name;
     private apiCall;
     constructor(name: string, apiCall: ApiCall);
+    /**
+     * Retrieve a legacy v1 analytics rule by name.
+     *
+     * @example
+     * await client.analyticsV1.rules("rule-1").retrieve()
+     *
+     * @see https://typesense.org/docs/29.0/api/analytics-query-suggestions.html
+     */
     retrieve(): Promise<AnalyticsRuleSchemaV1>;
+    /**
+     * Delete a legacy v1 analytics rule by name.
+     *
+     * @example
+     * await client.analyticsV1.rules("rule-1").delete()
+     *
+     * @see https://typesense.org/docs/29.0/api/analytics-query-suggestions.html
+     */
     delete(): Promise<AnalyticsRuleDeleteSchemaV1>;
     private endpointPath;
 }