@gooddata/api-client-tiger 10.18.0-alpha.8 → 10.18.0-beta.0

package/esm/generated/afm-rest-api/api.d.ts

@@ -25,7 +25,7 @@ export interface AFM {
      */
     attributes: Array<AttributeItem>;
     /**
-     * Various filter types to filter execution result.
+     * Various filter types to filter the execution result.
      * @type {Array<FilterDefinition>}
      * @memberof AFM
      */
@@ -76,16 +76,16 @@ export interface AbsoluteDateFilterAbsoluteDateFilter {
     to: string;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof AbsoluteDateFilterAbsoluteDateFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof AbsoluteDateFilterAbsoluteDateFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmObjectIdentifierDataset}
@@ -149,7 +149,7 @@ export interface AfmExecution {
     settings?: ExecutionSettings;
 }
 /**
- *
+ * Response to AFM execution request
  * @export
  * @interface AfmExecutionResponse
  */
@@ -163,6 +163,7 @@ export interface AfmExecutionResponse {
 }
 /**
  * @type AfmIdentifier
+ * Reference to the attribute label to which the filter should be applied.
  * @export
  */
 export type AfmIdentifier = AfmLocalIdentifier | AfmObjectIdentifier;
@@ -193,7 +194,7 @@ export interface AfmObjectIdentifier {
     identifier: AfmObjectIdentifierIdentifier;
 }
 /**
- *
+ * Reference to the date attribute to use.
  * @export
  * @interface AfmObjectIdentifierAttribute
  */
@@ -229,7 +230,7 @@ export declare const AfmObjectIdentifierAttributeIdentifierTypeEnum: {
 };
 export type AfmObjectIdentifierAttributeIdentifierTypeEnum = typeof AfmObjectIdentifierAttributeIdentifierTypeEnum[keyof typeof AfmObjectIdentifierAttributeIdentifierTypeEnum];
 /**
- *
+ * Reference to the metric, fact or attribute object to use for the metric.
  * @export
  * @interface AfmObjectIdentifierCore
  */
@@ -268,7 +269,7 @@ export declare const AfmObjectIdentifierCoreIdentifierTypeEnum: {
 };
 export type AfmObjectIdentifierCoreIdentifierTypeEnum = typeof AfmObjectIdentifierCoreIdentifierTypeEnum[keyof typeof AfmObjectIdentifierCoreIdentifierTypeEnum];
 /**
- *
+ * Reference to the date dataset to which the filter should be applied.
  * @export
  * @interface AfmObjectIdentifierDataset
  */
@@ -476,7 +477,7 @@ export interface AnomalyDetectionResult {
     anomalyFlag: Array<boolean>;
 }
 /**
- * Metric representing arithmetics between metrics.
+ * Metric representing arithmetics between other metrics.
  * @export
  * @interface ArithmeticMeasureDefinition
  */
@@ -548,19 +549,19 @@ export interface AttributeFilterElements {
     values: Array<string | null>;
 }
 /**
- *
+ * Attribute format describes formatting information to effectively format attribute values when needed.
  * @export
  * @interface AttributeFormat
  */
 export interface AttributeFormat {
     /**
-     * Format locale
+     * Format locale code like \'en-US\', \'cs-CZ\', etc.
      * @type {string}
      * @memberof AttributeFormat
      */
     locale: string;
     /**
-     * Format pattern
+     * ICU formatting pattern like \'y\', \'dd.MM.y\', etc.
      * @type {string}
      * @memberof AttributeFormat
      */
@@ -569,78 +570,78 @@ export interface AttributeFormat {
 /**
  *
  * @export
- * @interface AttributeHeaderOut
+ * @interface AttributeHeader
  */
-export interface AttributeHeaderOut {
+export interface AttributeHeader {
     /**
      *
-     * @type {AttributeHeaderOutAttributeHeader}
-     * @memberof AttributeHeaderOut
+     * @type {AttributeHeaderAttributeHeader}
+     * @memberof AttributeHeader
      */
-    attributeHeader: AttributeHeaderOutAttributeHeader;
+    attributeHeader: AttributeHeaderAttributeHeader;
 }
 /**
  *
  * @export
- * @interface AttributeHeaderOutAttributeHeader
+ * @interface AttributeHeaderAttributeHeader
  */
-export interface AttributeHeaderOutAttributeHeader {
+export interface AttributeHeaderAttributeHeader {
     /**
-     *
+     * Local identifier of the attribute this header relates to.
      * @type {string}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     localIdentifier: string;
     /**
      *
      * @type {RestApiIdentifier}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     label: RestApiIdentifier;
     /**
-     *
+     * Label name.
      * @type {string}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     labelName: string;
     /**
      *
      * @type {RestApiIdentifier}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     attribute: RestApiIdentifier;
     /**
-     *
+     * Attribute name.
      * @type {string}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     attributeName: string;
     /**
-     *
+     * Date granularity of the attribute, only filled for date attributes.
      * @type {string}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
-    granularity?: AttributeHeaderOutAttributeHeaderGranularityEnum;
+    granularity?: AttributeHeaderAttributeHeaderGranularityEnum;
     /**
      *
      * @type {RestApiIdentifier}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     primaryLabel: RestApiIdentifier;
     /**
      *
      * @type {AttributeFormat}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
     format?: AttributeFormat;
     /**
-     *
+     * Attribute value type.
      * @type {string}
-     * @memberof AttributeHeaderOutAttributeHeader
+     * @memberof AttributeHeaderAttributeHeader
      */
-    valueType?: AttributeHeaderOutAttributeHeaderValueTypeEnum;
+    valueType?: AttributeHeaderAttributeHeaderValueTypeEnum;
 }
-export declare const AttributeHeaderOutAttributeHeaderGranularityEnum: {
+export declare const AttributeHeaderAttributeHeaderGranularityEnum: {
     readonly MINUTE: "MINUTE";
     readonly HOUR: "HOUR";
     readonly DAY: "DAY";
@@ -657,8 +658,8 @@ export declare const AttributeHeaderOutAttributeHeaderGranularityEnum: {
     readonly MONTH_OF_YEAR: "MONTH_OF_YEAR";
     readonly QUARTER_OF_YEAR: "QUARTER_OF_YEAR";
 };
-export type AttributeHeaderOutAttributeHeaderGranularityEnum = typeof AttributeHeaderOutAttributeHeaderGranularityEnum[keyof typeof AttributeHeaderOutAttributeHeaderGranularityEnum];
-export declare const AttributeHeaderOutAttributeHeaderValueTypeEnum: {
+export type AttributeHeaderAttributeHeaderGranularityEnum = typeof AttributeHeaderAttributeHeaderGranularityEnum[keyof typeof AttributeHeaderAttributeHeaderGranularityEnum];
+export declare const AttributeHeaderAttributeHeaderValueTypeEnum: {
     readonly TEXT: "TEXT";
     readonly HYPERLINK: "HYPERLINK";
     readonly GEO: "GEO";
@@ -666,7 +667,7 @@ export declare const AttributeHeaderOutAttributeHeaderValueTypeEnum: {
     readonly GEO_LATITUDE: "GEO_LATITUDE";
     readonly IMAGE: "IMAGE";
 };
-export type AttributeHeaderOutAttributeHeaderValueTypeEnum = typeof AttributeHeaderOutAttributeHeaderValueTypeEnum[keyof typeof AttributeHeaderOutAttributeHeaderValueTypeEnum];
+export type AttributeHeaderAttributeHeaderValueTypeEnum = typeof AttributeHeaderAttributeHeaderValueTypeEnum[keyof typeof AttributeHeaderAttributeHeaderValueTypeEnum];
 /**
  *
  * @export
@@ -674,7 +675,7 @@ export type AttributeHeaderOutAttributeHeaderValueTypeEnum = typeof AttributeHea
  */
 export interface AttributeItem {
     /**
-     *
+     * Local identifier of the attribute. This can be used to reference the attribute in other parts of the execution definition.
      * @type {string}
      * @memberof AttributeItem
      */
@@ -686,7 +687,7 @@ export interface AttributeItem {
      */
     label: AfmObjectIdentifierLabel;
     /**
-     * Specifies that the label should be outer-joined.
+     * Indicates whether to show all values of given attribute even if the data bound to those values is not available.
      * @type {boolean}
      * @memberof AttributeItem
      */
@@ -1108,7 +1109,13 @@ export interface ComparisonMeasureValueFilter {
  */
 export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
     /**
-     *
+     * References to the attributes to be used when filtering.
+     * @type {Array<AfmIdentifier>}
+     * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
+     */
+    dimensionality?: Array<AfmIdentifier>;
+    /**
+     * A value that will be substituted for null values in the metric for the comparisons.
      * @type {number}
      * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
      */
@@ -1127,16 +1134,16 @@ export interface ComparisonMeasureValueFilterComparisonMeasureValueFilter {
     value: number;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof ComparisonMeasureValueFilterComparisonMeasureValueFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmIdentifier}
@@ -1246,7 +1253,7 @@ export interface DataColumnLocator {
     };
 }
 /**
- *
+ * Data column locators for the values.
  * @export
  * @interface DataColumnLocators
  */
@@ -1717,26 +1724,26 @@ export declare const ElementsResponseGranularityEnum: {
 };
 export type ElementsResponseGranularityEnum = typeof ElementsResponseGranularityEnum[keyof typeof ElementsResponseGranularityEnum];
 /**
- *
+ * Links to the execution result.
  * @export
  * @interface ExecutionLinks
  */
 export interface ExecutionLinks {
     /**
-     *
+     * Link to the result data.
      * @type {string}
      * @memberof ExecutionLinks
      */
     executionResult: string;
 }
 /**
- *
+ * Response to AFM execution request body
  * @export
  * @interface ExecutionResponse
  */
 export interface ExecutionResponse {
     /**
-     *
+     * Dimensions of the result
      * @type {Array<ResultDimension>}
      * @memberof ExecutionResponse
      */
@@ -1992,23 +1999,23 @@ export interface InlineFilterDefinition {
  */
 export interface InlineFilterDefinitionInline {
     /**
-     *
+     * MAQL query representing the filter.
      * @type {string}
      * @memberof InlineFilterDefinitionInline
      */
     filter: string;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof InlineFilterDefinitionInline
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof InlineFilterDefinitionInline
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
 }
 /**
  * Metric defined by the raw MAQL query.
@@ -2030,7 +2037,7 @@ export interface InlineMeasureDefinition {
  */
 export interface InlineMeasureDefinitionInline {
     /**
-     *
+     * MAQL query defining the metric.
      * @type {string}
      * @memberof InlineMeasureDefinitionInline
      */
@@ -2194,63 +2201,63 @@ export interface MeasureExecutionResultHeader {
     measureHeader: MeasureResultHeader;
 }
 /**
- *
+ * Measure group headers
  * @export
  * @interface MeasureGroupHeaders
  */
 export interface MeasureGroupHeaders {
     /**
      *
-     * @type {Array<MeasureHeaderOut>}
+     * @type {Array<MeasureHeader>}
      * @memberof MeasureGroupHeaders
      */
-    measureGroupHeaders?: Array<MeasureHeaderOut>;
+    measureGroupHeaders?: Array<MeasureHeader>;
     /**
      *
-     * @type {MeasureHeaderOut}
+     * @type {MeasureHeader}
      * @memberof MeasureGroupHeaders
      */
-    first?: MeasureHeaderOut;
+    first?: MeasureHeader;
     /**
      *
-     * @type {MeasureHeaderOut}
+     * @type {MeasureHeader}
      * @memberof MeasureGroupHeaders
      */
-    last?: MeasureHeaderOut;
+    last?: MeasureHeader;
 }
 /**
  *
  * @export
- * @interface MeasureHeaderOut
+ * @interface MeasureHeader
  */
-export interface MeasureHeaderOut {
+export interface MeasureHeader {
     /**
-     *
+     * Local identifier of the measure this header relates to.
      * @type {string}
-     * @memberof MeasureHeaderOut
+     * @memberof MeasureHeader
      */
     localIdentifier: string;
     /**
-     *
+     * Format to be used to format the measure data.
      * @type {string}
-     * @memberof MeasureHeaderOut
+     * @memberof MeasureHeader
      */
     format?: string;
     /**
-     *
+     * Name of the measure.
      * @type {string}
-     * @memberof MeasureHeaderOut
+     * @memberof MeasureHeader
      */
     name?: string;
 }
 /**
- *
+ * Metric is a quantity that is calculated from the data.
  * @export
  * @interface MeasureItem
  */
 export interface MeasureItem {
     /**
-     *
+     * Local identifier of the metric. This can be used to reference the metric in other parts of the execution definition.
      * @type {string}
      * @memberof MeasureItem
      */
@@ -2354,16 +2361,16 @@ export interface NegativeAttributeFilterNegativeAttributeFilter {
     notIn: AttributeFilterElements;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof NegativeAttributeFilterNegativeAttributeFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof NegativeAttributeFilterNegativeAttributeFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmIdentifier}
@@ -2403,7 +2410,7 @@ export interface Paging {
     next?: string;
 }
 /**
- *
+ * Combination of the date data set to use and how many periods ago to calculate the previous period for.
  * @export
  * @interface PopDataset
  */
@@ -2415,7 +2422,7 @@ export interface PopDataset {
      */
     dataset: AfmObjectIdentifierDataset;
     /**
-     *
+     * Number of periods ago to calculate the previous period for.
      * @type {number}
      * @memberof PopDataset
      */
@@ -2447,14 +2454,14 @@ export interface PopDatasetMeasureDefinitionPreviousPeriodMeasure {
      */
     measureIdentifier: AfmLocalIdentifier;
     /**
-     *
+     * Specification of which date data sets to use for determining the period to calculate the previous period for.
      * @type {Array<PopDataset>}
      * @memberof PopDatasetMeasureDefinitionPreviousPeriodMeasure
      */
     dateDatasets: Array<PopDataset>;
 }
 /**
- *
+ * Combination of the date attribute to use and how many periods ago to calculate the PoP for.
  * @export
  * @interface PopDate
  */
@@ -2466,7 +2473,7 @@ export interface PopDate {
      */
     attribute: AfmObjectIdentifierAttribute;
     /**
-     *
+     * Number of periods ago to calculate the previous period for.
      * @type {number}
      * @memberof PopDate
      */
@@ -2498,7 +2505,7 @@ export interface PopDateMeasureDefinitionOverPeriodMeasure {
      */
     measureIdentifier: AfmLocalIdentifier;
     /**
-     *
+     * Attributes to use for determining the period to calculate the PoP for.
      * @type {Array<PopDate>}
      * @memberof PopDateMeasureDefinitionOverPeriodMeasure
      */
@@ -2536,16 +2543,16 @@ export interface PositiveAttributeFilterPositiveAttributeFilter {
     in: AttributeFilterElements;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof PositiveAttributeFilterPositiveAttributeFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof PositiveAttributeFilterPositiveAttributeFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmIdentifier}
@@ -2573,7 +2580,13 @@ export interface RangeMeasureValueFilter {
  */
 export interface RangeMeasureValueFilterRangeMeasureValueFilter {
     /**
-     *
+     * References to the attributes to be used when filtering.
+     * @type {Array<AfmIdentifier>}
+     * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
+     */
+    dimensionality?: Array<AfmIdentifier>;
+    /**
+     * A value that will be substituted for null values in the metric for the comparisons.
      * @type {number}
      * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
      */
@@ -2598,16 +2611,16 @@ export interface RangeMeasureValueFilterRangeMeasureValueFilter {
     to: number;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof RangeMeasureValueFilterRangeMeasureValueFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmIdentifier}
@@ -2640,35 +2653,41 @@ export interface RankingFilter {
  */
 export interface RankingFilterRankingFilter {
     /**
-     *
+     * References to the attributes to be used when filtering.
+     * @type {Array<AfmIdentifier>}
+     * @memberof RankingFilterRankingFilter
+     */
+    dimensionality?: Array<AfmIdentifier>;
+    /**
+     * References to the metrics to be used when filtering.
      * @type {Array<AfmIdentifier>}
      * @memberof RankingFilterRankingFilter
      */
     measures: Array<AfmIdentifier>;
     /**
-     *
+     * The type of ranking to use, TOP or BOTTOM.
      * @type {string}
      * @memberof RankingFilterRankingFilter
      */
     operator: RankingFilterRankingFilterOperatorEnum;
     /**
-     *
+     * Number of top/bottom values to filter.
      * @type {number}
      * @memberof RankingFilterRankingFilter
      */
     value: number;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof RankingFilterRankingFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof RankingFilterRankingFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
 }
 export declare const RankingFilterRankingFilterOperatorEnum: {
     readonly TOP: "TOP";
@@ -2714,16 +2733,16 @@ export interface RelativeDateFilterRelativeDateFilter {
     to: number;
     /**
      *
-     * @type {boolean}
+     * @type {string}
      * @memberof RelativeDateFilterRelativeDateFilter
      */
-    applyOnResult?: boolean;
+    localIdentifier?: string;
     /**
      *
-     * @type {string}
+     * @type {boolean}
      * @memberof RelativeDateFilterRelativeDateFilter
      */
-    localIdentifier?: string;
+    applyOnResult?: boolean;
     /**
      *
      * @type {AfmObjectIdentifierDataset}
@@ -2800,7 +2819,7 @@ export interface ResultCacheMetadata {
     resultSize: number;
 }
 /**
- *
+ * Single result dimension
  * @export
  * @interface ResultDimension
  */
@@ -2812,7 +2831,7 @@ export interface ResultDimension {
      */
     headers: Array<ResultDimensionHeader>;
     /**
-     *
+     * Local identifier of the dimension.
      * @type {string}
      * @memberof ResultDimension
      */
@@ -2820,9 +2839,10 @@ export interface ResultDimension {
 }
 /**
  * @type ResultDimensionHeader
+ * One of the headers in a result dimension.
  * @export
  */
-export type ResultDimensionHeader = AttributeHeaderOut | MeasureGroupHeaders;
+export type ResultDimensionHeader = AttributeHeader | MeasureGroupHeaders;
 /**
  * Specifies how the result data will be formatted (```dimensions```) and which additional data shall be computed (```totals```).
  * @export
@@ -3084,7 +3104,7 @@ export interface SearchResultObject {
     scoreExactMatch?: number;
 }
 /**
- *
+ * Metric defined by referencing a MAQL metric or an LDM fact object with aggregation.
  * @export
  * @interface SimpleMeasureDefinition
  */
@@ -3115,7 +3135,7 @@ export interface SimpleMeasureDefinitionMeasure {
      */
     aggregation?: SimpleMeasureDefinitionMeasureAggregationEnum;
     /**
-     * If true compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
+     * If true, compute the percentage of given metric values (broken down by AFM attributes) to the total (not broken down).
      * @type {boolean}
      * @memberof SimpleMeasureDefinitionMeasure
      */
@@ -3226,7 +3246,7 @@ export interface SortKeyTotal {
  */
 export interface SortKeyTotalTotal {
     /**
-     *
+     * Local identifier of the total to sort by.
      * @type {string}
      * @memberof SortKeyTotalTotal
      */