@gooddata/api-client-tiger 11.58.0-alpha.5 → 11.58.0
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.
- package/esm/__version.d.ts +1 -1
- package/esm/__version.d.ts.map +1 -1
- package/esm/__version.js +1 -1
- package/esm/api-client-tiger.d.ts +436 -0
- package/esm/endpoints/export/index.d.ts +1 -1
- package/esm/endpoints/export/index.d.ts.map +1 -1
- package/esm/endpoints/export/index.js +1 -1
- package/esm/generated/export-json-api/api.d.ts +413 -0
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +428 -0
- package/package.json +4 -4
|
@@ -749,6 +749,16 @@ export interface ExportGetImageExport202ResponseInner {
|
|
|
749
749
|
'readOnly'?: boolean;
|
|
750
750
|
'short'?: number;
|
|
751
751
|
}
|
|
752
|
+
export interface ExportGetReportExport202ResponseInner {
|
|
753
|
+
'char'?: string;
|
|
754
|
+
'direct'?: boolean;
|
|
755
|
+
'double'?: number;
|
|
756
|
+
'float'?: number;
|
|
757
|
+
'int'?: number;
|
|
758
|
+
'long'?: number;
|
|
759
|
+
'readOnly'?: boolean;
|
|
760
|
+
'short'?: number;
|
|
761
|
+
}
|
|
752
762
|
export interface ExportGetSlidesExport202ResponseInner {
|
|
753
763
|
'char'?: string;
|
|
754
764
|
'direct'?: boolean;
|
|
@@ -1195,6 +1205,32 @@ export interface ExportRelativeDateFilterRelativeDateFilter {
|
|
|
1195
1205
|
}
|
|
1196
1206
|
export type ExportRelativeDateFilterRelativeDateFilterEmptyValueHandlingEnum = 'INCLUDE' | 'EXCLUDE' | 'ONLY';
|
|
1197
1207
|
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
|
+
/**
|
|
1209
|
+
* Export request object describing the export properties and metadata for report exports.
|
|
1210
|
+
*/
|
|
1211
|
+
export interface ExportReportExportRequest {
|
|
1212
|
+
/**
|
|
1213
|
+
* File name to be used for retrieving the pdf document.
|
|
1214
|
+
*/
|
|
1215
|
+
'fileName': string;
|
|
1216
|
+
/**
|
|
1217
|
+
* Requested resulting file type.
|
|
1218
|
+
*/
|
|
1219
|
+
'format': ExportReportExportRequestFormatEnum;
|
|
1220
|
+
/**
|
|
1221
|
+
* Metadata definition in free-form JSON format.
|
|
1222
|
+
*/
|
|
1223
|
+
'metadata'?: object | null;
|
|
1224
|
+
/**
|
|
1225
|
+
* Report identifier
|
|
1226
|
+
*/
|
|
1227
|
+
'reportId': string;
|
|
1228
|
+
/**
|
|
1229
|
+
* 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
|
+
*/
|
|
1231
|
+
'timezoneId'?: string | null;
|
|
1232
|
+
}
|
|
1233
|
+
export type ExportReportExportRequestFormatEnum = 'PDF';
|
|
1198
1234
|
/**
|
|
1199
1235
|
* Additional settings.
|
|
1200
1236
|
*/
|
|
@@ -1436,6 +1472,17 @@ export declare function ActionsExportAxiosParamCreator_CreatePdfExport(workspace
|
|
|
1436
1472
|
* @throws {RequiredError}
|
|
1437
1473
|
*/
|
|
1438
1474
|
export declare function ActionsExportAxiosParamCreator_CreateRawExport(workspaceId: string, exportRawExportRequest: ExportRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1475
|
+
/**
|
|
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.
|
|
1477
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1478
|
+
* @param {string} workspaceId
|
|
1479
|
+
* @param {ExportReportExportRequest} exportReportExportRequest
|
|
1480
|
+
* @param {boolean} [xGdcDebug]
|
|
1481
|
+
* @param {*} [options] Override http request option.
|
|
1482
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1483
|
+
* @throws {RequiredError}
|
|
1484
|
+
*/
|
|
1485
|
+
export declare function ActionsExportAxiosParamCreator_CreateReportExport(workspaceId: string, exportReportExportRequest: ExportReportExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1439
1486
|
/**
|
|
1440
1487
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.
|
|
1441
1488
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -1507,6 +1554,26 @@ export declare function ActionsExportAxiosParamCreator_GetMetadata(workspaceId:
|
|
|
1507
1554
|
* @throws {RequiredError}
|
|
1508
1555
|
*/
|
|
1509
1556
|
export declare function ActionsExportAxiosParamCreator_GetRawExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1557
|
+
/**
|
|
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.
|
|
1559
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1560
|
+
* @param {string} workspaceId
|
|
1561
|
+
* @param {string} exportId
|
|
1562
|
+
* @param {*} [options] Override http request option.
|
|
1563
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1564
|
+
* @throws {RequiredError}
|
|
1565
|
+
*/
|
|
1566
|
+
export declare function ActionsExportAxiosParamCreator_GetReportExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1567
|
+
/**
|
|
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.
|
|
1569
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1570
|
+
* @param {string} workspaceId
|
|
1571
|
+
* @param {string} exportId
|
|
1572
|
+
* @param {*} [options] Override http request option.
|
|
1573
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1574
|
+
* @throws {RequiredError}
|
|
1575
|
+
*/
|
|
1576
|
+
export declare function ActionsExportAxiosParamCreator_GetReportExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
1510
1577
|
/**
|
|
1511
1578
|
* 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.
|
|
1512
1579
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -1581,6 +1648,17 @@ export declare function ActionsExport_CreatePdfExport(axios: AxiosInstance, base
|
|
|
1581
1648
|
* @throws {RequiredError}
|
|
1582
1649
|
*/
|
|
1583
1650
|
export declare function ActionsExport_CreateRawExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
|
|
1651
|
+
/**
|
|
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.
|
|
1653
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1654
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1655
|
+
* @param {string} basePath Base path.
|
|
1656
|
+
* @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
|
|
1657
|
+
* @param {*} [options] Override http request option.
|
|
1658
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1659
|
+
* @throws {RequiredError}
|
|
1660
|
+
*/
|
|
1661
|
+
export declare function ActionsExport_CreateReportExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportCreateReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
|
|
1584
1662
|
/**
|
|
1585
1663
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.
|
|
1586
1664
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -1658,6 +1736,28 @@ export declare function ActionsExport_GetMetadata(axios: AxiosInstance, basePath
|
|
|
1658
1736
|
* @throws {RequiredError}
|
|
1659
1737
|
*/
|
|
1660
1738
|
export declare function ActionsExport_GetRawExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
|
|
1739
|
+
/**
|
|
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.
|
|
1741
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1742
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1743
|
+
* @param {string} basePath Base path.
|
|
1744
|
+
* @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
|
|
1745
|
+
* @param {*} [options] Override http request option.
|
|
1746
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1747
|
+
* @throws {RequiredError}
|
|
1748
|
+
*/
|
|
1749
|
+
export declare function ActionsExport_GetReportExport(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
|
|
1750
|
+
/**
|
|
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.
|
|
1752
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1753
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
1754
|
+
* @param {string} basePath Base path.
|
|
1755
|
+
* @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
1756
|
+
* @param {*} [options] Override http request option.
|
|
1757
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
1758
|
+
* @throws {RequiredError}
|
|
1759
|
+
*/
|
|
1760
|
+
export declare function ActionsExport_GetReportExportMetadata(axios: AxiosInstance, basePath: string, requestParameters: ActionsExportGetReportExportMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
1661
1761
|
/**
|
|
1662
1762
|
* 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.
|
|
1663
1763
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -1733,6 +1833,15 @@ export interface ActionsExportInterface {
|
|
|
1733
1833
|
* @memberof ActionsExportInterface
|
|
1734
1834
|
*/
|
|
1735
1835
|
createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
1836
|
+
/**
|
|
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.
|
|
1838
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
1839
|
+
* @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
|
|
1840
|
+
* @param {*} [options] Override http request option.
|
|
1841
|
+
* @throws {RequiredError}
|
|
1842
|
+
* @memberof ActionsExportInterface
|
|
1843
|
+
*/
|
|
1844
|
+
createReportExport(requestParameters: ActionsExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
1736
1845
|
/**
|
|
1737
1846
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.
|
|
1738
1847
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -1796,6 +1905,24 @@ export interface ActionsExportInterface {
|
|
|
1796
1905
|
* @memberof ActionsExportInterface
|
|
1797
1906
|
*/
|
|
1798
1907
|
getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
1908
|
+
/**
|
|
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.
|
|
1910
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1911
|
+
* @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
|
|
1912
|
+
* @param {*} [options] Override http request option.
|
|
1913
|
+
* @throws {RequiredError}
|
|
1914
|
+
* @memberof ActionsExportInterface
|
|
1915
|
+
*/
|
|
1916
|
+
getReportExport(requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
1917
|
+
/**
|
|
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.
|
|
1919
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1920
|
+
* @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
1921
|
+
* @param {*} [options] Override http request option.
|
|
1922
|
+
* @throws {RequiredError}
|
|
1923
|
+
* @memberof ActionsExportInterface
|
|
1924
|
+
*/
|
|
1925
|
+
getReportExportMetadata(requestParameters: ActionsExportGetReportExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1799
1926
|
/**
|
|
1800
1927
|
* 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.
|
|
1801
1928
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -1918,6 +2045,31 @@ export interface ActionsExportCreateRawExportRequest {
|
|
|
1918
2045
|
*/
|
|
1919
2046
|
readonly exportRawExportRequest: ExportRawExportRequest;
|
|
1920
2047
|
}
|
|
2048
|
+
/**
|
|
2049
|
+
* Request parameters for createReportExport operation in ActionsExport.
|
|
2050
|
+
* @export
|
|
2051
|
+
* @interface ActionsExportCreateReportExportRequest
|
|
2052
|
+
*/
|
|
2053
|
+
export interface ActionsExportCreateReportExportRequest {
|
|
2054
|
+
/**
|
|
2055
|
+
*
|
|
2056
|
+
* @type {string}
|
|
2057
|
+
* @memberof ActionsExportCreateReportExport
|
|
2058
|
+
*/
|
|
2059
|
+
readonly workspaceId: string;
|
|
2060
|
+
/**
|
|
2061
|
+
*
|
|
2062
|
+
* @type {ExportReportExportRequest}
|
|
2063
|
+
* @memberof ActionsExportCreateReportExport
|
|
2064
|
+
*/
|
|
2065
|
+
readonly exportReportExportRequest: ExportReportExportRequest;
|
|
2066
|
+
/**
|
|
2067
|
+
*
|
|
2068
|
+
* @type {boolean}
|
|
2069
|
+
* @memberof ActionsExportCreateReportExport
|
|
2070
|
+
*/
|
|
2071
|
+
readonly xGdcDebug?: boolean;
|
|
2072
|
+
}
|
|
1921
2073
|
/**
|
|
1922
2074
|
* Request parameters for createSlidesExport operation in ActionsExport.
|
|
1923
2075
|
* @export
|
|
@@ -2057,6 +2209,44 @@ export interface ActionsExportGetRawExportRequest {
|
|
|
2057
2209
|
*/
|
|
2058
2210
|
readonly exportId: string;
|
|
2059
2211
|
}
|
|
2212
|
+
/**
|
|
2213
|
+
* Request parameters for getReportExport operation in ActionsExport.
|
|
2214
|
+
* @export
|
|
2215
|
+
* @interface ActionsExportGetReportExportRequest
|
|
2216
|
+
*/
|
|
2217
|
+
export interface ActionsExportGetReportExportRequest {
|
|
2218
|
+
/**
|
|
2219
|
+
*
|
|
2220
|
+
* @type {string}
|
|
2221
|
+
* @memberof ActionsExportGetReportExport
|
|
2222
|
+
*/
|
|
2223
|
+
readonly workspaceId: string;
|
|
2224
|
+
/**
|
|
2225
|
+
*
|
|
2226
|
+
* @type {string}
|
|
2227
|
+
* @memberof ActionsExportGetReportExport
|
|
2228
|
+
*/
|
|
2229
|
+
readonly exportId: string;
|
|
2230
|
+
}
|
|
2231
|
+
/**
|
|
2232
|
+
* Request parameters for getReportExportMetadata operation in ActionsExport.
|
|
2233
|
+
* @export
|
|
2234
|
+
* @interface ActionsExportGetReportExportMetadataRequest
|
|
2235
|
+
*/
|
|
2236
|
+
export interface ActionsExportGetReportExportMetadataRequest {
|
|
2237
|
+
/**
|
|
2238
|
+
*
|
|
2239
|
+
* @type {string}
|
|
2240
|
+
* @memberof ActionsExportGetReportExportMetadata
|
|
2241
|
+
*/
|
|
2242
|
+
readonly workspaceId: string;
|
|
2243
|
+
/**
|
|
2244
|
+
*
|
|
2245
|
+
* @type {string}
|
|
2246
|
+
* @memberof ActionsExportGetReportExportMetadata
|
|
2247
|
+
*/
|
|
2248
|
+
readonly exportId: string;
|
|
2249
|
+
}
|
|
2060
2250
|
/**
|
|
2061
2251
|
* Request parameters for getSlidesExport operation in ActionsExport.
|
|
2062
2252
|
* @export
|
|
@@ -2157,6 +2347,15 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
|
|
|
2157
2347
|
* @memberof ActionsExport
|
|
2158
2348
|
*/
|
|
2159
2349
|
createRawExport(requestParameters: ActionsExportCreateRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2350
|
+
/**
|
|
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.
|
|
2352
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
2353
|
+
* @param {ActionsExportCreateReportExportRequest} requestParameters Request parameters.
|
|
2354
|
+
* @param {*} [options] Override http request option.
|
|
2355
|
+
* @throws {RequiredError}
|
|
2356
|
+
* @memberof ActionsExport
|
|
2357
|
+
*/
|
|
2358
|
+
createReportExport(requestParameters: ActionsExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2160
2359
|
/**
|
|
2161
2360
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.
|
|
2162
2361
|
* @summary (EXPERIMENTAL) Create slides export request
|
|
@@ -2220,6 +2419,24 @@ export declare class ActionsExport extends BaseAPI implements ActionsExportInter
|
|
|
2220
2419
|
* @memberof ActionsExport
|
|
2221
2420
|
*/
|
|
2222
2421
|
getRawExport(requestParameters: ActionsExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
2422
|
+
/**
|
|
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.
|
|
2424
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2425
|
+
* @param {ActionsExportGetReportExportRequest} requestParameters Request parameters.
|
|
2426
|
+
* @param {*} [options] Override http request option.
|
|
2427
|
+
* @throws {RequiredError}
|
|
2428
|
+
* @memberof ActionsExport
|
|
2429
|
+
*/
|
|
2430
|
+
getReportExport(requestParameters: ActionsExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
2431
|
+
/**
|
|
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.
|
|
2433
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2434
|
+
* @param {ActionsExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
2435
|
+
* @param {*} [options] Override http request option.
|
|
2436
|
+
* @throws {RequiredError}
|
|
2437
|
+
* @memberof ActionsExport
|
|
2438
|
+
*/
|
|
2439
|
+
getReportExportMetadata(requestParameters: ActionsExportGetReportExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2223
2440
|
/**
|
|
2224
2441
|
* 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.
|
|
2225
2442
|
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
@@ -2575,6 +2792,202 @@ export declare class RawExportExport extends BaseAPI implements RawExportExportI
|
|
|
2575
2792
|
*/
|
|
2576
2793
|
getRawExport(requestParameters: RawExportExportGetRawExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
2577
2794
|
}
|
|
2795
|
+
/**
|
|
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.
|
|
2797
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
2798
|
+
* @param {string} workspaceId
|
|
2799
|
+
* @param {ExportReportExportRequest} exportReportExportRequest
|
|
2800
|
+
* @param {boolean} [xGdcDebug]
|
|
2801
|
+
* @param {*} [options] Override http request option.
|
|
2802
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2803
|
+
* @throws {RequiredError}
|
|
2804
|
+
*/
|
|
2805
|
+
export declare function ReportExportExportAxiosParamCreator_CreateReportExport(workspaceId: string, exportReportExportRequest: ExportReportExportRequest, xGdcDebug?: boolean, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2806
|
+
/**
|
|
2807
|
+
* 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
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2809
|
+
* @param {string} workspaceId
|
|
2810
|
+
* @param {string} exportId
|
|
2811
|
+
* @param {*} [options] Override http request option.
|
|
2812
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2813
|
+
* @throws {RequiredError}
|
|
2814
|
+
*/
|
|
2815
|
+
export declare function ReportExportExportAxiosParamCreator_GetReportExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2816
|
+
/**
|
|
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.
|
|
2818
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2819
|
+
* @param {string} workspaceId
|
|
2820
|
+
* @param {string} exportId
|
|
2821
|
+
* @param {*} [options] Override http request option.
|
|
2822
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2823
|
+
* @throws {RequiredError}
|
|
2824
|
+
*/
|
|
2825
|
+
export declare function ReportExportExportAxiosParamCreator_GetReportExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
|
|
2826
|
+
/**
|
|
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.
|
|
2828
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
2829
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
2830
|
+
* @param {string} basePath Base path.
|
|
2831
|
+
* @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
|
|
2832
|
+
* @param {*} [options] Override http request option.
|
|
2833
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2834
|
+
* @throws {RequiredError}
|
|
2835
|
+
*/
|
|
2836
|
+
export declare function ReportExportExport_CreateReportExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ExportExportResponse>;
|
|
2837
|
+
/**
|
|
2838
|
+
* 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
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2840
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
2841
|
+
* @param {string} basePath Base path.
|
|
2842
|
+
* @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
|
|
2843
|
+
* @param {*} [options] Override http request option.
|
|
2844
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2845
|
+
* @throws {RequiredError}
|
|
2846
|
+
*/
|
|
2847
|
+
export declare function ReportExportExport_GetReportExport(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<File>;
|
|
2848
|
+
/**
|
|
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.
|
|
2850
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2851
|
+
* @param {AxiosInstance} axios Axios instance.
|
|
2852
|
+
* @param {string} basePath Base path.
|
|
2853
|
+
* @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
2854
|
+
* @param {*} [options] Override http request option.
|
|
2855
|
+
* @param {Configuration} [configuration] Optional configuration.
|
|
2856
|
+
* @throws {RequiredError}
|
|
2857
|
+
*/
|
|
2858
|
+
export declare function ReportExportExport_GetReportExportMetadata(axios: AxiosInstance, basePath: string, requestParameters: ReportExportExportGetReportExportMetadataRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
|
|
2859
|
+
/**
|
|
2860
|
+
* ReportExportExport - interface
|
|
2861
|
+
* @export
|
|
2862
|
+
* @interface ReportExportExport
|
|
2863
|
+
*/
|
|
2864
|
+
export interface ReportExportExportInterface {
|
|
2865
|
+
/**
|
|
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.
|
|
2867
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
2868
|
+
* @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
|
|
2869
|
+
* @param {*} [options] Override http request option.
|
|
2870
|
+
* @throws {RequiredError}
|
|
2871
|
+
* @memberof ReportExportExportInterface
|
|
2872
|
+
*/
|
|
2873
|
+
createReportExport(requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2874
|
+
/**
|
|
2875
|
+
* 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
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2877
|
+
* @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
|
|
2878
|
+
* @param {*} [options] Override http request option.
|
|
2879
|
+
* @throws {RequiredError}
|
|
2880
|
+
* @memberof ReportExportExportInterface
|
|
2881
|
+
*/
|
|
2882
|
+
getReportExport(requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
2883
|
+
/**
|
|
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.
|
|
2885
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2886
|
+
* @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
2887
|
+
* @param {*} [options] Override http request option.
|
|
2888
|
+
* @throws {RequiredError}
|
|
2889
|
+
* @memberof ReportExportExportInterface
|
|
2890
|
+
*/
|
|
2891
|
+
getReportExportMetadata(requestParameters: ReportExportExportGetReportExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2892
|
+
}
|
|
2893
|
+
/**
|
|
2894
|
+
* Request parameters for createReportExport operation in ReportExportExport.
|
|
2895
|
+
* @export
|
|
2896
|
+
* @interface ReportExportExportCreateReportExportRequest
|
|
2897
|
+
*/
|
|
2898
|
+
export interface ReportExportExportCreateReportExportRequest {
|
|
2899
|
+
/**
|
|
2900
|
+
*
|
|
2901
|
+
* @type {string}
|
|
2902
|
+
* @memberof ReportExportExportCreateReportExport
|
|
2903
|
+
*/
|
|
2904
|
+
readonly workspaceId: string;
|
|
2905
|
+
/**
|
|
2906
|
+
*
|
|
2907
|
+
* @type {ExportReportExportRequest}
|
|
2908
|
+
* @memberof ReportExportExportCreateReportExport
|
|
2909
|
+
*/
|
|
2910
|
+
readonly exportReportExportRequest: ExportReportExportRequest;
|
|
2911
|
+
/**
|
|
2912
|
+
*
|
|
2913
|
+
* @type {boolean}
|
|
2914
|
+
* @memberof ReportExportExportCreateReportExport
|
|
2915
|
+
*/
|
|
2916
|
+
readonly xGdcDebug?: boolean;
|
|
2917
|
+
}
|
|
2918
|
+
/**
|
|
2919
|
+
* Request parameters for getReportExport operation in ReportExportExport.
|
|
2920
|
+
* @export
|
|
2921
|
+
* @interface ReportExportExportGetReportExportRequest
|
|
2922
|
+
*/
|
|
2923
|
+
export interface ReportExportExportGetReportExportRequest {
|
|
2924
|
+
/**
|
|
2925
|
+
*
|
|
2926
|
+
* @type {string}
|
|
2927
|
+
* @memberof ReportExportExportGetReportExport
|
|
2928
|
+
*/
|
|
2929
|
+
readonly workspaceId: string;
|
|
2930
|
+
/**
|
|
2931
|
+
*
|
|
2932
|
+
* @type {string}
|
|
2933
|
+
* @memberof ReportExportExportGetReportExport
|
|
2934
|
+
*/
|
|
2935
|
+
readonly exportId: string;
|
|
2936
|
+
}
|
|
2937
|
+
/**
|
|
2938
|
+
* Request parameters for getReportExportMetadata operation in ReportExportExport.
|
|
2939
|
+
* @export
|
|
2940
|
+
* @interface ReportExportExportGetReportExportMetadataRequest
|
|
2941
|
+
*/
|
|
2942
|
+
export interface ReportExportExportGetReportExportMetadataRequest {
|
|
2943
|
+
/**
|
|
2944
|
+
*
|
|
2945
|
+
* @type {string}
|
|
2946
|
+
* @memberof ReportExportExportGetReportExportMetadata
|
|
2947
|
+
*/
|
|
2948
|
+
readonly workspaceId: string;
|
|
2949
|
+
/**
|
|
2950
|
+
*
|
|
2951
|
+
* @type {string}
|
|
2952
|
+
* @memberof ReportExportExportGetReportExportMetadata
|
|
2953
|
+
*/
|
|
2954
|
+
readonly exportId: string;
|
|
2955
|
+
}
|
|
2956
|
+
/**
|
|
2957
|
+
* ReportExportExport - object-oriented interface
|
|
2958
|
+
* @export
|
|
2959
|
+
* @class ReportExportExport
|
|
2960
|
+
* @extends {BaseAPI}
|
|
2961
|
+
*/
|
|
2962
|
+
export declare class ReportExportExport extends BaseAPI implements ReportExportExportInterface {
|
|
2963
|
+
/**
|
|
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.
|
|
2965
|
+
* @summary (EXPERIMENTAL) Create report export request
|
|
2966
|
+
* @param {ReportExportExportCreateReportExportRequest} requestParameters Request parameters.
|
|
2967
|
+
* @param {*} [options] Override http request option.
|
|
2968
|
+
* @throws {RequiredError}
|
|
2969
|
+
* @memberof ReportExportExport
|
|
2970
|
+
*/
|
|
2971
|
+
createReportExport(requestParameters: ReportExportExportCreateReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportExportResponse>;
|
|
2972
|
+
/**
|
|
2973
|
+
* 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
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2975
|
+
* @param {ReportExportExportGetReportExportRequest} requestParameters Request parameters.
|
|
2976
|
+
* @param {*} [options] Override http request option.
|
|
2977
|
+
* @throws {RequiredError}
|
|
2978
|
+
* @memberof ReportExportExport
|
|
2979
|
+
*/
|
|
2980
|
+
getReportExport(requestParameters: ReportExportExportGetReportExportRequest, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
2981
|
+
/**
|
|
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.
|
|
2983
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2984
|
+
* @param {ReportExportExportGetReportExportMetadataRequest} requestParameters Request parameters.
|
|
2985
|
+
* @param {*} [options] Override http request option.
|
|
2986
|
+
* @throws {RequiredError}
|
|
2987
|
+
* @memberof ReportExportExport
|
|
2988
|
+
*/
|
|
2989
|
+
getReportExportMetadata(requestParameters: ReportExportExportGetReportExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2990
|
+
}
|
|
2578
2991
|
/**
|
|
2579
2992
|
* Note: This API is an experimental and is going to change. Please, use it accordingly. A slides 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.
|
|
2580
2993
|
* @summary (EXPERIMENTAL) Create slides export request
|