@gooddata/api-client-tiger 11.22.0-alpha.5 → 11.22.0-alpha.6

package/esm/__version.d.ts

@@ -1,4 +1,4 @@
-export declare const LIB_VERSION = "11.22.0-alpha.5";
+export declare const LIB_VERSION = "11.22.0-alpha.6";
 export declare const LIB_DESCRIPTION = "API Client for GoodData Cloud and GoodData.CN";
 export declare const LIB_NAME = "@gooddata/api-client-tiger";
 //# sourceMappingURL=__version.d.ts.map

package/esm/__version.js

@@ -1,6 +1,6 @@
 // (C) 2021 GoodData Corporation
 // DO NOT CHANGE THIS FILE, IT IS RE-GENERATED ON EVERY BUILD
-export const LIB_VERSION = "11.22.0-alpha.5";
+export const LIB_VERSION = "11.22.0-alpha.6";
 export const LIB_DESCRIPTION = "API Client for GoodData Cloud and GoodData.CN";
 export const LIB_NAME = "@gooddata/api-client-tiger";
 //# sourceMappingURL=__version.js.map

package/esm/api-client-tiger.d.ts

@@ -2133,6 +2133,26 @@ declare interface ActionsApiGenerateDashboardSummaryRequest {
     readonly workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto;
 }
 
+/**
+ * Request parameters for generateDescription operation in ActionsApi.
+ * @export
+ * @interface ActionsApiGenerateDescriptionRequest
+ */
+declare interface ActionsApiGenerateDescriptionRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiGenerateDescription
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {GenerateDescriptionRequest}
+     * @memberof ActionsApiGenerateDescription
+     */
+    readonly generateDescriptionRequest: GenerateDescriptionRequest;
+}
+
 /**
  * Request parameters for generateLogicalModel operation in ActionsApi.
  * @export
@@ -5027,6 +5047,15 @@ export declare class AfmActionsApi extends LabelElementsBaseApi implements AfmAc
      * @memberof ActionsApi
      */
     generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {ActionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    generateDescription(requestParameters: ActionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -5401,6 +5430,15 @@ export declare interface AfmActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {ActionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    generateDescription(requestParameters: ActionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -14796,6 +14834,7 @@ export declare interface CreatedVisualization {
      * Saved visualization ID.
      */
     'savedVisualizationId'?: string;
+    'config'?: VisualizationConfig;
 }
 
 /**
@@ -44461,6 +44500,24 @@ export declare interface FilterViewsApiUpdateEntityFilterViewsRequest {
     readonly include?: Array<'analyticalDashboards' | 'users' | 'analyticalDashboard' | 'user' | 'ALL'>;
 }
 
+/**
+ * Forecast configuration.
+ */
+declare interface ForecastConfig {
+    /**
+     * Number of future periods that should be forecasted
+     */
+    'forecastPeriod': number;
+    /**
+     * Confidence interval boundary value.
+     */
+    'confidenceLevel': number;
+    /**
+     * Whether the input data is seasonal
+     */
+    'seasonal': boolean;
+}
+
 export declare interface ForecastRequest {
     /**
      * Number of future periods that should be forecasted
@@ -44538,6 +44595,30 @@ export declare interface GdStorageFile {
 
 export declare type GdStorageFileTypeEnum = 'CSV';
 
+declare interface GenerateDescriptionRequest {
+    /**
+     * Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute
+     */
+    'objectType': GenerateDescriptionRequestObjectTypeEnum;
+    /**
+     * Identifier of the object to describe
+     */
+    'objectId': string;
+}
+
+declare type GenerateDescriptionRequestObjectTypeEnum = 'Visualization' | 'Dashboard' | 'Metric' | 'Fact' | 'Attribute';
+
+declare interface GenerateDescriptionResponse {
+    /**
+     * Generated description of the requested object
+     */
+    'description'?: string;
+    /**
+     * Additional note with details in case generation was not performed
+     */
+    'note'?: string;
+}
+
 /**
  * A request containing all information needed for generation of logical model.
  */
@@ -76433,6 +76514,13 @@ export declare interface VisualExportRequest {
     'metadata'?: object;
 }
 
+/**
+ * Visualization config for smart-function rendering.
+ */
+export declare interface VisualizationConfig {
+    'forecast'?: ForecastConfig;
+}
+
 /**
  * VisualizationObjectApi - object-oriented interface
  * @export

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

@@ -762,6 +762,7 @@ export interface CreatedVisualization {
      * Saved visualization ID.
      */
     'savedVisualizationId'?: string;
+    'config'?: VisualizationConfig;
 }
 export type CreatedVisualizationVisualizationTypeEnum = 'TABLE' | 'HEADLINE' | 'BAR' | 'LINE' | 'PIE' | 'COLUMN';
 /**
@@ -1134,6 +1135,23 @@ export type FilterDefinition = AbsoluteDateFilter | AllTimeDateFilter | Comparis
  * Abstract filter definition type for simple metric.
  */
 export type FilterDefinitionForSimpleMeasure = AttributeFilter | DateFilter;
+/**
+ * Forecast configuration.
+ */
+export interface ForecastConfig {
+    /**
+     * Number of future periods that should be forecasted
+     */
+    'forecastPeriod': number;
+    /**
+     * Confidence interval boundary value.
+     */
+    'confidenceLevel': number;
+    /**
+     * Whether the input data is seasonal
+     */
+    'seasonal': boolean;
+}
 export interface ForecastRequest {
     /**
      * Number of future periods that should be forecasted
@@ -1168,6 +1186,27 @@ export interface FoundObjects {
      */
     'reasoning': string;
 }
+export interface GenerateDescriptionRequest {
+    /**
+     * Type of the object to describe. One of: visualization, dashboard, metric, fact, attribute
+     */
+    'objectType': GenerateDescriptionRequestObjectTypeEnum;
+    /**
+     * Identifier of the object to describe
+     */
+    'objectId': string;
+}
+export type GenerateDescriptionRequestObjectTypeEnum = 'Visualization' | 'Dashboard' | 'Metric' | 'Fact' | 'Attribute';
+export interface GenerateDescriptionResponse {
+    /**
+     * Generated description of the requested object
+     */
+    'description'?: string;
+    /**
+     * Additional note with details in case generation was not performed
+     */
+    'note'?: string;
+}
 /**
  * Configuration specific to geo area labels.
  */
@@ -2282,6 +2321,12 @@ export interface ValidateLLMEndpointResponse {
      */
     'message': string;
 }
+/**
+ * Visualization config for smart-function rendering.
+ */
+export interface VisualizationConfig {
+    'forecast'?: ForecastConfig;
+}
 export interface WorkflowDashboardSummaryRequestDto {
     'dashboardId': string;
     'keyMetricIds'?: Array<string>;
@@ -2770,6 +2815,16 @@ export declare function ActionsApiAxiosParamCreator_ForecastResult(workspaceId:
  * @throws {RequiredError}
  */
 export declare function ActionsApiAxiosParamCreator_GenerateDashboardSummary(workspaceId: string, workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+ * @summary Generate Description for Analytics Object
+ * @param {string} workspaceId Workspace identifier
+ * @param {GenerateDescriptionRequest} generateDescriptionRequest
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApiAxiosParamCreator_GenerateDescription(workspaceId: string, generateDescriptionRequest: GenerateDescriptionRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -3165,6 +3220,17 @@ export declare function ActionsApi_ForecastResult(axios: AxiosInstance, basePath
  * @throws {RequiredError}
  */
 export declare function ActionsApi_GenerateDashboardSummary(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
+/**
+ * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+ * @summary Generate Description for Analytics Object
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ActionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ActionsApi_GenerateDescription(axios: AxiosInstance, basePath: string, requestParameters: ActionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<GenerateDescriptionResponse>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -3533,6 +3599,15 @@ export interface ActionsApiInterface {
      * @memberof ActionsApiInterface
      */
     generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {ActionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApiInterface
+     */
+    generateDescription(requestParameters: ActionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -4182,6 +4257,25 @@ export interface ActionsApiGenerateDashboardSummaryRequest {
      */
     readonly workflowDashboardSummaryRequestDto: WorkflowDashboardSummaryRequestDto;
 }
+/**
+ * Request parameters for generateDescription operation in ActionsApi.
+ * @export
+ * @interface ActionsApiGenerateDescriptionRequest
+ */
+export interface ActionsApiGenerateDescriptionRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof ActionsApiGenerateDescription
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {GenerateDescriptionRequest}
+     * @memberof ActionsApiGenerateDescription
+     */
+    readonly generateDescriptionRequest: GenerateDescriptionRequest;
+}
 /**
  * Request parameters for getQualityIssues operation in ActionsApi.
  * @export
@@ -4696,6 +4790,15 @@ export declare class ActionsApi extends BaseAPI implements ActionsApiInterface {
      * @memberof ActionsApi
      */
     generateDashboardSummary(requestParameters: ActionsApiGenerateDashboardSummaryRequest, options?: AxiosRequestConfig): AxiosPromise<WorkflowDashboardSummaryResponseDto>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {ActionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActionsApi
+     */
+    generateDescription(requestParameters: ActionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -5900,6 +6003,16 @@ export declare function SmartFunctionsApiAxiosParamCreator_Forecast(workspaceId:
  * @throws {RequiredError}
  */
 export declare function SmartFunctionsApiAxiosParamCreator_ForecastResult(workspaceId: string, resultId: string, offset?: number, limit?: number, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+ * @summary Generate Description for Analytics Object
+ * @param {string} workspaceId Workspace identifier
+ * @param {GenerateDescriptionRequest} generateDescriptionRequest
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function SmartFunctionsApiAxiosParamCreator_GenerateDescription(workspaceId: string, generateDescriptionRequest: GenerateDescriptionRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -6106,6 +6219,17 @@ export declare function SmartFunctionsApi_Forecast(axios: AxiosInstance, basePat
  * @throws {RequiredError}
  */
 export declare function SmartFunctionsApi_ForecastResult(axios: AxiosInstance, basePath: string, requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<ForecastResult>;
+/**
+ * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+ * @summary Generate Description for Analytics Object
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {SmartFunctionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function SmartFunctionsApi_GenerateDescription(axios: AxiosInstance, basePath: string, requestParameters: SmartFunctionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<GenerateDescriptionResponse>;
 /**
  * Returns metadata quality issues detected by the platform linter.
  * @summary Get Quality Issues
@@ -6308,6 +6432,15 @@ export interface SmartFunctionsApiInterface {
      * @memberof SmartFunctionsApiInterface
      */
     forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {SmartFunctionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SmartFunctionsApiInterface
+     */
+    generateDescription(requestParameters: SmartFunctionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues
@@ -6669,6 +6802,25 @@ export interface SmartFunctionsApiForecastResultRequest {
      */
     readonly limit?: number;
 }
+/**
+ * Request parameters for generateDescription operation in SmartFunctionsApi.
+ * @export
+ * @interface SmartFunctionsApiGenerateDescriptionRequest
+ */
+export interface SmartFunctionsApiGenerateDescriptionRequest {
+    /**
+     * Workspace identifier
+     * @type {string}
+     * @memberof SmartFunctionsApiGenerateDescription
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {GenerateDescriptionRequest}
+     * @memberof SmartFunctionsApiGenerateDescription
+     */
+    readonly generateDescriptionRequest: GenerateDescriptionRequest;
+}
 /**
  * Request parameters for getQualityIssues operation in SmartFunctionsApi.
  * @export
@@ -6900,6 +7052,15 @@ export declare class SmartFunctionsApi extends BaseAPI implements SmartFunctions
      * @memberof SmartFunctionsApi
      */
     forecastResult(requestParameters: SmartFunctionsApiForecastResultRequest, options?: AxiosRequestConfig): AxiosPromise<ForecastResult>;
+    /**
+     * Generates a description for the specified analytics object. Returns description and a note with details if generation was not performed.
+     * @summary Generate Description for Analytics Object
+     * @param {SmartFunctionsApiGenerateDescriptionRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SmartFunctionsApi
+     */
+    generateDescription(requestParameters: SmartFunctionsApiGenerateDescriptionRequest, options?: AxiosRequestConfig): AxiosPromise<GenerateDescriptionResponse>;
     /**
      * Returns metadata quality issues detected by the platform linter.
      * @summary Get Quality Issues