/** * Typesense API * An open source search engine for building delightful search experiences. * * The version of the OpenAPI document: 30.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime.js'; import type { AnalyticsEvent, AnalyticsEventCreateResponse, AnalyticsEventsResponse, AnalyticsRule, AnalyticsRuleUpdate, AnalyticsStatus, CreateAnalyticsRule200Response, CreateAnalyticsRuleRequest } from '../models/index.js'; export interface CreateAnalyticsEventRequest { analyticsEvent: AnalyticsEvent; } export interface CreateAnalyticsRuleOperationRequest { createAnalyticsRuleRequest: CreateAnalyticsRuleRequest; } export interface DeleteAnalyticsRuleRequest { ruleName: string; } export interface GetAnalyticsEventsRequest { userId: string; name: string; n: number; } export interface RetrieveAnalyticsRuleRequest { ruleName: string; } export interface RetrieveAnalyticsRulesRequest { ruleTag?: string; } export interface UpsertAnalyticsRuleRequest { ruleName: string; analyticsRuleUpdate: AnalyticsRuleUpdate; } /** * */ export declare class AnalyticsApi extends runtime.BaseAPI { /** * Submit a single analytics event. The event must correspond to an existing analytics rule by name. * Create an analytics event */ createAnalyticsEventRaw(requestParameters: CreateAnalyticsEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Submit a single analytics event. The event must correspond to an existing analytics rule by name. * Create an analytics event */ createAnalyticsEvent(requestParameters: CreateAnalyticsEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create one or more analytics rules. You can send a single rule object or an array of rule objects. * Create analytics rule(s) */ createAnalyticsRuleRaw(requestParameters: CreateAnalyticsRuleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create one or more analytics rules. You can send a single rule object or an array of rule objects. * Create analytics rule(s) */ createAnalyticsRule(requestParameters: CreateAnalyticsRuleOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Permanently deletes an analytics rule, given it\'s name * Delete an analytics rule */ deleteAnalyticsRuleRaw(requestParameters: DeleteAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Permanently deletes an analytics rule, given it\'s name * Delete an analytics rule */ deleteAnalyticsRule(requestParameters: DeleteAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Triggers a flush of analytics data to persistent storage. * Flush in-memory analytics to disk */ flushAnalyticsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Triggers a flush of analytics data to persistent storage. * Flush in-memory analytics to disk */ flushAnalytics(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the most recent events for a user and rule. * Retrieve analytics events */ getAnalyticsEventsRaw(requestParameters: GetAnalyticsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the most recent events for a user and rule. * Retrieve analytics events */ getAnalyticsEvents(requestParameters: GetAnalyticsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Returns sizes of internal analytics buffers and queues. * Get analytics subsystem status */ getAnalyticsStatusRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns sizes of internal analytics buffers and queues. * Get analytics subsystem status */ getAnalyticsStatus(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve the details of an analytics rule, given it\'s name * Retrieves an analytics rule */ retrieveAnalyticsRuleRaw(requestParameters: RetrieveAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve the details of an analytics rule, given it\'s name * Retrieves an analytics rule */ retrieveAnalyticsRule(requestParameters: RetrieveAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results. * Retrieve analytics rules */ retrieveAnalyticsRulesRaw(requestParameters: RetrieveAnalyticsRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Retrieve all analytics rules. Use the optional rule_tag filter to narrow down results. * Retrieve analytics rules */ retrieveAnalyticsRules(requestParameters?: RetrieveAnalyticsRulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Upserts an analytics rule with the given name. * Upserts an analytics rule */ upsertAnalyticsRuleRaw(requestParameters: UpsertAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Upserts an analytics rule with the given name. * Upserts an analytics rule */ upsertAnalyticsRule(requestParameters: UpsertAnalyticsRuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }