@gooddata/api-client-tiger 10.27.0-alpha.9 → 10.27.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/__version.js.map +1 -1
- package/esm/api-client-tiger.d.ts +4347 -1738
- package/esm/automation.d.ts +2 -3
- package/esm/automation.d.ts.map +1 -1
- package/esm/automation.js +2 -2
- package/esm/automation.js.map +1 -1
- package/esm/client.d.ts +2 -2
- package/esm/client.d.ts.map +1 -1
- package/esm/client.js +1 -1
- package/esm/client.js.map +1 -1
- package/esm/generated/afm-rest-api/api.d.ts +60 -8
- package/esm/generated/afm-rest-api/api.d.ts.map +1 -1
- package/esm/generated/afm-rest-api/api.js +4 -4
- package/esm/generated/afm-rest-api/api.js.map +1 -1
- package/esm/generated/afm-rest-api/openapi-spec.json +51 -10
- package/esm/generated/automation-json-api/api.d.ts +1984 -705
- package/esm/generated/automation-json-api/api.d.ts.map +1 -1
- package/esm/generated/automation-json-api/api.js +275 -169
- package/esm/generated/automation-json-api/api.js.map +1 -1
- package/esm/generated/automation-json-api/openapi-spec.json +1046 -7
- package/esm/generated/export-json-api/api.d.ts +591 -4
- package/esm/generated/export-json-api/api.d.ts.map +1 -1
- package/esm/generated/export-json-api/api.js +522 -10
- package/esm/generated/export-json-api/api.js.map +1 -1
- package/esm/generated/export-json-api/openapi-spec.json +417 -1
- package/esm/generated/metadata-json-api/api.d.ts +1209 -1183
- package/esm/generated/metadata-json-api/api.d.ts.map +1 -1
- package/esm/generated/metadata-json-api/api.js +76 -57
- package/esm/generated/metadata-json-api/api.js.map +1 -1
- package/esm/generated/metadata-json-api/openapi-spec.json +7953 -7935
- package/esm/generated/result-json-api/base.d.ts.map +1 -1
- package/esm/generated/result-json-api/base.js +1 -13
- package/esm/generated/result-json-api/base.js.map +1 -1
- package/esm/generated/scan-json-api/api.d.ts +2 -1
- package/esm/generated/scan-json-api/api.d.ts.map +1 -1
- package/esm/generated/scan-json-api/api.js +2 -1
- package/esm/generated/scan-json-api/api.js.map +1 -1
- package/esm/generated/scan-json-api/openapi-spec.json +3 -2
- package/esm/index.d.ts +5 -2
- package/esm/index.d.ts.map +1 -1
- package/esm/index.js +1 -0
- package/esm/index.js.map +1 -1
- package/package.json +4 -4
|
@@ -355,6 +355,25 @@ export type ArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = typeof Ar
|
|
|
355
355
|
* @export
|
|
356
356
|
*/
|
|
357
357
|
export type AttributeFilter = NegativeAttributeFilter | PositiveAttributeFilter;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @export
|
|
361
|
+
* @interface AttributeFilterByDate
|
|
362
|
+
*/
|
|
363
|
+
export interface AttributeFilterByDate {
|
|
364
|
+
/**
|
|
365
|
+
*
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof AttributeFilterByDate
|
|
368
|
+
*/
|
|
369
|
+
filterLocalIdentifier: string;
|
|
370
|
+
/**
|
|
371
|
+
*
|
|
372
|
+
* @type {boolean}
|
|
373
|
+
* @memberof AttributeFilterByDate
|
|
374
|
+
*/
|
|
375
|
+
isCommonDate: boolean;
|
|
376
|
+
}
|
|
358
377
|
/**
|
|
359
378
|
* Filter on specific set of label values.
|
|
360
379
|
* @export
|
|
@@ -368,6 +387,25 @@ export interface AttributeFilterElements {
|
|
|
368
387
|
*/
|
|
369
388
|
values: Array<string>;
|
|
370
389
|
}
|
|
390
|
+
/**
|
|
391
|
+
*
|
|
392
|
+
* @export
|
|
393
|
+
* @interface AttributeFilterParent
|
|
394
|
+
*/
|
|
395
|
+
export interface AttributeFilterParent {
|
|
396
|
+
/**
|
|
397
|
+
*
|
|
398
|
+
* @type {string}
|
|
399
|
+
* @memberof AttributeFilterParent
|
|
400
|
+
*/
|
|
401
|
+
filterLocalIdentifier: string;
|
|
402
|
+
/**
|
|
403
|
+
*
|
|
404
|
+
* @type {Over}
|
|
405
|
+
* @memberof AttributeFilterParent
|
|
406
|
+
*/
|
|
407
|
+
over: Over;
|
|
408
|
+
}
|
|
371
409
|
/**
|
|
372
410
|
*
|
|
373
411
|
* @export
|
|
@@ -519,6 +557,74 @@ export interface CustomOverride {
|
|
|
519
557
|
[key: string]: CustomMetric;
|
|
520
558
|
};
|
|
521
559
|
}
|
|
560
|
+
/**
|
|
561
|
+
*
|
|
562
|
+
* @export
|
|
563
|
+
* @interface DashboardAttributeFilter
|
|
564
|
+
*/
|
|
565
|
+
export interface DashboardAttributeFilter {
|
|
566
|
+
/**
|
|
567
|
+
*
|
|
568
|
+
* @type {DashboardFilter & object}
|
|
569
|
+
* @memberof DashboardAttributeFilter
|
|
570
|
+
*/
|
|
571
|
+
attributeFilter: DashboardFilter & object;
|
|
572
|
+
}
|
|
573
|
+
/**
|
|
574
|
+
*
|
|
575
|
+
* @export
|
|
576
|
+
* @interface DashboardDateFilter
|
|
577
|
+
*/
|
|
578
|
+
export interface DashboardDateFilter {
|
|
579
|
+
/**
|
|
580
|
+
*
|
|
581
|
+
* @type {DashboardFilter & object}
|
|
582
|
+
* @memberof DashboardDateFilter
|
|
583
|
+
*/
|
|
584
|
+
dateFilter: DashboardFilter & object;
|
|
585
|
+
}
|
|
586
|
+
/**
|
|
587
|
+
*
|
|
588
|
+
* @export
|
|
589
|
+
* @interface DashboardFilter
|
|
590
|
+
*/
|
|
591
|
+
export interface DashboardFilter {
|
|
592
|
+
/**
|
|
593
|
+
*
|
|
594
|
+
* @type {string}
|
|
595
|
+
* @memberof DashboardFilter
|
|
596
|
+
*/
|
|
597
|
+
localIdentifier?: string;
|
|
598
|
+
}
|
|
599
|
+
/**
|
|
600
|
+
* Export request object describing the export properties for dashboard tabular exports.
|
|
601
|
+
* @export
|
|
602
|
+
* @interface DashboardTabularExportRequest
|
|
603
|
+
*/
|
|
604
|
+
export interface DashboardTabularExportRequest {
|
|
605
|
+
/**
|
|
606
|
+
* Requested tabular export type.
|
|
607
|
+
* @type {string}
|
|
608
|
+
* @memberof DashboardTabularExportRequest
|
|
609
|
+
*/
|
|
610
|
+
format: DashboardTabularExportRequestFormatEnum;
|
|
611
|
+
/**
|
|
612
|
+
* Filename of downloaded file without extension.
|
|
613
|
+
* @type {string}
|
|
614
|
+
* @memberof DashboardTabularExportRequest
|
|
615
|
+
*/
|
|
616
|
+
fileName: string;
|
|
617
|
+
/**
|
|
618
|
+
* List of filters that will be used instead of the default dashboard filters.
|
|
619
|
+
* @type {Array<DashboardAttributeFilter | DashboardDateFilter>}
|
|
620
|
+
* @memberof DashboardTabularExportRequest
|
|
621
|
+
*/
|
|
622
|
+
dashboardFiltersOverride?: Array<DashboardAttributeFilter | DashboardDateFilter>;
|
|
623
|
+
}
|
|
624
|
+
export declare const DashboardTabularExportRequestFormatEnum: {
|
|
625
|
+
readonly XLSX: "XLSX";
|
|
626
|
+
};
|
|
627
|
+
export type DashboardTabularExportRequestFormatEnum = typeof DashboardTabularExportRequestFormatEnum[keyof typeof DashboardTabularExportRequestFormatEnum];
|
|
522
628
|
/**
|
|
523
629
|
* @type DateFilter
|
|
524
630
|
* Abstract filter definition type for dates.
|
|
@@ -569,6 +675,47 @@ export type FilterDefinition = AbsoluteDateFilter | ComparisonMeasureValueFilter
|
|
|
569
675
|
* @export
|
|
570
676
|
*/
|
|
571
677
|
export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
|
|
678
|
+
/**
|
|
679
|
+
* Export request object describing the export properties and metadata for image exports.
|
|
680
|
+
* @export
|
|
681
|
+
* @interface ImageExportRequest
|
|
682
|
+
*/
|
|
683
|
+
export interface ImageExportRequest {
|
|
684
|
+
/**
|
|
685
|
+
* Requested resulting file type.
|
|
686
|
+
* @type {string}
|
|
687
|
+
* @memberof ImageExportRequest
|
|
688
|
+
*/
|
|
689
|
+
format: ImageExportRequestFormatEnum;
|
|
690
|
+
/**
|
|
691
|
+
* File name to be used for retrieving the image document.
|
|
692
|
+
* @type {string}
|
|
693
|
+
* @memberof ImageExportRequest
|
|
694
|
+
*/
|
|
695
|
+
fileName: string;
|
|
696
|
+
/**
|
|
697
|
+
* Dashboard identifier
|
|
698
|
+
* @type {string}
|
|
699
|
+
* @memberof ImageExportRequest
|
|
700
|
+
*/
|
|
701
|
+
dashboardId: string;
|
|
702
|
+
/**
|
|
703
|
+
* List of widget identifiers to be exported. Note that only one widget is currently supported.
|
|
704
|
+
* @type {Array<string>}
|
|
705
|
+
* @memberof ImageExportRequest
|
|
706
|
+
*/
|
|
707
|
+
widgetIds?: Array<string>;
|
|
708
|
+
/**
|
|
709
|
+
* Metadata definition in free-form JSON format.
|
|
710
|
+
* @type {object}
|
|
711
|
+
* @memberof ImageExportRequest
|
|
712
|
+
*/
|
|
713
|
+
metadata?: object | null;
|
|
714
|
+
}
|
|
715
|
+
export declare const ImageExportRequestFormatEnum: {
|
|
716
|
+
readonly PNG: "PNG";
|
|
717
|
+
};
|
|
718
|
+
export type ImageExportRequestFormatEnum = typeof ImageExportRequestFormatEnum[keyof typeof ImageExportRequestFormatEnum];
|
|
572
719
|
/**
|
|
573
720
|
* Filter in form of direct MAQL query.
|
|
574
721
|
* @export
|
|
@@ -763,6 +910,19 @@ export interface NegativeAttributeFilterNegativeAttributeFilter {
|
|
|
763
910
|
*/
|
|
764
911
|
label: AfmIdentifier;
|
|
765
912
|
}
|
|
913
|
+
/**
|
|
914
|
+
*
|
|
915
|
+
* @export
|
|
916
|
+
* @interface Over
|
|
917
|
+
*/
|
|
918
|
+
export interface Over {
|
|
919
|
+
/**
|
|
920
|
+
*
|
|
921
|
+
* @type {Array<string>}
|
|
922
|
+
* @memberof Over
|
|
923
|
+
*/
|
|
924
|
+
attributes: Array<string>;
|
|
925
|
+
}
|
|
766
926
|
/**
|
|
767
927
|
* Custom CSS styles for the table. (PDF, HTML)
|
|
768
928
|
* @export
|
|
@@ -1507,10 +1667,20 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1507
1667
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1508
1668
|
* @param {string} workspaceId
|
|
1509
1669
|
* @param {string} dashboardId
|
|
1670
|
+
* @param {DashboardTabularExportRequest} dashboardTabularExportRequest
|
|
1510
1671
|
* @param {*} [options] Override http request option.
|
|
1511
1672
|
* @throws {RequiredError}
|
|
1512
1673
|
*/
|
|
1513
|
-
createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1674
|
+
createDashboardExportRequest: (workspaceId: string, dashboardId: string, dashboardTabularExportRequest: DashboardTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1675
|
+
/**
|
|
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.
|
|
1677
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
1678
|
+
* @param {string} workspaceId
|
|
1679
|
+
* @param {ImageExportRequest} imageExportRequest
|
|
1680
|
+
* @param {*} [options] Override http request option.
|
|
1681
|
+
* @throws {RequiredError}
|
|
1682
|
+
*/
|
|
1683
|
+
createImageExport: (workspaceId: string, imageExportRequest: ImageExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1514
1684
|
/**
|
|
1515
1685
|
* An visual 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.
|
|
1516
1686
|
* @summary Create visual - pdf export request
|
|
@@ -1556,6 +1726,24 @@ export declare const ActionsApiAxiosParamCreator: (configuration?: Configuration
|
|
|
1556
1726
|
* @throws {RequiredError}
|
|
1557
1727
|
*/
|
|
1558
1728
|
getExportedFile: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1729
|
+
/**
|
|
1730
|
+
* 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.
|
|
1731
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1732
|
+
* @param {string} workspaceId
|
|
1733
|
+
* @param {string} exportId
|
|
1734
|
+
* @param {*} [options] Override http request option.
|
|
1735
|
+
* @throws {RequiredError}
|
|
1736
|
+
*/
|
|
1737
|
+
getImageExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1738
|
+
/**
|
|
1739
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
1740
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1741
|
+
* @param {string} workspaceId
|
|
1742
|
+
* @param {string} exportId
|
|
1743
|
+
* @param {*} [options] Override http request option.
|
|
1744
|
+
* @throws {RequiredError}
|
|
1745
|
+
*/
|
|
1746
|
+
getImageExportMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
1559
1747
|
/**
|
|
1560
1748
|
* 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/visual endpoint. The metadata structure is not verified.
|
|
1561
1749
|
* @summary Retrieve metadata context
|
|
@@ -1612,10 +1800,20 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
1612
1800
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
1613
1801
|
* @param {string} workspaceId
|
|
1614
1802
|
* @param {string} dashboardId
|
|
1803
|
+
* @param {DashboardTabularExportRequest} dashboardTabularExportRequest
|
|
1804
|
+
* @param {*} [options] Override http request option.
|
|
1805
|
+
* @throws {RequiredError}
|
|
1806
|
+
*/
|
|
1807
|
+
createDashboardExportRequest(workspaceId: string, dashboardId: string, dashboardTabularExportRequest: DashboardTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
|
|
1808
|
+
/**
|
|
1809
|
+
* 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.
|
|
1810
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
1811
|
+
* @param {string} workspaceId
|
|
1812
|
+
* @param {ImageExportRequest} imageExportRequest
|
|
1615
1813
|
* @param {*} [options] Override http request option.
|
|
1616
1814
|
* @throws {RequiredError}
|
|
1617
1815
|
*/
|
|
1618
|
-
|
|
1816
|
+
createImageExport(workspaceId: string, imageExportRequest: ImageExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
|
|
1619
1817
|
/**
|
|
1620
1818
|
* An visual 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.
|
|
1621
1819
|
* @summary Create visual - pdf export request
|
|
@@ -1661,6 +1859,24 @@ export declare const ActionsApiFp: (configuration?: Configuration) => {
|
|
|
1661
1859
|
* @throws {RequiredError}
|
|
1662
1860
|
*/
|
|
1663
1861
|
getExportedFile(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1862
|
+
/**
|
|
1863
|
+
* 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.
|
|
1864
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1865
|
+
* @param {string} workspaceId
|
|
1866
|
+
* @param {string} exportId
|
|
1867
|
+
* @param {*} [options] Override http request option.
|
|
1868
|
+
* @throws {RequiredError}
|
|
1869
|
+
*/
|
|
1870
|
+
getImageExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1871
|
+
/**
|
|
1872
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
1873
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1874
|
+
* @param {string} workspaceId
|
|
1875
|
+
* @param {string} exportId
|
|
1876
|
+
* @param {*} [options] Override http request option.
|
|
1877
|
+
* @throws {RequiredError}
|
|
1878
|
+
*/
|
|
1879
|
+
getImageExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1664
1880
|
/**
|
|
1665
1881
|
* 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/visual endpoint. The metadata structure is not verified.
|
|
1666
1882
|
* @summary Retrieve metadata context
|
|
@@ -1720,6 +1936,14 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
1720
1936
|
* @throws {RequiredError}
|
|
1721
1937
|
*/
|
|
1722
1938
|
createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
1939
|
+
/**
|
|
1940
|
+
* 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.
|
|
1941
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
1942
|
+
* @param {ActionsApiCreateImageExportRequest} requestParameters Request parameters.
|
|
1943
|
+
* @param {*} [options] Override http request option.
|
|
1944
|
+
* @throws {RequiredError}
|
|
1945
|
+
*/
|
|
1946
|
+
createImageExport(requestParameters: ActionsApiCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
1723
1947
|
/**
|
|
1724
1948
|
* An visual 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.
|
|
1725
1949
|
* @summary Create visual - pdf export request
|
|
@@ -1760,6 +1984,22 @@ export declare const ActionsApiFactory: (configuration?: Configuration, basePath
|
|
|
1760
1984
|
* @throws {RequiredError}
|
|
1761
1985
|
*/
|
|
1762
1986
|
getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1987
|
+
/**
|
|
1988
|
+
* 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.
|
|
1989
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
1990
|
+
* @param {ActionsApiGetImageExportRequest} requestParameters Request parameters.
|
|
1991
|
+
* @param {*} [options] Override http request option.
|
|
1992
|
+
* @throws {RequiredError}
|
|
1993
|
+
*/
|
|
1994
|
+
getImageExport(requestParameters: ActionsApiGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1995
|
+
/**
|
|
1996
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
1997
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
1998
|
+
* @param {ActionsApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
1999
|
+
* @param {*} [options] Override http request option.
|
|
2000
|
+
* @throws {RequiredError}
|
|
2001
|
+
*/
|
|
2002
|
+
getImageExportMetadata(requestParameters: ActionsApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1763
2003
|
/**
|
|
1764
2004
|
* 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/visual endpoint. The metadata structure is not verified.
|
|
1765
2005
|
* @summary Retrieve metadata context
|
|
@@ -1816,6 +2056,15 @@ export interface ActionsApiInterface {
|
|
|
1816
2056
|
* @memberof ActionsApiInterface
|
|
1817
2057
|
*/
|
|
1818
2058
|
createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
2059
|
+
/**
|
|
2060
|
+
* 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.
|
|
2061
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2062
|
+
* @param {ActionsApiCreateImageExportRequest} requestParameters Request parameters.
|
|
2063
|
+
* @param {*} [options] Override http request option.
|
|
2064
|
+
* @throws {RequiredError}
|
|
2065
|
+
* @memberof ActionsApiInterface
|
|
2066
|
+
*/
|
|
2067
|
+
createImageExport(requestParameters: ActionsApiCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
1819
2068
|
/**
|
|
1820
2069
|
* An visual 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.
|
|
1821
2070
|
* @summary Create visual - pdf export request
|
|
@@ -1861,6 +2110,24 @@ export interface ActionsApiInterface {
|
|
|
1861
2110
|
* @memberof ActionsApiInterface
|
|
1862
2111
|
*/
|
|
1863
2112
|
getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2113
|
+
/**
|
|
2114
|
+
* 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.
|
|
2115
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2116
|
+
* @param {ActionsApiGetImageExportRequest} requestParameters Request parameters.
|
|
2117
|
+
* @param {*} [options] Override http request option.
|
|
2118
|
+
* @throws {RequiredError}
|
|
2119
|
+
* @memberof ActionsApiInterface
|
|
2120
|
+
*/
|
|
2121
|
+
getImageExport(requestParameters: ActionsApiGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2122
|
+
/**
|
|
2123
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2124
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2125
|
+
* @param {ActionsApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2126
|
+
* @param {*} [options] Override http request option.
|
|
2127
|
+
* @throws {RequiredError}
|
|
2128
|
+
* @memberof ActionsApiInterface
|
|
2129
|
+
*/
|
|
2130
|
+
getImageExportMetadata(requestParameters: ActionsApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
1864
2131
|
/**
|
|
1865
2132
|
* 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/visual endpoint. The metadata structure is not verified.
|
|
1866
2133
|
* @summary Retrieve metadata context
|
|
@@ -1925,6 +2192,31 @@ export interface ActionsApiCreateDashboardExportRequestRequest {
|
|
|
1925
2192
|
* @memberof ActionsApiCreateDashboardExportRequest
|
|
1926
2193
|
*/
|
|
1927
2194
|
readonly dashboardId: string;
|
|
2195
|
+
/**
|
|
2196
|
+
*
|
|
2197
|
+
* @type {DashboardTabularExportRequest}
|
|
2198
|
+
* @memberof ActionsApiCreateDashboardExportRequest
|
|
2199
|
+
*/
|
|
2200
|
+
readonly dashboardTabularExportRequest: DashboardTabularExportRequest;
|
|
2201
|
+
}
|
|
2202
|
+
/**
|
|
2203
|
+
* Request parameters for createImageExport operation in ActionsApi.
|
|
2204
|
+
* @export
|
|
2205
|
+
* @interface ActionsApiCreateImageExportRequest
|
|
2206
|
+
*/
|
|
2207
|
+
export interface ActionsApiCreateImageExportRequest {
|
|
2208
|
+
/**
|
|
2209
|
+
*
|
|
2210
|
+
* @type {string}
|
|
2211
|
+
* @memberof ActionsApiCreateImageExport
|
|
2212
|
+
*/
|
|
2213
|
+
readonly workspaceId: string;
|
|
2214
|
+
/**
|
|
2215
|
+
*
|
|
2216
|
+
* @type {ImageExportRequest}
|
|
2217
|
+
* @memberof ActionsApiCreateImageExport
|
|
2218
|
+
*/
|
|
2219
|
+
readonly imageExportRequest: ImageExportRequest;
|
|
1928
2220
|
}
|
|
1929
2221
|
/**
|
|
1930
2222
|
* Request parameters for createPdfExport operation in ActionsApi.
|
|
@@ -2021,6 +2313,44 @@ export interface ActionsApiGetExportedFileRequest {
|
|
|
2021
2313
|
*/
|
|
2022
2314
|
readonly exportId: string;
|
|
2023
2315
|
}
|
|
2316
|
+
/**
|
|
2317
|
+
* Request parameters for getImageExport operation in ActionsApi.
|
|
2318
|
+
* @export
|
|
2319
|
+
* @interface ActionsApiGetImageExportRequest
|
|
2320
|
+
*/
|
|
2321
|
+
export interface ActionsApiGetImageExportRequest {
|
|
2322
|
+
/**
|
|
2323
|
+
*
|
|
2324
|
+
* @type {string}
|
|
2325
|
+
* @memberof ActionsApiGetImageExport
|
|
2326
|
+
*/
|
|
2327
|
+
readonly workspaceId: string;
|
|
2328
|
+
/**
|
|
2329
|
+
*
|
|
2330
|
+
* @type {string}
|
|
2331
|
+
* @memberof ActionsApiGetImageExport
|
|
2332
|
+
*/
|
|
2333
|
+
readonly exportId: string;
|
|
2334
|
+
}
|
|
2335
|
+
/**
|
|
2336
|
+
* Request parameters for getImageExportMetadata operation in ActionsApi.
|
|
2337
|
+
* @export
|
|
2338
|
+
* @interface ActionsApiGetImageExportMetadataRequest
|
|
2339
|
+
*/
|
|
2340
|
+
export interface ActionsApiGetImageExportMetadataRequest {
|
|
2341
|
+
/**
|
|
2342
|
+
*
|
|
2343
|
+
* @type {string}
|
|
2344
|
+
* @memberof ActionsApiGetImageExportMetadata
|
|
2345
|
+
*/
|
|
2346
|
+
readonly workspaceId: string;
|
|
2347
|
+
/**
|
|
2348
|
+
*
|
|
2349
|
+
* @type {string}
|
|
2350
|
+
* @memberof ActionsApiGetImageExportMetadata
|
|
2351
|
+
*/
|
|
2352
|
+
readonly exportId: string;
|
|
2353
|
+
}
|
|
2024
2354
|
/**
|
|
2025
2355
|
* Request parameters for getMetadata operation in ActionsApi.
|
|
2026
2356
|
* @export
|
|
@@ -2132,6 +2462,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
2132
2462
|
* @memberof ActionsApi
|
|
2133
2463
|
*/
|
|
2134
2464
|
createDashboardExportRequest(requestParameters: ActionsApiCreateDashboardExportRequestRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
|
|
2465
|
+
/**
|
|
2466
|
+
* 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.
|
|
2467
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2468
|
+
* @param {ActionsApiCreateImageExportRequest} requestParameters Request parameters.
|
|
2469
|
+
* @param {*} [options] Override http request option.
|
|
2470
|
+
* @throws {RequiredError}
|
|
2471
|
+
* @memberof ActionsApi
|
|
2472
|
+
*/
|
|
2473
|
+
createImageExport(requestParameters: ActionsApiCreateImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
|
|
2135
2474
|
/**
|
|
2136
2475
|
* An visual 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.
|
|
2137
2476
|
* @summary Create visual - pdf export request
|
|
@@ -2177,6 +2516,24 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
2177
2516
|
* @memberof ActionsApi
|
|
2178
2517
|
*/
|
|
2179
2518
|
getExportedFile(requestParameters: ActionsApiGetExportedFileRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2519
|
+
/**
|
|
2520
|
+
* 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.
|
|
2521
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2522
|
+
* @param {ActionsApiGetImageExportRequest} requestParameters Request parameters.
|
|
2523
|
+
* @param {*} [options] Override http request option.
|
|
2524
|
+
* @throws {RequiredError}
|
|
2525
|
+
* @memberof ActionsApi
|
|
2526
|
+
*/
|
|
2527
|
+
getImageExport(requestParameters: ActionsApiGetImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2528
|
+
/**
|
|
2529
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2530
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2531
|
+
* @param {ActionsApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2532
|
+
* @param {*} [options] Override http request option.
|
|
2533
|
+
* @throws {RequiredError}
|
|
2534
|
+
* @memberof ActionsApi
|
|
2535
|
+
*/
|
|
2536
|
+
getImageExportMetadata(requestParameters: ActionsApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2180
2537
|
/**
|
|
2181
2538
|
* 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/visual endpoint. The metadata structure is not verified.
|
|
2182
2539
|
* @summary Retrieve metadata context
|
|
@@ -2223,6 +2580,228 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
|
|
|
2223
2580
|
*/
|
|
2224
2581
|
getTabularExport(requestParameters: ActionsApiGetTabularExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2225
2582
|
}
|
|
2583
|
+
/**
|
|
2584
|
+
* ImageExportApi - axios parameter creator
|
|
2585
|
+
* @export
|
|
2586
|
+
*/
|
|
2587
|
+
export declare const ImageExportApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
2588
|
+
/**
|
|
2589
|
+
* 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.
|
|
2590
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2591
|
+
* @param {string} workspaceId
|
|
2592
|
+
* @param {ImageExportRequest} imageExportRequest
|
|
2593
|
+
* @param {*} [options] Override http request option.
|
|
2594
|
+
* @throws {RequiredError}
|
|
2595
|
+
*/
|
|
2596
|
+
createImageExport: (workspaceId: string, imageExportRequest: ImageExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2597
|
+
/**
|
|
2598
|
+
* 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.
|
|
2599
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2600
|
+
* @param {string} workspaceId
|
|
2601
|
+
* @param {string} exportId
|
|
2602
|
+
* @param {*} [options] Override http request option.
|
|
2603
|
+
* @throws {RequiredError}
|
|
2604
|
+
*/
|
|
2605
|
+
getImageExport: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2606
|
+
/**
|
|
2607
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2608
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2609
|
+
* @param {string} workspaceId
|
|
2610
|
+
* @param {string} exportId
|
|
2611
|
+
* @param {*} [options] Override http request option.
|
|
2612
|
+
* @throws {RequiredError}
|
|
2613
|
+
*/
|
|
2614
|
+
getImageExportMetadata: (workspaceId: string, exportId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2615
|
+
};
|
|
2616
|
+
/**
|
|
2617
|
+
* ImageExportApi - functional programming interface
|
|
2618
|
+
* @export
|
|
2619
|
+
*/
|
|
2620
|
+
export declare const ImageExportApiFp: (configuration?: Configuration) => {
|
|
2621
|
+
/**
|
|
2622
|
+
* 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.
|
|
2623
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2624
|
+
* @param {string} workspaceId
|
|
2625
|
+
* @param {ImageExportRequest} imageExportRequest
|
|
2626
|
+
* @param {*} [options] Override http request option.
|
|
2627
|
+
* @throws {RequiredError}
|
|
2628
|
+
*/
|
|
2629
|
+
createImageExport(workspaceId: string, imageExportRequest: ImageExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
|
|
2630
|
+
/**
|
|
2631
|
+
* 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.
|
|
2632
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2633
|
+
* @param {string} workspaceId
|
|
2634
|
+
* @param {string} exportId
|
|
2635
|
+
* @param {*} [options] Override http request option.
|
|
2636
|
+
* @throws {RequiredError}
|
|
2637
|
+
*/
|
|
2638
|
+
getImageExport(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2639
|
+
/**
|
|
2640
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2641
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2642
|
+
* @param {string} workspaceId
|
|
2643
|
+
* @param {string} exportId
|
|
2644
|
+
* @param {*} [options] Override http request option.
|
|
2645
|
+
* @throws {RequiredError}
|
|
2646
|
+
*/
|
|
2647
|
+
getImageExportMetadata(workspaceId: string, exportId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2648
|
+
};
|
|
2649
|
+
/**
|
|
2650
|
+
* ImageExportApi - factory interface
|
|
2651
|
+
* @export
|
|
2652
|
+
*/
|
|
2653
|
+
export declare const ImageExportApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
2654
|
+
/**
|
|
2655
|
+
* 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.
|
|
2656
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2657
|
+
* @param {ImageExportApiCreateImageExportRequest} requestParameters Request parameters.
|
|
2658
|
+
* @param {*} [options] Override http request option.
|
|
2659
|
+
* @throws {RequiredError}
|
|
2660
|
+
*/
|
|
2661
|
+
createImageExport(requestParameters: ImageExportApiCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
2662
|
+
/**
|
|
2663
|
+
* 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.
|
|
2664
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2665
|
+
* @param {ImageExportApiGetImageExportRequest} requestParameters Request parameters.
|
|
2666
|
+
* @param {*} [options] Override http request option.
|
|
2667
|
+
* @throws {RequiredError}
|
|
2668
|
+
*/
|
|
2669
|
+
getImageExport(requestParameters: ImageExportApiGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2670
|
+
/**
|
|
2671
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2672
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2673
|
+
* @param {ImageExportApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2674
|
+
* @param {*} [options] Override http request option.
|
|
2675
|
+
* @throws {RequiredError}
|
|
2676
|
+
*/
|
|
2677
|
+
getImageExportMetadata(requestParameters: ImageExportApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2678
|
+
};
|
|
2679
|
+
/**
|
|
2680
|
+
* ImageExportApi - interface
|
|
2681
|
+
* @export
|
|
2682
|
+
* @interface ImageExportApi
|
|
2683
|
+
*/
|
|
2684
|
+
export interface ImageExportApiInterface {
|
|
2685
|
+
/**
|
|
2686
|
+
* 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.
|
|
2687
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2688
|
+
* @param {ImageExportApiCreateImageExportRequest} requestParameters Request parameters.
|
|
2689
|
+
* @param {*} [options] Override http request option.
|
|
2690
|
+
* @throws {RequiredError}
|
|
2691
|
+
* @memberof ImageExportApiInterface
|
|
2692
|
+
*/
|
|
2693
|
+
createImageExport(requestParameters: ImageExportApiCreateImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<ExportResponse>;
|
|
2694
|
+
/**
|
|
2695
|
+
* 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.
|
|
2696
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2697
|
+
* @param {ImageExportApiGetImageExportRequest} requestParameters Request parameters.
|
|
2698
|
+
* @param {*} [options] Override http request option.
|
|
2699
|
+
* @throws {RequiredError}
|
|
2700
|
+
* @memberof ImageExportApiInterface
|
|
2701
|
+
*/
|
|
2702
|
+
getImageExport(requestParameters: ImageExportApiGetImageExportRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2703
|
+
/**
|
|
2704
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2705
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2706
|
+
* @param {ImageExportApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2707
|
+
* @param {*} [options] Override http request option.
|
|
2708
|
+
* @throws {RequiredError}
|
|
2709
|
+
* @memberof ImageExportApiInterface
|
|
2710
|
+
*/
|
|
2711
|
+
getImageExportMetadata(requestParameters: ImageExportApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
2712
|
+
}
|
|
2713
|
+
/**
|
|
2714
|
+
* Request parameters for createImageExport operation in ImageExportApi.
|
|
2715
|
+
* @export
|
|
2716
|
+
* @interface ImageExportApiCreateImageExportRequest
|
|
2717
|
+
*/
|
|
2718
|
+
export interface ImageExportApiCreateImageExportRequest {
|
|
2719
|
+
/**
|
|
2720
|
+
*
|
|
2721
|
+
* @type {string}
|
|
2722
|
+
* @memberof ImageExportApiCreateImageExport
|
|
2723
|
+
*/
|
|
2724
|
+
readonly workspaceId: string;
|
|
2725
|
+
/**
|
|
2726
|
+
*
|
|
2727
|
+
* @type {ImageExportRequest}
|
|
2728
|
+
* @memberof ImageExportApiCreateImageExport
|
|
2729
|
+
*/
|
|
2730
|
+
readonly imageExportRequest: ImageExportRequest;
|
|
2731
|
+
}
|
|
2732
|
+
/**
|
|
2733
|
+
* Request parameters for getImageExport operation in ImageExportApi.
|
|
2734
|
+
* @export
|
|
2735
|
+
* @interface ImageExportApiGetImageExportRequest
|
|
2736
|
+
*/
|
|
2737
|
+
export interface ImageExportApiGetImageExportRequest {
|
|
2738
|
+
/**
|
|
2739
|
+
*
|
|
2740
|
+
* @type {string}
|
|
2741
|
+
* @memberof ImageExportApiGetImageExport
|
|
2742
|
+
*/
|
|
2743
|
+
readonly workspaceId: string;
|
|
2744
|
+
/**
|
|
2745
|
+
*
|
|
2746
|
+
* @type {string}
|
|
2747
|
+
* @memberof ImageExportApiGetImageExport
|
|
2748
|
+
*/
|
|
2749
|
+
readonly exportId: string;
|
|
2750
|
+
}
|
|
2751
|
+
/**
|
|
2752
|
+
* Request parameters for getImageExportMetadata operation in ImageExportApi.
|
|
2753
|
+
* @export
|
|
2754
|
+
* @interface ImageExportApiGetImageExportMetadataRequest
|
|
2755
|
+
*/
|
|
2756
|
+
export interface ImageExportApiGetImageExportMetadataRequest {
|
|
2757
|
+
/**
|
|
2758
|
+
*
|
|
2759
|
+
* @type {string}
|
|
2760
|
+
* @memberof ImageExportApiGetImageExportMetadata
|
|
2761
|
+
*/
|
|
2762
|
+
readonly workspaceId: string;
|
|
2763
|
+
/**
|
|
2764
|
+
*
|
|
2765
|
+
* @type {string}
|
|
2766
|
+
* @memberof ImageExportApiGetImageExportMetadata
|
|
2767
|
+
*/
|
|
2768
|
+
readonly exportId: string;
|
|
2769
|
+
}
|
|
2770
|
+
/**
|
|
2771
|
+
* ImageExportApi - object-oriented interface
|
|
2772
|
+
* @export
|
|
2773
|
+
* @class ImageExportApi
|
|
2774
|
+
* @extends {BaseAPI}
|
|
2775
|
+
*/
|
|
2776
|
+
export declare class ImageExportApi extends BaseAPI implements ImageExportApiInterface {
|
|
2777
|
+
/**
|
|
2778
|
+
* 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.
|
|
2779
|
+
* @summary (EXPERIMENTAL) Create image export request
|
|
2780
|
+
* @param {ImageExportApiCreateImageExportRequest} requestParameters Request parameters.
|
|
2781
|
+
* @param {*} [options] Override http request option.
|
|
2782
|
+
* @throws {RequiredError}
|
|
2783
|
+
* @memberof ImageExportApi
|
|
2784
|
+
*/
|
|
2785
|
+
createImageExport(requestParameters: ImageExportApiCreateImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ExportResponse, any>>;
|
|
2786
|
+
/**
|
|
2787
|
+
* 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.
|
|
2788
|
+
* @summary (EXPERIMENTAL) Retrieve exported files
|
|
2789
|
+
* @param {ImageExportApiGetImageExportRequest} requestParameters Request parameters.
|
|
2790
|
+
* @param {*} [options] Override http request option.
|
|
2791
|
+
* @throws {RequiredError}
|
|
2792
|
+
* @memberof ImageExportApi
|
|
2793
|
+
*/
|
|
2794
|
+
getImageExport(requestParameters: ImageExportApiGetImageExportRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2795
|
+
/**
|
|
2796
|
+
* 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/image endpoint. The metadata structure is not verified.
|
|
2797
|
+
* @summary (EXPERIMENTAL) Retrieve metadata context
|
|
2798
|
+
* @param {ImageExportApiGetImageExportMetadataRequest} requestParameters Request parameters.
|
|
2799
|
+
* @param {*} [options] Override http request option.
|
|
2800
|
+
* @throws {RequiredError}
|
|
2801
|
+
* @memberof ImageExportApi
|
|
2802
|
+
*/
|
|
2803
|
+
getImageExportMetadata(requestParameters: ImageExportApiGetImageExportMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2804
|
+
}
|
|
2226
2805
|
/**
|
|
2227
2806
|
* RawExportApi - axios parameter creator
|
|
2228
2807
|
* @export
|
|
@@ -2614,10 +3193,11 @@ export declare const TabularExportApiAxiosParamCreator: (configuration?: Configu
|
|
|
2614
3193
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2615
3194
|
* @param {string} workspaceId
|
|
2616
3195
|
* @param {string} dashboardId
|
|
3196
|
+
* @param {DashboardTabularExportRequest} dashboardTabularExportRequest
|
|
2617
3197
|
* @param {*} [options] Override http request option.
|
|
2618
3198
|
* @throws {RequiredError}
|
|
2619
3199
|
*/
|
|
2620
|
-
createDashboardExportRequest: (workspaceId: string, dashboardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
3200
|
+
createDashboardExportRequest: (workspaceId: string, dashboardId: string, dashboardTabularExportRequest: DashboardTabularExportRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
2621
3201
|
/**
|
|
2622
3202
|
* An tabular 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.
|
|
2623
3203
|
* @summary Create tabular export request
|
|
@@ -2647,10 +3227,11 @@ export declare const TabularExportApiFp: (configuration?: Configuration) => {
|
|
|
2647
3227
|
* @summary (EXPERIMENTAL) Create dashboard tabular export request
|
|
2648
3228
|
* @param {string} workspaceId
|
|
2649
3229
|
* @param {string} dashboardId
|
|
3230
|
+
* @param {DashboardTabularExportRequest} dashboardTabularExportRequest
|
|
2650
3231
|
* @param {*} [options] Override http request option.
|
|
2651
3232
|
* @throws {RequiredError}
|
|
2652
3233
|
*/
|
|
2653
|
-
createDashboardExportRequest(workspaceId: string, dashboardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
|
|
3234
|
+
createDashboardExportRequest(workspaceId: string, dashboardId: string, dashboardTabularExportRequest: DashboardTabularExportRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ExportResponse>>;
|
|
2654
3235
|
/**
|
|
2655
3236
|
* An tabular 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.
|
|
2656
3237
|
* @summary Create tabular export request
|
|
@@ -2752,6 +3333,12 @@ export interface TabularExportApiCreateDashboardExportRequestRequest {
|
|
|
2752
3333
|
* @memberof TabularExportApiCreateDashboardExportRequest
|
|
2753
3334
|
*/
|
|
2754
3335
|
readonly dashboardId: string;
|
|
3336
|
+
/**
|
|
3337
|
+
*
|
|
3338
|
+
* @type {DashboardTabularExportRequest}
|
|
3339
|
+
* @memberof TabularExportApiCreateDashboardExportRequest
|
|
3340
|
+
*/
|
|
3341
|
+
readonly dashboardTabularExportRequest: DashboardTabularExportRequest;
|
|
2755
3342
|
}
|
|
2756
3343
|
/**
|
|
2757
3344
|
* Request parameters for createTabularExport operation in TabularExportApi.
|