@widgetic/api-sdk 1.0.10 → 1.0.15

package/dist/apis/CompositionsApi.d.ts

@@ -10,46 +10,129 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { Composition, CompositionVersion, CreateCompositionRequest, GetAllCompositions200Response, UpdateCompositionRequest, UpdateCompositionStatusRequest } from '../models/index';
-export interface CreateCompositionOperationRequest {
-    createCompositionRequest: CreateCompositionRequest;
+import type { CheckCompositionAccess200Response, Composition, CompositionVersion, CreateComposition201Response, DuplicateComposition202Response, DuplicateCompositionRequest, GetAllCompositions200Response, GetCompositionContentSchema200Response, GetCompositionDesignSchema200Response, GetCompositionsBatch200Response, GetCompositionsBatchRequest, NewComposition, SetDynamicContent200Response, SetDynamicContentRequest, UpdateCompositionRequest, UpdateCompositionStatusRequest, ValidateCompositionContent200Response } from '../models/index';
+export interface CheckCompositionAccessRequest {
+    id: string;
+}
+export interface CreateCompositionRequest {
+    newComposition: NewComposition;
+}
+export interface CreateCompositionDatabaseRecordRequest {
+    id: string;
+    table: string;
+    body: object;
 }
 export interface DeleteCompositionRequest {
     id: string;
 }
+export interface DeleteCompositionDatabaseRecordRequest {
+    id: string;
+    table: string;
+    recordId: string;
+}
+export interface DuplicateCompositionOperationRequest {
+    id: string;
+    duplicateCompositionRequest?: DuplicateCompositionRequest;
+}
 export interface GetAllCompositionsRequest {
     page?: number;
     size?: number;
     sort?: string;
+    widgetId?: string;
+    workspace?: GetAllCompositionsWorkspaceEnum;
+    projectFolder?: string;
+    status?: GetAllCompositionsStatusEnum;
+    include?: string;
 }
 export interface GetCompositionByIdRequest {
     id: string;
 }
+export interface GetCompositionContentRequest {
+    id: string;
+}
+export interface GetCompositionContentSchemaRequest {
+    id: string;
+}
+export interface GetCompositionDatabaseRecordRequest {
+    id: string;
+    table: string;
+    recordId: string;
+}
+export interface GetCompositionDatabaseRecordsRequest {
+    id: string;
+    table: string;
+}
+export interface GetCompositionDesignRequest {
+    id: string;
+}
+export interface GetCompositionDesignSchemaRequest {
+    id: string;
+}
+export interface GetCompositionEmbedSettingsRequest {
+    id: string;
+}
 export interface GetCompositionVersionsRequest {
     id: string;
 }
+export interface GetCompositionsBatchOperationRequest {
+    getCompositionsBatchRequest: GetCompositionsBatchRequest;
+}
+export interface SetDynamicContentOperationRequest {
+    id: string;
+    setDynamicContentRequest: SetDynamicContentRequest;
+}
 export interface UpdateCompositionOperationRequest {
     id: string;
     updateCompositionRequest: UpdateCompositionRequest;
 }
+export interface UpdateCompositionDatabaseRecordRequest {
+    id: string;
+    table: string;
+    recordId: string;
+    body: object;
+}
 export interface UpdateCompositionStatusOperationRequest {
     id: string;
     updateCompositionStatusRequest: UpdateCompositionStatusRequest;
 }
+export interface ValidateCompositionContentRequest {
+    id: string;
+    body: object;
+}
 /**
  *
  */
 export declare class CompositionsApi extends runtime.BaseAPI {
+    /**
+     * Checks if the authenticated user can access a specific composition based on workspace context and permissions.
+     * Check Composition Access
+     */
+    checkCompositionAccessRaw(requestParameters: CheckCompositionAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CheckCompositionAccess200Response>>;
+    /**
+     * Checks if the authenticated user can access a specific composition based on workspace context and permissions.
+     * Check Composition Access
+     */
+    checkCompositionAccess(requestParameters: CheckCompositionAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CheckCompositionAccess200Response>;
     /**
      * Creates a new composition.
      * Create Composition
      */
-    createCompositionRaw(requestParameters: CreateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Composition>>;
+    createCompositionRaw(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateComposition201Response>>;
     /**
      * Creates a new composition.
      * Create Composition
      */
-    createComposition(requestParameters: CreateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;
+    createComposition(requestParameters: CreateCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateComposition201Response>;
+    /**
+     * Creates a new record in a table in the composition\'s database.
+     * Create Record In Composition Database
+     */
+    createCompositionDatabaseRecordRaw(requestParameters: CreateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Creates a new record in a table in the composition\'s database.
+     * Create Record In Composition Database
+     */
+    createCompositionDatabaseRecord(requestParameters: CreateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Deletes a specific composition.
      * Delete Composition
@@ -60,6 +143,26 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Delete Composition
      */
     deleteComposition(requestParameters: DeleteCompositionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes a specific record from a table in the composition\'s database.
+     * Delete Record From Composition Database
+     */
+    deleteCompositionDatabaseRecordRaw(requestParameters: DeleteCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a specific record from a table in the composition\'s database.
+     * Delete Record From Composition Database
+     */
+    deleteCompositionDatabaseRecord(requestParameters: DeleteCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates a duplicate of an existing composition for the authenticated user.
+     * Duplicate Composition
+     */
+    duplicateCompositionRaw(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DuplicateComposition202Response>>;
+    /**
+     * Creates a duplicate of an existing composition for the authenticated user.
+     * Duplicate Composition
+     */
+    duplicateComposition(requestParameters: DuplicateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DuplicateComposition202Response>;
     /**
      * Retrieves all compositions with pagination support.
      * Get All Compositions
@@ -74,12 +177,82 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Retrieves a specific composition by its ID.
      * Get Composition
      */
-    getCompositionByIdRaw(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Composition>>;
+    getCompositionByIdRaw(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateComposition201Response>>;
     /**
      * Retrieves a specific composition by its ID.
      * Get Composition
      */
-    getCompositionById(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;
+    getCompositionById(requestParameters: GetCompositionByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateComposition201Response>;
+    /**
+     * Retrieves the current content of a composition
+     * Get Current Content
+     */
+    getCompositionContentRaw(requestParameters: GetCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Retrieves the current content of a composition
+     * Get Current Content
+     */
+    getCompositionContent(requestParameters: GetCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Retrieves the content schema for a composition based on its widget type
+     * Get Content Schema
+     */
+    getCompositionContentSchemaRaw(requestParameters: GetCompositionContentSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionContentSchema200Response>>;
+    /**
+     * Retrieves the content schema for a composition based on its widget type
+     * Get Content Schema
+     */
+    getCompositionContentSchema(requestParameters: GetCompositionContentSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionContentSchema200Response>;
+    /**
+     * Retrieves a specific record from a table in the composition\'s database.
+     * Get Record From Composition Database
+     */
+    getCompositionDatabaseRecordRaw(requestParameters: GetCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Retrieves a specific record from a table in the composition\'s database.
+     * Get Record From Composition Database
+     */
+    getCompositionDatabaseRecord(requestParameters: GetCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves all records from a specific table in the composition\'s database.
+     * Get All Records From Composition Database Table
+     */
+    getCompositionDatabaseRecordsRaw(requestParameters: GetCompositionDatabaseRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Retrieves all records from a specific table in the composition\'s database.
+     * Get All Records From Composition Database Table
+     */
+    getCompositionDatabaseRecords(requestParameters: GetCompositionDatabaseRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Retrieves only the design field from a composition.
+     * Get Composition Design
+     */
+    getCompositionDesignRaw(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Retrieves only the design field from a composition.
+     * Get Composition Design
+     */
+    getCompositionDesign(requestParameters: GetCompositionDesignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
+    /**
+     * Retrieves the design schema for a composition based on its widget type
+     * Get Design Schema
+     */
+    getCompositionDesignSchemaRaw(requestParameters: GetCompositionDesignSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionDesignSchema200Response>>;
+    /**
+     * Retrieves the design schema for a composition based on its widget type
+     * Get Design Schema
+     */
+    getCompositionDesignSchema(requestParameters: GetCompositionDesignSchemaRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionDesignSchema200Response>;
+    /**
+     * Retrieves only the embedSettings field from a composition.
+     * Get Composition Embed Settings
+     */
+    getCompositionEmbedSettingsRaw(requestParameters: GetCompositionEmbedSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<object>>;
+    /**
+     * Retrieves only the embedSettings field from a composition.
+     * Get Composition Embed Settings
+     */
+    getCompositionEmbedSettings(requestParameters: GetCompositionEmbedSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<object>;
     /**
      * Retrieves version history for a specific composition.
      * Get Composition Versions
@@ -90,16 +263,46 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Get Composition Versions
      */
     getCompositionVersions(requestParameters: GetCompositionVersionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CompositionVersion>>;
+    /**
+     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.
+     * Get Compositions Batch
+     */
+    getCompositionsBatchRaw(requestParameters: GetCompositionsBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCompositionsBatch200Response>>;
+    /**
+     * Retrieves multiple compositions by their IDs in a single request. This endpoint includes domain validation for embed contexts and is used by the embed SDK.
+     * Get Compositions Batch
+     */
+    getCompositionsBatch(requestParameters: GetCompositionsBatchOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCompositionsBatch200Response>;
+    /**
+     * Updates the content of a composition dynamically with optional schema validation
+     * Set Dynamic Content
+     */
+    setDynamicContentRaw(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetDynamicContent200Response>>;
+    /**
+     * Updates the content of a composition dynamically with optional schema validation
+     * Set Dynamic Content
+     */
+    setDynamicContent(requestParameters: SetDynamicContentOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetDynamicContent200Response>;
     /**
      * Updates a specific composition.
      * Update Composition
      */
-    updateCompositionRaw(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Composition>>;
+    updateCompositionRaw(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateComposition201Response>>;
     /**
      * Updates a specific composition.
      * Update Composition
      */
-    updateComposition(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;
+    updateComposition(requestParameters: UpdateCompositionOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateComposition201Response>;
+    /**
+     * Updates a specific record in a table in the composition\'s database.
+     * Update Record In Composition Database
+     */
+    updateCompositionDatabaseRecordRaw(requestParameters: UpdateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Updates a specific record in a table in the composition\'s database.
+     * Update Record In Composition Database
+     */
+    updateCompositionDatabaseRecord(requestParameters: UpdateCompositionDatabaseRecordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Updates the status of a specific composition.
      * Update Composition Status
@@ -110,4 +313,31 @@ export declare class CompositionsApi extends runtime.BaseAPI {
      * Update Composition Status
      */
     updateCompositionStatus(requestParameters: UpdateCompositionStatusOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Composition>;
+    /**
+     * Validates content against the composition\'s widget schema without updating
+     * Validate Content
+     */
+    validateCompositionContentRaw(requestParameters: ValidateCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ValidateCompositionContent200Response>>;
+    /**
+     * Validates content against the composition\'s widget schema without updating
+     * Validate Content
+     */
+    validateCompositionContent(requestParameters: ValidateCompositionContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ValidateCompositionContent200Response>;
 }
+/**
+ * @export
+ */
+export declare const GetAllCompositionsWorkspaceEnum: {
+    readonly True: "true";
+    readonly False: "false";
+};
+export type GetAllCompositionsWorkspaceEnum = typeof GetAllCompositionsWorkspaceEnum[keyof typeof GetAllCompositionsWorkspaceEnum];
+/**
+ * @export
+ */
+export declare const GetAllCompositionsStatusEnum: {
+    readonly Draft: "draft";
+    readonly Published: "published";
+    readonly Archived: "archived";
+};
+export type GetAllCompositionsStatusEnum = typeof GetAllCompositionsStatusEnum[keyof typeof GetAllCompositionsStatusEnum];