@gooddata/api-client-tiger 9.10.0-alpha.8 → 10.0.0-alpha.1

package/esm/generated/afm-rest-api/openapi-spec.json

@@ -17,6 +17,68 @@
         }
     ],
     "paths": {
+        "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/{resultId}": {
+            "post": {
+                "tags": ["Smart Functions", "actions"],
+                "summary": "(BETA) Smart functions - Forecast",
+                "description": "(BETA) Computes forecasted data points from the provided execution result and parameters.",
+                "operationId": "forecast",
+                "parameters": [
+                    {
+                        "name": "workspaceId",
+                        "in": "path",
+                        "description": "Workspace identifier",
+                        "required": true,
+                        "schema": {
+                            "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "name": "resultId",
+                        "in": "path",
+                        "description": "Input result ID to be used in the computation",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        },
+                        "example": "9bd52018570364264fcf62d373da6bed313120e8"
+                    },
+                    {
+                        "name": "skip-cache",
+                        "in": "header",
+                        "description": "Ignore all caches during execution of current request.",
+                        "required": false,
+                        "schema": {
+                            "type": "boolean",
+                            "default": false
+                        }
+                    }
+                ],
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "$ref": "#/components/schemas/ForecastRequest"
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/SmartFunctionResponse"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/actions/workspaces/{workspaceId}/execution/collectLabelElements": {
             "post": {
                 "tags": ["Computation", "actions"],
@@ -329,6 +391,66 @@
                 }
             }
         },
+        "/api/v1/actions/workspaces/{workspaceId}/execution/functions/forecast/result/{resultId}": {
+            "get": {
+                "tags": ["Smart Functions", "actions"],
+                "summary": "(BETA) Smart functions - Forecast Result",
+                "description": "(BETA) Gets forecast result.",
+                "operationId": "forecastResult",
+                "parameters": [
+                    {
+                        "name": "workspaceId",
+                        "in": "path",
+                        "description": "Workspace identifier",
+                        "required": true,
+                        "schema": {
+                            "pattern": "^(?!\\.)[.A-Za-z0-9_-]{1,255}$",
+                            "type": "string"
+                        }
+                    },
+                    {
+                        "name": "resultId",
+                        "in": "path",
+                        "description": "Result ID",
+                        "required": true,
+                        "schema": {
+                            "type": "string"
+                        },
+                        "example": "a9b28f9dc55f37ea9f4a5fb0c76895923591e781"
+                    },
+                    {
+                        "name": "offset",
+                        "in": "query",
+                        "required": false,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int32"
+                        }
+                    },
+                    {
+                        "name": "limit",
+                        "in": "query",
+                        "required": false,
+                        "schema": {
+                            "type": "integer",
+                            "format": "int32"
+                        }
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "description": "OK",
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "$ref": "#/components/schemas/ForecastResult"
+                                }
+                            }
+                        }
+                    }
+                }
+            }
+        },
         "/api/v1/actions/workspaces/{workspaceId}/execution/afm/execute/result/{resultId}/metadata": {
             "get": {
                 "tags": ["Computation", "actions"],
@@ -474,6 +596,50 @@
     },
     "components": {
         "schemas": {
+            "ForecastRequest": {
+                "required": ["forecastPeriod"],
+                "type": "object",
+                "properties": {
+                    "forecastPeriod": {
+                        "type": "integer",
+                        "description": "Number of future periods that should be forecasted",
+                        "format": "int32"
+                    },
+                    "confidenceLevel": {
+                        "maximum": 1,
+                        "exclusiveMaximum": true,
+                        "minimum": 0,
+                        "exclusiveMinimum": true,
+                        "type": "number",
+                        "description": "Confidence interval boundary value.",
+                        "format": "float",
+                        "default": 0.95
+                    },
+                    "seasonal": {
+                        "type": "boolean",
+                        "description": "Whether the input data is seasonal",
+                        "default": false
+                    }
+                }
+            },
+            "ExecutionLinks": {
+                "required": ["executionResult"],
+                "type": "object",
+                "properties": {
+                    "executionResult": {
+                        "type": "string"
+                    }
+                }
+            },
+            "SmartFunctionResponse": {
+                "required": ["links"],
+                "type": "object",
+                "properties": {
+                    "links": {
+                        "$ref": "#/components/schemas/ExecutionLinks"
+                    }
+                }
+            },
             "AttributeFormat": {
                 "required": ["locale", "pattern"],
                 "type": "object",
@@ -1830,20 +1996,15 @@
                             },
                             "format": {
                                 "$ref": "#/components/schemas/AttributeFormat"
+                            },
+                            "valueType": {
+                                "type": "string",
+                                "enum": ["TEXT", "HYPERLINK", "GEO", "GEO_LONGITUDE", "GEO_LATITUDE", "IMAGE"]
                             }
                         }
                     }
                 }
             },
-            "ExecutionLinks": {
-                "required": ["executionResult"],
-                "type": "object",
-                "properties": {
-                    "executionResult": {
-                        "type": "string"
-                    }
-                }
-            },
             "ExecutionResponse": {
                 "required": ["dimensions", "links"],
                 "type": "object",
@@ -1976,6 +2137,46 @@
                 },
                 "description": "Entity describing the valid descendants response."
             },
+            "ForecastResult": {
+                "required": ["attribute", "lowerBound", "origin", "prediction", "upperBound"],
+                "type": "object",
+                "properties": {
+                    "attribute": {
+                        "type": "array",
+                        "items": {
+                            "type": "string"
+                        }
+                    },
+                    "origin": {
+                        "type": "array",
+                        "items": {
+                            "type": "number",
+                            "nullable": true
+                        }
+                    },
+                    "prediction": {
+                        "type": "array",
+                        "items": {
+                            "type": "number",
+                            "nullable": true
+                        }
+                    },
+                    "lowerBound": {
+                        "type": "array",
+                        "items": {
+                            "type": "number",
+                            "nullable": true
+                        }
+                    },
+                    "upperBound": {
+                        "type": "array",
+                        "items": {
+                            "type": "number",
+                            "nullable": true
+                        }
+                    }
+                }
+            },
             "ResultCacheMetadata": {
                 "required": ["afm", "executionResponse", "resultSize", "resultSpec"],
                 "type": "object",

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

@@ -9101,15 +9101,82 @@ export interface JsonApiOrganizationIn {
     id: string;
     /**
      *
-     * @type {JsonApiOrganizationPatchAttributes}
+     * @type {JsonApiOrganizationInAttributes}
      * @memberof JsonApiOrganizationIn
      */
-    attributes?: JsonApiOrganizationPatchAttributes;
+    attributes?: JsonApiOrganizationInAttributes;
 }
 export declare const JsonApiOrganizationInTypeEnum: {
     readonly ORGANIZATION: "organization";
 };
 export type JsonApiOrganizationInTypeEnum = typeof JsonApiOrganizationInTypeEnum[keyof typeof JsonApiOrganizationInTypeEnum];
+/**
+ *
+ * @export
+ * @interface JsonApiOrganizationInAttributes
+ */
+export interface JsonApiOrganizationInAttributes {
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    name?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    hostname?: string;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    allowedOrigins?: Array<string>;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    oauthIssuerLocation?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    oauthClientId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    oauthClientSecret?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    earlyAccess?: string;
+    /**
+     * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    oauthIssuerId?: string;
+    /**
+     * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
+     * @type {string}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    oauthSubjectIdClaim?: string;
+    /**
+     * Flag to enable/disable JIT provisioning in the given organization
+     * @type {boolean}
+     * @memberof JsonApiOrganizationInAttributes
+     */
+    jitEnabled?: boolean;
+}
 /**
  *
  * @export
@@ -9368,82 +9435,15 @@ export interface JsonApiOrganizationPatch {
     id: string;
     /**
      *
-     * @type {JsonApiOrganizationPatchAttributes}
+     * @type {JsonApiOrganizationInAttributes}
      * @memberof JsonApiOrganizationPatch
      */
-    attributes?: JsonApiOrganizationPatchAttributes;
+    attributes?: JsonApiOrganizationInAttributes;
 }
 export declare const JsonApiOrganizationPatchTypeEnum: {
     readonly ORGANIZATION: "organization";
 };
 export type JsonApiOrganizationPatchTypeEnum = typeof JsonApiOrganizationPatchTypeEnum[keyof typeof JsonApiOrganizationPatchTypeEnum];
-/**
- *
- * @export
- * @interface JsonApiOrganizationPatchAttributes
- */
-export interface JsonApiOrganizationPatchAttributes {
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    name?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    hostname?: string;
-    /**
-     *
-     * @type {Array<string>}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    allowedOrigins?: Array<string>;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    oauthIssuerLocation?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    oauthClientId?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    oauthClientSecret?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    earlyAccess?: string;
-    /**
-     * Any string identifying the OIDC provider. This value is used as suffix for OAuth2 callback (redirect) URL. If not defined, the standard callback URL is used. This value is valid only for external OIDC providers, not for the internal DEX provider.
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    oauthIssuerId?: string;
-    /**
-     * Any string identifying the claim in ID token, that should be used for user identification. The default value is \'sub\'.
-     * @type {string}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    oauthSubjectIdClaim?: string;
-    /**
-     * Flag to enable/disable JIT provisioning in the given organization
-     * @type {boolean}
-     * @memberof JsonApiOrganizationPatchAttributes
-     */
-    jitEnabled?: boolean;
-}
 /**
  *
  * @export
@@ -9477,10 +9477,10 @@ export interface JsonApiOrganizationSettingIn {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiOrganizationSettingIn
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiOrganizationSettingInTypeEnum: {
     readonly ORGANIZATION_SETTING: "organizationSetting";
@@ -9519,10 +9519,10 @@ export interface JsonApiOrganizationSettingOut {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiOrganizationSettingOut
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiOrganizationSettingOutTypeEnum: {
     readonly ORGANIZATION_SETTING: "organizationSetting";
@@ -9592,10 +9592,10 @@ export interface JsonApiOrganizationSettingOutWithLinks {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiOrganizationSettingOutWithLinks
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
     /**
      *
      * @type {ObjectLinks}
@@ -9627,10 +9627,10 @@ export interface JsonApiOrganizationSettingPatch {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiOrganizationSettingPatch
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiOrganizationSettingPatchTypeEnum: {
     readonly ORGANIZATION_SETTING: "organizationSetting";
@@ -11049,49 +11049,15 @@ export interface JsonApiUserSettingIn {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiUserSettingIn
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiUserSettingInTypeEnum: {
     readonly USER_SETTING: "userSetting";
 };
 export type JsonApiUserSettingInTypeEnum = typeof JsonApiUserSettingInTypeEnum[keyof typeof JsonApiUserSettingInTypeEnum];
-/**
- *
- * @export
- * @interface JsonApiUserSettingInAttributes
- */
-export interface JsonApiUserSettingInAttributes {
-    /**
-     * Free-form JSON content. Maximum supported length is 15000 characters.
-     * @type {object}
-     * @memberof JsonApiUserSettingInAttributes
-     */
-    content?: object;
-    /**
-     *
-     * @type {string}
-     * @memberof JsonApiUserSettingInAttributes
-     */
-    type?: JsonApiUserSettingInAttributesTypeEnum;
-}
-export declare const JsonApiUserSettingInAttributesTypeEnum: {
-    readonly TIMEZONE: "TIMEZONE";
-    readonly ACTIVE_THEME: "ACTIVE_THEME";
-    readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
-    readonly WHITE_LABELING: "WHITE_LABELING";
-    readonly LOCALE: "LOCALE";
-    readonly METADATA_LOCALE: "METADATA_LOCALE";
-    readonly FORMAT_LOCALE: "FORMAT_LOCALE";
-    readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
-    readonly WEEK_START: "WEEK_START";
-    readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
-    readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
-    readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
-};
-export type JsonApiUserSettingInAttributesTypeEnum = typeof JsonApiUserSettingInAttributesTypeEnum[keyof typeof JsonApiUserSettingInAttributesTypeEnum];
 /**
  *
  * @export
@@ -11125,15 +11091,49 @@ export interface JsonApiUserSettingOut {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiUserSettingOut
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiUserSettingOutTypeEnum: {
     readonly USER_SETTING: "userSetting";
 };
 export type JsonApiUserSettingOutTypeEnum = typeof JsonApiUserSettingOutTypeEnum[keyof typeof JsonApiUserSettingOutTypeEnum];
+/**
+ *
+ * @export
+ * @interface JsonApiUserSettingOutAttributes
+ */
+export interface JsonApiUserSettingOutAttributes {
+    /**
+     * Free-form JSON content. Maximum supported length is 15000 characters.
+     * @type {object}
+     * @memberof JsonApiUserSettingOutAttributes
+     */
+    content?: object;
+    /**
+     *
+     * @type {string}
+     * @memberof JsonApiUserSettingOutAttributes
+     */
+    type?: JsonApiUserSettingOutAttributesTypeEnum;
+}
+export declare const JsonApiUserSettingOutAttributesTypeEnum: {
+    readonly TIMEZONE: "TIMEZONE";
+    readonly ACTIVE_THEME: "ACTIVE_THEME";
+    readonly ACTIVE_COLOR_PALETTE: "ACTIVE_COLOR_PALETTE";
+    readonly WHITE_LABELING: "WHITE_LABELING";
+    readonly LOCALE: "LOCALE";
+    readonly METADATA_LOCALE: "METADATA_LOCALE";
+    readonly FORMAT_LOCALE: "FORMAT_LOCALE";
+    readonly MAPBOX_TOKEN: "MAPBOX_TOKEN";
+    readonly WEEK_START: "WEEK_START";
+    readonly SHOW_HIDDEN_CATALOG_ITEMS: "SHOW_HIDDEN_CATALOG_ITEMS";
+    readonly OPERATOR_OVERRIDES: "OPERATOR_OVERRIDES";
+    readonly TIMEZONE_VALIDATION_ENABLED: "TIMEZONE_VALIDATION_ENABLED";
+};
+export type JsonApiUserSettingOutAttributesTypeEnum = typeof JsonApiUserSettingOutAttributesTypeEnum[keyof typeof JsonApiUserSettingOutAttributesTypeEnum];
 /**
  *
  * @export
@@ -11198,10 +11198,10 @@ export interface JsonApiUserSettingOutWithLinks {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiUserSettingOutWithLinks
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
     /**
      *
      * @type {ObjectLinks}
@@ -12614,10 +12614,10 @@ export interface JsonApiWorkspaceSettingIn {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiWorkspaceSettingIn
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiWorkspaceSettingInTypeEnum: {
     readonly WORKSPACE_SETTING: "workspaceSetting";
@@ -12662,10 +12662,10 @@ export interface JsonApiWorkspaceSettingOut {
     meta?: JsonApiAttributeHierarchyOutMeta;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiWorkspaceSettingOut
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiWorkspaceSettingOutTypeEnum: {
     readonly WORKSPACE_SETTING: "workspaceSetting";
@@ -12741,10 +12741,10 @@ export interface JsonApiWorkspaceSettingOutWithLinks {
     meta?: JsonApiAttributeHierarchyOutMeta;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiWorkspaceSettingOutWithLinks
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
     /**
      *
      * @type {ObjectLinks}
@@ -12776,10 +12776,10 @@ export interface JsonApiWorkspaceSettingPatch {
     id: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiWorkspaceSettingPatch
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiWorkspaceSettingPatchTypeEnum: {
     readonly WORKSPACE_SETTING: "workspaceSetting";
@@ -12818,10 +12818,10 @@ export interface JsonApiWorkspaceSettingPostOptionalId {
     id?: string;
     /**
      *
-     * @type {JsonApiUserSettingInAttributes}
+     * @type {JsonApiUserSettingOutAttributes}
      * @memberof JsonApiWorkspaceSettingPostOptionalId
      */
-    attributes?: JsonApiUserSettingInAttributes;
+    attributes?: JsonApiUserSettingOutAttributes;
 }
 export declare const JsonApiWorkspaceSettingPostOptionalIdTypeEnum: {
     readonly WORKSPACE_SETTING: "workspaceSetting";