/** * 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 { AnalyticsDashboardServiceGenerateWidgetSummaryBody, AnalyticsDashboardServiceUpdateDashboardBody, CreateDashboardRequest, CreateDashboardResponse, GenerateWidgetSummaryResponse, GetWidgetSummaryResponse, ListDashboardsResponse, UpdateDashboardResponse } from '../models/index'; export interface AnalyticsDashboardServiceCreateDashboardRequest { createDashboardRequest: CreateDashboardRequest; } export interface AnalyticsDashboardServiceDeleteDashboardRequest { id: string; } export interface AnalyticsDashboardServiceGenerateWidgetSummaryRequest { dashboardId: string; widgetId: string; analyticsDashboardServiceGenerateWidgetSummaryBody: AnalyticsDashboardServiceGenerateWidgetSummaryBody; } export interface AnalyticsDashboardServiceGetWidgetSummaryRequest { dashboardId: string; widgetId: string; } export interface AnalyticsDashboardServiceListDashboardsRequest { linkId?: string; scope?: string; } export interface AnalyticsDashboardServiceUpdateDashboardRequest { id: string; analyticsDashboardServiceUpdateDashboardBody: AnalyticsDashboardServiceUpdateDashboardBody; } /** * AnalyticsDashboardApi - interface * * @export * @interface AnalyticsDashboardApiInterface */ export interface AnalyticsDashboardApiInterface { /** * Creates request options for analyticsDashboardServiceCreateDashboard without sending the request * @param {CreateDashboardRequest} createDashboardRequest * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceCreateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest): Promise; /** * * @summary Create analytics dashboard * @param {CreateDashboardRequest} createDashboardRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceCreateDashboardRaw(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create analytics dashboard */ analyticsDashboardServiceCreateDashboard(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceDeleteDashboard without sending the request * @param {string} id * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceDeleteDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest): Promise; /** * Delete a dashboard and its associated agent conversation. * @summary Delete analytics dashboard * @param {string} id * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceDeleteDashboardRaw(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a dashboard and its associated agent conversation. * Delete analytics dashboard */ analyticsDashboardServiceDeleteDashboard(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceGenerateWidgetSummary without sending the request * @param {string} dashboardId Dashboard holding the widget * @param {string} widgetId Widget whose values should be analysed * @param {AnalyticsDashboardServiceGenerateWidgetSummaryBody} analyticsDashboardServiceGenerateWidgetSummaryBody * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceGenerateWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest): Promise; /** * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested. * @summary Generate a widget agent summary * @param {string} dashboardId Dashboard holding the widget * @param {string} widgetId Widget whose values should be analysed * @param {AnalyticsDashboardServiceGenerateWidgetSummaryBody} analyticsDashboardServiceGenerateWidgetSummaryBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceGenerateWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested. * Generate a widget agent summary */ analyticsDashboardServiceGenerateWidgetSummary(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceGetWidgetSummary without sending the request * @param {string} dashboardId * @param {string} widgetId * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceGetWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest): Promise; /** * Returns the last generated analysis, and whether the underlying values have changed since. * @summary Get a stored widget agent summary * @param {string} dashboardId * @param {string} widgetId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceGetWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the last generated analysis, and whether the underlying values have changed since. * Get a stored widget agent summary */ analyticsDashboardServiceGetWidgetSummary(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceListDashboards without sending the request * @param {string} [linkId] Restricts the result to the dashboard scoped to this link. Takes precedence over scope when both are set. * @param {string} [scope] Restricts the result by scope. Unset returns every dashboard. - DASHBOARD_SCOPE_UNSPECIFIED: Every dashboard in the workspace, link-scoped or not. - DASHBOARD_SCOPE_WORKSPACE: Only the workspace-wide dashboard, the one with no link. - DASHBOARD_SCOPE_LINK: Only dashboards tied to a link. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceListDashboardsRequestOpts(requestParameters: AnalyticsDashboardServiceListDashboardsRequest): Promise; /** * * @summary List analytics dashboards * @param {string} [linkId] Restricts the result to the dashboard scoped to this link. Takes precedence over scope when both are set. * @param {string} [scope] Restricts the result by scope. Unset returns every dashboard. - DASHBOARD_SCOPE_UNSPECIFIED: Every dashboard in the workspace, link-scoped or not. - DASHBOARD_SCOPE_WORKSPACE: Only the workspace-wide dashboard, the one with no link. - DASHBOARD_SCOPE_LINK: Only dashboards tied to a link. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceListDashboardsRaw(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List analytics dashboards */ analyticsDashboardServiceListDashboards(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceUpdateDashboard without sending the request * @param {string} id ID of the dashboard to update. * @param {AnalyticsDashboardServiceUpdateDashboardBody} analyticsDashboardServiceUpdateDashboardBody * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceUpdateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest): Promise; /** * * @summary Update analytics dashboard * @param {string} id ID of the dashboard to update. * @param {AnalyticsDashboardServiceUpdateDashboardBody} analyticsDashboardServiceUpdateDashboardBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof AnalyticsDashboardApiInterface */ analyticsDashboardServiceUpdateDashboardRaw(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update analytics dashboard */ analyticsDashboardServiceUpdateDashboard(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * */ export declare class AnalyticsDashboardApi extends runtime.BaseAPI implements AnalyticsDashboardApiInterface { /** * Creates request options for analyticsDashboardServiceCreateDashboard without sending the request */ analyticsDashboardServiceCreateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest): Promise; /** * Create analytics dashboard */ analyticsDashboardServiceCreateDashboardRaw(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create analytics dashboard */ analyticsDashboardServiceCreateDashboard(requestParameters: AnalyticsDashboardServiceCreateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceDeleteDashboard without sending the request */ analyticsDashboardServiceDeleteDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest): Promise; /** * Delete a dashboard and its associated agent conversation. * Delete analytics dashboard */ analyticsDashboardServiceDeleteDashboardRaw(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a dashboard and its associated agent conversation. * Delete analytics dashboard */ analyticsDashboardServiceDeleteDashboard(requestParameters: AnalyticsDashboardServiceDeleteDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceGenerateWidgetSummary without sending the request */ analyticsDashboardServiceGenerateWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest): Promise; /** * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested. * Generate a widget agent summary */ analyticsDashboardServiceGenerateWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Analyses the widget\'s current values and stores the result. Consumes platform credits, so it runs only when requested. * Generate a widget agent summary */ analyticsDashboardServiceGenerateWidgetSummary(requestParameters: AnalyticsDashboardServiceGenerateWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceGetWidgetSummary without sending the request */ analyticsDashboardServiceGetWidgetSummaryRequestOpts(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest): Promise; /** * Returns the last generated analysis, and whether the underlying values have changed since. * Get a stored widget agent summary */ analyticsDashboardServiceGetWidgetSummaryRaw(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the last generated analysis, and whether the underlying values have changed since. * Get a stored widget agent summary */ analyticsDashboardServiceGetWidgetSummary(requestParameters: AnalyticsDashboardServiceGetWidgetSummaryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceListDashboards without sending the request */ analyticsDashboardServiceListDashboardsRequestOpts(requestParameters: AnalyticsDashboardServiceListDashboardsRequest): Promise; /** * List analytics dashboards */ analyticsDashboardServiceListDashboardsRaw(requestParameters: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * List analytics dashboards */ analyticsDashboardServiceListDashboards(requestParameters?: AnalyticsDashboardServiceListDashboardsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Creates request options for analyticsDashboardServiceUpdateDashboard without sending the request */ analyticsDashboardServiceUpdateDashboardRequestOpts(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest): Promise; /** * Update analytics dashboard */ analyticsDashboardServiceUpdateDashboardRaw(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update analytics dashboard */ analyticsDashboardServiceUpdateDashboard(requestParameters: AnalyticsDashboardServiceUpdateDashboardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }