/** * Linkbreakers API * This is a documentation of all the APIs of Linkbreakers * * The version of the OpenAPI document: 1.118.3 * * * 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'; import type { EventsMetric, WorkspaceInsight, WorkspaceMetric } from '../models/index'; export interface MetricsServiceGetEventsMetricRequest { startDate?: Date; endDate?: Date; linkId?: string; } /** * WorkspaceMetricsApi - interface * * @export * @interface WorkspaceMetricsApiInterface */ export interface WorkspaceMetricsApiInterface { /** * Creates request options for metricsServiceGetEventsMetric without sending the request * @param {Date} [startDate] Inclusive start timestamp for the aggregation * @param {Date} [endDate] Inclusive end timestamp for the aggregation * @param {string} [linkId] Optional link filter (UUID); when omitted aggregates workspace-wide UUID format * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetEventsMetricRequestOpts(requestParameters: MetricsServiceGetEventsMetricRequest): Promise; /** * Retrieve aggregated event analytics for the provided time window and optional link filter. * @summary Get events metric * @param {Date} [startDate] Inclusive start timestamp for the aggregation * @param {Date} [endDate] Inclusive end timestamp for the aggregation * @param {string} [linkId] Optional link filter (UUID); when omitted aggregates workspace-wide UUID format * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetEventsMetricRaw(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve aggregated event analytics for the provided time window and optional link filter. * Get events metric */ metricsServiceGetEventsMetric(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for metricsServiceGetWorkspaceInsight without sending the request * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetWorkspaceInsightRequestOpts(): Promise; /** * Return workspace usage insights including the preferred link type based on historical link creation patterns. * @summary Get workspace insight * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetWorkspaceInsightRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return workspace usage insights including the preferred link type based on historical link creation patterns. * Get workspace insight */ metricsServiceGetWorkspaceInsight(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for metricsServiceGetWorkspaceMetric without sending the request * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetWorkspaceMetricRequestOpts(): Promise; /** * Return high-level workspace totals covering members, links, and activity volume. * @summary Get workspace metric * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WorkspaceMetricsApiInterface */ metricsServiceGetWorkspaceMetricRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return high-level workspace totals covering members, links, and activity volume. * Get workspace metric */ metricsServiceGetWorkspaceMetric(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class WorkspaceMetricsApi extends runtime.BaseAPI implements WorkspaceMetricsApiInterface { /** * Creates request options for metricsServiceGetEventsMetric without sending the request */ metricsServiceGetEventsMetricRequestOpts(requestParameters: MetricsServiceGetEventsMetricRequest): Promise; /** * Retrieve aggregated event analytics for the provided time window and optional link filter. * Get events metric */ metricsServiceGetEventsMetricRaw(requestParameters: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Retrieve aggregated event analytics for the provided time window and optional link filter. * Get events metric */ metricsServiceGetEventsMetric(requestParameters?: MetricsServiceGetEventsMetricRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for metricsServiceGetWorkspaceInsight without sending the request */ metricsServiceGetWorkspaceInsightRequestOpts(): Promise; /** * Return workspace usage insights including the preferred link type based on historical link creation patterns. * Get workspace insight */ metricsServiceGetWorkspaceInsightRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return workspace usage insights including the preferred link type based on historical link creation patterns. * Get workspace insight */ metricsServiceGetWorkspaceInsight(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for metricsServiceGetWorkspaceMetric without sending the request */ metricsServiceGetWorkspaceMetricRequestOpts(): Promise; /** * Return high-level workspace totals covering members, links, and activity volume. * Get workspace metric */ metricsServiceGetWorkspaceMetricRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Return high-level workspace totals covering members, links, and activity volume. * Get workspace metric */ metricsServiceGetWorkspaceMetric(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }