/** * Identity Security Cloud API - Reports Data Extraction * Use these APIs to interact with the Identity Security Cloud platform to achieve repeatable, automated processes with greater scalability. We encourage you to join the SailPoint Developer Community forum at https://developer.sailpoint.com/discuss to connect with other developers using our APIs. * * The version of the OpenAPI document: v1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import type { RequestArgs } from './base'; import { BaseAPI } from './base'; /** * Arguments for Account Export report (ACCOUNTS) * @export * @interface Accountsexportreportarguments */ export interface Accountsexportreportarguments { /** * Source ID. * @type {string} * @memberof Accountsexportreportarguments */ 'application': string; /** * Source name. * @type {string} * @memberof Accountsexportreportarguments */ 'sourceName': string; } /** * * @export * @interface ErrorMessageDto */ export interface ErrorMessageDto { /** * The locale for the message text, a BCP 47 language tag. * @type {string} * @memberof ErrorMessageDto */ 'locale'?: string | null; /** * * @type {LocaleOrigin} * @memberof ErrorMessageDto */ 'localeOrigin'?: LocaleOrigin | null; /** * Actual text of the error message in the indicated locale. * @type {string} * @memberof ErrorMessageDto */ 'text'?: string; } /** * * @export * @interface ErrorResponseDto */ export interface ErrorResponseDto { /** * Fine-grained error code providing more detail of the error. * @type {string} * @memberof ErrorResponseDto */ 'detailCode'?: string; /** * Unique tracking id for the error. * @type {string} * @memberof ErrorResponseDto */ 'trackingId'?: string; /** * Generic localized reason for error * @type {Array} * @memberof ErrorResponseDto */ 'messages'?: Array; /** * Plain-text descriptive reasons to provide additional detail to the text provided in the messages field * @type {Array} * @memberof ErrorResponseDto */ 'causes'?: Array; } /** * * @export * @interface GetReportResultV1401Response */ export interface GetReportResultV1401Response { /** * A message describing the error * @type {any} * @memberof GetReportResultV1401Response */ 'error'?: any; } /** * * @export * @interface GetReportResultV1429Response */ export interface GetReportResultV1429Response { /** * A message describing the error * @type {any} * @memberof GetReportResultV1429Response */ 'message'?: any; } /** * Arguments for Identities Details report (IDENTITIES_DETAILS) * @export * @interface Identitiesdetailsreportarguments */ export interface Identitiesdetailsreportarguments { /** * Flag to specify if only correlated identities are included in report. * @type {boolean} * @memberof Identitiesdetailsreportarguments */ 'correlatedOnly': boolean; } /** * Arguments for Identities report (IDENTITIES) * @export * @interface Identitiesreportarguments */ export interface Identitiesreportarguments { /** * Flag to specify if only correlated identities are included in report. * @type {boolean} * @memberof Identitiesreportarguments */ 'correlatedOnly'?: boolean; } /** * Arguments for Identity Profile Identity Error report (IDENTITY_PROFILE_IDENTITY_ERROR) * @export * @interface Identityprofileidentityerrorreportarguments */ export interface Identityprofileidentityerrorreportarguments { /** * Source ID. * @type {string} * @memberof Identityprofileidentityerrorreportarguments */ 'authoritativeSource': string; } /** * Enum representing the currently supported indices. Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const Index: { readonly Accessprofiles: "accessprofiles"; readonly Accountactivities: "accountactivities"; readonly Entitlements: "entitlements"; readonly Events: "events"; readonly Identities: "identities"; readonly Roles: "roles"; readonly Star: "*"; }; export type Index = typeof Index[keyof typeof Index]; /** * An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice. * @export * @enum {string} */ export declare const LocaleOrigin: { readonly Default: "DEFAULT"; readonly Request: "REQUEST"; }; export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin]; /** * Arguments for Orphan Identities report (ORPHAN_IDENTITIES) * @export * @interface Orphanidentitiesreportarguments */ export interface Orphanidentitiesreportarguments { /** * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. * @type {Array} * @memberof Orphanidentitiesreportarguments */ 'selectedFormats'?: Array; } export declare const OrphanidentitiesreportargumentsSelectedFormatsEnum: { readonly Csv: "CSV"; readonly Pdf: "PDF"; }; export type OrphanidentitiesreportargumentsSelectedFormatsEnum = typeof OrphanidentitiesreportargumentsSelectedFormatsEnum[keyof typeof OrphanidentitiesreportargumentsSelectedFormatsEnum]; /** * Details about report to be processed. * @export * @interface ReportDetails */ export interface ReportDetails { /** * Use this property to define what report should be processed in the RDE service. * @type {string} * @memberof ReportDetails */ 'reportType'?: ReportDetailsReportTypeEnum; /** * * @type {ReportDetailsArguments} * @memberof ReportDetails */ 'arguments'?: ReportDetailsArguments; } export declare const ReportDetailsReportTypeEnum: { readonly Accounts: "ACCOUNTS"; readonly IdentitiesDetails: "IDENTITIES_DETAILS"; readonly Identities: "IDENTITIES"; readonly IdentityProfileIdentityError: "IDENTITY_PROFILE_IDENTITY_ERROR"; readonly OrphanIdentities: "ORPHAN_IDENTITIES"; readonly SearchExport: "SEARCH_EXPORT"; readonly UncorrelatedAccounts: "UNCORRELATED_ACCOUNTS"; }; export type ReportDetailsReportTypeEnum = typeof ReportDetailsReportTypeEnum[keyof typeof ReportDetailsReportTypeEnum]; /** * The string-object map(dictionary) with the arguments needed for report processing. * @export * @interface ReportDetailsArguments */ export interface ReportDetailsArguments { /** * Source ID. * @type {string} * @memberof ReportDetailsArguments */ 'application': string; /** * Source name. * @type {string} * @memberof ReportDetailsArguments */ 'sourceName': string; /** * Flag to specify if only correlated identities are included in report. * @type {boolean} * @memberof ReportDetailsArguments */ 'correlatedOnly': boolean; /** * Source ID. * @type {string} * @memberof ReportDetailsArguments */ 'authoritativeSource': string; /** * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. * @type {Array} * @memberof ReportDetailsArguments */ 'selectedFormats'?: Array; /** * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. * @type {Array} * @memberof ReportDetailsArguments */ 'indices'?: Array; /** * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. * @type {string} * @memberof ReportDetailsArguments */ 'query': string; /** * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. * @type {string} * @memberof ReportDetailsArguments */ 'columns'?: string; /** * The fields to be used to sort the search results. Use + or - to specify the sort direction. * @type {Array} * @memberof ReportDetailsArguments */ 'sort'?: Array; } export declare const ReportDetailsArgumentsSelectedFormatsEnum: { readonly Csv: "CSV"; readonly Pdf: "PDF"; }; export type ReportDetailsArgumentsSelectedFormatsEnum = typeof ReportDetailsArgumentsSelectedFormatsEnum[keyof typeof ReportDetailsArgumentsSelectedFormatsEnum]; /** * Details about report result or current state. * @export * @interface ReportResults */ export interface ReportResults { /** * Use this property to define what report should be processed in the RDE service. * @type {string} * @memberof ReportResults */ 'reportType'?: ReportResultsReportTypeEnum; /** * Name of the task definition which is started to process requesting report. Usually the same as report name * @type {string} * @memberof ReportResults */ 'taskDefName'?: string; /** * Unique task definition identifier. * @type {string} * @memberof ReportResults */ 'id'?: string; /** * Report processing start date * @type {string} * @memberof ReportResults */ 'created'?: string; /** * Report current state or result status. * @type {string} * @memberof ReportResults */ 'status'?: ReportResultsStatusEnum; /** * Report processing time in ms. * @type {number} * @memberof ReportResults */ 'duration'?: number; /** * Report size in rows. * @type {number} * @memberof ReportResults */ 'rows'?: number; /** * Output report file formats. This are formats for calling get endpoint as a query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. * @type {Array} * @memberof ReportResults */ 'availableFormats'?: Array; } export declare const ReportResultsReportTypeEnum: { readonly Accounts: "ACCOUNTS"; readonly IdentitiesDetails: "IDENTITIES_DETAILS"; readonly Identities: "IDENTITIES"; readonly IdentityProfileIdentityError: "IDENTITY_PROFILE_IDENTITY_ERROR"; readonly OrphanIdentities: "ORPHAN_IDENTITIES"; readonly SearchExport: "SEARCH_EXPORT"; readonly UncorrelatedAccounts: "UNCORRELATED_ACCOUNTS"; }; export type ReportResultsReportTypeEnum = typeof ReportResultsReportTypeEnum[keyof typeof ReportResultsReportTypeEnum]; export declare const ReportResultsStatusEnum: { readonly Success: "SUCCESS"; readonly Failure: "FAILURE"; readonly Warning: "WARNING"; readonly Terminated: "TERMINATED"; }; export type ReportResultsStatusEnum = typeof ReportResultsStatusEnum[keyof typeof ReportResultsStatusEnum]; export declare const ReportResultsAvailableFormatsEnum: { readonly Csv: "CSV"; readonly Pdf: "PDF"; }; export type ReportResultsAvailableFormatsEnum = typeof ReportResultsAvailableFormatsEnum[keyof typeof ReportResultsAvailableFormatsEnum]; /** * Arguments for Search Export report (SEARCH_EXPORT) The report file generated will be a zip file containing csv files of the search results. * @export * @interface Searchexportreportarguments */ export interface Searchexportreportarguments { /** * The names of the Elasticsearch indices in which to search. If none are provided, then all indices will be searched. * @type {Array} * @memberof Searchexportreportarguments */ 'indices'?: Array; /** * The query using the Elasticsearch [Query String Query](https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-query-string-query.html#query-string) syntax from the Query DSL extended by SailPoint to support Nested queries. * @type {string} * @memberof Searchexportreportarguments */ 'query': string; /** * Comma separated string consisting of technical attribute names of fields to include in report. Use `access.spread`, `apps.spread`, `accounts.spread` to include respective identity access details. Use `accessProfiles.spread` to unclude access profile details. Use `entitlements.spread` to include entitlement details. * @type {string} * @memberof Searchexportreportarguments */ 'columns'?: string; /** * The fields to be used to sort the search results. Use + or - to specify the sort direction. * @type {Array} * @memberof Searchexportreportarguments */ 'sort'?: Array; } /** * Details about job or task type, state and lifecycle. * @export * @interface TaskResultDetails */ export interface TaskResultDetails { /** * Type of the job or task underlying in the report processing. It could be a quartz task, QPOC or MENTOS jobs or a refresh/sync task. * @type {string} * @memberof TaskResultDetails */ 'type'?: TaskResultDetailsTypeEnum; /** * Unique task definition identifier. * @type {string} * @memberof TaskResultDetails */ 'id'?: string; /** * Use this property to define what report should be processed in the RDE service. * @type {string} * @memberof TaskResultDetails */ 'reportType'?: TaskResultDetailsReportTypeEnum; /** * Description of the report purpose and/or contents. * @type {string} * @memberof TaskResultDetails */ 'description'?: string; /** * Name of the parent task/report if exists. * @type {string} * @memberof TaskResultDetails */ 'parentName'?: string | null; /** * Name of the report processing initiator. * @type {string} * @memberof TaskResultDetails */ 'launcher'?: string; /** * Report creation date * @type {string} * @memberof TaskResultDetails */ 'created'?: string; /** * Report start date * @type {string} * @memberof TaskResultDetails */ 'launched'?: string | null; /** * Report completion date * @type {string} * @memberof TaskResultDetails */ 'completed'?: string | null; /** * Report completion status. * @type {string} * @memberof TaskResultDetails */ 'completionStatus'?: TaskResultDetailsCompletionStatusEnum | null; /** * List of the messages dedicated to the report. From task definition perspective here usually should be warnings or errors. * @type {Array} * @memberof TaskResultDetails */ 'messages'?: Array; /** * Task definition results, if necessary. * @type {Array} * @memberof TaskResultDetails */ 'returns'?: Array; /** * Extra attributes map(dictionary) needed for the report. * @type {object} * @memberof TaskResultDetails */ 'attributes'?: object; /** * Current report state. * @type {string} * @memberof TaskResultDetails */ 'progress'?: string | null; } export declare const TaskResultDetailsTypeEnum: { readonly Quartz: "QUARTZ"; readonly Qpoc: "QPOC"; readonly Mentos: "MENTOS"; readonly QueuedTask: "QUEUED_TASK"; }; export type TaskResultDetailsTypeEnum = typeof TaskResultDetailsTypeEnum[keyof typeof TaskResultDetailsTypeEnum]; export declare const TaskResultDetailsReportTypeEnum: { readonly Accounts: "ACCOUNTS"; readonly IdentitiesDetails: "IDENTITIES_DETAILS"; readonly Identities: "IDENTITIES"; readonly IdentityProfileIdentityError: "IDENTITY_PROFILE_IDENTITY_ERROR"; readonly OrphanIdentities: "ORPHAN_IDENTITIES"; readonly SearchExport: "SEARCH_EXPORT"; readonly UncorrelatedAccounts: "UNCORRELATED_ACCOUNTS"; }; export type TaskResultDetailsReportTypeEnum = typeof TaskResultDetailsReportTypeEnum[keyof typeof TaskResultDetailsReportTypeEnum]; export declare const TaskResultDetailsCompletionStatusEnum: { readonly Success: "SUCCESS"; readonly Warning: "WARNING"; readonly Error: "ERROR"; readonly Terminated: "TERMINATED"; readonly TempError: "TEMP_ERROR"; }; export type TaskResultDetailsCompletionStatusEnum = typeof TaskResultDetailsCompletionStatusEnum[keyof typeof TaskResultDetailsCompletionStatusEnum]; /** * * @export * @interface TaskResultDetailsMessagesInner */ export interface TaskResultDetailsMessagesInner { /** * Type of the message. * @type {string} * @memberof TaskResultDetailsMessagesInner */ 'type'?: TaskResultDetailsMessagesInnerTypeEnum; /** * Flag whether message is an error. * @type {boolean} * @memberof TaskResultDetailsMessagesInner */ 'error'?: boolean; /** * Flag whether message is a warning. * @type {boolean} * @memberof TaskResultDetailsMessagesInner */ 'warning'?: boolean; /** * Message string identifier. * @type {string} * @memberof TaskResultDetailsMessagesInner */ 'key'?: string; /** * Message context with the locale based language. * @type {string} * @memberof TaskResultDetailsMessagesInner */ 'localizedText'?: string; } export declare const TaskResultDetailsMessagesInnerTypeEnum: { readonly Info: "INFO"; readonly Warn: "WARN"; readonly Error: "ERROR"; }; export type TaskResultDetailsMessagesInnerTypeEnum = typeof TaskResultDetailsMessagesInnerTypeEnum[keyof typeof TaskResultDetailsMessagesInnerTypeEnum]; /** * * @export * @interface TaskResultDetailsReturnsInner */ export interface TaskResultDetailsReturnsInner { /** * Attribute description. * @type {string} * @memberof TaskResultDetailsReturnsInner */ 'displayLabel'?: string; /** * System or database attribute name. * @type {string} * @memberof TaskResultDetailsReturnsInner */ 'attributeName'?: string; } /** * Arguments for Uncorrelated Accounts report (UNCORRELATED_ACCOUNTS) * @export * @interface Uncorrelatedaccountsreportarguments */ export interface Uncorrelatedaccountsreportarguments { /** * Output report file formats. These are formats for calling GET endpoint as query parameter \'fileFormat\'. In case report won\'t have this argument there will be [\'CSV\', \'PDF\'] as default. * @type {Array} * @memberof Uncorrelatedaccountsreportarguments */ 'selectedFormats'?: Array; } export declare const UncorrelatedaccountsreportargumentsSelectedFormatsEnum: { readonly Csv: "CSV"; readonly Pdf: "PDF"; }; export type UncorrelatedaccountsreportargumentsSelectedFormatsEnum = typeof UncorrelatedaccountsreportargumentsSelectedFormatsEnum[keyof typeof UncorrelatedaccountsreportargumentsSelectedFormatsEnum]; /** * ReportsDataExtractionApi - axios parameter creator * @export */ export declare const ReportsDataExtractionApiAxiosParamCreator: (configuration?: Configuration) => { /** * Cancels a running report. * @summary Cancel report * @param {string} id ID of the running Report to cancel * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelReportV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. * @summary Get report result * @param {string} taskResultId Unique identifier of the task result which handled report * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportResultV1: (taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Gets a report in file format. * @summary Get report file * @param {string} taskResultId Unique identifier of the task result which handled report * @param {GetReportV1FileFormatEnum} fileFormat Output format of the requested report file * @param {string} [name] preferred Report file name, by default will be used report name from task result. * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportV1: (taskResultId: string, fileFormat: GetReportV1FileFormatEnum, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise; /** * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. * @summary Run report * @param {ReportDetails} reportDetails * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startReportV1: (reportDetails: ReportDetails, axiosOptions?: RawAxiosRequestConfig) => Promise; }; /** * ReportsDataExtractionApi - functional programming interface * @export */ export declare const ReportsDataExtractionApiFp: (configuration?: Configuration) => { /** * Cancels a running report. * @summary Cancel report * @param {string} id ID of the running Report to cancel * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelReportV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. * @summary Get report result * @param {string} taskResultId Unique identifier of the task result which handled report * @param {boolean} [completed] state of task result to apply ordering when results are fetching from the DB * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportResultV1(taskResultId: string, completed?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets a report in file format. * @summary Get report file * @param {string} taskResultId Unique identifier of the task result which handled report * @param {GetReportV1FileFormatEnum} fileFormat Output format of the requested report file * @param {string} [name] preferred Report file name, by default will be used report name from task result. * @param {boolean} [auditable] Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportV1(taskResultId: string, fileFormat: GetReportV1FileFormatEnum, name?: string, auditable?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. * @summary Run report * @param {ReportDetails} reportDetails * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startReportV1(reportDetails: ReportDetails, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * ReportsDataExtractionApi - factory interface * @export */ export declare const ReportsDataExtractionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Cancels a running report. * @summary Cancel report * @param {ReportsDataExtractionApiCancelReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ cancelReportV1(requestParameters: ReportsDataExtractionApiCancelReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. * @summary Get report result * @param {ReportsDataExtractionApiGetReportResultV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportResultV1(requestParameters: ReportsDataExtractionApiGetReportResultV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Gets a report in file format. * @summary Get report file * @param {ReportsDataExtractionApiGetReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ getReportV1(requestParameters: ReportsDataExtractionApiGetReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; /** * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. * @summary Run report * @param {ReportsDataExtractionApiStartReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} */ startReportV1(requestParameters: ReportsDataExtractionApiStartReportV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise; }; /** * Request parameters for cancelReportV1 operation in ReportsDataExtractionApi. * @export * @interface ReportsDataExtractionApiCancelReportV1Request */ export interface ReportsDataExtractionApiCancelReportV1Request { /** * ID of the running Report to cancel * @type {string} * @memberof ReportsDataExtractionApiCancelReportV1 */ readonly id: string; } /** * Request parameters for getReportResultV1 operation in ReportsDataExtractionApi. * @export * @interface ReportsDataExtractionApiGetReportResultV1Request */ export interface ReportsDataExtractionApiGetReportResultV1Request { /** * Unique identifier of the task result which handled report * @type {string} * @memberof ReportsDataExtractionApiGetReportResultV1 */ readonly taskResultId: string; /** * state of task result to apply ordering when results are fetching from the DB * @type {boolean} * @memberof ReportsDataExtractionApiGetReportResultV1 */ readonly completed?: boolean; } /** * Request parameters for getReportV1 operation in ReportsDataExtractionApi. * @export * @interface ReportsDataExtractionApiGetReportV1Request */ export interface ReportsDataExtractionApiGetReportV1Request { /** * Unique identifier of the task result which handled report * @type {string} * @memberof ReportsDataExtractionApiGetReportV1 */ readonly taskResultId: string; /** * Output format of the requested report file * @type {'csv' | 'pdf'} * @memberof ReportsDataExtractionApiGetReportV1 */ readonly fileFormat: GetReportV1FileFormatEnum; /** * preferred Report file name, by default will be used report name from task result. * @type {string} * @memberof ReportsDataExtractionApiGetReportV1 */ readonly name?: string; /** * Enables auditing for current report download. Will create an audit event and sent it to the REPORT cloud-audit kafka topic. Event will be created if there is any result present by requested taskResultId. * @type {boolean} * @memberof ReportsDataExtractionApiGetReportV1 */ readonly auditable?: boolean; } /** * Request parameters for startReportV1 operation in ReportsDataExtractionApi. * @export * @interface ReportsDataExtractionApiStartReportV1Request */ export interface ReportsDataExtractionApiStartReportV1Request { /** * * @type {ReportDetails} * @memberof ReportsDataExtractionApiStartReportV1 */ readonly reportDetails: ReportDetails; } /** * ReportsDataExtractionApi - object-oriented interface * @export * @class ReportsDataExtractionApi * @extends {BaseAPI} */ export declare class ReportsDataExtractionApi extends BaseAPI { /** * Cancels a running report. * @summary Cancel report * @param {ReportsDataExtractionApiCancelReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ReportsDataExtractionApi */ cancelReportV1(requestParameters: ReportsDataExtractionApiCancelReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Get the report results for a report that was run or is running. Returns empty report result in case there are no active task definitions with used in payload task definition name. * @summary Get report result * @param {ReportsDataExtractionApiGetReportResultV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ReportsDataExtractionApi */ getReportResultV1(requestParameters: ReportsDataExtractionApiGetReportResultV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Gets a report in file format. * @summary Get report file * @param {ReportsDataExtractionApiGetReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ReportsDataExtractionApi */ getReportV1(requestParameters: ReportsDataExtractionApiGetReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; /** * Use this API to run a report according to report input details. If non-concurrent task is already running then it returns, otherwise new task creates and returns. * @summary Run report * @param {ReportsDataExtractionApiStartReportV1Request} requestParameters Request parameters. * @param {*} [axiosOptions] Override http request option. * @throws {RequiredError} * @memberof ReportsDataExtractionApi */ startReportV1(requestParameters: ReportsDataExtractionApiStartReportV1Request, axiosOptions?: RawAxiosRequestConfig): Promise>; } /** * @export */ export declare const GetReportV1FileFormatEnum: { readonly Csv: "csv"; readonly Pdf: "pdf"; }; export type GetReportV1FileFormatEnum = typeof GetReportV1FileFormatEnum[keyof typeof GetReportV1FileFormatEnum];