@gooddata/api-client-tiger 11.61.0-alpha.1 → 11.61.0-alpha.3

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

@@ -772,7 +772,7 @@ export interface AiComposeAnswerDetail {
     'suggestedActions'?: number | null;
 }
 export type AiComposeAnswerDetailCategoryEnum = 'composeAnswer';
-export type AiComposeAnswerDetailOutputEnum = 'text' | 'visualization' | 'dashboard' | 'keyDriverAnalysis' | 'whatIf' | 'searchResults' | 'alertProposal' | 'clarifyingQuestions';
+export type AiComposeAnswerDetailOutputEnum = 'text' | 'visualization' | 'dashboard' | 'report' | 'keyDriverAnalysis' | 'whatIf' | 'searchResults' | 'alertProposal' | 'clarifyingQuestions';
 export interface AiCompoundMeasureValueFilter {
     'compoundMeasureValueFilter': AiCompoundMeasureValueFilterBody;
 }
@@ -2367,6 +2367,8 @@ export type AiMultipartContentPartsInner = ({
 } & AiDashboardPatchPart) | ({
     type: 'kda';
 } & AiKeyDriverAnalysisPart) | ({
+    type: 'report';
+} & AiReportPart) | ({
     type: 'searchResults';
 } & AiSearchResults) | ({
     type: 'text';
@@ -3253,6 +3255,36 @@ export declare const AiRenderAs: {
     readonly OUTLINE: 'outline';
 };
 export type AiRenderAs = typeof AiRenderAs[keyof typeof AiRenderAs];
+/**
+ * PATCH /conversations/{conversationId}/reports/{reportRef} body.
+ */
+export interface AiReportIdUpdateRequest {
+    /**
+     * Id of the report entity the client saved the draft as.
+     */
+    'id': string;
+}
+/**
+ * A report draft the assistant composed, resolved from conversation state.  Like a dashboard draft it is not persisted until the user saves it; ``report`` is null when the ref no longer resolves, so the client can still show that a report was promised. Every refinement is a new version under a new ``report_ref``, so an earlier card keeps its version.
+ */
+export interface AiReportPart {
+    'base_report_id'?: string | null;
+    /**
+     * Shape of `report`: the Analytics-as-Code report document, v1.
+     */
+    'format'?: AiReportPartFormatEnum;
+    'page_count'?: number | null;
+    'report'?: object | null;
+    'refines_ref'?: string | null;
+    'report_ref'?: string | null;
+    'saved_report_id'?: string | null;
+    /**
+     * Type of multipart part.
+     */
+    'type'?: AiReportPartTypeEnum;
+}
+export type AiReportPartFormatEnum = 'aac-v1';
+export type AiReportPartTypeEnum = 'report';
 export declare const AiRequestedReasoningEffort: {
     readonly LOW: 'LOW';
     readonly MEDIUM: 'MEDIUM';
@@ -4217,6 +4249,18 @@ export interface AiUserContextObjectReferenceGroup {
     'context'?: AiUserContextObjectReference | null;
     'objects': Array<AiUserContextObjectReference>;
 }
+/**
+ * The report open in the report editor, so refinements can target it without an id.
+ */
+export interface AiUserContextReport {
+    'definition'?: object | null;
+    /**
+     * `report_ref` of the conversation draft open in the editor while it is not saved yet. A change the assistant makes to it is then a new version of that draft, not a new report. Optional.
+     */
+    'draftRef'?: string | null;
+    'id'?: string | null;
+    'title'?: string | null;
+}
 export interface AiUserContextRichTextWidgetDescriptor {
     'content'?: string | null;
     'filters'?: Array<AiVisualizationFilter> | null;
@@ -4233,6 +4277,7 @@ export interface AiUserContextSwitcherVisualization {
 }
 export interface AiUserContextView {
     'dashboard'?: AiUserContextDashboard | null;
+    'report'?: AiUserContextReport | null;
 }
 export interface AiUserContextVisualizationSwitcherWidgetDescriptor {
     'activeVisualizationId': string;
@@ -5459,6 +5504,18 @@ export declare function ConversationsAiAxiosParamCreator_PatchConversationApiV1A
  * @throws {RequiredError}
  */
 export declare function ConversationsAiAxiosParamCreator_PatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatch(workspaceId: string, conversationId: string, dashboardId: string, aiDashboardIdUpdateRequest: AiDashboardIdUpdateRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
+/**
+ * Records the report entity the user saved the conversation\'s report draft as.
+ * @summary Link a saved report
+ * @param {string} workspaceId
+ * @param {string} conversationId
+ * @param {string} reportRef
+ * @param {AiReportIdUpdateRequest} aiReportIdUpdateRequest
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ConversationsAiAxiosParamCreator_PatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch(workspaceId: string, conversationId: string, reportRef: string, aiReportIdUpdateRequest: AiReportIdUpdateRequest, options?: AxiosRequestConfig, configuration?: Configuration): Promise<RequestArgs>;
 /**
  * Attaches positive or negative feedback, with optional free-text, to one response.
  * @summary Rate a response
@@ -5625,6 +5682,17 @@ export declare function ConversationsAi_PatchConversationApiV1AiWorkspacesWorksp
  * @throws {RequiredError}
  */
 export declare function ConversationsAi_PatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatch(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiPatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatchRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
+/**
+ * Records the report entity the user saved the conversation\'s report draft as.
+ * @summary Link a saved report
+ * @param {AxiosInstance} axios Axios instance.
+ * @param {string} basePath Base path.
+ * @param {ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest} requestParameters Request parameters.
+ * @param {*} [options] Override http request option.
+ * @param {Configuration} [configuration] Optional configuration.
+ * @throws {RequiredError}
+ */
+export declare function ConversationsAi_PatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch(axios: AxiosInstance, basePath: string, requestParameters: ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest, options?: AxiosRequestConfig, configuration?: Configuration): AxiosPromise<void>;
 /**
  * Attaches positive or negative feedback, with optional free-text, to one response.
  * @summary Rate a response
@@ -5780,6 +5848,15 @@ export interface ConversationsAiInterface {
      * @memberof ConversationsAiInterface
      */
     patchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatch(requestParameters: ConversationsAiPatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Records the report entity the user saved the conversation\'s report draft as.
+     * @summary Link a saved report
+     * @param {ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationsAiInterface
+     */
+    patchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch(requestParameters: ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Attaches positive or negative feedback, with optional free-text, to one response.
      * @summary Rate a response
@@ -6032,6 +6109,37 @@ export interface ConversationsAiPatchDashboardApiV1AiWorkspacesWorkspaceIdChatCo
      */
     readonly aiDashboardIdUpdateRequest: AiDashboardIdUpdateRequest;
 }
+/**
+ * Request parameters for patchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch operation in ConversationsAi.
+ * @export
+ * @interface ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest
+ */
+export interface ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest {
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch
+     */
+    readonly workspaceId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch
+     */
+    readonly conversationId: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch
+     */
+    readonly reportRef: string;
+    /**
+     *
+     * @type {AiReportIdUpdateRequest}
+     * @memberof ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch
+     */
+    readonly aiReportIdUpdateRequest: AiReportIdUpdateRequest;
+}
 /**
  * Request parameters for patchResponseApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdResponsesResponseIdPatch operation in ConversationsAi.
  * @export
@@ -6292,6 +6400,15 @@ export declare class ConversationsAi extends BaseAPI implements ConversationsAiI
      * @memberof ConversationsAi
      */
     patchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatch(requestParameters: ConversationsAiPatchDashboardApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdDashboardsDashboardIdPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Records the report entity the user saved the conversation\'s report draft as.
+     * @summary Link a saved report
+     * @param {ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationsAi
+     */
+    patchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatch(requestParameters: ConversationsAiPatchReportApiV1AiWorkspacesWorkspaceIdChatConversationsConversationIdReportsReportRefPatchRequest, options?: AxiosRequestConfig): AxiosPromise<void>;
     /**
      * Attaches positive or negative feedback, with optional free-text, to one response.
      * @summary Rate a response