@connectreport/connectreport-js 2.78.6 → 2.79.0

package/dist/index.d.ts

@@ -1,7 +1,1519 @@
-import { TemplatesApi, ImagesApi, ReportTasksApi, ReportsApi, BaseTemplatesApi, DocumentsApi, FilterCyclesApi, JobsApi } from "./api";
-import { Configuration } from "./configuration";
-import { AxiosInstance } from "axios";
-export declare class ConnectReport {
+import * as axios from 'axios';
+import { AxiosInstance } from 'axios';
+
+/**
+ * ConnectReport Core API
+ * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
+ *
+ * The version of the OpenAPI document: 2.79.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface ConfigurationParameters {
+    apiKey?: string;
+    httpsAgent?: any;
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    httpsAgent?: any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+
+/**
+ * ConnectReport Core API
+ * Leverage core reporting, templating, and document automation capabilities of ConnectReport Server.
+ *
+ * The version of the OpenAPI document: 2.79.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+
+/**
+ *
+ * @export
+ * @interface FilterCycle
+ */
+interface FilterCycle {
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    id?: string;
+    /**
+     * Title of the report task
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    templateId: string;
+    /**
+     * Datetime in UTC when report task\'s schedule will execute
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    startOn: string;
+    /**
+     * Datetime in UTC when report task schedule will end
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    endOn?: string;
+    /**
+     * Describes the frequency of the report task\'s schedule
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    frequency: FilterCycleFrequencyEnum;
+    /**
+     *
+     * @type {number | string}
+     * @memberof FilterCycle
+     */
+    every?: number | string;
+    /**
+     * Denotes whether the report task will go into the report processing queue
+     * @type {boolean}
+     * @memberof FilterCycle
+     */
+    enabled?: boolean;
+    /**
+     * Array of objects denoting filter sets to apply to the report task
+     * @type {Array<ReportTaskFilterSets>}
+     * @memberof FilterCycle
+     */
+    filterSets?: Array<ReportTaskFilterSets>;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    filterCycleId?: string;
+    /**
+     * Calculated datetime in UTC when the report task will run next, if applicable
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    nextRunAt?: string;
+    /**
+     * The error object from the last report task execution, if applicable
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    error?: string;
+    /**
+     * The average time to run the report task, in minutes
+     * @type {number}
+     * @memberof FilterCycle
+     */
+    averageTimeToGenerate?: number;
+    /**
+     * Custom filters to apply. This field will be updated entirely if provided
+     * @type {Array<ReportTaskCustomSelection>}
+     * @memberof FilterCycle
+     */
+    customSelection?: Array<ReportTaskCustomSelection>;
+    /**
+     *
+     * @type {Array<ReportTaskVariables>}
+     * @memberof FilterCycle
+     */
+    variables?: Array<ReportTaskVariables>;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof FilterCycle
+     */
+    meta?: {
+        [key: string]: string;
+    };
+    /**
+     * The time spent waiting on data platform responses during the last report task execution, in minutes
+     * @type {number}
+     * @memberof FilterCycle
+     */
+    dataPlatformWaitTime?: number;
+    /**
+     * Denotes whether the generated report should be emailed to its users or groups after a successful run
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    email?: FilterCycleEmailEnum;
+    /**
+     * Groups to share the published report with. This field will be updated entirely if provided
+     * @type {Array<ReportTaskGroupsToShareWith>}
+     * @memberof FilterCycle
+     */
+    groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
+    /**
+     *
+     * @type {Array<ReportTaskTags>}
+     * @memberof FilterCycle
+     */
+    tags?: Array<ReportTaskTags>;
+    /**
+     * The trigger name for the report task. Used to execute tasks on a trigger
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    trigger?: string;
+    /**
+     * The customized subject of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    emailSubject?: string;
+    /**
+     * The customized body of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    emailBody?: string;
+    /**
+     *
+     * @type {FilterCycleAllOfFieldInfo}
+     * @memberof FilterCycle
+     */
+    fieldInfo?: FilterCycleAllOfFieldInfo;
+    /**
+     * This field will be updated entirely if provided and will result in removing any existing report tasks associated with the filter cycle.
+     * @type {Array<FilterCycleAllOfFieldValues>}
+     * @memberof FilterCycle
+     */
+    fieldValues?: Array<FilterCycleAllOfFieldValues>;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycle
+     */
+    connectionId?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FilterCycle
+     */
+    selectAll?: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof FilterCycle
+     */
+    autotag?: boolean;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum FilterCycleFrequencyEnum {
+    Monthly = "Monthly",
+    OnceNow = "Once - now",
+    OnceScheduled = "Once - scheduled",
+    Annually = "Annually",
+    Daily = "Daily",
+    Weekly = "Weekly",
+    UponTrigger = "Upon trigger"
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum FilterCycleEmailEnum {
+    Pdf = "pdf",
+    Pptx = "pptx",
+    Xlsx = "xlsx",
+    Csv = "csv"
+}
+/**
+ *
+ * @export
+ * @interface FilterCycleAllOfFieldInfo
+ */
+interface FilterCycleAllOfFieldInfo {
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycleAllOfFieldInfo
+     */
+    fieldId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycleAllOfFieldInfo
+     */
+    fieldName?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycleAllOfFieldInfo
+     */
+    fieldDef?: string;
+}
+/**
+ *
+ * @export
+ * @interface FilterCycleAllOfFieldValues
+ */
+interface FilterCycleAllOfFieldValues {
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycleAllOfFieldValues
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof FilterCycleAllOfFieldValues
+     */
+    text?: string;
+    /**
+     *
+     * @type {number}
+     * @memberof FilterCycleAllOfFieldValues
+     */
+    number?: number;
+}
+/**
+ *
+ * @export
+ * @interface InlineResponse200
+ */
+interface InlineResponse200 {
+    /**
+     *
+     * @type {Array<Template>}
+     * @memberof InlineResponse200
+     */
+    baseTemplates?: Array<Template>;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineResponse200
+     */
+    totalPages?: number;
+}
+/**
+ *
+ * @export
+ * @interface InlineResponse2001
+ */
+interface InlineResponse2001 {
+    /**
+     *
+     * @type {string}
+     * @memberof InlineResponse2001
+     */
+    path?: string;
+}
+/**
+ *
+ * @export
+ * @interface InlineResponse2002
+ */
+interface InlineResponse2002 {
+    /**
+     *
+     * @type {Array<ReportTaskResponse>}
+     * @memberof InlineResponse2002
+     */
+    reportTasks?: Array<ReportTaskResponse>;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineResponse2002
+     */
+    totalPages?: number;
+}
+/**
+ *
+ * @export
+ * @interface InlineResponse2003
+ */
+interface InlineResponse2003 {
+    /**
+     *
+     * @type {Array<Report>}
+     * @memberof InlineResponse2003
+     */
+    reports?: Array<Report>;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineResponse2003
+     */
+    totalPages?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineResponse2003
+     */
+    totalItems?: number;
+}
+/**
+ *
+ * @export
+ * @interface InlineResponse2004
+ */
+interface InlineResponse2004 {
+    /**
+     *
+     * @type {Array<Template>}
+     * @memberof InlineResponse2004
+     */
+    templates?: Array<Template>;
+    /**
+     *
+     * @type {number}
+     * @memberof InlineResponse2004
+     */
+    totalPages?: number;
+}
+/**
+ *
+ * @export
+ * @interface Job
+ */
+interface Job {
+    /**
+     *
+     * @type {string}
+     * @memberof Job
+     */
+    id?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof Job
+     */
+    data?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof Job
+     */
+    status?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Job
+     */
+    error?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Job
+     */
+    userId?: string;
+}
+/**
+ *
+ * @export
+ * @interface JobResponse
+ */
+interface JobResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof JobResponse
+     */
+    jobId?: string;
+    /**
+     *
+     * @type {object}
+     * @memberof JobResponse
+     */
+    data?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof JobResponse
+     */
+    status?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JobResponse
+     */
+    error?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JobResponse
+     */
+    userId?: string;
+}
+/**
+ *
+ * @export
+ * @interface Report
+ */
+interface Report {
+    /**
+     *
+     * @type {string}
+     * @memberof Report
+     */
+    reportId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Report
+     */
+    id?: string;
+    /**
+     * Datetime in UTC when the report was published
+     * @type {string}
+     * @memberof Report
+     */
+    createdAt?: string;
+    /**
+     * Title of the report task
+     * @type {string}
+     * @memberof Report
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Report
+     */
+    authorId?: string;
+    /**
+     * The given name of the author of the report
+     * @type {string}
+     * @memberof Report
+     */
+    firstName?: string;
+    /**
+     * The surname of the author of the report
+     * @type {string}
+     * @memberof Report
+     */
+    lastName?: string;
+    /**
+     * The relative path to the thumbnail of the report
+     * @type {string}
+     * @memberof Report
+     */
+    thumbnailPath?: string;
+    /**
+     * The size in bytes of the report HTML contents
+     * @type {number}
+     * @memberof Report
+     */
+    sizeBytes?: number;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskCustomSelection
+ */
+interface ReportTaskCustomSelection {
+    /**
+     * The label of the field. Used for display in certain scenarios.
+     * @type {string}
+     * @memberof ReportTaskCustomSelection
+     */
+    fieldName?: string;
+    /**
+     * The definition of the field.
+     * @type {string}
+     * @memberof ReportTaskCustomSelection
+     */
+    fieldDef?: string;
+    /**
+     *
+     * @type {Array<ReportTaskFieldValues>}
+     * @memberof ReportTaskCustomSelection
+     */
+    fieldValues?: Array<ReportTaskFieldValues>;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskFieldValues
+ */
+interface ReportTaskFieldValues {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskFieldValues
+     */
+    text?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskFieldValues
+     */
+    number?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskFilterSets
+ */
+interface ReportTaskFilterSets {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskFilterSets
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskFilterSets
+     */
+    title?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskGroupsToShareWith
+ */
+interface ReportTaskGroupsToShareWith {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskGroupsToShareWith
+     */
+    groupId?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskRequest
+ */
+interface ReportTaskRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    id?: string;
+    /**
+     * Title of the report task
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    templateId: string;
+    /**
+     * Datetime in UTC when report task\'s schedule will execute
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    startOn: string;
+    /**
+     * Datetime in UTC when report task schedule will end
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    endOn?: string;
+    /**
+     * Describes the frequency of the report task\'s schedule
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    frequency: ReportTaskRequestFrequencyEnum;
+    /**
+     *
+     * @type {number | string}
+     * @memberof ReportTaskRequest
+     */
+    every?: number | string;
+    /**
+     * Denotes whether the report task will go into the report processing queue
+     * @type {boolean}
+     * @memberof ReportTaskRequest
+     */
+    enabled?: boolean;
+    /**
+     * Array of objects denoting filter sets to apply to the report task
+     * @type {Array<ReportTaskFilterSets>}
+     * @memberof ReportTaskRequest
+     */
+    filterSets?: Array<ReportTaskFilterSets>;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    filterCycleId?: string;
+    /**
+     * Calculated datetime in UTC when the report task will run next, if applicable
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    nextRunAt?: string;
+    /**
+     * The error object from the last report task execution, if applicable
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    error?: string;
+    /**
+     * The average time to run the report task, in minutes
+     * @type {number}
+     * @memberof ReportTaskRequest
+     */
+    averageTimeToGenerate?: number;
+    /**
+     * Custom filters to apply. This field will be updated entirely if provided
+     * @type {Array<ReportTaskCustomSelection>}
+     * @memberof ReportTaskRequest
+     */
+    customSelection?: Array<ReportTaskCustomSelection>;
+    /**
+     *
+     * @type {Array<ReportTaskVariables>}
+     * @memberof ReportTaskRequest
+     */
+    variables?: Array<ReportTaskVariables>;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof ReportTaskRequest
+     */
+    meta?: {
+        [key: string]: string;
+    };
+    /**
+     * The time spent waiting on data platform responses during the last report task execution, in minutes
+     * @type {number}
+     * @memberof ReportTaskRequest
+     */
+    dataPlatformWaitTime?: number;
+    /**
+     * Denotes whether the generated report should be emailed to its users or groups after a successful run
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    email?: ReportTaskRequestEmailEnum;
+    /**
+     * Groups to share the published report with. This field will be updated entirely if provided
+     * @type {Array<ReportTaskGroupsToShareWith>}
+     * @memberof ReportTaskRequest
+     */
+    groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
+    /**
+     *
+     * @type {Array<ReportTaskTags>}
+     * @memberof ReportTaskRequest
+     */
+    tags?: Array<ReportTaskTags>;
+    /**
+     * The trigger name for the report task. Used to execute tasks on a trigger
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    trigger?: string;
+    /**
+     * The customized subject of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    emailSubject?: string;
+    /**
+     * The customized body of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof ReportTaskRequest
+     */
+    emailBody?: string;
+    /**
+     * Emails to send the report to. This is only allowed if \"Allow reports to be shared with any email\" is to true.
+     * @type {Array<string>}
+     * @memberof ReportTaskRequest
+     */
+    emailRecipients?: Array<string>;
+    /**
+     * Denotes whether the email recipient list is confirmed. Value required to be true if emailRecipients is defined.
+     * @type {boolean}
+     * @memberof ReportTaskRequest
+     */
+    confirmedEmailRecipients?: boolean;
+    /**
+     * Users to share the published report with. This field will be updated entirely if provided
+     * @type {Array<ReportTaskRequestAllOfUsersToShareWith>}
+     * @memberof ReportTaskRequest
+     */
+    usersToShareWith?: Array<ReportTaskRequestAllOfUsersToShareWith>;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum ReportTaskRequestFrequencyEnum {
+    Monthly = "Monthly",
+    OnceNow = "Once - now",
+    OnceScheduled = "Once - scheduled",
+    Annually = "Annually",
+    Daily = "Daily",
+    Weekly = "Weekly",
+    UponTrigger = "Upon trigger"
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum ReportTaskRequestEmailEnum {
+    Pdf = "pdf",
+    Pptx = "pptx",
+    Xlsx = "xlsx",
+    Csv = "csv"
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskRequestAllOfUsersToShareWith
+ */
+interface ReportTaskRequestAllOfUsersToShareWith {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskRequestAllOfUsersToShareWith
+     */
+    userId?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskResponse
+ */
+interface ReportTaskResponse {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    id?: string;
+    /**
+     * Title of the report task
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    title: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    templateId: string;
+    /**
+     * Datetime in UTC when report task\'s schedule will execute
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    startOn: string;
+    /**
+     * Datetime in UTC when report task schedule will end
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    endOn?: string;
+    /**
+     * Describes the frequency of the report task\'s schedule
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    frequency: ReportTaskResponseFrequencyEnum;
+    /**
+     *
+     * @type {number | string}
+     * @memberof ReportTaskResponse
+     */
+    every?: number | string;
+    /**
+     * Denotes whether the report task will go into the report processing queue
+     * @type {boolean}
+     * @memberof ReportTaskResponse
+     */
+    enabled?: boolean;
+    /**
+     * Array of objects denoting filter sets to apply to the report task
+     * @type {Array<ReportTaskFilterSets>}
+     * @memberof ReportTaskResponse
+     */
+    filterSets?: Array<ReportTaskFilterSets>;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    filterCycleId?: string;
+    /**
+     * Calculated datetime in UTC when the report task will run next, if applicable
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    nextRunAt?: string;
+    /**
+     * The error object from the last report task execution, if applicable
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    error?: string;
+    /**
+     * The average time to run the report task, in minutes
+     * @type {number}
+     * @memberof ReportTaskResponse
+     */
+    averageTimeToGenerate?: number;
+    /**
+     * Custom filters to apply. This field will be updated entirely if provided
+     * @type {Array<ReportTaskCustomSelection>}
+     * @memberof ReportTaskResponse
+     */
+    customSelection?: Array<ReportTaskCustomSelection>;
+    /**
+     *
+     * @type {Array<ReportTaskVariables>}
+     * @memberof ReportTaskResponse
+     */
+    variables?: Array<ReportTaskVariables>;
+    /**
+     *
+     * @type {{ [key: string]: string; }}
+     * @memberof ReportTaskResponse
+     */
+    meta?: {
+        [key: string]: string;
+    };
+    /**
+     * The time spent waiting on data platform responses during the last report task execution, in minutes
+     * @type {number}
+     * @memberof ReportTaskResponse
+     */
+    dataPlatformWaitTime?: number;
+    /**
+     * Denotes whether the generated report should be emailed to its users or groups after a successful run
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    email?: ReportTaskResponseEmailEnum;
+    /**
+     * Groups to share the published report with. This field will be updated entirely if provided
+     * @type {Array<ReportTaskGroupsToShareWith>}
+     * @memberof ReportTaskResponse
+     */
+    groupsToShareWith?: Array<ReportTaskGroupsToShareWith>;
+    /**
+     *
+     * @type {Array<ReportTaskTags>}
+     * @memberof ReportTaskResponse
+     */
+    tags?: Array<ReportTaskTags>;
+    /**
+     * The trigger name for the report task. Used to execute tasks on a trigger
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    trigger?: string;
+    /**
+     * The customized subject of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    emailSubject?: string;
+    /**
+     * The customized body of the email to be sent if the report task is configured to email
+     * @type {string}
+     * @memberof ReportTaskResponse
+     */
+    emailBody?: string;
+    /**
+     * Users to share the published report with. This field will be updated entirely if provided
+     * @type {Array<ReportTaskResponseAllOfUsersToShareWith>}
+     * @memberof ReportTaskResponse
+     */
+    usersToShareWith?: Array<ReportTaskResponseAllOfUsersToShareWith>;
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum ReportTaskResponseFrequencyEnum {
+    Monthly = "Monthly",
+    OnceNow = "Once - now",
+    OnceScheduled = "Once - scheduled",
+    Annually = "Annually",
+    Daily = "Daily",
+    Weekly = "Weekly",
+    UponTrigger = "Upon trigger"
+}
+/**
+    * @export
+    * @enum {string}
+    */
+declare enum ReportTaskResponseEmailEnum {
+    Pdf = "pdf",
+    Pptx = "pptx",
+    Xlsx = "xlsx",
+    Csv = "csv"
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskResponseAllOfUsersToShareWith
+ */
+interface ReportTaskResponseAllOfUsersToShareWith {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskResponseAllOfUsersToShareWith
+     */
+    userId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskResponseAllOfUsersToShareWith
+     */
+    email?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskTags
+ */
+interface ReportTaskTags {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTags
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskTags
+     */
+    name?: string;
+}
+/**
+ *
+ * @export
+ * @interface ReportTaskVariables
+ */
+interface ReportTaskVariables {
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskVariables
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ReportTaskVariables
+     */
+    value?: string;
+}
+/**
+ *
+ * @export
+ * @interface Template
+ */
+interface Template {
+    /**
+     *
+     * @type {string}
+     * @memberof Template
+     */
+    id?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof Template
+     */
+    title: string;
+    /**
+     * HTML content of the template
+     * @type {string}
+     * @memberof Template
+     */
+    htmlContent: string;
+    /**
+     * Width of the template in pixels
+     * @type {number}
+     * @memberof Template
+     */
+    pageWidth: number;
+    /**
+     * Height of the template in pixels
+     * @type {number}
+     * @memberof Template
+     */
+    pageHeight: number;
+}
+/**
+ * BaseTemplatesApi - object-oriented interface
+ * @export
+ * @class BaseTemplatesApi
+ * @extends {BaseAPI}
+ */
+declare class BaseTemplatesApi extends BaseAPI {
+    /**
+     * Duplicate a base template by its ID
+     * @summary Duplicate a base template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BaseTemplatesApi
+     */
+    duplicateBaseTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     *
+     * @summary List base templates
+     * @param {number} [pageNum]
+     * @param {number} [page]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BaseTemplatesApi
+     */
+    getBaseTemplates(pageNum?: number, page?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse200, any>>;
+}
+/**
+ * DocumentsApi - object-oriented interface
+ * @export
+ * @class DocumentsApi
+ * @extends {BaseAPI}
+ */
+declare class DocumentsApi extends BaseAPI {
+    /**
+     *
+     * @summary Retrieve a generated document
+     * @param {string} fileName
+     * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} fileType
+     * @param {string} [attachmentName] A document file title. This value is reflected back to the client in the fileName header.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsApi
+     */
+    getDocument(fileName: string, fileType: 'pdf' | 'pptx' | 'xlsx' | 'csv', attachmentName?: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
+}
+/**
+ * FilterCyclesApi - object-oriented interface
+ * @export
+ * @class FilterCyclesApi
+ * @extends {BaseAPI}
+ */
+declare class FilterCyclesApi extends BaseAPI {
+    /**
+     *
+     * @summary Create a filter cycle
+     * @param {FilterCycle} filterCycle
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    createFilterCycle(filterCycle: FilterCycle, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
+    /**
+     *
+     * @summary Delete a filter cycle
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    deleteFilterCycle(id: string, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
+    /**
+     *
+     * @summary Disable all report tasks in a cycle
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    disableAllInCycle(id: string, options?: any): Promise<axios.AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Enable all report tasks in a cycle
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    enableAllInCycle(id: string, options?: any): Promise<axios.AxiosResponse<void, any>>;
+    /**
+     *
+     * @summary Get a filter cycle
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    getFilterCycle(id: string, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
+    /**
+     *
+     * @summary List filter cycles
+     * @param {string} templateId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    getFilterCycles(templateId: string, options?: any): Promise<axios.AxiosResponse<FilterCycle[], any>>;
+    /**
+     *
+     * @summary Update a filter cycle
+     * @param {string} id
+     * @param {FilterCycle} filterCycle
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof FilterCyclesApi
+     */
+    updateFilterCycle(id: string, filterCycle: FilterCycle, options?: any): Promise<axios.AxiosResponse<FilterCycle, any>>;
+}
+/**
+ * ImagesApi - object-oriented interface
+ * @export
+ * @class ImagesApi
+ * @extends {BaseAPI}
+ */
+declare class ImagesApi extends BaseAPI {
+    /**
+     *
+     * @summary Retrieves a user uploaded image for use in a template
+     * @param {string} title
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImagesApi
+     */
+    getImage(title: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
+    /**
+     * Uploads an image to the server for use in templates
+     * @summary Upload an image for use in a template
+     * @param {any} [image]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ImagesApi
+     */
+    uploadImage(image?: any, options?: any): Promise<axios.AxiosResponse<InlineResponse2001, any>>;
+}
+/**
+ * JobsApi - object-oriented interface
+ * @export
+ * @class JobsApi
+ * @extends {BaseAPI}
+ */
+declare class JobsApi extends BaseAPI {
+    /**
+     * Get the status of a queued job, including its status and result if available.
+     * @summary Get job
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof JobsApi
+     */
+    getJob(id: string, options?: any): Promise<axios.AxiosResponse<Job, any>>;
+}
+/**
+ * ReportTasksApi - object-oriented interface
+ * @export
+ * @class ReportTasksApi
+ * @extends {BaseAPI}
+ */
+declare class ReportTasksApi extends BaseAPI {
+    /**
+     *
+     * @summary Create report task
+     * @param {ReportTaskRequest} reportTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    createReportTask(reportTaskRequest: ReportTaskRequest, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
+    /**
+     * Delete a report task by its ID
+     * @summary Delete report task
+     * @param {string} id
+     * @param {boolean} [deleteAssociatedReports]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    deleteReportTask(id: string, deleteAssociatedReports?: boolean, options?: any): Promise<axios.AxiosResponse<void, any>>;
+    /**
+     * Read a report task by its ID
+     * @summary Read report task
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    getReportTask(id: string, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
+    /**
+     *
+     * @summary List report tasks
+     * @param {number} [pageNum]
+     * @param {{ [key: string]: string; }} [meta] When you list report tasks you can filter the list given one or metadata key/value pairs. Only items that contain all of the given metadata properties are returned.
+     * @param {string} [templateId]
+     * @param {number} [perPage]
+     * @param {'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId'} [orderBy]
+     * @param {'asc' | 'desc'} [order] The order to retrieve the logs in
+     * @param {object} [filter] Filters for report tasks.  JSON encoded object in the form of &#x60;{ field: string, query: string}&#x60;, or for date range fields (including \&quot;startOn\&quot; and \&quot;endOn\&quot;), &#x60;{ field: string, query: { start: Date, end: Date }}&#x60;. ### Examples:  Filter on \&quot;startOn\&quot;: &#x60;&#x60;&#x60; {   \&quot;field\&quot;: \&quot;startOn\&quot;,    \&quot;query\&quot;: {     \&quot;start\&quot;: \&quot;2020-01-01T00:00:00.000Z\&quot;,     \&quot;end\&quot;: \&quot;2020-01-02T00:00:00.000Z\&quot;   } } &#x60;&#x60;&#x60;  Filter on \&quot;enabled\&quot; &#x60;&#x60;&#x60; {   \&quot;field\&quot;: \&quot;enabled\&quot;,   \&quot;query\&quot;: \&quot;True\&quot;  } &#x60;&#x60;&#x60;  Filter on \&quot;frequency\&quot;: &#x60;&#x60;&#x60; {   \&quot;field\&quot;: \&quot;frequency\&quot;,   \&quot;query\&quot;: \&quot;Monthly\&quot;  } &#x60;&#x60;&#x60;
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    getReportTasks(pageNum?: number, meta?: {
+        [key: string]: string;
+    }, templateId?: string, perPage?: number, orderBy?: 'title' | 'startOn' | 'endOn' | 'enabled' | 'username' | 'frequency' | 'scheduledJobs.lastFinishedAt' | 'scheduledJobs.nextRunAt' | 'scheduledJobs.lastRunAt' | 'averageTimeToGenerate' | 'id' | 'templateId', order?: 'asc' | 'desc', filter?: object, options?: any): Promise<axios.AxiosResponse<InlineResponse2002, any>>;
+    /**
+     * Duplicates the task and runs it as \"Once - Now\"
+     * @summary Run task now
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    runReportTaskNow(id: string, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
+    /**
+     * Accepts partial updates
+     * @summary Update report task by ID
+     * @param {string} id
+     * @param {ReportTaskRequest} reportTaskRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportTasksApi
+     */
+    updateReportTask(id: string, reportTaskRequest: ReportTaskRequest, options?: any): Promise<axios.AxiosResponse<ReportTaskResponse, any>>;
+}
+/**
+ * ReportsApi - object-oriented interface
+ * @export
+ * @class ReportsApi
+ * @extends {BaseAPI}
+ */
+declare class ReportsApi extends BaseAPI {
+    /**
+     *
+     * @summary Delete a published report
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    deleteReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
+    /**
+     *
+     * @summary Get a published report
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    getReport(id: string, options?: any): Promise<axios.AxiosResponse<Report, any>>;
+    /**
+     *
+     * @summary List reports
+     * @param {number} [pageNum]
+     * @param {number} [perPage]
+     * @param {'title' | 'createdAt'} [orderBy] The field to order the list of reports on
+     * @param {'asc' | 'desc'} [order] The order to sort the list of reports on
+     * @param {string} [tagId] A tagId to filter the list of reports on
+     * @param {string} [reportTaskId] A reportId to filter the list of reports on
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    getReports(pageNum?: number, perPage?: number, orderBy?: 'title' | 'createdAt', order?: 'asc' | 'desc', tagId?: string, reportTaskId?: string, options?: any): Promise<axios.AxiosResponse<InlineResponse2003, any>>;
+    /**
+     *
+     * @summary Render a published report
+     * @param {string} id
+     * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApi
+     */
+    renderReport(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<axios.AxiosResponse<Job, any>>;
+}
+/**
+ * TemplatesApi - object-oriented interface
+ * @export
+ * @class TemplatesApi
+ * @extends {BaseAPI}
+ */
+declare class TemplatesApi extends BaseAPI {
+    /**
+     *
+     * @summary Create report template by ID
+     * @param {Template} template
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    createTemplate(template: Template, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     * Delete a report template by its ID
+     * @summary Delete report template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    deleteTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     * Duplicate a report template by its ID
+     * @summary Duplicate a report template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    duplicateTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     * Export a report template to a .CRPT file
+     * @summary Export a report template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    exportTemplate(id: string, options?: any): Promise<axios.AxiosResponse<any, any>>;
+    /**
+     * Read a report template by its ID
+     * @summary Read report template
+     * @param {string} id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    getTemplate(id: string, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     *
+     * @summary List report templates
+     * @param {number} [pageNum]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    getTemplates(pageNum?: number, options?: any): Promise<axios.AxiosResponse<InlineResponse2004, any>>;
+    /**
+     * Imports an exported .CRPT file
+     * @summary Import a template
+     * @param {any} [template]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    importTemplate(template?: any, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+    /**
+     * Render a report template to PDF, PPTX, or XLSX. Responds with a job entity.
+     * @summary Render a report template
+     * @param {string} id
+     * @param {'pdf' | 'pptx' | 'xlsx' | 'csv'} format
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    renderTemplate(id: string, format: 'pdf' | 'pptx' | 'xlsx' | 'csv', options?: any): Promise<axios.AxiosResponse<JobResponse, any>>;
+    /**
+     * Accepts partial updates
+     * @summary Update report template by ID
+     * @param {string} id
+     * @param {Template} template
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TemplatesApi
+     */
+    updateTemplate(id: string, template: Template, options?: any): Promise<axios.AxiosResponse<Template, any>>;
+}
+
+declare class ConnectReport {
     templates: TemplatesApi;
     images: ImagesApi;
     reports: ReportsApi;
@@ -14,3 +1526,5 @@ export declare class ConnectReport {
     client: AxiosInstance;
     constructor(config: Pick<Configuration, "apiKey" | "basePath" | "formDataCtor" | "httpsAgent">);
 }
+
+export { ConnectReport };