@elliemae/pui-scripting-object 1.51.0 → 1.51.2

package/dist/types/lib/objects/application.d.ts

@@ -286,9 +286,13 @@ export declare enum ToastType {
  */
 export type ToastOptions = {
     /**
-     * title of the toast message
+     * title of the toast
      */
-    message: string;
+    title: string;
+    /**
+     * content of the toast
+     */
+    content: string;
     /**
      * {@link ToastType}
      *
@@ -562,14 +566,25 @@ export interface IApplication extends IScriptingObject {
     /**
      * open a modal
      * @param options modal properties
-     * @returns user selected modal action value as string
+     * @returns action selected by the user
+     * @example
+     * ```typescript
+     * const result = await application.openModal({
+     *  type: ModalType.WARNING,
+     *  data: {
+     *   title: 'Warning',
+     *   body: 'This operation is final and cannot be reversed. Do you want to proceed?',
+     *   actions: ['Ok', 'Cancel']
+     *  }
+     * });
+     * if (result === 'Ok') {
+     *  // user clicked Ok
+     * } else {
+     *  // user clicked Cancel
+     * }
+     * ```
      */
     openModal(options: ModalOptions): Promise<string>;
-    /**
-     * open a toast message
-     * @param options toast properties
-     */
-    openToast(options: ToastOptions): Promise<void>;
     /**
      * Perform an action
      * @param action action name
@@ -581,6 +596,19 @@ export interface IApplication extends IScriptingObject {
      * @param options Print options
      */
     print(options: PrintOptions): Promise<void>;
+    /**
+     * show toast message
+     * @param options toast options
+     * @example
+     * ```typescript
+     * await application.showToast({
+     *  title: 'Greeting',
+     *  content: 'Hello World',
+     *  type: ToastType.INFO
+     * });
+     * ```
+     */
+    showToast(options: ToastOptions): Promise<void>;
     /**
      * get supportability of an action
      * @param name action name