import { GetLibraryAnalyticsComponentActions200Response } from '../../models/base/get-library-analytics-component-actions200-response/index'; import { GetLibraryAnalyticsComponentUsages200Response } from '../../models/base/get-library-analytics-component-usages200-response/index'; import { GetLibraryAnalyticsStyleActions200Response } from '../../models/base/get-library-analytics-style-actions200-response/index'; import { GetLibraryAnalyticsStyleUsages200Response } from '../../models/base/get-library-analytics-style-usages200-response/index'; import { GetLibraryAnalyticsVariableActions200Response } from '../../models/base/get-library-analytics-variable-actions200-response/index'; import { GetLibraryAnalyticsVariableUsages200Response } from '../../models/base/get-library-analytics-variable-usages200-response/index'; import { Api, ApiClient, RequestMetadata } from '@ama-sdk/core'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsComponentActions function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsComponentActionsGroupByEnum = 'component' | 'team'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsComponentUsages function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsComponentUsagesGroupByEnum = 'component' | 'file'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsStyleActions function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsStyleActionsGroupByEnum = 'style' | 'team'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsStyleUsages function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsStyleUsagesGroupByEnum = 'style' | 'file'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsVariableActions function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsVariableActionsGroupByEnum = 'variable' | 'team'; /** Enum groupBy used in the LibraryAnalyticsApi's getLibraryAnalyticsVariableUsages function parameter */ export type LibraryAnalyticsApiGetLibraryAnalyticsVariableUsagesGroupByEnum = 'variable' | 'file'; /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsComponentActions function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsComponentActionsRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsComponentActionsGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior. */ 'start_date'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week. */ 'end_date'?: string; } /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsComponentUsages function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsComponentUsagesRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsComponentUsagesGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; } /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsStyleActions function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsStyleActionsRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsStyleActionsGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior. */ 'start_date'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week. */ 'end_date'?: string; } /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsStyleUsages function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsStyleUsagesRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsStyleUsagesGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; } /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsVariableActions function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsVariableActionsRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsVariableActionsGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the earliest week to include. Dates are rounded back to the nearest start of a week. Defaults to one year prior. */ 'start_date'?: string; /** ISO 8601 date string (YYYY-MM-DD) of the latest week to include. Dates are rounded forward to the nearest end of a week. Defaults to the latest computed week. */ 'end_date'?: string; } /** Parameters object to LibraryAnalyticsApi's getLibraryAnalyticsVariableUsages function */ export interface LibraryAnalyticsApiGetLibraryAnalyticsVariableUsagesRequestData { /** File key of the library to fetch analytics data for. */ 'file_key': string; /** A dimension to group returned analytics data by. */ 'group_by': LibraryAnalyticsApiGetLibraryAnalyticsVariableUsagesGroupByEnum; /** Cursor indicating what page of data to fetch. Obtained from prior API call. */ 'cursor'?: string; } export declare class LibraryAnalyticsApi implements Api { /** API name */ static readonly apiName = "LibraryAnalyticsApi"; /** @inheritDoc */ readonly apiName = "LibraryAnalyticsApi"; /** Tokens of the parameters containing PII */ readonly piiParamTokens: { [key: string]: string; }; /** @inheritDoc */ client: ApiClient; /** * Initialize your interface * * @param apiClient Client used to process call to the API */ constructor(apiClient: ApiClient); /** * Get library analytics component action data. * Returns a list of library analytics component actions data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsComponentActions(data: LibraryAnalyticsApiGetLibraryAnalyticsComponentActionsRequestData, metadata?: RequestMetadata): Promise; /** * Get library analytics component usage data. * Returns a list of library analytics component usage data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsComponentUsages(data: LibraryAnalyticsApiGetLibraryAnalyticsComponentUsagesRequestData, metadata?: RequestMetadata): Promise; /** * Get library analytics style action data. * Returns a list of library analytics style actions data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsStyleActions(data: LibraryAnalyticsApiGetLibraryAnalyticsStyleActionsRequestData, metadata?: RequestMetadata): Promise; /** * Get library analytics style usage data. * Returns a list of library analytics style usage data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsStyleUsages(data: LibraryAnalyticsApiGetLibraryAnalyticsStyleUsagesRequestData, metadata?: RequestMetadata): Promise; /** * Get library analytics variable action data. * Returns a list of library analytics variable actions data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsVariableActions(data: LibraryAnalyticsApiGetLibraryAnalyticsVariableActionsRequestData, metadata?: RequestMetadata): Promise; /** * Get library analytics variable usage data. * Returns a list of library analytics variable usage data broken down by the requested dimension. * @param data Data to provide to the API call * @param metadata Metadata to pass to the API call */ getLibraryAnalyticsVariableUsages(data: LibraryAnalyticsApiGetLibraryAnalyticsVariableUsagesRequestData, metadata?: RequestMetadata): Promise; } //# sourceMappingURL=library-analytics-api.d.ts.map