@gooddata/api-client-tiger 10.33.0-alpha.8 → 10.33.0-alpha.81

package/esm/generated/automation-json-api/api.d.ts

@@ -172,6 +172,12 @@ export interface AutomationAdHocAutomation {
      * @memberof AutomationAdHocAutomation
      */
     slidesExports?: Array<AutomationAutomationSlidesExport>;
+    /**
+     *
+     * @type {Array<AutomationAutomationDashboardTabularExport>}
+     * @memberof AutomationAdHocAutomation
+     */
+    dashboardTabularExports?: Array<AutomationAutomationDashboardTabularExport>;
     /**
      * External recipients of the automation action results.
      * @type {Array<AutomationAutomationExternalRecipient>}
@@ -656,12 +662,62 @@ export declare const AutomationArithmeticMeasureDefinitionArithmeticMeasureOpera
     readonly CHANGE: "CHANGE";
 };
 export type AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum = typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum[keyof typeof AutomationArithmeticMeasureDefinitionArithmeticMeasureOperatorEnum];
+/**
+ * @type AutomationAttributeElements
+ * @export
+ */
+export type AutomationAttributeElements = AutomationAttributeElementsByRef | AutomationAttributeElementsByValue;
+/**
+ *
+ * @export
+ * @interface AutomationAttributeElementsByRef
+ */
+export interface AutomationAttributeElementsByRef {
+    /**
+     * List of attribute elements by reference
+     * @type {Array<string>}
+     * @memberof AutomationAttributeElementsByRef
+     */
+    uris: Array<string>;
+}
+/**
+ *
+ * @export
+ * @interface AutomationAttributeElementsByValue
+ */
+export interface AutomationAttributeElementsByValue {
+    /**
+     * List of attribute elements by value
+     * @type {Array<string>}
+     * @memberof AutomationAttributeElementsByValue
+     */
+    values: Array<string>;
+}
 /**
  * @type AutomationAttributeFilter
  * Abstract filter definition type attributes
  * @export
  */
 export type AutomationAttributeFilter = AutomationNegativeAttributeFilter | AutomationPositiveAttributeFilter;
+/**
+ *
+ * @export
+ * @interface AutomationAttributeFilterByDate
+ */
+export interface AutomationAttributeFilterByDate {
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationAttributeFilterByDate
+     */
+    filterLocalIdentifier: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AutomationAttributeFilterByDate
+     */
+    isCommonDate: boolean;
+}
 /**
  * Filter on specific set of label values.
  * @export
@@ -675,6 +731,25 @@ export interface AutomationAttributeFilterElements {
      */
     values: Array<string>;
 }
+/**
+ *
+ * @export
+ * @interface AutomationAttributeFilterParent
+ */
+export interface AutomationAttributeFilterParent {
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationAttributeFilterParent
+     */
+    filterLocalIdentifier: string;
+    /**
+     *
+     * @type {AutomationOver}
+     * @memberof AutomationAttributeFilterParent
+     */
+    over: AutomationOver;
+}
 /**
  *
  * @export
@@ -730,6 +805,19 @@ export declare const AutomationAutomationAlertTriggerEnum: {
     readonly ONCE: "ONCE";
 };
 export type AutomationAutomationAlertTriggerEnum = typeof AutomationAutomationAlertTriggerEnum[keyof typeof AutomationAutomationAlertTriggerEnum];
+/**
+ *
+ * @export
+ * @interface AutomationAutomationDashboardTabularExport
+ */
+export interface AutomationAutomationDashboardTabularExport {
+    /**
+     *
+     * @type {AutomationDashboardTabularExportRequestV2}
+     * @memberof AutomationAutomationDashboardTabularExport
+     */
+    requestPayload: AutomationDashboardTabularExportRequestV2;
+}
 /**
  *
  * @export
@@ -853,6 +941,55 @@ export interface AutomationAutomationVisualExport {
      */
     requestPayload: AutomationVisualExportRequest;
 }
+/**
+ * Bounding filter for this relative date filter. This can be used to limit the range of the relative date filter to a specific date range.
+ * @export
+ * @interface AutomationBoundedFilter
+ */
+export interface AutomationBoundedFilter {
+    /**
+     *
+     * @type {AutomationAfmObjectIdentifierDataset}
+     * @memberof AutomationBoundedFilter
+     */
+    dataset: AutomationAfmObjectIdentifierDataset;
+    /**
+     * Date granularity specifying particular date attribute in given dimension.
+     * @type {string}
+     * @memberof AutomationBoundedFilter
+     */
+    granularity: AutomationBoundedFilterGranularityEnum;
+    /**
+     * Start of the filtering interval. Specified by number of periods (with respect to given granularity). Typically negative (historical time interval like -2 for \'2 days/weeks, ... ago\'). If null, then start of the range is unbounded.
+     * @type {number}
+     * @memberof AutomationBoundedFilter
+     */
+    from?: number | null;
+    /**
+     * End of the filtering interval. Specified by number of periods (with respect to given granularity). Value \'O\' is representing current time-interval (current day, week, ...). If null, then end of the range is unbounded.
+     * @type {number}
+     * @memberof AutomationBoundedFilter
+     */
+    to?: number | null;
+}
+export declare const AutomationBoundedFilterGranularityEnum: {
+    readonly MINUTE: "MINUTE";
+    readonly HOUR: "HOUR";
+    readonly DAY: "DAY";
+    readonly WEEK: "WEEK";
+    readonly MONTH: "MONTH";
+    readonly QUARTER: "QUARTER";
+    readonly YEAR: "YEAR";
+    readonly MINUTE_OF_HOUR: "MINUTE_OF_HOUR";
+    readonly HOUR_OF_DAY: "HOUR_OF_DAY";
+    readonly DAY_OF_WEEK: "DAY_OF_WEEK";
+    readonly DAY_OF_MONTH: "DAY_OF_MONTH";
+    readonly DAY_OF_YEAR: "DAY_OF_YEAR";
+    readonly WEEK_OF_YEAR: "WEEK_OF_YEAR";
+    readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
+    readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
+};
+export type AutomationBoundedFilterGranularityEnum = typeof AutomationBoundedFilterGranularityEnum[keyof typeof AutomationBoundedFilterGranularityEnum];
 /**
  *
  * @export
@@ -1026,12 +1163,268 @@ export interface AutomationCustomOverride {
         [key: string]: AutomationCustomMetric;
     };
 }
+/**
+ *
+ * @export
+ * @interface AutomationDashboardAttributeFilter
+ */
+export interface AutomationDashboardAttributeFilter {
+    /**
+     *
+     * @type {AutomationDashboardAttributeFilterAttributeFilter}
+     * @memberof AutomationDashboardAttributeFilter
+     */
+    attributeFilter: AutomationDashboardAttributeFilterAttributeFilter;
+}
+/**
+ *
+ * @export
+ * @interface AutomationDashboardAttributeFilterAttributeFilter
+ */
+export interface AutomationDashboardAttributeFilterAttributeFilter {
+    /**
+     *
+     * @type {AutomationIdentifierRef}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    displayForm: AutomationIdentifierRef;
+    /**
+     *
+     * @type {boolean}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    negativeSelection: boolean;
+    /**
+     *
+     * @type {AutomationAttributeElements}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    attributeElements: AutomationAttributeElements;
+    /**
+     *
+     * @type {Array<AutomationAttributeFilterParent>}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    filterElementsBy?: Array<AutomationAttributeFilterParent>;
+    /**
+     *
+     * @type {Array<AutomationAttributeFilterByDate>}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    filterElementsByDate?: Array<AutomationAttributeFilterByDate>;
+    /**
+     *
+     * @type {Array<AutomationIdentifierRef>}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    validateElementsBy?: Array<AutomationIdentifierRef>;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    title?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    selectionMode?: AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardAttributeFilterAttributeFilter
+     */
+    localIdentifier?: string;
+}
+export declare const AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum: {
+    readonly SINGLE: "single";
+    readonly MULTI: "multi";
+};
+export type AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum = typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum[keyof typeof AutomationDashboardAttributeFilterAttributeFilterSelectionModeEnum];
+/**
+ *
+ * @export
+ * @interface AutomationDashboardDateFilter
+ */
+export interface AutomationDashboardDateFilter {
+    /**
+     *
+     * @type {AutomationDashboardDateFilterDateFilter}
+     * @memberof AutomationDashboardDateFilter
+     */
+    dateFilter: AutomationDashboardDateFilterDateFilter;
+}
+/**
+ *
+ * @export
+ * @interface AutomationDashboardDateFilterDateFilter
+ */
+export interface AutomationDashboardDateFilterDateFilter {
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    type: AutomationDashboardDateFilterDateFilterTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    granularity: AutomationDashboardDateFilterDateFilterGranularityEnum;
+    /**
+     *
+     * @type {string | number}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    from?: string | number;
+    /**
+     *
+     * @type {string | number}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    to?: string | number;
+    /**
+     *
+     * @type {AutomationIdentifierRef}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    dataSet?: AutomationIdentifierRef;
+    /**
+     *
+     * @type {AutomationIdentifierRef}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    attribute?: AutomationIdentifierRef;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDashboardDateFilterDateFilter
+     */
+    localIdentifier?: string;
+}
+export declare const AutomationDashboardDateFilterDateFilterTypeEnum: {
+    readonly RELATIVE: "relative";
+    readonly ABSOLUTE: "absolute";
+};
+export type AutomationDashboardDateFilterDateFilterTypeEnum = typeof AutomationDashboardDateFilterDateFilterTypeEnum[keyof typeof AutomationDashboardDateFilterDateFilterTypeEnum];
+export declare const AutomationDashboardDateFilterDateFilterGranularityEnum: {
+    readonly ALL_TIME_GRANULARITY: "ALL_TIME_GRANULARITY";
+    readonly GDC_TIME_YEAR: "GDC.time.year";
+    readonly GDC_TIME_WEEK_US: "GDC.time.week_us";
+    readonly GDC_TIME_WEEK_IN_YEAR: "GDC.time.week_in_year";
+    readonly GDC_TIME_WEEK_IN_QUARTER: "GDC.time.week_in_quarter";
+    readonly GDC_TIME_WEEK: "GDC.time.week";
+    readonly GDC_TIME_EUWEEK_IN_YEAR: "GDC.time.euweek_in_year";
+    readonly GDC_TIME_EUWEEK_IN_QUARTER: "GDC.time.euweek_in_quarter";
+    readonly GDC_TIME_QUARTER: "GDC.time.quarter";
+    readonly GDC_TIME_QUARTER_IN_YEAR: "GDC.time.quarter_in_year";
+    readonly GDC_TIME_MONTH: "GDC.time.month";
+    readonly GDC_TIME_MONTH_IN_QUARTER: "GDC.time.month_in_quarter";
+    readonly GDC_TIME_MONTH_IN_YEAR: "GDC.time.month_in_year";
+    readonly GDC_TIME_DAY_IN_YEAR: "GDC.time.day_in_year";
+    readonly GDC_TIME_DAY_IN_QUARTER: "GDC.time.day_in_quarter";
+    readonly GDC_TIME_DAY_IN_MONTH: "GDC.time.day_in_month";
+    readonly GDC_TIME_DAY_IN_WEEK: "GDC.time.day_in_week";
+    readonly GDC_TIME_DAY_IN_EUWEEK: "GDC.time.day_in_euweek";
+    readonly GDC_TIME_DATE: "GDC.time.date";
+    readonly GDC_TIME_HOUR: "GDC.time.hour";
+    readonly GDC_TIME_HOUR_IN_DAY: "GDC.time.hour_in_day";
+    readonly GDC_TIME_MINUTE: "GDC.time.minute";
+    readonly GDC_TIME_MINUTE_IN_HOUR: "GDC.time.minute_in_hour";
+};
+export type AutomationDashboardDateFilterDateFilterGranularityEnum = typeof AutomationDashboardDateFilterDateFilterGranularityEnum[keyof typeof AutomationDashboardDateFilterDateFilterGranularityEnum];
+/**
+ * Additional settings.
+ * @export
+ * @interface AutomationDashboardExportSettings
+ */
+export interface AutomationDashboardExportSettings {
+    /**
+     * If true, the export will contain the information about the exported date and dashboard filters.
+     * @type {boolean}
+     * @memberof AutomationDashboardExportSettings
+     */
+    exportInfo?: boolean;
+    /**
+     * Merge equal headers in neighbouring cells. Used for [XLSX] format only.
+     * @type {boolean}
+     * @memberof AutomationDashboardExportSettings
+     */
+    mergeHeaders?: boolean;
+}
+/**
+ * @type AutomationDashboardFilter
+ * @export
+ */
+export type AutomationDashboardFilter = AutomationDashboardAttributeFilter | AutomationDashboardDateFilter;
+/**
+ * Export request object describing the export properties for dashboard tabular exports (v2 with dashboardId).
+ * @export
+ * @interface AutomationDashboardTabularExportRequestV2
+ */
+export interface AutomationDashboardTabularExportRequestV2 {
+    /**
+     * Requested tabular export type.
+     * @type {string}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    format: AutomationDashboardTabularExportRequestV2FormatEnum;
+    /**
+     * Filename of downloaded file without extension.
+     * @type {string}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    fileName: string;
+    /**
+     * List of filters that will be used instead of the default dashboard filters.
+     * @type {Array<AutomationDashboardFilter>}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    dashboardFiltersOverride?: Array<AutomationDashboardFilter>;
+    /**
+     * Dashboard identifier
+     * @type {string}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    dashboardId: string;
+    /**
+     * List of widget identifiers to be exported. Note that only one widget is currently supported.
+     * @type {Array<string>}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    widgetIds?: Array<string>;
+    /**
+     *
+     * @type {AutomationDashboardExportSettings}
+     * @memberof AutomationDashboardTabularExportRequestV2
+     */
+    settings?: AutomationDashboardExportSettings;
+}
+export declare const AutomationDashboardTabularExportRequestV2FormatEnum: {
+    readonly XLSX: "XLSX";
+};
+export type AutomationDashboardTabularExportRequestV2FormatEnum = typeof AutomationDashboardTabularExportRequestV2FormatEnum[keyof typeof AutomationDashboardTabularExportRequestV2FormatEnum];
 /**
  * @type AutomationDateFilter
  * Abstract filter definition type for dates.
  * @export
  */
 export type AutomationDateFilter = AutomationAbsoluteDateFilter | AutomationRelativeDateFilter;
+/**
+ *
+ * @export
+ * @interface AutomationDateValue
+ */
+export interface AutomationDateValue {
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationDateValue
+     */
+    value: string;
+}
 /**
  * An analytical dashboard identifier.
  * @export
@@ -1229,6 +1622,60 @@ export type AutomationFilterDefinition = AutomationAbsoluteDateFilter | Automati
  * @export
  */
 export type AutomationFilterDefinitionForSimpleMeasure = AutomationAttributeFilter | AutomationDateFilter;
+/**
+ *
+ * @export
+ * @interface AutomationIdentifierRef
+ */
+export interface AutomationIdentifierRef {
+    /**
+     *
+     * @type {AutomationIdentifierRefIdentifier}
+     * @memberof AutomationIdentifierRef
+     */
+    identifier?: AutomationIdentifierRefIdentifier;
+}
+/**
+ *
+ * @export
+ * @interface AutomationIdentifierRefIdentifier
+ */
+export interface AutomationIdentifierRefIdentifier {
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationIdentifierRefIdentifier
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof AutomationIdentifierRefIdentifier
+     */
+    type: AutomationIdentifierRefIdentifierTypeEnum;
+}
+export declare const AutomationIdentifierRefIdentifierTypeEnum: {
+    readonly ANALYTICAL_DASHBOARD: "analyticalDashboard";
+    readonly ATTRIBUTE: "attribute";
+    readonly ATTRIBUTE_HIERARCHY: "attributeHierarchy";
+    readonly DASHBOARD_PLUGIN: "dashboardPlugin";
+    readonly DATASET: "dataset";
+    readonly FACT: "fact";
+    readonly LABEL: "label";
+    readonly METRIC: "metric";
+    readonly USER_DATA_FILTER: "userDataFilter";
+    readonly EXPORT_DEFINITION: "exportDefinition";
+    readonly AUTOMATION: "automation";
+    readonly PROMPT: "prompt";
+    readonly VISUALIZATION_OBJECT: "visualizationObject";
+    readonly FILTER_CONTEXT: "filterContext";
+    readonly WORKSPACE_SETTINGS: "workspaceSettings";
+    readonly CUSTOM_APPLICATION_SETTING: "customApplicationSetting";
+    readonly WORKSPACE_DATA_FILTER: "workspaceDataFilter";
+    readonly WORKSPACE_DATA_FILTER_SETTING: "workspaceDataFilterSetting";
+    readonly FILTER_VIEW: "filterView";
+};
+export type AutomationIdentifierRefIdentifierTypeEnum = typeof AutomationIdentifierRefIdentifierTypeEnum[keyof typeof AutomationIdentifierRefIdentifierTypeEnum];
 /**
  * Export request object describing the export properties and metadata for image exports.
  * @export
@@ -1601,6 +2048,19 @@ export interface AutomationNotificationsMetaTotal {
      */
     all: number;
 }
+/**
+ *
+ * @export
+ * @interface AutomationOver
+ */
+export interface AutomationOver {
+    /**
+     *
+     * @type {Array<AutomationIdentifierRef>}
+     * @memberof AutomationOver
+     */
+    attributes: Array<AutomationIdentifierRef>;
+}
 /**
  * Custom CSS styles for the table. (PDF, HTML)
  * @export
@@ -2097,7 +2557,7 @@ export declare const AutomationRelativeOperatorEnum: {
 };
 export type AutomationRelativeOperatorEnum = typeof AutomationRelativeOperatorEnum[keyof typeof AutomationRelativeOperatorEnum];
 /**
- * A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension.
+ * A date filter specifying a time interval that is relative to the current date. For example, last week, next month, and so on. Field dataset is representing qualifier of date dimension. The \'from\' and \'to\' properties mark the boundaries of the interval. If \'from\' is omitted, all values earlier than \'to\' are included. If \'to\' is omitted, all values later than \'from\' are included. It is not allowed to omit both.
  * @export
  * @interface AutomationRelativeDateFilter
  */
@@ -2145,6 +2605,12 @@ export interface AutomationRelativeDateFilterRelativeDateFilter {
      * @memberof AutomationRelativeDateFilterRelativeDateFilter
      */
     applyOnResult?: boolean;
+    /**
+     *
+     * @type {AutomationBoundedFilter}
+     * @memberof AutomationRelativeDateFilterRelativeDateFilter
+     */
+    boundedFilter?: AutomationBoundedFilter;
     /**
      *
      * @type {AutomationAfmObjectIdentifierDataset}
@@ -2773,6 +3239,12 @@ export interface AutomationWebhookMessageData {
      * @memberof AutomationWebhookMessageData
      */
     slidesExports?: Array<AutomationExportResult>;
+    /**
+     *
+     * @type {Array<AutomationExportResult>}
+     * @memberof AutomationWebhookMessageData
+     */
+    dashboardTabularExports?: Array<AutomationExportResult>;
     /**
      *
      * @type {AutomationAlertDescription}