@gooddata/api-client-tiger 11.63.0-alpha.0 → 11.63.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -60,7 +60,7 @@ export interface ExportAbsoluteDateFilterAbsoluteDateFilter {
60
60
  }
61
61
  export type ExportAbsoluteDateFilterAbsoluteDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
62
62
  /**
63
- * An absolute date range filter defined at a specific granularity. The \'from\'/\'to\' literals must match the format of the chosen granularity (e.g. \'2020\' for YEAR, \'2012-05\' for MONTH, \'2012-3\' for QUARTER, \'1996-01\' for WEEK, \'2010-10-30\' for DAY, or a plain ordinal like \'6\' for periodical granularities such as MONTH_OF_YEAR). At least one of \'from\'/\'to\' must be provided; specifying only one yields an open-ended range.
63
+ * An absolute date range filter defined at a specific granularity. The \'from\'/\'to\' literals must match the format of the chosen granularity (e.g. \'2020\' for YEAR, \'2012-05\' for MONTH, \'2012-3\' for QUARTER, \'1996-01\' for WEEK, \'2010-10-30\' for DAY, \'2010-10-30 13\' for HOUR, \'2010-10-30 13:30\' for MINUTE, \'2010-10-30 13:30:45\' for SECOND, or a plain ordinal like \'6\' for periodical granularities such as MONTH_OF_YEAR). At least one of \'from\'/\'to\' must be provided; specifying only one yields an open-ended range.
64
64
  */
65
65
  export interface ExportAbsoluteGranularityDateFilter {
66
66
  'absoluteGranularityDateFilter': ExportAbsoluteGranularityDateFilterAbsoluteGranularityDateFilter;
@@ -739,6 +739,16 @@ export type ExportFilterDefinition = ExportAbsoluteDateFilter | ExportAbsoluteGr
739
739
  * Abstract filter definition type for simple metric.
740
740
  */
741
741
  export type ExportFilterDefinitionForSimpleMeasure = ExportAttributeFilter | ExportDateFilter;
742
+ export interface ExportGetDocumentExport202ResponseInner {
743
+ 'char'?: string;
744
+ 'direct'?: boolean;
745
+ 'double'?: number;
746
+ 'float'?: number;
747
+ 'int'?: number;
748
+ 'long'?: number;
749
+ 'readOnly'?: boolean;
750
+ 'short'?: number;
751
+ }
742
752
  export interface ExportGetImageExport202ResponseInner {
743
753
  'char'?: string;
744
754
  'direct'?: boolean;
@@ -1206,9 +1216,13 @@ export interface ExportRelativeDateFilterRelativeDateFilter {
1206
1216
  export type ExportRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
1207
1217
  export type ExportRelativeDateFilterRelativeDateFilterGranularityEnum = 'SECOND' | 'SECOND_OF_MINUTE' | 'SECOND_OF_DAY' | 'MINUTE' | 'MINUTE_OF_HOUR' | 'MINUTE_OF_DAY' | 'HOUR' | 'HOUR_OF_DAY' | 'DAY' | 'DAY_OF_WEEK' | 'DAY_OF_MONTH' | 'DAY_OF_QUARTER' | 'DAY_OF_YEAR' | 'WEEK' | 'WEEK_OF_YEAR' | 'MONTH' | 'MONTH_OF_YEAR' | 'QUARTER' | 'QUARTER_OF_YEAR' | 'YEAR' | 'FISCAL_DAY_OF_FISCAL_WEEK' | 'FISCAL_DAY_OF_FISCAL_MONTH' | 'FISCAL_DAY_OF_FISCAL_QUARTER' | 'FISCAL_DAY_OF_FISCAL_SEMESTER' | 'FISCAL_DAY_OF_FISCAL_YEAR' | 'FISCAL_WEEK' | 'FISCAL_WEEK_OF_FISCAL_MONTH' | 'FISCAL_WEEK_OF_FISCAL_QUARTER' | 'FISCAL_WEEK_OF_FISCAL_SEMESTER' | 'FISCAL_WEEK_OF_FISCAL_YEAR' | 'FISCAL_MONTH' | 'FISCAL_MONTH_OF_FISCAL_QUARTER' | 'FISCAL_MONTH_OF_FISCAL_SEMESTER' | 'FISCAL_MONTH_OF_FISCAL_YEAR' | 'FISCAL_QUARTER' | 'FISCAL_QUARTER_OF_FISCAL_SEMESTER' | 'FISCAL_QUARTER_OF_FISCAL_YEAR' | 'FISCAL_SEMESTER' | 'FISCAL_SEMESTER_OF_FISCAL_YEAR' | 'FISCAL_YEAR';
1208
1218
  /**
1209
- * Export request object describing the export properties and metadata for report exports.
1219
+ * Export request object describing the export properties and metadata for document exports.
1210
1220
  */
1211
1221
  export interface ExportReportExportRequest {
1222
+ /**
1223
+ * Document identifier; the export renders the Publisher document page.
1224
+ */
1225
+ 'documentId'?: string;
1212
1226
  /**
1213
1227
  * File name to be used for retrieving the pdf document.
1214
1228
  */
@@ -1222,9 +1236,10 @@ export interface ExportReportExportRequest {
1222
1236
  */
1223
1237
  'metadata'?: object | null;
1224
1238
  /**
1225
- * Report identifier
1239
+ * Document identifier; the export renders the Publisher report page. Deprecated. \'documentId\' renders the Publisher document page instead, so switching changes the page the export opens. Must not be set together with \'documentId\'.
1240
+ * @deprecated
1226
1241
  */
1227
- 'reportId': string;
1242
+ 'reportId'?: string;
1228
1243
  /**
1229
1244
  * Time zone the export should be rendered in, as an IANA identifier (e.g. \'Asia/Kolkata\') or a GMT offset (e.g. \'GMT+01:00\'). When omitted, the workspace time zone setting is used.
1230
1245
  */
@@ -1440,6 +1455,17 @@ export interface ExportVisualExportRequest {
1440
1455
  * @throws {RequiredError}
1441
1456
  */
1442
1457
  export declare function ActionsExportAxiosParamCreator_CreateDashboardExportRequest(workspaceId: string, dashboardId: string, exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1458
+ /**
1459
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1460
+ * @summary (EXPERIMENTAL) Create document export request
1461
+ * @param {string} workspaceId
1462
+ * @param {ExportReportExportRequest} exportReportExportRequest
1463
+ * @param {boolean} [xGdcDebug]
1464
+ * @param {*} [options] Override http request option.
1465
+ * @param {Configuration} [configuration] Optional configuration.
1466
+ * @throws {RequiredError}
1467
+ */
1468
+ export declare function ActionsExportAxiosParamCreator_CreateDocumentExport(workspaceId: string, exportReportExportRequest: ExportReportExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1443
1469
  /**
1444
1470
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1445
1471
  * @summary (EXPERIMENTAL) Create image export request
@@ -1473,7 +1499,7 @@ export declare function ActionsExportAxiosParamCreator_CreatePdfExport(workspace
1473
1499
  */
1474
1500
  export declare function ActionsExportAxiosParamCreator_CreateRawExport(workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1475
1501
  /**
1476
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1502
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1477
1503
  * @summary (EXPERIMENTAL) Create report export request
1478
1504
  * @param {string} workspaceId
1479
1505
  * @param {ExportReportExportRequest} exportReportExportRequest
@@ -1504,6 +1530,26 @@ export declare function ActionsExportAxiosParamCreator_CreateSlidesExport(worksp
1504
1530
  * @throws {RequiredError}
1505
1531
  */
1506
1532
  export declare function ActionsExportAxiosParamCreator_CreateTabularExport(workspaceId: string, exportTabularExportRequest: ExportTabularExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1533
+ /**
1534
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1535
+ * @summary (EXPERIMENTAL) Retrieve exported document
1536
+ * @param {string} workspaceId
1537
+ * @param {string} exportId
1538
+ * @param {*} [options] Override http request option.
1539
+ * @param {Configuration} [configuration] Optional configuration.
1540
+ * @throws {RequiredError}
1541
+ */
1542
+ export declare function ActionsExportAxiosParamCreator_GetDocumentExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1543
+ /**
1544
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
1545
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1546
+ * @param {string} workspaceId
1547
+ * @param {string} exportId
1548
+ * @param {*} [options] Override http request option.
1549
+ * @param {Configuration} [configuration] Optional configuration.
1550
+ * @throws {RequiredError}
1551
+ */
1552
+ export declare function ActionsExportAxiosParamCreator_GetDocumentExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1507
1553
  /**
1508
1554
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1509
1555
  * @summary Retrieve exported files
@@ -1555,7 +1601,7 @@ export declare function ActionsExportAxiosParamCreator_GetMetadata(workspaceId:
1555
1601
  */
1556
1602
  export declare function ActionsExportAxiosParamCreator_GetRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1557
1603
  /**
1558
- * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1604
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1559
1605
  * @summary (EXPERIMENTAL) Retrieve exported files
1560
1606
  * @param {string} workspaceId
1561
1607
  * @param {string} exportId
@@ -1565,7 +1611,7 @@ export declare function ActionsExportAxiosParamCreator_GetRawExport(workspaceId:
1565
1611
  */
1566
1612
  export declare function ActionsExportAxiosParamCreator_GetReportExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
1567
1613
  /**
1568
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
1614
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
1569
1615
  * @summary (EXPERIMENTAL) Retrieve metadata context
1570
1616
  * @param {string} workspaceId
1571
1617
  * @param {string} exportId
@@ -1615,6 +1661,17 @@ export declare function ActionsExportAxiosParamCreator_GetTabularExport(workspac
1615
1661
  * @throws {RequiredError}
1616
1662
  */
1617
1663
  export declare function ActionsExport_CreateDashboardExportRequest(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
1664
+ /**
1665
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1666
+ * @summary (EXPERIMENTAL) Create document export request
1667
+ * @param {AxiosInstance} axios Axios instance.
1668
+ * @param {string} basePath Base path.
1669
+ * @param {ActionsExportCreateDocumentExportRequest} requestParameters Request parameters.
1670
+ * @param {*} [options] Override http request option.
1671
+ * @param {Configuration} [configuration] Optional configuration.
1672
+ * @throws {RequiredError}
1673
+ */
1674
+ export declare function ActionsExport_CreateDocumentExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateDocumentExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
1618
1675
  /**
1619
1676
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1620
1677
  * @summary (EXPERIMENTAL) Create image export request
@@ -1649,7 +1706,7 @@ export declare function ActionsExport_CreatePdfExport(axios: AxiosInstance, base
1649
1706
  */
1650
1707
  export declare function ActionsExport_CreateRawExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
1651
1708
  /**
1652
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1709
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1653
1710
  * @summary (EXPERIMENTAL) Create report export request
1654
1711
  * @param {AxiosInstance} axios Axios instance.
1655
1712
  * @param {string} basePath Base path.
@@ -1681,6 +1738,28 @@ export declare function ActionsExport_CreateSlidesExport(axios: AxiosInstance, b
1681
1738
  * @throws {RequiredError}
1682
1739
  */
1683
1740
  export declare function ActionsExport_CreateTabularExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
1741
+ /**
1742
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1743
+ * @summary (EXPERIMENTAL) Retrieve exported document
1744
+ * @param {AxiosInstance} axios Axios instance.
1745
+ * @param {string} basePath Base path.
1746
+ * @param {ActionsExportGetDocumentExportRequest} requestParameters Request parameters.
1747
+ * @param {*} [options] Override http request option.
1748
+ * @param {Configuration} [configuration] Optional configuration.
1749
+ * @throws {RequiredError}
1750
+ */
1751
+ export declare function ActionsExport_GetDocumentExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetDocumentExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
1752
+ /**
1753
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
1754
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1755
+ * @param {AxiosInstance} axios Axios instance.
1756
+ * @param {string} basePath Base path.
1757
+ * @param {ActionsExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
1758
+ * @param {*} [options] Override http request option.
1759
+ * @param {Configuration} [configuration] Optional configuration.
1760
+ * @throws {RequiredError}
1761
+ */
1762
+ export declare function ActionsExport_GetDocumentExportMetadata(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
1684
1763
  /**
1685
1764
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1686
1765
  * @summary Retrieve exported files
@@ -1737,7 +1816,7 @@ export declare function ActionsExport_GetMetadata(axios: AxiosInstance, basePath
1737
1816
  */
1738
1817
  export declare function ActionsExport_GetRawExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
1739
1818
  /**
1740
- * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1819
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1741
1820
  * @summary (EXPERIMENTAL) Retrieve exported files
1742
1821
  * @param {AxiosInstance} axios Axios instance.
1743
1822
  * @param {string} basePath Base path.
@@ -1748,7 +1827,7 @@ export declare function ActionsExport_GetRawExport(axios: AxiosInstance, basePat
1748
1827
  */
1749
1828
  export declare function ActionsExport_GetReportExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
1750
1829
  /**
1751
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
1830
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
1752
1831
  * @summary (EXPERIMENTAL) Retrieve metadata context
1753
1832
  * @param {AxiosInstance} axios Axios instance.
1754
1833
  * @param {string} basePath Base path.
@@ -1806,6 +1885,15 @@ export interface ActionsExportInterface {
1806
1885
  * @memberof ActionsExportInterface
1807
1886
  */
1808
1887
  createDashboardExportRequest(requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
1888
+ /**
1889
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1890
+ * @summary (EXPERIMENTAL) Create document export request
1891
+ * @param {ActionsExportCreateDocumentExportRequest} requestParameters Request parameters.
1892
+ * @param {*} [options] Override http request option.
1893
+ * @throws {RequiredError}
1894
+ * @memberof ActionsExportInterface
1895
+ */
1896
+ createDocumentExport(requestParameters: ActionsExportCreateDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
1809
1897
  /**
1810
1898
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1811
1899
  * @summary (EXPERIMENTAL) Create image export request
@@ -1834,10 +1922,11 @@ export interface ActionsExportInterface {
1834
1922
  */
1835
1923
  createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
1836
1924
  /**
1837
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1925
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
1838
1926
  * @summary (EXPERIMENTAL) Create report export request
1839
1927
  * @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
1840
1928
  * @param {*} [options] Override http request option.
1929
+ * @deprecated
1841
1930
  * @throws {RequiredError}
1842
1931
  * @memberof ActionsExportInterface
1843
1932
  */
@@ -1860,6 +1949,24 @@ export interface ActionsExportInterface {
1860
1949
  * @memberof ActionsExportInterface
1861
1950
  */
1862
1951
  createTabularExport(requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
1952
+ /**
1953
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1954
+ * @summary (EXPERIMENTAL) Retrieve exported document
1955
+ * @param {ActionsExportGetDocumentExportRequest} requestParameters Request parameters.
1956
+ * @param {*} [options] Override http request option.
1957
+ * @throws {RequiredError}
1958
+ * @memberof ActionsExportInterface
1959
+ */
1960
+ getDocumentExport(requestParameters: ActionsExportGetDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
1961
+ /**
1962
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
1963
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
1964
+ * @param {ActionsExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
1965
+ * @param {*} [options] Override http request option.
1966
+ * @throws {RequiredError}
1967
+ * @memberof ActionsExportInterface
1968
+ */
1969
+ getDocumentExportMetadata(requestParameters: ActionsExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
1863
1970
  /**
1864
1971
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
1865
1972
  * @summary Retrieve exported files
@@ -1906,19 +2013,21 @@ export interface ActionsExportInterface {
1906
2013
  */
1907
2014
  getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
1908
2015
  /**
1909
- * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2016
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
1910
2017
  * @summary (EXPERIMENTAL) Retrieve exported files
1911
2018
  * @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
1912
2019
  * @param {*} [options] Override http request option.
2020
+ * @deprecated
1913
2021
  * @throws {RequiredError}
1914
2022
  * @memberof ActionsExportInterface
1915
2023
  */
1916
2024
  getReportExport(requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
1917
2025
  /**
1918
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2026
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
1919
2027
  * @summary (EXPERIMENTAL) Retrieve metadata context
1920
2028
  * @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
1921
2029
  * @param {*} [options] Override http request option.
2030
+ * @deprecated
1922
2031
  * @throws {RequiredError}
1923
2032
  * @memberof ActionsExportInterface
1924
2033
  */
@@ -1976,6 +2085,31 @@ export interface ActionsExportCreateDashboardExportRequestRequest {
1976
2085
  */
1977
2086
  readonly exportDashboardTabularExportRequest: ExportDashboardTabularExportRequest;
1978
2087
  }
2088
+ /**
2089
+ * Request parameters for createDocumentExport operation in ActionsExport.
2090
+ * @export
2091
+ * @interface ActionsExportCreateDocumentExportRequest
2092
+ */
2093
+ export interface ActionsExportCreateDocumentExportRequest {
2094
+ /**
2095
+ *
2096
+ * @type {string}
2097
+ * @memberof ActionsExportCreateDocumentExport
2098
+ */
2099
+ readonly workspaceId: string;
2100
+ /**
2101
+ *
2102
+ * @type {ExportReportExportRequest}
2103
+ * @memberof ActionsExportCreateDocumentExport
2104
+ */
2105
+ readonly exportReportExportRequest: ExportReportExportRequest;
2106
+ /**
2107
+ *
2108
+ * @type {boolean}
2109
+ * @memberof ActionsExportCreateDocumentExport
2110
+ */
2111
+ readonly xGdcDebug?: boolean;
2112
+ }
1979
2113
  /**
1980
2114
  * Request parameters for createImageExport operation in ActionsExport.
1981
2115
  * @export
@@ -2114,6 +2248,44 @@ export interface ActionsExportCreateTabularExportRequest {
2114
2248
  */
2115
2249
  readonly exportTabularExportRequest: ExportTabularExportRequest;
2116
2250
  }
2251
+ /**
2252
+ * Request parameters for getDocumentExport operation in ActionsExport.
2253
+ * @export
2254
+ * @interface ActionsExportGetDocumentExportRequest
2255
+ */
2256
+ export interface ActionsExportGetDocumentExportRequest {
2257
+ /**
2258
+ *
2259
+ * @type {string}
2260
+ * @memberof ActionsExportGetDocumentExport
2261
+ */
2262
+ readonly workspaceId: string;
2263
+ /**
2264
+ *
2265
+ * @type {string}
2266
+ * @memberof ActionsExportGetDocumentExport
2267
+ */
2268
+ readonly exportId: string;
2269
+ }
2270
+ /**
2271
+ * Request parameters for getDocumentExportMetadata operation in ActionsExport.
2272
+ * @export
2273
+ * @interface ActionsExportGetDocumentExportMetadataRequest
2274
+ */
2275
+ export interface ActionsExportGetDocumentExportMetadataRequest {
2276
+ /**
2277
+ *
2278
+ * @type {string}
2279
+ * @memberof ActionsExportGetDocumentExportMetadata
2280
+ */
2281
+ readonly workspaceId: string;
2282
+ /**
2283
+ *
2284
+ * @type {string}
2285
+ * @memberof ActionsExportGetDocumentExportMetadata
2286
+ */
2287
+ readonly exportId: string;
2288
+ }
2117
2289
  /**
2118
2290
  * Request parameters for getExportedFile operation in ActionsExport.
2119
2291
  * @export
@@ -2320,6 +2492,15 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
2320
2492
  * @memberof ActionsExport
2321
2493
  */
2322
2494
  createDashboardExportRequest(requestParameters: ActionsExportCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2495
+ /**
2496
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2497
+ * @summary (EXPERIMENTAL) Create document export request
2498
+ * @param {ActionsExportCreateDocumentExportRequest} requestParameters Request parameters.
2499
+ * @param {*} [options] Override http request option.
2500
+ * @throws {RequiredError}
2501
+ * @memberof ActionsExport
2502
+ */
2503
+ createDocumentExport(requestParameters: ActionsExportCreateDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2323
2504
  /**
2324
2505
  * Note: This API is an experimental and is going to change. Please, use it accordingly. An image export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2325
2506
  * @summary (EXPERIMENTAL) Create image export request
@@ -2348,10 +2529,11 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
2348
2529
  */
2349
2530
  createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2350
2531
  /**
2351
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2532
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2352
2533
  * @summary (EXPERIMENTAL) Create report export request
2353
2534
  * @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
2354
2535
  * @param {*} [options] Override http request option.
2536
+ * @deprecated
2355
2537
  * @throws {RequiredError}
2356
2538
  * @memberof ActionsExport
2357
2539
  */
@@ -2374,6 +2556,24 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
2374
2556
  * @memberof ActionsExport
2375
2557
  */
2376
2558
  createTabularExport(requestParameters: ActionsExportCreateTabularExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2559
+ /**
2560
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2561
+ * @summary (EXPERIMENTAL) Retrieve exported document
2562
+ * @param {ActionsExportGetDocumentExportRequest} requestParameters Request parameters.
2563
+ * @param {*} [options] Override http request option.
2564
+ * @throws {RequiredError}
2565
+ * @memberof ActionsExport
2566
+ */
2567
+ getDocumentExport(requestParameters: ActionsExportGetDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2568
+ /**
2569
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
2570
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
2571
+ * @param {ActionsExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
2572
+ * @param {*} [options] Override http request option.
2573
+ * @throws {RequiredError}
2574
+ * @memberof ActionsExport
2575
+ */
2576
+ getDocumentExportMetadata(requestParameters: ActionsExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2377
2577
  /**
2378
2578
  * Returns 202 until original POST export request is not processed.Returns 200 with exported data once the export is done.
2379
2579
  * @summary Retrieve exported files
@@ -2420,19 +2620,21 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
2420
2620
  */
2421
2621
  getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2422
2622
  /**
2423
- * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2623
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2424
2624
  * @summary (EXPERIMENTAL) Retrieve exported files
2425
2625
  * @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
2426
2626
  * @param {*} [options] Override http request option.
2627
+ * @deprecated
2427
2628
  * @throws {RequiredError}
2428
2629
  * @memberof ActionsExport
2429
2630
  */
2430
2631
  getReportExport(requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2431
2632
  /**
2432
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2633
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2433
2634
  * @summary (EXPERIMENTAL) Retrieve metadata context
2434
2635
  * @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
2435
2636
  * @param {*} [options] Override http request option.
2637
+ * @deprecated
2436
2638
  * @throws {RequiredError}
2437
2639
  * @memberof ActionsExport
2438
2640
  */
@@ -2793,7 +2995,18 @@ export declare class RawExportExport extends BaseAPI implements RawExportExportI
2793
2995
  getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2794
2996
  }
2795
2997
  /**
2796
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2998
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2999
+ * @summary (EXPERIMENTAL) Create document export request
3000
+ * @param {string} workspaceId
3001
+ * @param {ExportReportExportRequest} exportReportExportRequest
3002
+ * @param {boolean} [xGdcDebug]
3003
+ * @param {*} [options] Override http request option.
3004
+ * @param {Configuration} [configuration] Optional configuration.
3005
+ * @throws {RequiredError}
3006
+ */
3007
+ export declare function ReportExportExportAxiosParamCreator_CreateDocumentExport(workspaceId: string, exportReportExportRequest: ExportReportExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
3008
+ /**
3009
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2797
3010
  * @summary (EXPERIMENTAL) Create report export request
2798
3011
  * @param {string} workspaceId
2799
3012
  * @param {ExportReportExportRequest} exportReportExportRequest
@@ -2805,6 +3018,26 @@ export declare class RawExportExport extends BaseAPI implements RawExportExportI
2805
3018
  export declare function ReportExportExportAxiosParamCreator_CreateReportExport(workspaceId: string, exportReportExportRequest: ExportReportExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
2806
3019
  /**
2807
3020
  * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
3021
+ * @summary (EXPERIMENTAL) Retrieve exported document
3022
+ * @param {string} workspaceId
3023
+ * @param {string} exportId
3024
+ * @param {*} [options] Override http request option.
3025
+ * @param {Configuration} [configuration] Optional configuration.
3026
+ * @throws {RequiredError}
3027
+ */
3028
+ export declare function ReportExportExportAxiosParamCreator_GetDocumentExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
3029
+ /**
3030
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
3031
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
3032
+ * @param {string} workspaceId
3033
+ * @param {string} exportId
3034
+ * @param {*} [options] Override http request option.
3035
+ * @param {Configuration} [configuration] Optional configuration.
3036
+ * @throws {RequiredError}
3037
+ */
3038
+ export declare function ReportExportExportAxiosParamCreator_GetDocumentExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
3039
+ /**
3040
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2808
3041
  * @summary (EXPERIMENTAL) Retrieve exported files
2809
3042
  * @param {string} workspaceId
2810
3043
  * @param {string} exportId
@@ -2814,7 +3047,7 @@ export declare function ReportExportExportAxiosParamCreator_CreateReportExport(w
2814
3047
  */
2815
3048
  export declare function ReportExportExportAxiosParamCreator_GetReportExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
2816
3049
  /**
2817
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
3050
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2818
3051
  * @summary (EXPERIMENTAL) Retrieve metadata context
2819
3052
  * @param {string} workspaceId
2820
3053
  * @param {string} exportId
@@ -2824,7 +3057,18 @@ export declare function ReportExportExportAxiosParamCreator_GetReportExport(work
2824
3057
  */
2825
3058
  export declare function ReportExportExportAxiosParamCreator_GetReportExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
2826
3059
  /**
2827
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3060
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3061
+ * @summary (EXPERIMENTAL) Create document export request
3062
+ * @param {AxiosInstance} axios Axios instance.
3063
+ * @param {string} basePath Base path.
3064
+ * @param {ReportExportExportCreateDocumentExportRequest} requestParameters Request parameters.
3065
+ * @param {*} [options] Override http request option.
3066
+ * @param {Configuration} [configuration] Optional configuration.
3067
+ * @throws {RequiredError}
3068
+ */
3069
+ export declare function ReportExportExport_CreateDocumentExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportCreateDocumentExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
3070
+ /**
3071
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2828
3072
  * @summary (EXPERIMENTAL) Create report export request
2829
3073
  * @param {AxiosInstance} axios Axios instance.
2830
3074
  * @param {string} basePath Base path.
@@ -2836,6 +3080,28 @@ export declare function ReportExportExportAxiosParamCreator_GetReportExportMetad
2836
3080
  export declare function ReportExportExport_CreateReportExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
2837
3081
  /**
2838
3082
  * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
3083
+ * @summary (EXPERIMENTAL) Retrieve exported document
3084
+ * @param {AxiosInstance} axios Axios instance.
3085
+ * @param {string} basePath Base path.
3086
+ * @param {ReportExportExportGetDocumentExportRequest} requestParameters Request parameters.
3087
+ * @param {*} [options] Override http request option.
3088
+ * @param {Configuration} [configuration] Optional configuration.
3089
+ * @throws {RequiredError}
3090
+ */
3091
+ export declare function ReportExportExport_GetDocumentExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportGetDocumentExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
3092
+ /**
3093
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
3094
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
3095
+ * @param {AxiosInstance} axios Axios instance.
3096
+ * @param {string} basePath Base path.
3097
+ * @param {ReportExportExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
3098
+ * @param {*} [options] Override http request option.
3099
+ * @param {Configuration} [configuration] Optional configuration.
3100
+ * @throws {RequiredError}
3101
+ */
3102
+ export declare function ReportExportExport_GetDocumentExportMetadata(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
3103
+ /**
3104
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2839
3105
  * @summary (EXPERIMENTAL) Retrieve exported files
2840
3106
  * @param {AxiosInstance} axios Axios instance.
2841
3107
  * @param {string} basePath Base path.
@@ -2846,7 +3112,7 @@ export declare function ReportExportExport_CreateReportExport(axios: AxiosInstan
2846
3112
  */
2847
3113
  export declare function ReportExportExport_GetReportExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
2848
3114
  /**
2849
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
3115
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2850
3116
  * @summary (EXPERIMENTAL) Retrieve metadata context
2851
3117
  * @param {AxiosInstance} axios Axios instance.
2852
3118
  * @param {string} basePath Base path.
@@ -2863,33 +3129,88 @@ export declare function ReportExportExport_GetReportExportMetadata(axios: AxiosI
2863
3129
  */
2864
3130
  export interface ReportExportExportInterface {
2865
3131
  /**
2866
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3132
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3133
+ * @summary (EXPERIMENTAL) Create document export request
3134
+ * @param {ReportExportExportCreateDocumentExportRequest} requestParameters Request parameters.
3135
+ * @param {*} [options] Override http request option.
3136
+ * @throws {RequiredError}
3137
+ * @memberof ReportExportExportInterface
3138
+ */
3139
+ createDocumentExport(requestParameters: ReportExportExportCreateDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
3140
+ /**
3141
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2867
3142
  * @summary (EXPERIMENTAL) Create report export request
2868
3143
  * @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
2869
3144
  * @param {*} [options] Override http request option.
3145
+ * @deprecated
2870
3146
  * @throws {RequiredError}
2871
3147
  * @memberof ReportExportExportInterface
2872
3148
  */
2873
3149
  createReportExport(requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2874
3150
  /**
2875
3151
  * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
3152
+ * @summary (EXPERIMENTAL) Retrieve exported document
3153
+ * @param {ReportExportExportGetDocumentExportRequest} requestParameters Request parameters.
3154
+ * @param {*} [options] Override http request option.
3155
+ * @throws {RequiredError}
3156
+ * @memberof ReportExportExportInterface
3157
+ */
3158
+ getDocumentExport(requestParameters: ReportExportExportGetDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
3159
+ /**
3160
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
3161
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
3162
+ * @param {ReportExportExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
3163
+ * @param {*} [options] Override http request option.
3164
+ * @throws {RequiredError}
3165
+ * @memberof ReportExportExportInterface
3166
+ */
3167
+ getDocumentExportMetadata(requestParameters: ReportExportExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
3168
+ /**
3169
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2876
3170
  * @summary (EXPERIMENTAL) Retrieve exported files
2877
3171
  * @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
2878
3172
  * @param {*} [options] Override http request option.
3173
+ * @deprecated
2879
3174
  * @throws {RequiredError}
2880
3175
  * @memberof ReportExportExportInterface
2881
3176
  */
2882
3177
  getReportExport(requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2883
3178
  /**
2884
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
3179
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2885
3180
  * @summary (EXPERIMENTAL) Retrieve metadata context
2886
3181
  * @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
2887
3182
  * @param {*} [options] Override http request option.
3183
+ * @deprecated
2888
3184
  * @throws {RequiredError}
2889
3185
  * @memberof ReportExportExportInterface
2890
3186
  */
2891
3187
  getReportExportMetadata(requestParameters: ReportExportExportGetReportExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
2892
3188
  }
3189
+ /**
3190
+ * Request parameters for createDocumentExport operation in ReportExportExport.
3191
+ * @export
3192
+ * @interface ReportExportExportCreateDocumentExportRequest
3193
+ */
3194
+ export interface ReportExportExportCreateDocumentExportRequest {
3195
+ /**
3196
+ *
3197
+ * @type {string}
3198
+ * @memberof ReportExportExportCreateDocumentExport
3199
+ */
3200
+ readonly workspaceId: string;
3201
+ /**
3202
+ *
3203
+ * @type {ExportReportExportRequest}
3204
+ * @memberof ReportExportExportCreateDocumentExport
3205
+ */
3206
+ readonly exportReportExportRequest: ExportReportExportRequest;
3207
+ /**
3208
+ *
3209
+ * @type {boolean}
3210
+ * @memberof ReportExportExportCreateDocumentExport
3211
+ */
3212
+ readonly xGdcDebug?: boolean;
3213
+ }
2893
3214
  /**
2894
3215
  * Request parameters for createReportExport operation in ReportExportExport.
2895
3216
  * @export
@@ -2915,6 +3236,44 @@ export interface ReportExportExportCreateReportExportRequest {
2915
3236
  */
2916
3237
  readonly xGdcDebug?: boolean;
2917
3238
  }
3239
+ /**
3240
+ * Request parameters for getDocumentExport operation in ReportExportExport.
3241
+ * @export
3242
+ * @interface ReportExportExportGetDocumentExportRequest
3243
+ */
3244
+ export interface ReportExportExportGetDocumentExportRequest {
3245
+ /**
3246
+ *
3247
+ * @type {string}
3248
+ * @memberof ReportExportExportGetDocumentExport
3249
+ */
3250
+ readonly workspaceId: string;
3251
+ /**
3252
+ *
3253
+ * @type {string}
3254
+ * @memberof ReportExportExportGetDocumentExport
3255
+ */
3256
+ readonly exportId: string;
3257
+ }
3258
+ /**
3259
+ * Request parameters for getDocumentExportMetadata operation in ReportExportExport.
3260
+ * @export
3261
+ * @interface ReportExportExportGetDocumentExportMetadataRequest
3262
+ */
3263
+ export interface ReportExportExportGetDocumentExportMetadataRequest {
3264
+ /**
3265
+ *
3266
+ * @type {string}
3267
+ * @memberof ReportExportExportGetDocumentExportMetadata
3268
+ */
3269
+ readonly workspaceId: string;
3270
+ /**
3271
+ *
3272
+ * @type {string}
3273
+ * @memberof ReportExportExportGetDocumentExportMetadata
3274
+ */
3275
+ readonly exportId: string;
3276
+ }
2918
3277
  /**
2919
3278
  * Request parameters for getReportExport operation in ReportExportExport.
2920
3279
  * @export
@@ -2961,28 +3320,58 @@ export interface ReportExportExportGetReportExportMetadataRequest {
2961
3320
  */
2962
3321
  export declare class ReportExportExport extends BaseAPI implements ReportExportExportInterface {
2963
3322
  /**
2964
- * Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3323
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. A document export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
3324
+ * @summary (EXPERIMENTAL) Create document export request
3325
+ * @param {ReportExportExportCreateDocumentExportRequest} requestParameters Request parameters.
3326
+ * @param {*} [options] Override http request option.
3327
+ * @throws {RequiredError}
3328
+ * @memberof ReportExportExport
3329
+ */
3330
+ createDocumentExport(requestParameters: ReportExportExportCreateDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
3331
+ /**
3332
+ * Deprecated, use createDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. A report export job will be created based on the export request and put to queue to be executed. The result of the operation will be an exportResult identifier that will be assembled by the client into a url that can be polled.
2965
3333
  * @summary (EXPERIMENTAL) Create report export request
2966
3334
  * @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
2967
3335
  * @param {*} [options] Override http request option.
3336
+ * @deprecated
2968
3337
  * @throws {RequiredError}
2969
3338
  * @memberof ReportExportExport
2970
3339
  */
2971
3340
  createReportExport(requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
2972
3341
  /**
2973
3342
  * Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
3343
+ * @summary (EXPERIMENTAL) Retrieve exported document
3344
+ * @param {ReportExportExportGetDocumentExportRequest} requestParameters Request parameters.
3345
+ * @param {*} [options] Override http request option.
3346
+ * @throws {RequiredError}
3347
+ * @memberof ReportExportExport
3348
+ */
3349
+ getDocumentExport(requestParameters: ReportExportExportGetDocumentExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
3350
+ /**
3351
+ * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/document endpoint. The metadata structure is not verified.
3352
+ * @summary (EXPERIMENTAL) Retrieve document export metadata
3353
+ * @param {ReportExportExportGetDocumentExportMetadataRequest} requestParameters Request parameters.
3354
+ * @param {*} [options] Override http request option.
3355
+ * @throws {RequiredError}
3356
+ * @memberof ReportExportExport
3357
+ */
3358
+ getDocumentExportMetadata(requestParameters: ReportExportExportGetDocumentExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
3359
+ /**
3360
+ * Deprecated, use getDocumentExport. Note: This API is an experimental and is going to change. Please, use it accordingly. After clients creates a POST export request, the processing of it will start shortly asynchronously. To retrieve the result, client has to check periodically for the result on this endpoint. In case the result isn\'t ready yet, the service returns 202. If the result is ready, it returns 200 and octet stream of the result file with provided filename.
2974
3361
  * @summary (EXPERIMENTAL) Retrieve exported files
2975
3362
  * @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
2976
3363
  * @param {*} [options] Override http request option.
3364
+ * @deprecated
2977
3365
  * @throws {RequiredError}
2978
3366
  * @memberof ReportExportExport
2979
3367
  */
2980
3368
  getReportExport(requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
2981
3369
  /**
2982
- * Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
3370
+ * Deprecated, use getDocumentExportMetadata. Note: This API is an experimental and is going to change. Please, use it accordingly. This endpoint serves as a cache for user-defined metadata of the export for the front end UI to retrieve it, if one was created using the POST ../export/report endpoint. The metadata structure is not verified.
2983
3371
  * @summary (EXPERIMENTAL) Retrieve metadata context
2984
3372
  * @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
2985
3373
  * @param {*} [options] Override http request option.
3374
+ * @deprecated
2986
3375
  * @throws {RequiredError}
2987
3376
  * @memberof ReportExportExport
2988
3377
  */