@chili-publish/studio-sdk 0.123.0 → 0.133.2

package/lib/src/controllers/FrameController.d.ts

@@ -19,337 +19,337 @@ export declare class FrameController {
     private shapeController;
     /**
      * This method returns the list of frames
-     * @returns
+     * @returns list of all frames
      */
-    getFrames: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    getAll: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
     /**
      * This method returns the list of selected frames
-     * @returns
+     * @returns list of all selected frames
      */
-    getSelectedFrames: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    getSelected: () => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
     /**
-     * This method returns the list of frames by pageId
-     * @param pageId The ID of a specific page
-     * @returns
+     * This method returns the list of frames by id
+     * @param id the id of a specific page
+     * @returns list of all frames by id
      */
-    getFramesByPageId: (pageId: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
+    getAllByPageId: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType[]>>;
     /**
      * This method returns a frame by its name
-     * @param name The name of a specific frame
-     * @returns
+     * @param name the name of a specific frame
+     * @returns frame properties
      */
-    getFrameByName: (name: string) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
+    getByName: (name: string) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
     /**
      * This method returns a frame by its id
-     * @param id The ID of a specific frame
-     * @returns
+     * @param id the id of a specific frame
+     * @returns frame properties
      */
-    getFrameById: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
+    getById: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameType>>;
     /**
      * This method returns all frame properties on current layout
-     * @returns
+     * @returns all frame properties on current layout
      */
-    getFramePropertiesOnSelectedLayout: () => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
+    getPropertiesOnSelectedLayout: () => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
     /**
-     * This method returns frame properties for a given frame and layout
-     * @param frameId The ID of a specific frame
-     * @param layoutId The ID of a specific layout
-     * @returns
+     * This method returns frame layout properties for a given frame and layout
+     * @param id the id of a specific frame
+     * @param layoutId the id of a specific layout
+     * @returns frame layout properties
      */
-    getFramePropertiesByFrameId: (frameId: Id, layoutId?: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType>>;
+    getLayoutProperties: (id: Id, layoutId?: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType>>;
     /**
-     * This method returns frame properties for a given layout
-     * @param layoutId The ID of a specific layout
-     * @returns
+     * This method returns a list of frame properties for a given layout
+     * @param id the id of a specific layout
+     * @returns list of frame layout properties
      */
-    getFramesProperties: (layoutId: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
+    getAllLayoutProperties: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<FrameLayoutType[]>>;
     /**
      * This method will reset the frame size (width and height) to the frame's original value
-     * @param frameId The ID of a specific frame
+     * @param id the id of a specific frame
      * @returns
      */
-    resetFrameSize: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetSize: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will select a specific frame
-     * @param frameId The ID of a specific frame
+     * @param id the id of a specific frame
      * @returns
      */
-    selectFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    select: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will select multipleFrames
-     * @param frameIds An array of all IDs you want to select
+     * @param ids An array of all ids you want to select
      * @returns
      */
-    selectMultipleFrames: (frameIds: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    selectMultiple: (ids: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method changes the order of frames in the z-index list.
-     * @param orderIndex The index in the list to move to
-     * @param frameIdsToMove An array of all IDs you want to move to the given index
+     * @param order the index in the list to move to
+     * @param ids An array of all IDs you want to move to the given index
      * @returns
      */
-    reorderFrames: (orderIndex: number, frameIdsToMove: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    reorderFrames: (order: number, ids: Id[]) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will update the z-index of a frame.
-     * @param frameId The ID of the frame you want to change the z-index of
-     * @param method The z-index update method to perform
+     * @param id the id of the frame you want to change the z-index of
+     * @param method the z-index update method to perform
      * @returns
      */
-    setFrameZIndex: (frameId: Id, method: UpdateZIndexMethod) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setZIndex: (id: Id, method: UpdateZIndexMethod) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the height of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @param id the id of a specific frame
+     * @param height the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
      * @returns
      */
-    setFrameHeight: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setHeight: (id: Id, height: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will set the rotation angle of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @param id the id of a specific frame
+     * @param rotation the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
      * @returns
      */
-    setFrameRotation: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setRotation: (id: Id, rotation: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will set the width of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @param id the id of a specific frame
+     * @param width the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
      * @returns
      */
-    setFrameWidth: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setWidth: (id: Id, width: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will set the x value of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @param id the id of a specific frame
+     * @param XValue the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
      * @returns
      */
-    setFrameX: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setX: (id: Id, XValue: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will set the y value of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param value The string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
+     * @param id the id of a specific frame
+     * @param YValue the string value that will be calculated (f.e. 1+1 will result in 2) The notation is in pixels
      * @returns
      */
-    setFrameY: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setY: (id: Id, YValue: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will update the name of a specific frame
-     * @param frameId The ID of a specific frame
-     * @param frameName The new name that the frame should receive
+     * @param id the id of a specific frame
+     * @param name the new name that the frame should receive
      * @returns
      */
-    setFrameName: (frameId: Id, frameName: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    rename: (id: Id, name: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset properties of a specific frame to their original values
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    reset: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the x value of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrameX: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetX: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the y value of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrameY: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetY: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the rotation value of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrameRotation: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetRotation: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the width of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrameWidth: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetWidth: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the height of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetFrameHeight: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetHeight: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the fitMode property of a specific frame to its original value
-     * @param frameId The ID of the frame that needs to get reset
+     * @param id the id of the frame that needs to get reset
      * @returns
      */
-    resetImageFrameFitMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetImageFrameFitMode: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the visibility property of a specified frame. If set to false the frame will be invisible and vice versa.
-     * @param frameId The ID of the frame that needs to get updated
+     * @param id the id of the frame that needs to get updated
      * @param value True means the frame gets visible, false means the frame gets invisible
      * @returns
      */
-    setFrameVisibility: (frameId: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setVisibility: (id: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will remove a specific frame using the Id.
-     * @param frameId The ID of the frame that needs to be deleted
+     * @param id the id of the frame that needs to be deleted
      * @returns
      */
-    removeFrame: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    remove: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
-     * This method will add a new frame of 'frameType' to the template positioned on the requested
+     * This method will create a new frame of 'type' to the template positioned on the requested
      * coordinates.
-     * @param frameType The type of frame to create
+     * @param type the type of frame to create
      * @param x X coordinate of the new frame within the template
      * @param y Y coordinate of the new frame within the template
      * @param width Width of the new frame within the template
      * @param height Height of the new frame within the template
-     * @returns The newly created frame's ID
+     * @returns the newly created frame's id
      */
-    addFrame: (frameType: FrameTypeEnum, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    create: (type: FrameTypeEnum, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
-     * This method will add a new frame of 'shapeType' type to the template positioned on the requested
+     * This method will create a new frame of 'type' type to the template positioned on the requested
      * coordinates.
-     * @param shapeType The type of frame to create
+     * @param type the type of frame to create
      * @param x X coordinate of the new frame within the template
      * @param y Y coordinate of the new frame within the template
      * @param width Width of the new frame within the template
      * @param height Height of the new frame within the template
-     * @returns The newly created frame's ID
+     * @returns the newly created shape frame's id
      */
-    addShapeFrame: (shapeType: ShapeType, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
+    createShapeFrame: (type: ShapeType, x: number, y: number, width: number, height: number) => Promise<import("../types/CommonTypes").EditorResponse<string>>;
     /**
      * This method sets or removes the image source to the ImageFrame
-     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
-     * @param src A new image source
+     * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
+     * @param newImageSource A new image source
      * @returns
      */
     private updateImageSource;
     /**
      * This method removes the image source from the ImageFrame
-     * @param imageFrameId The ID of the imageFrame where an image needs to be removed from
+     * @param imageFrameId the id of the imageFrame where an image needs to be removed from
      */
     removeImageSource: (imageFrameId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will assign an image from a mediaConnector to the correct ImageFrame
-     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
-     * @param connectorId Unique Id of the media connector
-     * @param resourceId Unique Id of the asset that you want to assign to the imageFrame
+     * @param id Unique Id of the media connector
+     * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
+     * @param assetId Unique id of the asset that you want to assign to the imageFrame
      * @returns
      */
-    setImageFromConnector: (imageFrameId: Id, connectorId: string, resourceId: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setImageFromConnector: (imageFrameId: Id, connectorId: Id, assetId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will assign an image from url to the correct ImageFrame
      * Make sure the url can be accessed by the editor.
-     * @param imageFrameId The ID of the imageFrame where an image needs to be assigned to
+     * @param imageFrameId the id of the imageFrame where an image needs to be assigned to
      * @param url A valid image uri
      * @returns
      */
     setImageFromUrl: (imageFrameId: Id, url: string) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the fitMode property of a specified image frame.
-     * @param imageFrameId The ID of the imageFrame that needs to get updated.
-     * @param fitMode The new fitMode that you want to set to the imageFrame.
+     * @param imageFrameId the id of the imageFrame that needs to get updated.
+     * @param fitMode the new fitMode that you want to set to the imageFrame.
      * @returns
      */
     setImageFrameFitMode: (imageFrameId: Id, fitMode: FitMode) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the constrainProportions property of a specified frame.
-     * @param frameId The ID of the frame that needs to get updated.
+     * @param id the id of the frame that needs to get updated.
      * @param constrainProportions The new constraint that you want to set to the frame.
      * @returns
      */
-    setFrameConstrainProportions: (frameId: Id, constrainProportions: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setFrameConstrainProportions: (id: Id, constrainProportions: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the vertical alignment property of a specified frame.
-     * @param frameId The ID of the frame that needs to get updated
-     * @param verticalAlign The new vertical alignment to be set to the frame.
+     * @param id the id of the frame that needs to get updated
+     * @param verticalAlign the new vertical alignment to be set to the frame.
      * @returns
      */
-    setVerticalAlignment: (frameId: Id, verticalAlign: VerticalAlign) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setVerticalAlign: (id: Id, verticalAlign: VerticalAlign) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the min copyFitting property of a specified frame.
-     * @param frameId The ID of the frame that needs to get updated
-     * @param value The new min copyFitting value to be set to the frame.
+     * @param id the id of the frame that needs to get updated
+     * @param value the new min copyFitting value to be set to the frame.
      * @returns
      */
-    setMinCopyfitting: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setMinCopyfitting: (id: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will set the max copyFitting property of a specified frame.
-     * @param frameId The ID of the frame that needs to get updated
-     * @param value The new max copyFitting value to be set to the frame.
+     * @param id the id of the frame that needs to get updated
+     * @param value the new max copyFitting value to be set to the frame.
      * @returns
      */
-    setMaxCopyfitting: (frameId: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
+    setMaxCopyfitting: (id: Id, value: string) => Promise<import("../types/CommonTypes").EditorResponse<null> | null>;
     /**
      * This method will enable copyFitting on a specified frame.
-     * @param frameId The ID of the frame that needs to get updated
-     * @param value The new value to be set to the frame.
+     * @param id the id of the frame that needs to get updated
+     * @param value the new value to be set to the frame.
      * @returns
      */
-    setEnableCopyfitting: (frameId: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setEnableCopyfitting: (id: Id, value: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the frame minCopyfitting to the frame's original value
-     * @param frameId The ID of a specific frame
+     * @param id the id of a specific frame
      * @returns
      */
-    resetMinCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetMinCopyfitting: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the frame maxCopyfitting to the frame's original value
-     * @param frameId The ID of a specific frame
+     * @param id the id of a specific frame
      * @returns
      */
-    resetMaxCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetMaxCopyfitting: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the frame enableCopyfitting to the frame's original value
-     * @param frameId The ID of a specific frame
+     * @param id the id of a specific frame
      * @returns
      */
-    resetEnableCopyfitting: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetEnableCopyfitting: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the visibility of the shape fill.
-     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param shapeFrameId the id of the shapeFrame that needs to get updated.
      * @param enableFill Whether the shape fill is visible.
      * @returns
      */
     setShapeFrameEnableFill: (shapeFrameId: Id, enableFill: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the shape fill color of a specified shape frame.
-     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-     * @param fillColor The new shape fill color that you want to set to the shapeFrame.
+     * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+     * @param fillColor the new shape fill color that you want to set to the shapeFrame.
      * @returns
      */
     setShapeFrameFillColor: (shapeFrameId: Id, fillColor: ColorUsage) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the visibility of the shape stroke.
-     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
+     * @param shapeFrameId the id of the shapeFrame that needs to get updated.
      * @param enableStroke Whether the shape stroke is visible.
      * @returns
      */
     setShapeFrameEnableStroke: (shapeFrameId: Id, enableStroke: boolean) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the shape stroke color of a specified shape frame.
-     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-     * @param strokeColor The new shape stroke color that you want to set to the shapeFrame.
+     * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+     * @param strokeColor the new shape stroke color that you want to set to the shapeFrame.
      * @returns
      */
     setShapeFrameStrokeColor: (shapeFrameId: Id, strokeColor: ColorUsage) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the shape stroke weight of a specified shape frame.
-     * @param shapeFrameId The ID of the shapeFrame that needs to get updated.
-     * @param strokeWeight The new shape stroke weight that you want to set to the shapeFrame.
+     * @param shapeFrameId the id of the shapeFrame that needs to get updated.
+     * @param strokeWeight the new shape stroke weight that you want to set to the shapeFrame.
      * @returns
      */
     setShapeFrameStrokeWeight: (shapeFrameId: Id, strokeWeight: number) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will set the blend mode of a specified shape frame
-     * @param frameId The ID of a specific frame
-     * @param blendMode The blend mode
+     * @param id the id of a specific frame
+     * @param blendMode the blend mode
      * @returns
      */
-    setFrameBlendMode: (frameId: Id, blendMode: BlendMode) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    setBlendMode: (id: Id, blendMode: BlendMode) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will make the specified image frame go into cropping mode.
-     * @param frameId The ID of a specific image frame
+     * @param id the id of a specific image frame
      * @returns
      */
-    enterCropMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    enterCropMode: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will exit cropping mode while saving the applied crop.
      * @returns
@@ -357,13 +357,13 @@ export declare class FrameController {
     applyCropMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will reset the currently applied crop mode and apply the last selected fit mode again.
-     * @param frameId The ID of a specific image frame
+     * @param id the id of a specific image frame
      * @returns
      */
-    resetCropMode: (frameId: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    resetCropMode: (id: Id) => Promise<import("../types/CommonTypes").EditorResponse<null>>;
     /**
      * This method will exit cropping mode without saving the applied crop.
      * @returns
      */
-    cancelCropMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
+    exitCropMode: () => Promise<import("../types/CommonTypes").EditorResponse<null>>;
 }