@bigbinary/neeto-playwright-commons 1.9.10 → 1.9.11

package/index.d.ts

@@ -81,13 +81,13 @@ declare class CustomCommands {
    *
    * @example 
    *
-   * // wait for 3 responses
+   *   // wait for 3 responses
    * 
-   * neetoPlaywrightUtilities.interceptMultipleResponses({
-   *   responseUrl: "/login",
-   *   times: 3,
-   *   baseURL: "https://app.neetoauth.net",
-   * });
+   *   neetoPlaywrightUtilities.interceptMultipleResponses({
+   *    responseUrl: "/login",
+   *    times: 3,
+   *    baseURL: "https://app.neetoauth.net",
+   *   });
    * @endexample
   */
   interceptMultipleResponses: ({
@@ -98,41 +98,41 @@ declare class CustomCommands {
     customPageContext,
     timeout
   }?: Partial<InterceptMultipleResponsesParams>) => Promise<Response[]>;
+  private recursiveMethod;
   /**
    *
-   * Comand to check for a condition recursively until it's true, then execute a
+   * Command to check for a condition recursively until it's true, then execute a
    *
    * callback. This process will be repeated until the specified timeout.
    *
    * @example 
    *
-   * //  checks if the URL contains /login for 5000 ms. If /login is found within this timeframe, the callback is executed.
+   *  //checks if the URL contains /login for 5000 ms. If /login is found within this timeframe, the callback is executed.
    * 
-   * await neetoPlaywrightUtilities.executeRecursively({
-   *   timeout: 5000,
-   *   condition: () => this.page.url().match(/.*login/),
-   *   callback: async () => {
+   *  await neetoPlaywrightUtilities.executeRecursively({
+   *    timeout: 5000,
+   *    condition: () => this.page.url().match(/.*login/),
+   *    callback: async () => {
    *     await expect("#locator").to.equal("Login");
-   *   },
-   * });
+   *    },
+   *  });
    * @endexample
   */
-  private recursiveMethod;
   executeRecursively: ExecuteRecursively;
   /**
    *
-   * Command to assert the toastr message or icon. Optionaly provide
+   * Command to assert the toastr message. It takes the following parameters:
    *
-   * closeAfterVerification to close the toastr after verification.
+   * closeAfterVerification(optional): Boolean to close the toast after verification. Default is true.
    *
-   * closeAfterVerification is set to true by default
+   * message: Text that should be on toast.
    *
    * @example 
    *
-   * await neetoPlaywrightUtilities.verifySuccessToast({
-   *   message: "Toastr message",
-   *   closeAfterVerification: false,
-   * });
+   *   await neetoPlaywrightUtilities.verifySuccessToast({
+   *     message: "Toastr message",
+   *     closeAfterVerification: false,
+   *   });
    * @endexample
   */
   verifySuccessToast: ({
@@ -145,32 +145,86 @@ declare class CustomCommands {
    *
    * @example 
    *
-   * // wait for 3 responses after reloading
-   * await neetoPlaywrightUtilities.reloadAndWait(3);
+   *   // wait for 3 responses after reloading
+   *   await neetoPlaywrightUtilities.reloadAndWait(3);
    * @endexample
   */
   reloadAndWait: (requestCount: number, customPageContext?: Page, interceptMultipleResponsesProps?: Partial<Omit<InterceptMultipleResponsesParams, "times">>) => Promise<void>;
+  /**
+   *
+   * Command to wait until the page has no loaders or spinners.
+   *
+   * @example 
+   *
+   *   await neetoPlaywrightUtilities.waitForPageLoad({
+   *     visiblityTimeout = 35_000,
+   *     customPageContext,
+   *   });
+   * @endexample
+  */
   waitForPageLoad: ({
     visibilityTimeout,
     customPageContext
   }?: Partial<WaitForPageLoadParams>) => Promise<void>;
   /**
    *
-   * Command to send a request.
+   * Command to send an API request.
    *
    * @example 
    *
-   * await neetoPlaywrightUtilities.apiRequest({
-   *   url: "/api/v1/tags",
-   *   failOnStatusCode, // throws error for status codes other than 2xx and 3xx
-   *   body, // request body
-   *   method, // request method
-   *   params, // request params
-   *   headers, // aditional request headers
-   * });
+   *   await neetoPlaywrightUtilities.apiRequest({
+   *     url: "/api/v1/tags",
+   *     failOnStatusCode, // throws error for status codes other than 2xx and 3xx
+   *     body, // request body
+   *     method, // request method  "get" | "patch" | "post" | "put" | "delete"
+   *     params, // request params
+   *     headers, // aditional request headers
+   *   });
    * @endexample
   */
   apiRequest: ApiRequest;
+  /**
+   *
+   * Command to select an option from a select input. It retries until the select
+   *
+   * operation is completed. It takes the following parameters:
+   *
+   * selectValueContainer: is the selector for the select input container.
+   *
+   * selectMenu: is the selector for the select input menu.
+   *
+   * value: is the value to be selected.
+   *
+   * options: is an object with the following optional parameters:
+   *
+   * visiblityTimeout: is the time to wait for the select input to be visible. Default is 2000ms.
+   *
+   * textAssertionTimeout: is the time to wait for the selected value to be visible in the select input. Default is 1000ms.
+   *
+   * retryTimeout: is the time to wait until the select operation is completed. Default is 20000ms.
+   *
+   * @example 
+   *
+   *   await neetoPlaywrightUtilities.selectOptionFromDropdown({
+   *     selectValueContainer,
+   *     selectMenu,
+   *     value,
+   *     options = {},
+   *   });
+   *   // or
+   * 
+   *   await neetoPlaywrightUtilities.selectOptionFromDropdown({
+   *     selectValueContainer,
+   *     selectMenu,
+   *     value,
+   *     options:{
+   *       visiblityTimeout:200,
+   *       textAssertionTimeout:1000,
+   *       retryTimeout:20000
+   *     },
+   *   });
+   * @endexample
+  */
   selectOptionFromDropdown: ({
     selectValueContainer,
     selectMenu,
@@ -179,26 +233,24 @@ declare class CustomCommands {
   }: SelectOptionFromDropdownParams) => Promise<void>;
   /**
    *
-   * Command to verify the value of a field. It can take either a single object or an
-   *
-   * array of objects, each representing a field and its expected value.
+   * Command to verify the value of a field. It can take either a single object or an array of objects, each representing a field and its expected value.
    *
    * @example 
    *
    * // verifyFieldValue with an array of field-value pairs as it's parameter
-   * await neetoPlaywrightUtilities.verifyFieldValue([
-   *   { field: COMMON_SELECTORS.submitButton, value: "Submit" },
-   *   {
-   *     field: COMMON_SELECTORS.cancelButton,
-   *     value: "cancel",
-   *   },
-   * ]);
+   *   await neetoPlaywrightUtilities.verifyFieldValue([
+   *     { field: COMMON_SELECTORS.submitButton, value: "Submit" },
+   *     {
+   *       field: COMMON_SELECTORS.cancelButton,
+   *       value: "cancel",
+   *     },
+   *   ]);
    * 
-   * // verifyFieldValue with a field-value object as it's parameter
-   * await neetoPlaywrightUtilities.verifyFieldValue({
-   *   field: COMMON_SELECTORS.submitButton,
-   *   value: "Submit",
-   * });
+   *   // verifyFieldValue with a field-value object as it's parameter
+   *   await neetoPlaywrightUtilities.verifyFieldValue({
+   *     field: COMMON_SELECTORS.submitButton,
+   *     value: "Submit",
+   *   });
    * @endexample
   */
   verifyFieldValue: VerifyFieldValue;
@@ -208,12 +260,12 @@ declare class CustomCommands {
    *
    * @example 
    *
-   * await neetoPlaywrightUtilities.searchAndVerify({
-   *   searchTerm: "searchTerm",
-   *   searchInputSelector: COMMON_SELECTORS.inputField,
-   *   countSelector: COMMON_SELECTORS.count,
-   *   countText: "43 items",
-   * });
+   *   await neetoPlaywrightUtilities.searchAndVerify({
+   *     searchTerm: "searchTerm",
+   *     searchInputSelector: COMMON_SELECTORS.inputField,
+   *     countSelector: COMMON_SELECTORS.count,
+   *     countText: "43 items",
+   *   });
    * @endexample
   */
   searchAndVerify: ({
@@ -224,30 +276,16 @@ declare class CustomCommands {
   }: SearchAndVerifyProps) => Promise<void>;
   /**
    *
-   * Command to upload an image to image uploader and verify it.
+   * Command to upload an image to image uploader and verify it. It takes the following parameters:
    *
-   * @example 
-   *
-   * await neetoPlaywrightUtilities.uploadImage("../assets/image.png");
-   * @endexample
-  */
-  uploadImage: (localImagePath: string) => Promise<void>;
-  /**
-   *
-   * Command to verify the tooltip content. It takes the following parameters:
-   *
-   * triggerElement: The element that triggers the tooltip.
-   *
-   * content: The content inside the tooltip.
+   * localImagePath: Path to image.
    *
    * @example 
    *
-   * await neetoPlaywrightUtilities.verifyTooltip({
-   *   triggerElement: page.getByTestId("triggerElement"),
-   *   content: "Tooltip content",
-   * });
+   *   await neetoPlaywrightUtilities.uploadImage("../assets/image.png");
    * @endexample
   */
+  uploadImage: (localImagePath: string) => Promise<void>;
   verifyTooltip: ({
     triggerElement,
     content
@@ -269,11 +307,21 @@ declare class MailosaurUtils {
   constructor(mailosaur: MailosaurClient);
   /**
    *
-   * Used to extract the email content
+   * Used to extract the email content. It takes the following parameters:
+   *
+   * email (required): The Mailosaur email to which the OTP was sent to.
+   *
+   * subjectSubstring (optional): A substring of the email subject to filter it.
+   *
+   * timeout (optional): The timeout time in milliseconds after which the method
+   *
+   * throws an error if an email is not found. Defaults to 2 minutes
+   *
+   * receivedAfter: A date object used to filter the emails based on the time of
    *
-   * undefined
+   * receiving it. Only emails incoming after this timestamp will be taken into
    *
-   * undefined
+   * account. Defaults to the timestamp of invoking this method.
    *
    * @example 
    *
@@ -284,7 +332,7 @@ declare class MailosaurUtils {
    *     timeout: 60 * 1000,
    *     receivedAfter: new Date()
    *   })
-   * }
+   * })
    * @endexample
   */
   getEmailContent: ({
@@ -295,11 +343,23 @@ declare class MailosaurUtils {
   }: EmailContentParams) => Promise<mailosaur_lib_models.Message>;
   /**
    *
-   * Used to extract the OTP from the neeto OTP emails
+   * Used to extract the OTP from the neeto OTP emails. It takes the following parameters:
+   *
+   * email(required): The Mailosaur email to which the OTP was sent to.
+   *
+   * subjectSubstring (optional): A substring of the email subject to filter it.
+   *
+   * Defaults to "is your login code"
    *
-   * undefined
+   * timeout (optional): The timeout time in milliseconds after which the method
    *
-   * undefined
+   * throws an error if an email is not found. Defaults to 2 minutes
+   *
+   * receivedAfter: A date object used to filter the emails based on the time of
+   *
+   * receiving it. Only emails incoming after this timestamp will be taken into
+   *
+   * account. Defaults to the timestamp of invoking this method.
    *
    * @example 
    *
@@ -310,25 +370,19 @@ declare class MailosaurUtils {
    *     timeout: 60 * 1000,
    *     receivedAfter: new Date()
    *   })
-   * }
+   * })
    * @endexample
-   * undefined
-   *
-   * A string containing the OTP value.
-   *
   */
   fetchOtpFromEmail: FetchOtpFromEmail;
   /**
    *
    * Used to generate a random Email ID to the Mailosaur Server.
    *
-   * undefined
-   *
    * @example 
    *
    * test("sample test", async ({ mailosaurUtils }) => {
    *   const email = mailosaurUtils.generateRandomMailosaurEmail();
-   * }
+   * })
    * @endexample
   */
   generateRandomMailosaurEmail: () => string;
@@ -341,6 +395,35 @@ interface CustomFixture {
 }
 type Commands = Fixtures<CustomFixture, PlaywrightWorkerArgs & PlaywrightWorkerOptions, PlaywrightTestArgs & PlaywrightTestOptions, PlaywrightWorkerArgs & PlaywrightWorkerOptions>;
 declare const commands: Commands;
+/**
+ *
+ * Function generates staging data for a specified product. It takes the following parameters:
+ *
+ * product (optional): A string representing the product for which staging data is being generated. Defaults to "invoice" if not provided.
+ *
+ * @example 
+ *
+ *   import { generateStagingData } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *   // Generate staging data for the default product ("invoice")
+ *   const stagingData = generateStagingData();
+ * 
+ *   console.log(stagingData);
+ *   
+ *   Output:
+ *   {
+ *     firstName: 'André',
+ *     lastName: "O'Reilly",
+ *     otp: 111111,
+ *     domain: 'neetoinvoice.net',
+ *     currentUserName: 'André O'Reilly', // Depends on IS_STAGING_ENV and CREDENTIALS
+ *     businessName: 'cpt-invoice-0322153521234', // Timestamp will be different
+ *     subdomainName: 'cpt-invoice-0322153521234', // Timestamp will be different if IS_STAGING_ENV is true, else 'spinkart'
+ *     email: 'cpt12345+invoice+0322153521234@bigbinary.com' // OTP bypass key will be included if IS_STAGING_ENV is true, else CREDENTIALS.email
+ *   }
+ * 
+ * @endexample
+*/
 declare const generateStagingData: (product?: string) => {
   firstName: string;
   lastName: string;
@@ -414,26 +497,182 @@ declare class EmbedBase {
     neetoPlaywrightUtilities,
     appName
   }: EmbedBasePageConstructorParams);
+  /**
+   *
+   * Initializes the embed test page. It takes the following parameters:
+   *
+   * embedType: Type of embedded content (inline, floatingPopup, elementClick).
+   *
+   * embedCode: Embed code.
+   *
+   * customElementText: Custom text for element click type (default: "Click here").
+   *
+   * @example 
+   *
+   *   await embedBase.initializeEmbedPage({
+   *     embedType: "inline",
+   *     embedCode: "<iframe src='example.com'></iframe>"
+   *   });
+   *   // OR
+   * 
+   *    await embedBase.initializeEmbedPage({
+   *     embedType: "inline",
+   *     embedCode: "<iframe src='example.com'></iframe>",
+   *     customElementText:"Click here"
+   *   });
+   * @endexample
+  */
   initializeEmbedPage: ({
     embedType,
     embedCode,
     customElementText
   }: initializeEmbedPageParams) => Promise<Page>;
+  /**
+   *
+   * Closes the embed modal and page.
+   *
+   * @example 
+   *
+   *   await embedBase.closeEmbedModalAndPage();
+   * @endexample
+  */
   closeEmbedModalAndPage: () => Promise<void>;
+  /**
+   *
+   * Clicks on the popup button.
+   *
+   * It takes the following parameters as an object:
+   *
+   * checked: Indicates whether an element is checked.
+   *
+   * disabled: Indicates whether an element is disabled.
+   *
+   * exact: Indicates whether an exact match is required.
+   *
+   * expanded: Indicates whether an element is expanded.
+   *
+   * includeHidden: Indicates whether hidden elements should be included.
+   *
+   * level: Specifies the level of the element.
+   *
+   * name: Specifies the name of the element, which can be a string or a regular expression.
+   *
+   * pressed: Indicates whether an element is pressed.
+   *
+   * selected: Indicates whether an element is selected.
+   *
+   * @example 
+   *
+   *   await embedBase.clickOnPopupButton({ name: "Popup Button" });
+   *   //OR
+   *   await embedBase.clickOnPopupButton({
+   *     checked: true,
+   *     disabled: false,
+   *     exact: true,
+   *     expanded: false,
+   *     includeHidden: false,
+   *     level: 2,
+   *     name: "Popup Button",
+   *     pressed: false,
+   *     selected: true
+   *   });
+   * @endexample
+  */
   clickOnPopupButton: (popUpButtonSelectorOptions: GetByRoleOptions) => Promise<void>;
+  /**
+   *
+   * Copies the embed script. It takes the following parameters:
+   *
+   * embedLabel: Label for the embed script.
+   *
+   * @example 
+   *
+   *   const embedScript = await embedBase.copyEmbedScript({ embedLabel: "Embed Script" });
+   * @endexample
+  */
   copyEmbedScript: ({
     embedLabel
   }: {
     embedLabel: string;
   }) => Promise<string>;
+  /**
+   *
+   * Selects the embed type. It takes the following parameters:
+   *
+   * embedLabel: Label for the embed type.
+   *
+   * @example 
+   *
+   *   await embedBase.selectEmbedType("Inline Embed");
+   * @endexample
+  */
   selectEmbedType: (embedLabel: string) => Promise<void>;
+  /**
+   *
+   * Verifies inline customization of embedded content. It takes the following parameters:
+   *
+   * headingTestId: Test ID of the heading element.
+   *
+   * inlineEmbedInterceptParams: Parameters for intercepting multiple responses.
+   *
+   * customizationOptions: Options for customization.
+   *
+   * @example 
+   *
+   *   await embedBase.verifyInlineCustomization({
+   *     headingTestId: "heading",
+   *     inlineEmbedInterceptParams: { urlRegex: /example\.com/, status: 200 },
+   *     customizationOptions: { embedHeight: "100", embedWidth: "100", embedDivContainerId: "container" }
+   *   });
+   * @endexample
+  */
   verifyInlineCustomization: ({
     headingTestId,
     inlineEmbedInterceptParams,
     customizationOptions
   }: VerifyInlineCustomizationParams) => Promise<void>;
+  /**
+   *
+   * Verifies floating popup customization of embedded content. It takes the following parameters:
+   *
+   * customizationOptions: Options for customization.
+   *
+   * @example 
+   *
+   *   await embedBase.verifyFloatingPopupCustomization({
+   *     buttonText: "Popup Button",
+   *     buttonColorHex: "#FFFFFF",
+   *     buttonTextColorHex: "#000000",
+   *     buttonPosition: "Bottom left"
+   *   });
+   * @endexample
+  */
   verifyFloatingPopupCustomization: (customizationOptions: FloatingPopupCustomizationOptions) => Promise<void>;
+  /**
+   *
+   * Verifies element click customization of embedded content. It takes the following parameters:
+   *
+   * customizationOptions: Options for customization.
+   *
+   * @example 
+   *
+   *   await embedBase.verifyElementClickCustomization({ customId: "custom-element" });
+   * @endexample
+  */
   verifyElementClickCustomization: (customizationOptions: ElementClickCustomizationOptions) => Promise<void>;
+  /**
+   *
+   * Expects multiple texts to be present in the code block. It takes the following parameters:
+   *
+   * containTextOptions: Array of strings or regex patterns to be checked in the code block.
+   *
+   * @example 
+   *
+   *   await embedBase.expectMultipleTextsInCodeblock([
+   *     "Text1", "Text2", /Pattern/
+   *   ]);
+   * @endexample
+  */
   expectMultipleTextsInCodeblock: (containTextOptions: [string | RegExp, string | RegExp, ...(string | RegExp)[]]) => Promise<void>;
 }
 interface HelpAndProfilePageInitializerProps {
@@ -464,18 +703,85 @@ declare class HelpAndProfilePage {
   private hoverOnBody;
   openHelpCenterV2: () => Promise<void>;
   private openLiveChatAndVerify;
+  /**
+   *
+   * The function reloads the page, opens the chat interface, closes and reopens the chat frame, initiates a new conversation, and verifies the conversation window content.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.openAndVerifyChatWidgetV2();
+   * @endexample
+  */
   openAndVerifyChatWidgetV2: () => Promise<void>;
+  /**
+   *
+   * Opens and verifies the help articles in Help Center.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.openAndVerifyHelpArticlesV2();
+   * @endexample
+  */
   openAndVerifyHelpArticlesV2: () => Promise<void>;
   private openChangelogPaneV2;
+  /**
+   *
+   * Opens and verifies the changelog in Help Center.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.openAndVerifyChangelogV2();
+   * @endexample
+  */
   openAndVerifyChangelogV2: () => Promise<void>;
   private formatKeyboardShortcut;
+  /**
+   *
+   * Opens and verifies the keyboard shortcuts pane in Help Center. It takes the following parameters:
+   *
+   * productShortcuts: Array of objects containing description and sequence of product shortcuts.
+   *
+   * osPlatform: Platform for keyboard shortcuts ("mac" or "windows").
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.openAndVerifyKeyboardShortcutsPaneV2(productShortcuts, "windows");
+   * @endexample
+  */
   openAndVerifyKeyboardShortcutsPaneV2: (productShortcuts: {
     description: string;
     sequence: string;
   }[], osPlatform?: "mac" | "windows") => Promise<void>;
+  /**
+   *
+   * Opens and verifies the app switcher in Help Center.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.openAppSwitcherAndVerifyV2();
+   * @endexample
+  */
   openAppSwitcherAndVerifyV2: () => Promise<void>;
   private openAuthLinkAndVerify;
+  /**
+   *
+   * Verifies the profile and organization links in Help Center.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.verifyProfileAndOrganizationLinksV2();
+   * @endexample
+  */
   verifyProfileAndOrganizationLinksV2: () => Promise<void>;
+  /**
+   *
+   * Verifies logout functionality in Help Center.
+   *
+   * @example 
+   *
+   *   await helpAndProfilePage.verifyLogout();
+   * @endexample
+  */
   verifyLogoutV2: () => Promise<void>;
 }
 type Integration = "dailyco" | "github" | "google-calendar" | "google-analytics" | "google-sheets" | "microsoft-teams" | "neeto-chat" | "neeto-crm" | "slack" | "twilio" | "whereby" | "zapier" | "zoom";
@@ -512,10 +818,72 @@ declare class IntegrationBase {
     integrationRouteIndex,
     integrationRouteResponsesParams
   }: IntegrationBaseParams);
+  /**
+   *
+   * Disconnects an active integration. It takes the following parameters:
+   *
+   * interceptMultipleResponsesParams: Optional parameter for intercepting multiple responses.
+   *
+   * @example 
+   *
+   *   await integrationBase.disconnect();
+   *   // OR
+   *   await integrationBase.disconnect({
+   *     responseUrl: "/auth";
+   *     times:1;
+   *     baseUrl: "https://www.zoom.com";
+   *     responseStatus: 200;
+   *   });
+   * @endexample
+  */
   disconnect: (interceptMultipleResponsesParams?: PartialInterceptMultipleResponsesParams$1) => Promise<void>;
+  /**
+   *
+   * Connects an integration. It takes the following parameters:
+   *
+   * skipGoTo: Boolean indicating whether to skip navigating to integration index (default: false).
+   *
+   * @example 
+   *
+   *   await integrationBase.connect();
+   *   // OR
+   *   await integrationBase.connect(true);
+   * @endexample
+  */
   connect: (skipGoTo?: boolean) => Promise<void>;
+  /**
+   *
+   * Verifies the integration status. It takes the following parameters:
+   *
+   * status: Integration status ("connected" or "disconnected") (default: "connected").
+   *
+   * @example 
+   *
+   *   await integrationBase.verifyIntegrationStatus();
+   *   // OR
+   *   await integrationBase.verifyIntegrationStatus("disconnected");
+   * @endexample
+  */
   verifyIntegrationStatus: (status?: IntegrationStatus) => Promise<void>;
+  /**
+   *
+   * Clicks on the integration card.
+   *
+   * @example 
+   *
+   *   await integrationBase.clickOnIntegrationCard();
+   * @endexample
+  */
   clickOnIntegrationCard: () => Promise<void>;
+  /**
+   *
+   * Navigates to the integration index route.
+   *
+   * @example 
+   *
+   *   await integrationBase.gotoIntegrationIndex();
+   * @endexample
+  */
   gotoIntegrationIndex: () => Promise<void>;
 }
 type AsyncNoArgsFunction = () => Promise<void>;
@@ -540,18 +908,150 @@ declare class SlackPage extends IntegrationBase {
     neetoPlaywrightUtilities,
     integrationRouteIndex
   }: SlackPageParams);
+  /**
+   *
+   * Connects to slack integration and verifies the connection. It takes the following parameters:
+   *
+   * redirectUrl: URL to redirect after connecting.
+   *
+   * customSteps (optional): Custom steps to perform after connection.
+   *
+   * channelToConfigure (optional): Channel to configure.
+   *
+   * @example 
+   *
+   *   await slackPage.connectAndVerifyIntegration(/example\.com/, customSteps, "general");
+   * @endexample
+  */
   connectAndVerifyIntegration: (redirectUrl: RedirectUrl, customSteps?: AsyncNoArgsFunction, channelToConfigure?: string) => Promise<void>;
-  disconnectAndVerifyIntegration: () => Promise<void>;
+  /**
+   *
+   * Disconnects from Slack integration and verifies disconnection.
+   *
+   * @example 
+   *
+   *   await slackPage.disconnectAndVerifyIntegration();
+   * @endexample
+  */
+  disconnectAndVerifyIntegration: () => Promise<void>;
+  /**
+   *
+   * Updates and configures slack channel. It takes the following parameters:
+   *
+   * newSlackChannel: The name of the slack channel to which the update will be applied.
+   *
+   * interceptMultipleResponsesParams (optional): Parameters for intercepting multiple responses.
+   *
+   * refreshInterceptMultipleResponsesParams (optional): Parameters for refreshing intercepting multiple responses.
+   *
+   * refreshChannelList (optional): Whether to refresh the channel list.
+   *
+   * @example 
+   *
+   *   await slackPage.updateConfigureSlackChannel({
+   *     newSlackChannel: "example-channel",
+   *     refreshChannelList: true
+   *   });
+   *   //or
+   *   await slackPage.updateConfigureSlackChannel({
+   *     newSlackChannel: "example-channel",
+   *     refreshChannelList: true,
+   *     refreshInterceptMultipleResponsesParams:{
+   *       responseUrl: "/auth";
+   *       times:1;
+   *       baseUrl: "https://www.zoom.com";
+   *       responseStatus: 200;
+   *     },
+   *     interceptMultipleResponsesParams:{
+   *       responseUrl: "/auth";
+   *       times:1;
+   *       baseUrl: "https://www.zoom.com";
+   *       responseStatus: 200;
+   *     }
+   *   });
+   * @endexample
+  */
   updateConfigureSlackChannel: ({
     newSlackChannel,
     interceptMultipleResponsesParams,
     refreshInterceptMultipleResponsesParams,
     refreshChannelList
   }: UpdateConfigureSlackChannelParams) => Promise<void>;
+  /**
+   *
+   * Clicks on the refresh button to update the channel list. It takes the following parameters:
+   *
+   * refreshInterceptMultipleResponsesParams (optional): Parameters for refreshing intercepting multiple responses.
+   *
+   * @example 
+   *
+   *   await slackPage.clickOnChannelListRefreshButton();
+   *   // or
+   *   await slackPage.clickOnChannelListRefreshButton({
+   *         responseUrl: "/auth";
+   *         times:1;
+   *         baseUrl: "https://www.zoom.com";
+   *         responseStatus: 200;
+   *     });
+   * 
+   * @endexample
+  */
   clickOnChannelListRefreshButton: (refreshInterceptMultipleResponsesParams?: PartialInterceptMultipleResponsesParams) => Promise<void>;
+  /**
+   *
+   * Logs into slack web app. It takes the following parameters:
+   *
+   * slackWebappPage: Playwright Page object for Slack web app.
+   *
+   * customCredentials (optional): Custom credentials for logging in.
+   *
+   * @example 
+   *
+   *   await slackPage.loginToSlackWebapp(slackWebappPageInstance);
+   *     // OR
+   *   await slackPage.loginToSlackWebapp(slackWebappPageInstance,{
+   *     loginEmail:"jhondoe@gmail.com",
+   *     loginPassword: "123456789",
+   *     workspace: "your-workspace-name",
+   *   })
+   * @endexample
+  */
   loginToSlackWebapp: (slackWebappPage: Page, customCredentials?: Record<"workspace" | "loginPassword" | "loginEmail", string | undefined>) => Promise<void>;
+  /**
+   *
+   * Logs out from slack web app.
+   *
+   * @example 
+   *
+   *   await slackPage.logoutFromSlackWebApp();
+   * @endexample
+  */
   logoutFromSlackWebApp: () => Promise<void>;
+  /**
+   *
+   * Navigates to a Slack channel. It takes the following parameters:
+   *
+   * slackChannel: Name of the Slack channel.
+   *
+   * @example 
+   *
+   *   await slackPage.goToSlackChannel("general");
+   * @endexample
+  */
   goToSlackChannel: (slackChannel: string) => Promise<void>;
+  /**
+   *
+   * Creates a new slack channel. It takes the following parameters:
+   *
+   * channelName: Name of the new Slack channel.
+   *
+   * kind: Type of the new Slack channel (public or private, optional).
+   *
+   * @example 
+   *
+   *   await slackPage.createNewSlackChannel({ channelName: "new-channel", kind: "public" });
+   * @endexample
+  */
   createNewSlackChannel: ({
     channelName,
     kind
@@ -559,6 +1059,17 @@ declare class SlackPage extends IntegrationBase {
     channelName: string;
     kind?: "public" | "private" | undefined;
   }) => Promise<void>;
+  /**
+   *
+   * Deletes a slack channel. It takes the following parameters:
+   *
+   * channel: Name of the Slack channel to delete.
+   *
+   * @example 
+   *
+   *   await slackPage.deleteSlackChannel("old-channel");
+   * @endexample
+  */
   deleteSlackChannel: (channel: string) => Promise<void>;
 }
 interface WebhooksPageParams {
@@ -591,24 +1102,97 @@ declare class WebhooksPage {
     neetoPlaywrightUtilities,
     context
   }: WebhooksPageParams);
+  /**
+   *
+   * Retrieves the webhook URL and token from a third-party site.
+   *
+   * Returns: Object containing webhook site URL and token.
+   *
+   * @example 
+   *
+   *   const { webhookSiteURL, webhookToken } = await webhooksPage.getWebhookURL();
+   * @endexample
+  */
   getWebhookURL: () => Promise<{
     webhookSiteURL: string;
     webhookToken: string | undefined;
   }>;
+  /**
+   *
+   * Adds a webhook using the provided webhook site URL. It takes the following parameters:
+   *
+   * webhookSiteURL: URL of the webhook site.
+   *
+   * @example 
+   *
+   *   await webhooksPage.addWebhook({ webhookSiteURL: "https://example.com/webhook" });
+   * @endexample
+  */
   addWebhook: ({
     webhookSiteURL
   }: {
     webhookSiteURL: string;
   }) => Promise<void>;
+  /**
+   *
+   * Verifies the latest webhook response. It takes the following parameters:
+   *
+   * callback: Callback function to execute on parsed response.
+   *
+   * webhookToken: Token of the webhook.
+   *
+   * Other parameters to be passed to the callback function.
+   *
+   * @example 
+   *
+   *   await webhooksPage.verifyLatestWebhookResponse({
+   *     callback: ({ parsedResponse }) => console.log(parsedResponse),
+   *     webhookToken: "exampleToken"
+   *   });
+   * @endexample
+  */
   verifyLatestWebhookResponse: ({
     callback,
     webhookToken,
     ...otherParams
   }: VerifyWebhookResponseParams) => Promise<void>;
+  /**
+   *
+   * Verifies webhook deliveries. It takes the following parameters:
+   *
+   * callback: Callback function to execute on parsed response.
+   *
+   * Other parameters to be passed to the callback function.
+   *
+   * @example 
+   *
+   *   await webhooksPage.verifyWebhookDeliveries({
+   *     callback: ({ parsedResponse }) => console.log(parsedResponse)
+   *   });
+   * @endexample
+  */
   verifyWebhookDeliveries: ({
     callback,
     ...otherParams
   }: VerifyWebhookDeliveriesParams) => Promise<void>;
+  /**
+   *
+   * Verifies webhook delivery by event. It takes the following parameters:
+   *
+   * event: Event name.
+   *
+   * callbackToVerifyDeliveries: Callback function to execute on parsed response.
+   *
+   * Other parameters to be passed to the callback function.
+   *
+   * @example 
+   *
+   *   await webhooksPage.verifyWebhookDeliveryByEvent({
+   *     event: "eventName",
+   *     callbackToVerifyDeliveries: ({ parsedResponse }) => console.log(parsedResponse)
+   *   });
+   * @endexample
+  */
   verifyWebhookDeliveryByEvent: ({
     event,
     callbackToVerifyDeliveries,
@@ -628,10 +1212,71 @@ declare class ZapierPage extends IntegrationBase {
     neetoPlaywrightUtilities: CustomCommands;
     integrationRouteIndex?: string;
   });
+  /**
+   *
+   * Logs into zapier web app. It takes the following parameters:
+   *
+   * zapierWebPage: Playwright Page object for Zapier web app.
+   *
+   * @example 
+   *
+   *   await zapierPage.loginToZapier(zapierWebPageInstance);
+   * @endexample
+  */
   loginToZapier: (zapierWebPage: Page) => Promise<void>;
+  /**
+   *
+   * Logs out from zapier web app.
+   *
+   * @example 
+   *
+   *   await zapierPage.logoutFromZapier();
+   * @endexample
+  */
   logoutFromZapier: () => Promise<void>;
+  /**
+   *
+   * Reconnects zapier account and publishes changes. It takes the following parameters:
+   *
+   * zapierApiKey: Zapier API key.
+   *
+   * @example 
+   *
+   *   await zapierPage.reconnectAccountAndPublish("your-zapier-api-key");
+   * @endexample
+  */
   reconnectAccountAndPublish: (zapierApiKey: string) => Promise<void>;
+  /**
+   *
+   * Deletes all connections in zapier. It takes the following parameters:
+   *
+   * zapierAppLink: Link to Zapier app.
+   *
+   * @example 
+   *
+   *   await zapierPage.deleteAllConnections("https://zapier.com/app/dashboard");
+   * @endexample
+  */
   deleteAllConnections: (zapierAppLink: string) => Promise<void>;
+  /**
+   *
+   * Verifies that a Zap is triggered. It takes the following parameters:
+   *
+   * submittedEmail: Submitted email address.
+   *
+   * zapTriggeredAfter: Date after which the Zap should be triggered.
+   *
+   * productName: Name of the product.
+   *
+   * @example 
+   *
+   *   await zapierPage.verifyZapIsTriggered({
+   *     submittedEmail: "example@example.com",
+   *     zapTriggeredAfter: new Date(),
+   *     productName: "neetoChat"
+   *   });
+   * @endexample
+  */
   verifyZapIsTriggered: ({
     productName,
     submittedEmail,
@@ -641,12 +1286,43 @@ declare class ZapierPage extends IntegrationBase {
     zapTriggeredAfter: Date;
     productName: string;
   }) => Promise<mailosaur_lib_models.Message>;
+  /**
+   *
+   * Skips test if Zapier task limit is exhausted.
+   *
+   * @example 
+   *
+   *   await zapierPage.skipIfTaskLimitIsExhausted();
+   * @endexample
+  */
   skipIfTaskLimitIsExhausted: () => Promise<void>;
+  /**
+   *
+   * Connects to zapier integration and verifies the connection. It takes the following parameters:
+   *
+   * apiKeyLabel: Label for Zapier API key.
+   *
+   * Returns: Zapier API key.
+   *
+   * @example 
+   *
+   *   const apiKey = await zapierPage.connectAndVerify({ apiKeyLabel: "Your API Key" });
+   * @endexample
+  */
   connectAndVerify: ({
     apiKeyLabel
   }: {
     apiKeyLabel: string;
   }) => Promise<string>;
+  /**
+   *
+   * Disconnects from Zapier integration and verifies disconnection.
+   *
+   * @example 
+   *
+   *   await zapierPage.disconnectAndVerify();
+   * @endexample
+  */
   disconnectAndVerify: () => Promise<void>;
 }
 interface VerifyDescriptionEditorParams {
@@ -747,13 +1423,13 @@ declare class ImageUploader {
    *
    * @example 
    *
-   * await imageUploader.cropImage({
-   *     toggleAspectRatioLock: false
-   *     aspectRatioHeight: "9",
-   *     aspectRatioWidth: "16",
-   *     width: "100",
-   *     height: "100",
-   * })
+   *     await imageUploader.cropImage({
+   *         toggleAspectRatioLock: false
+   *         aspectRatioHeight: "9",
+   *         aspectRatioWidth: "16",
+   *         width: "100",
+   *         height: "100",
+   *     })
    * @endexample
   */
   cropImage: ({
@@ -783,15 +1459,15 @@ declare class ImageUploader {
    *
    * @example 
    *
-   * await imageUploader.uploadNewImageFromLibrary({
-   *     localImagePath,
-   *     toggleOrginalImage: false,
-   *     toggleAspectRatioLock: false,
-   *     aspectRatioHeight: "9",
-   *     aspectRatioWidth: "16",
-   *     width: "100",
-   *     height: "100",
-   * })
+   *     await imageUploader.uploadNewImageFromLibrary({
+   *         localImagePath,
+   *         toggleOrginalImage: false,
+   *         toggleAspectRatioLock: false,
+   *         aspectRatioHeight: "9",
+   *         aspectRatioWidth: "16",
+   *         width: "100",
+   *         height: "100",
+   *     })
    * @endexample
   */
   uploadNewImageFromLibrary: ({
@@ -849,7 +1525,7 @@ declare class ImageUploader {
   }?: Partial<SelectImage>) => Promise<void>;
   /**
    *
-   * Used to select an image from the library and crop it if required. It takes the following parameters
+   * Used to select an image from the library and crop it if required. It takes the following parameters:
    *
    * nthImage (optional): The index of the image to be selected. Default is 0.
    *
@@ -869,16 +1545,16 @@ declare class ImageUploader {
    *
    * @example 
    *
-   * await imageUploader.selectImageFromLibrary({
-   *     nthImage: 0,
-   *     searchTerm: "",
-   *     toggleOrginalImage: false,
-   *     toggleAspectRatioLock: false,
-   *     aspectRatioHeight: "9",
-   *     aspectRatioWidth: "16",
-   *     width: "100",
-   *     height: "100",
-   * })
+   *     await imageUploader.selectImageFromLibrary({
+   *         nthImage: 0,
+   *         searchTerm: "",
+   *         toggleOrginalImage: false,
+   *         toggleAspectRatioLock: false,
+   *         aspectRatioHeight: "9",
+   *         aspectRatioWidth: "16",
+   *         width: "100",
+   *         height: "100",
+   *     })
    * @endexample
   */
   selectImageFromLibrary: ({
@@ -1234,7 +1910,48 @@ declare class OrganizationPage {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to generate  the subdomain URL. It takes the following parameters:
+   *
+   * appName(required): Name of the app.
+   *
+   * @example 
+   *
+   *   const domain = organizationPage.baseUrlGenerator(appName)
+   *   console.log(domain) // https://${subdomainName}.${appName}.net
+   *   // "subdomainName" is the loggedIn user name
+   * @endexample
+  */
   baseUrlGenerator: (appName: string) => string;
+  /**
+   *
+   * Used to create a new organization. It takes the following parameters:
+   *
+   * email: Owner emails.
+   *
+   * businessName: Your business name.
+   *
+   * subdomainName: Your subdomain.
+   *
+   * firstName: User first name.
+   *
+   * lastName: User last name.
+   *
+   * appName: App name
+   *
+   * @example 
+   *
+   *   await organizationPage.createOrganization({
+   *     email:"jhondoe@gmail.com",
+   *     businessName:"BigBinary",
+   *     subdomainName:"bigbinary",
+   *     firstName:"jhon",
+   *     lastName:"doe",
+   *     appName:"neetoChat"
+   *   })
+   * @endexample
+  */
   createOrganization: ({
     email,
     businessName,
@@ -1243,9 +1960,58 @@ declare class OrganizationPage {
     lastName,
     appName
   }: CreateOrganizationProps) => Promise<void>;
+  /**
+   *
+   * Used to set up an Organization. It takes the following parameters:
+   *
+   * product: Name of the product.
+   *
+   * @example 
+   *
+   *   await organizationPage.setupOrganization("Chat")
+   * @endexample
+  */
   setupOrganization: (product: string) => Promise<void>;
+  /**
+   *
+   * Used to update already existing subdomain name. It takes the following parameters:
+   *
+   * appName: Name of the app.
+   *
+   * @example 
+   *
+   *   await organizationPage.updateSubdomainIfExists("latest subdomain")
+   * @endexample
+  */
   updateSubdomainIfExists: (appName: string) => Promise<void>;
+  /**
+   *
+   * Used to login via SSO. It takes the following parameters:
+   *
+   * email (optional): A bypass email. If not provided, a random bypass email will be generated.
+   *
+   * @example 
+   *
+   *  await organizationPage.loginViaSSO()
+   * @endexample
+  */
   loginViaSSO: (email?: string) => Promise<void>;
+  /**
+   *
+   * Used to fill and submit all the profile info. It takes the following parameters:
+   *
+   * firstName (optional): The first name of the user.
+   *
+   * lastName (optional): The last name of the user.
+   *
+   * @example 
+   *
+   *   await organizationPage.setupProfile({
+   *     firstName:"John",
+   *     lastName:"Doe"
+   *   })
+   * @endexample
+  */
   setupProfile: ({
     firstName,
     lastName
@@ -1253,12 +2019,61 @@ declare class OrganizationPage {
     firstName?: string | undefined;
     lastName?: string | undefined;
   }) => Promise<void>;
+  /**
+   *
+   * Used to login and onboard the user to app. It takes the following parameters:
+   *
+   * email: User email.
+   *
+   * firstName: User first name.
+   *
+   * lastName: User last name.
+   *
+   * handleOnBoard: Method to call after onboarding.
+   *
+   * @example 
+   *
+   *   await organizationPage.loginAndOnboard({
+   *     email:"jhondoe@gmail.com",
+   *     firstName:"jhon",
+   *     lastName:"doe",
+   *     handleOnboarding:() => methodToOnBoard
+   *   })
+   * @endexample
+  */
   loginAndOnboard: ({
     email,
     firstName,
     lastName,
     handleOnboarding
   }: LoginAndOnboardParams) => Promise<void>;
+  /**
+   *
+   * Used to signUp the user. It takes the following parameters:
+   *
+   * otp: (optional) OTP to verify the email.
+   *
+   * fetchOtpFromEmail: (optional) Method to fetch OTP from email.
+   *
+   * @example 
+   *
+   *   const fetchOtpFromEmail = (email,timeOut)=>Promise<void>
+   * 
+   *   const credentials = {
+   *     otp:1234,
+   *     domain:"chat.com",
+   *     currentUserName:"jhon",
+   *     businessName:"bigbinary",
+   *     subdomainName: "bigbinary"
+   *   }
+   * 
+   *   await organizationPage.signUp({
+   *     credentials,
+   *     fetchOtpFromEmail,
+   *     appName:"neetoChat"
+   *   })
+   * @endexample
+  */
   signUp: ({
     credentials,
     fetchOtpFromEmail,
@@ -1292,6 +2107,26 @@ declare class OrganizationPage {
     };
     baseURL: string | undefined;
   }>;
+  /**
+   *
+   * Used to fill and complete all the details of an Organization.
+   *
+   * @example 
+   *
+   *   const credentials = {
+   *     otp:1234,
+   *     domain:"chat.com",
+   *     currentUserName:"jhon",
+   *     businessName:"bigbinary",
+   *     subdomainName: "bigbinary"
+   *   }
+   * 
+   *   await organizationPage.fillOrganizationDetails({
+   *     credentials,
+   *     appName:"neetoChat"
+   *   })
+   * @endexample
+  */
   fillOrganizationDetails: ({
     credentials,
     appName
@@ -1305,32 +2140,193 @@ declare class SidebarSection {
   neetoPlaywrightUtilities: CustomCommands;
   t: TFunction;
   constructor(page: Page, neetoPlaywrightUtilities: CustomCommands);
+  /**
+   *
+   * Used to click on the sub link in the sidebar. It takes the following parameters:
+   *
+   * label (required): The label of the sub link.
+   *
+   * @example 
+   *
+   *   await sideBarPage.clickOnSubLink("open menu item")
+   * @endexample
+  */
   clickOnSubLink: (label: string) => Promise<void>;
+  /**
+   *
+   * Used to go back to the previous page. It takes the following parameters:
+   *
+   * label (required): The label of the go back button.
+   *
+   * @example 
+   *
+   *   await sideBarPage.sidebarGoBackButton("settings")
+   * @endexample
+  */
   clickOnGoBackButton: (label: string) => Promise<void>;
 }
+/**
+ *
+ * Constants related to different environments.
+ *
+ * development: Represents the development environment.
+ *
+ * staging: Represents the staging environment.
+ *
+ * review: Represents the review environment.
+ *
+ * @example 
+ *
+ * if (process.env.NODE_ENV === ENVIRONMENT.development) {
+ *   // Perform actions specific to the development environment
+ * }
+ * 
+ * // OR
+ * 
+ * if (process.env.NODE_ENV === ENVIRONMENT.staging) {
+ *   // Perform actions specific to the staging environment
+ * }
+ * 
+ * // OR
+ * 
+ * if (process.env.NODE_ENV === ENVIRONMENT.review) {
+ *   // Perform actions specific to the review environment
+ * }
+ * @endexample
+*/
 declare const ENVIRONMENT: {
   development: string;
   staging: string;
   review: string;
 };
+/**
+ *
+ * Boolean value indicating whether the current environment is staging.
+ *
+ * @example 
+ *
+ * if(IS_STAGING_ENV){
+ *   // Perform actions specific to the staging environment
+ * }
+ * @endexample
+*/
 declare const IS_STAGING_ENV: boolean;
+/**
+ *
+ * Path to the JSON file for storing authentication data.
+ *
+*/
 declare const STORAGE_STATE = "./e2e/auth/user.json";
+/**
+ *
+ * Pattern for global translations file path.
+ *
+*/
 declare const GLOBAL_TRANSLATIONS_PATTERN = "../node_modules/@bigbinary/**/translations/en.json";
+/**
+ *
+ * Path to project-specific translations file.
+ *
+*/
 declare const PROJECT_TRANSLATIONS_PATH = "../app/javascript/src/translations/en.json";
+/**
+ *
+ * Default credentials for testing purposes.
+ *
+*/
 declare const CREDENTIALS: {
   name: string;
   email: string;
   password: string;
 };
+/**
+ *
+ * Pattern for the subject of OTP emails.
+ *
+*/
 declare const OTP_EMAIL_PATTERN = "is your login code";
+/**
+ *
+ * Default Slack channel.
+ *
+*/
 declare const SLACK_DEFAULT_CHANNEL = "general";
+/**
+ *
+ * Function to generate Zapier test email address based on the product. It takes the following parameters:
+ *
+ * product: Product name.
+ *
+ * @example 
+ *
+ * const testEmail = ZAPIER_TEST_EMAIL("neetoChat");
+ * 
+ * console.log(testEmail) // `neeto-neetoChat-zapier-test@${process.env.INTEGRATION_MAILOSAUR_SERVER_ID}.mailosaur.net`
+ * @endexample
+*/
 declare const ZAPIER_TEST_EMAIL: (product: string) => string;
 declare const USER_AGENTS: {
   windows: string;
   mac: string;
 };
+/**
+ *
+ * Description: Base URL for API endpoints.
+ *
+ * Value: "/api/v1"
+ *
+ * @example 
+ *
+ *   import { BASE_URL } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+*/
 declare const BASE_URL = "/api/v1";
 declare const NEETO_AUTH_BASE_URL: (subdomain?: string) => string;
+/**
+ *
+ * Object containing various route URLs.
+ *
+ * @example 
+ *
+ *   import { ROUTES } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * neetoAuthSignup: URL for Neeto Auth signup page.
+ *
+ * neetoAuth: Base URL for Neeto Auth.
+ *
+ * loginLink: URL for login page.
+ *
+ * profile: URL for user profile page.
+ *
+ * admin: URL for admin page.
+ *
+ * myProfile: URL for personal profile page.
+ *
+ * authSettings: URL for authentication settings page.
+ *
+ * webhooks: URL for webhooks page.
+ *
+ * login: URL for login API endpoint.
+ *
+ * signup: URL for signup API endpoint.
+ *
+ * subdomainAvailability: URL for checking subdomain availability API endpoint.
+ *
+ * countries: URL for countries API endpoint.
+ *
+ * neetoApps: URL for Neeto Apps API endpoint.
+ *
+ * teamMembers: Object containing URLs related to team members.
+ *
+ * all: URL for retrieving all team members.
+ *
+ * bulkUpdate: URL for bulk updating team members.
+ *
+ * index: URL for team members index.
+ *
+ * show(id): Method to generate URL for showing a specific team member's details.
+ *
+*/
 declare const ROUTES: {
   neetoAuthSignup: string;
   neetoAuth: string;
@@ -1354,6 +2350,23 @@ declare const ROUTES: {
   };
   attachment: string;
 };
+/**
+ *
+ * Object containing API route URLs.
+ *
+ * @example 
+ *
+ * import { API_ROUTES } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * teamMembers: Object containing URLs related to team members (similar structure to ROUTES).
+ *
+ * integrations: Object containing URLs for integrations.
+ *
+ * zapier: Object containing URLs specific to Zapier integration.
+ *
+ * api_keys: URL for Zapier API keys.
+ *
+*/
 declare const API_ROUTES: {
   teamMembers: {
     all: string;
@@ -1367,6 +2380,39 @@ declare const API_ROUTES: {
     };
   };
 };
+/**
+ *
+ * Object containing URLs for third-party services.
+ *
+ * @example 
+ *
+ *  import { THIRD_PARTY_ROUTES } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * webhooks: Object containing URLs for webhook services.
+ *
+ * site: Base URL for webhook.site.
+ *
+ * slack: Object containing URLs for Slack.
+ *
+ * loginWithPassword(workspace): Method to generate URL for logging into Slack workspace using password.
+ *
+ * @example 
+ *
+ *   THIRD_PARTY_ROUTES.slack.loginWithPassword("example") // Outputs: "https://example.slack.com/sign_in_with_password"
+ * @endexample
+ * zapier: Object containing URLs for Zapier.
+ *
+ * login: URL for Zapier login.
+ *
+ * logOut: URL for Zapier logout.
+ *
+ * zapEditor(zapId): Method to generate URL for Zapier Zap editor.
+ *
+ * @example 
+ *
+ *   THIRD_PARTY_ROUTES.zapier.zapEditor("123") // Outputs: "https://zapier.com/editor/123"
+ * @endexample
+*/
 declare const THIRD_PARTY_ROUTES: {
   webhooks: {
     site: string;
@@ -1386,18 +2432,144 @@ declare const NEETO_ROUTES: {
 declare const networkConditions: Record<"Slow 3G" | "Fast 3G" | "No Throttling", Protocol.Network.emulateNetworkConditionsParameters>;
 /**
  *
- * This constant contains the commonly used selectors including selectors for
- *
- * neetoUI components.
- *
- * undefined
+ * Common selectors for UI elements.
  *
  * @example 
  *
  * import { COMMON_SELECTORS } from "@bigbinary/neeto-playwright-commons";
- * 
- * cy.get(COMMON_SELECTORS.alertTitle).should("be.visible");
  * @endexample
+ * copyButton: Selector for the copy button.
+ *
+ * spinner: Selector for spinners.
+ *
+ * subheaderText: Selector to get the subheader text.
+ *
+ * alertTitle: Selector for alert titles.
+ *
+ * alertModalMessage: Selector for alert modal messages.
+ *
+ * alertModalSubmitButton: to get the submit button of the neetoUI Alert component.
+ *
+ * checkbox: Selector for checkboxes.
+ *
+ * checkboxLabel: Selector for checkbox labels.
+ *
+ * dropdownContainer: Selector for dropdown containers.
+ *
+ * dropdownIcon: Selector for dropdown icons.
+ *
+ * heading: Selector for headings.
+ *
+ * paneBody: Selector for pane bodies.
+ *
+ * paneHeader: Selector for pane headers.
+ *
+ * profileSidebar: Selector for profile sidebars.
+ *
+ * selectOption(label: string): Method that generates a selector for select options based on the label.
+ *
+ * radioLabel(embedLabel: string): Method that generates a selector for radio labels based on the embedded label.
+ *
+ * toastMessage: To get the neetoUI Toastr message.
+ *
+ * toastCloseButton: To get the neetoUI Toastr close icon.
+ *
+ * windowAlert: Selector for window alerts.
+ *
+ * body: Selector for the body.
+ *
+ * toastIcon: To get the neetoUI Toastr icon.
+ *
+ * paneModalCrossIcon: Selector for pane modal cross icons.
+ *
+ * inputField: Selector to get neetoUI input field.
+ *
+ * alertConfirmationText: Selector for alert confirmation text.
+ *
+ * alertCancelButton: Selector for alert cancel buttons.
+ *
+ * alertModalCrossIcon: Selector for alert modal cross icons.
+ *
+ * saveChangesButton: Selector for save changes buttons.
+ *
+ * cancelButton: Selector for cancel buttons.
+ *
+ * inputFieldError: Selector for input field errors.
+ *
+ * selectDropDownError: Selector for select dropdown errors.
+ *
+ * subTitleHeading: Selector for subtitle headings.
+ *
+ * noDataTitle: Selector for no data titles.
+ *
+ * noDataDescription: Selector for no data descriptions.
+ *
+ * backdrop: Selector for backdrops.
+ *
+ * menuBarHeading: Selector for menu bar headings.
+ *
+ * dropdownWrapper: Selector for dropdown wrappers.
+ *
+ * toggleButton: Selector for toggle buttons.
+ *
+ * tooltip: Selector for tooltips.
+ *
+ * articlePageTitle: Selector for article page titles.
+ *
+ * tabItem: Selector for tab items.
+ *
+ * labelInputError: Selector for label input errors.
+ *
+ * urlInputError: Selector for URL input errors.
+ *
+ * noDataPrimaryButton: Selector for no data primary buttons.
+ *
+ * modalHeader: Selector for modal headers.
+ *
+ * nameInputError: Selector for name input errors.
+ *
+ * selectContainer: to get the select container.
+ *
+ * selectValueContainer: Selector for select value containers.
+ *
+ * dropdownMenu: Selector for dropdown menus.
+ *
+ * sidebarToggle: Selector for sidebar toggles.
+ *
+ * subheader: Selector for subheaders.
+ *
+ * settingsLink: Selector for settings links.
+ *
+ * ticketFieldTextInput(label: string | number): Method that generates a selector for ticket field text inputs based on the label.
+ *
+ * appSwitcherButton: Selector for app switcher buttons.
+ *
+ * appSwitcherWrapper: Selector for app switcher wrappers.
+ *
+ * tableSpinner: Selector to get the spinner when the table is loading.
+ *
+ * pageLoader: Selector to get the spinner when the page element is loading.
+ *
+ * homeButton: Selector for home buttons.
+ *
+ * neetoUiSwitch: Selector for Neeto UI switches.
+ *
+ * floatingActionMenuButton: Selector for floating action menu buttons.
+ *
+ * columnsDropdownContainer: Selector for columns dropdown containers.
+ *
+ * columnsDropdownButton: Selector for columns dropdown buttons.
+ *
+ * breadcrumbHeader: Selector for breadcrumb headers.
+ *
+ * header: Selector to get the page header.
+ *
+ * sidebarSubLink(label: string): Method that generates a selector for sidebar sub-links based on the label.
+ *
+ * sidebarGoBackButton(label: string): Method that generates a selector for sidebar go-back buttons based on the label.
+ *
+ * selectSingleValue: Selector for select single values.
+ *
 */
 declare const COMMON_SELECTORS: {
   emailInputError: string;
@@ -1473,6 +2645,57 @@ declare const COMMON_SELECTORS: {
   takeActionDropdown: string;
   columnsSearchInput: string;
 };
+/**
+ *
+ * Selectors for Neeto editor components.
+ *
+ * @example 
+ *
+ * import { NEETO_EDITOR_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * boldOption: Selector for the bold option.
+ *
+ * italicOption: Selector for the italic option.
+ *
+ * underlineOption: Selector for the underline option.
+ *
+ * strikeOption: Selector for the strike option.
+ *
+ * codeBlockOption: Selector for the code block option.
+ *
+ * highlightOption: Selector for the highlight option.
+ *
+ * linkInput: Selector for the link input.
+ *
+ * linkSubmitButton: Selector for the link submit button.
+ *
+ * commandList(index: number): Method that generates a selector for command list items based on the index.
+ *
+ * imageUploadUrlSubmitButton: Selector for the image upload URL submit button.
+ *
+ * imageUploadUrlInputTextField: Selector for the image upload URL input text field.
+ *
+ * uploadInput: Selector for the upload input.
+ *
+ * editorMenuBarWrapper: Selector for the editor menu bar wrapper.
+ *
+ * undoOption: Selector for the undo option.
+ *
+ * redoOption: Selector for the redo option.
+ *
+ * imageWrapper: Selector for the image wrapper.
+ *
+ * contentField: Selector for the content field.
+ *
+ * addLinkButton: Selector for the add link button.
+ *
+ * addLinkTextField: Selector for the add link text input field.
+ *
+ * addURLTextField: Selector for the add URL input field.
+ *
+ * submitLinkButton: Selector for the submit link button.
+ *
+*/
 declare const NEETO_EDITOR_SELECTORS: {
   boldOption: string;
   italicOption: string;
@@ -1542,6 +2765,47 @@ declare const FONT_SIZE_SELECTORS: {
   h4: string;
   h5: string;
 };
+/**
+ *
+ * Selectors for Neeto filters components.
+ *
+ * @example 
+ *
+ * import { NEETO_FILTERS_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * emailSelectContainer: Selector for the email select container wrapper.
+ *
+ * filterPaneHeading: Selector for the Neeto filters pane header.
+ *
+ * neetoFiltersEmailBlock: Selector for the Neeto filters email block.
+ *
+ * neetoFiltersRoleBlock: Selector for the Neeto filters role block.
+ *
+ * neetoFiltersBarClearButton: Selector for the Neeto filters bar clear button.
+ *
+ * neetoFiltersNameFilterField: Selector for the Neeto filters name filter field.
+ *
+ * neetoFilterNameBlock: Selector for the Neeto filter name block.
+ *
+ * roleSelectContainer: Selector for the role select container wrapper.
+ *
+ * filterButton: Selector for the Neeto filters toggle button.
+ *
+ * filtersClearButton: Selector for the Neeto filters clear button.
+ *
+ * filterDoneButton: Selector for the Neeto filters done button.
+ *
+ * filteredMembersCount: Selector for the filtered members count.
+ *
+ * allMenubarBlock: Selector for the all menubar block.
+ *
+ * filtersEmailFilter: Selector for the Neeto filters email filter.
+ *
+ * paneModalCrossIcon: Selector for the Neeto filters pane modal cross icon.
+ *
+ * searchTermBlock: Selector for the Neeto filters search term block.
+ *
+*/
 declare const NEETO_FILTERS_SELECTORS: {
   emailSelectContainer: string;
   filterPaneHeading: string;
@@ -1560,6 +2824,33 @@ declare const NEETO_FILTERS_SELECTORS: {
   paneModalCrossIcon: string;
   searchTermBlock: string;
 };
+/**
+ *
+ * Selectors for Help Center components.
+ *
+ * @example 
+ *
+ * import { HELP_CENTER_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * helpButton: Selector for the help button.
+ *
+ * documentationButton: Selector for the documentation button.
+ *
+ * keyboardShortcutButton: Selector for the keyboard shortcut button.
+ *
+ * chatButton: Selector for the chat button.
+ *
+ * whatsNewButton: Selector for the "What's New" button.
+ *
+ * whatsNewWidgetInfo: Selector for the "What's New" widget info.
+ *
+ * whatsNewWidgetCloseButton: Selector for the "What's New" widget close button.
+ *
+ * keyboardShortcutPaneHeading: Selector for the keyboard shortcut pane heading.
+ *
+ * keyboardShortcutPaneCrossIcon: Selector for the keyboard shortcut pane cross icon.
+ *
+*/
 declare const HELP_CENTER_SELECTORS: {
   helpButton: string;
   documentationButton: string;
@@ -1571,6 +2862,33 @@ declare const HELP_CENTER_SELECTORS: {
   keyboardShortcutPaneHeading: string;
   keyboardShortcutPaneCrossIcon: string;
 };
+/**
+ *
+ * Selectors for login components.
+ *
+ * @example 
+ *
+ * import { LOGIN_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * appleAuthenticationButton: Selector for the Apple authentication button.
+ *
+ * emailTextField: Selector to get the email field.
+ *
+ * googleAuthenticationButton: Selector for the Google authentication button.
+ *
+ * githubAuthenticationButton: Selector for the GitHub authentication button.
+ *
+ * loginViaEmailButton: Selector for the login via email button.
+ *
+ * passwordTextField: Selector for the password text field.
+ *
+ * rememberMeCheckBox: Selector for the remember me check box.
+ *
+ * submitButton: Selector for the submit button.
+ *
+ * twitterAuthenticationButton: Selector for the Twitter authentication button.
+ *
+*/
 declare const LOGIN_SELECTORS: {
   appleAuthenticationButton: string;
   emailTextField: string;
@@ -1582,6 +2900,61 @@ declare const LOGIN_SELECTORS: {
   submitButton: string;
   twitterAuthenticationButton: string;
 };
+/**
+ *
+ * Selectors for member components.
+ *
+ * @example 
+ *
+ * import { MEMBER_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * membersTab: Selector for the members tab.
+ *
+ * newButton: Selector for the "New" button to add a new member.
+ *
+ * continueButton: Selector for the "Continue" button.
+ *
+ * submitButton: Selector for the "Submit" button.
+ *
+ * searchTextField: Selector for the search text field.
+ *
+ * deactivatedAgentsButton: Selector for the deactivated agents button.
+ *
+ * activatedMembersButton: Selector for the activated members button.
+ *
+ * columnCheckBox: Selector to get the neetoUI checkbox.
+ *
+ * roleLabel(role: string): Method that generates a selector for role labels based on the role.
+ *
+ * dropDownIcon: Selector to get the neetoUI Dropdown icon button.
+ *
+ * editButton: Selector for the edit button.
+ *
+ * menuBarHeading: Selector for the menu bar heading.
+ *
+ * activateOrDeactivateMember: Selector for the activate or deactivate member button.
+ *
+ * columnsButton: Selector for the columns button.
+ *
+ * columnsDropdownContainer: Selector for the columns dropdown container.
+ *
+ * emailDropdownItemLabel: Selector for the email dropdown item label.
+ *
+ * roleDropdownItemLabel: Selector for the role dropdown item label.
+ *
+ * inviteStatusDropdownItemLabel: Selector for the invite status dropdown item label.
+ *
+ * heading: Selector for the manage members pane header.
+ *
+ * activateButton: Selector for the activate members button.
+ *
+ * deactivateButton: Selector for the deactivate members button.
+ *
+ * rolesButton: Selector for the manage member roles button.
+ *
+ * statusTag: Selector for the member status tag.
+ *
+*/
 declare const MEMBER_SELECTORS: {
   membersTab: string;
   newButton: string;
@@ -1611,6 +2984,27 @@ declare const MEMBER_SELECTORS: {
   takeActionStateOption: (option?: string) => string;
   checkboxLabel: (label: string) => string;
 };
+/**
+ *
+ * Selectors for member form components.
+ *
+ * @example 
+ *
+ * import { MEMBER_FORM_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * emailTextField: Selector for the email text field in the member form.
+ *
+ * firstNameTextField: Selector for the first name text field in the member form.
+ *
+ * lastNameTextField: Selector for the last name text field in the member form.
+ *
+ * emailInput: Selector for the email input in the member form.
+ *
+ * emailErrorField: Selector for the email error field in the member form.
+ *
+ * cancelButton: Selector for the cancel button in the member form.
+ *
+*/
 declare const MEMBER_FORM_SELECTORS: {
   emailTextField: string;
   firstNameTextField: string;
@@ -1619,6 +3013,52 @@ declare const MEMBER_FORM_SELECTORS: {
   emailErrorField: string;
   cancelButton: string;
 };
+/**
+ *
+ * Selectors for roles components.
+ *
+ * @example 
+ *
+ * import {
+ *  ROLES_SELECTORS
+ * } from "@bigbinary/neeto-playwright-commons";
+ * 
+ * @endexample
+ * newButton: Selector for the "New" button to add a new role.
+ *
+ * proceedButton: Selector for the "Proceed" button.
+ *
+ * cancelButton: Selector for the "Cancel" button.
+ *
+ * tableHeaderRoleName: Selector for the table header role name.
+ *
+ * nameTextField: Selector for the name text field when adding or updating a role.
+ *
+ * searchTextField: Selector for the search text field for roles.
+ *
+ * updateRolePaneHeading: Selector for the heading when updating a role.
+ *
+ * updateRoleCancelButton: Selector for the cancel button when updating a role.
+ *
+ * descriptionTextField: Selector for the description text field when adding or updating a role.
+ *
+ * permissionCategoryTitle: Selector for the title of the permission category.
+ *
+ * headerColumn: Selector for the header column of the roles table.
+ *
+ * dropDownIcon: Selector for the dropdown icon in the roles table header.
+ *
+ * tableHeaderRoleTitle: Selector for the title in the roles table header.
+ *
+ * permissionCheckbox: Selector for the permission checkbox.
+ *
+ * editRoleButton: Selector for the edit role button in the roles table.
+ *
+ * deleteRoleButton: Selector for the delete role button in the roles table.
+ *
+ * permissionCard: Selector for the permission card.
+ *
+*/
 declare const ROLES_SELECTORS: {
   newButton: string;
   proceedButton: string;
@@ -1639,19 +3079,39 @@ declare const ROLES_SELECTORS: {
   permissionCard: string;
 };
 /**
- *
- * This constant contains the commonly used selectors for getting elements from
- *
- * signup page in neetoAuth.
- *
- * undefined
  *
  * @example 
  *
  * import { SIGNUP_SELECTORS } from "@bigbinary/neeto-playwright-commons";
- * 
- * cy.get(SIGNUP_SELECTORS.emailTextField).should("be.visible");
  * @endexample
+ * Selectors for signup components.
+ *
+ * emailTextField: Selector for the email text field in the signup form.
+ *
+ * firstNameTextField: Selector for the first name text field in the signup form.
+ *
+ * lastNameTextField: Selector for the last name text field in the signup form.
+ *
+ * organizationNameTextField: Selector for the organization name text field in the signup form.
+ *
+ * organizationSubmitButton: Selector for the organization submit button in the signup form.
+ *
+ * otpTextBox: Selector for the OTP input text box in the signup form.
+ *
+ * profileSubmitButton: Selector for the profile submit button in the signup form.
+ *
+ * signupViaEmailButton: Selector for the signup via email button.
+ *
+ * submitButton: Selector for the submit button in the signup form.
+ *
+ * subdomainNameTextField: Selector for the subdomain name text field in the signup form.
+ *
+ * subdomainError: Selector for the subdomain input error message in the signup form.
+ *
+ * tryFreeButton: Selector for the "Try Free" button.
+ *
+ * unregisterdEmailError: Selector for the error message when using an unregistered email in the signup form.
+ *
 */
 declare const SIGNUP_SELECTORS: {
   emailTextField: string;
@@ -1668,6 +3128,31 @@ declare const SIGNUP_SELECTORS: {
   tryFreeButton: string;
   unregisterdEmailError: string;
 };
+/**
+ *
+ * Selectors for tags components.
+ *
+ * @example 
+ *
+ * import { TAGS_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * newTagButton: Selector for the "New Tag" button.
+ *
+ * tagNameTextField: Selector for the tag name text field.
+ *
+ * editButton: Selector for the edit button for tags.
+ *
+ * deleteButton: Selector for the delete button for tags.
+ *
+ * cancelButton: Selector for the cancel button when managing tags.
+ *
+ * submitButton: Selector for the submit button when managing tags.
+ *
+ * searchTextField: Selector for the search text field for tags.
+ *
+ * descriptionTextArea: Selector for the description text area for tags.
+ *
+*/
 declare const TAGS_SELECTORS: {
   newTagButton: string;
   tagNameTextField: string;
@@ -1678,6 +3163,33 @@ declare const TAGS_SELECTORS: {
   searchTextField: string;
   descriptionTextArea: string;
 };
+/**
+ *
+ * Selectors for merging tags components.
+ *
+ * @example 
+ *
+ * import { MERGE_TAGS_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * mergeTagsButton: Selector for the "Merge Tags" button.
+ *
+ * mergeButton: Selector for the merge button.
+ *
+ * sourceSearchTextField: Selector for the search text field in the source tags section.
+ *
+ * sourceTagsList: Selector for the list of source tags.
+ *
+ * destinationTagsList: Selector for the list of destination tags.
+ *
+ * destinationSearchTextField: Selector for the search text field in the destination tags section.
+ *
+ * cancelButton: Selector for the cancel button when merging tags.
+ *
+ * proceedButton: Selector for the proceed button when merging tags.
+ *
+ * disabledTag: Selector for disabled tags.
+ *
+*/
 declare const MERGE_TAGS_SELECTORS: {
   mergeTagsButton: string;
   mergeButton: string;
@@ -1689,6 +3201,29 @@ declare const MERGE_TAGS_SELECTORS: {
   proceedButton: string;
   disabledTag: string;
 };
+/**
+ *
+ * Selectors for the chat widget components.
+ *
+ * @example 
+ *
+ * import { CHAT_WIDGET_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * iframe: Selector for the chat widget iframe.
+ *
+ * spinner: Selector for the spinner in the chat widget.
+ *
+ * helpButton: Selector for the help button in the chat widget.
+ *
+ * preChatEmailInput: Selector for the email input in the pre-chat section of the chat widget.
+ *
+ * preChatSubmitButton: Selector for the submit button in the pre-chat section of the chat widget.
+ *
+ * chatBubble: Selector for the chat message bubble in the chat widget.
+ *
+ * closeChat: Selector for the close button in the chat widget.
+ *
+*/
 declare const CHAT_WIDGET_SELECTORS: {
   iframe: string;
   spinner: string;
@@ -1698,16 +3233,69 @@ declare const CHAT_WIDGET_SELECTORS: {
   chatBubble: string;
   closeChat: string;
 };
+/**
+ *
+ * @example 
+ *
+ * import { CHANGELOG_WIDGET_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * Selectors for the changelog widget components.
+ *
+ * changelogWrapper: Selector for the wrapper of the changelog widget.
+ *
+ * closeButton: Selector for the close button in the changelog widget.
+ *
+ * publicUrlLink: Selector for the public URL link in the changelog widget.
+ *
+*/
 declare const CHANGELOG_WIDGET_SELECTORS: {
   changelogWrapper: string;
   closeButton: string;
   publicUrlLink: string;
 };
+/**
+ *
+ * Selectors for the keyboard shortcuts pane components.
+ *
+ * @example 
+ *
+ * import { KEYBOARD_SHORTCUTS_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * keyboardShortcutsPane: Selector for the keyboard shortcuts pane.
+ *
+ * closePaneButton: Selector for the close button in the keyboard shortcuts pane.
+ *
+ * hotKeyItem: Selector for the hotkey item in the keyboard shortcuts pane.
+ *
+*/
 declare const KEYBOARD_SHORTCUTS_SELECTORS: {
   keyboardShortcutsPane: string;
   closePaneButton: string;
   hotKeyItem: string;
 };
+/**
+ *
+ * Selectors for profile section components.
+ *
+ * @example 
+ *
+ * import { PROFILE_SECTION_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * profileSectionButton: Selector for the profile section button.
+ *
+ * profilePopup: Selector for the profile popup.
+ *
+ * myProfileButton: Selector for the "My Profile" button.
+ *
+ * profileOrganizationSettingsButton: Selector for the profile organization settings button.
+ *
+ * logoutButton: Selector for the logout button.
+ *
+ * neetoAuthLink: Selector for the Neeto authentication link button.
+ *
+ * profileSidebarCancelButton: Selector for the profile sidebar cancel button.
+ *
+*/
 declare const PROFILE_SECTION_SELECTORS: {
   profileSectionButton: string;
   profilePopup: string;
@@ -1717,6 +3305,43 @@ declare const PROFILE_SECTION_SELECTORS: {
   neetoAuthLink: string;
   profileSidebarCancelButton: string;
 };
+/**
+ *
+ * Selectors for Slack components.
+ *
+ * @example 
+ *
+ * import { SLACK_SELECTORS} from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * messageContainer: Selector for the message container.
+ *
+ * loginEmail: Selector for the login email input.
+ *
+ * loginPassword: Selector for the login password input.
+ *
+ * signInButton: Selector for the sign-in button.
+ *
+ * teamPicketButtonContent: Selector for the team picker button content.
+ *
+ * redirectOpenInBrowser: Selector for the redirect "open in browser" button.
+ *
+ * workspaceActionsButton: Selector for the workspace actions button.
+ *
+ * teamMenuTrigger: Selector for the team menu trigger.
+ *
+ * menuItemButton: Selector for the menu item button.
+ *
+ * threadsFlexpane: Selector for the threads flexpane.
+ *
+ * replyBar: Selector for the reply bar.
+ *
+ * markdownElement: Selector for the markdown element.
+ *
+ * virtualListItem: Selector for the virtual list item.
+ *
+ * channelItems: Selector for channel items.
+ *
+*/
 declare const SLACK_SELECTORS: {
   messageContainer: string;
   loginEmail: string;
@@ -1733,6 +3358,39 @@ declare const SLACK_SELECTORS: {
   virtualListItem: string;
   channelItems: string;
 };
+/**
+ *
+ * Selectors for Slack components using 'data-qa' attributes.
+ *
+ * @example 
+ *
+ * import { SLACK_DATA_QA_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * sectionHeadingButton: Selector for the section heading button.
+ *
+ * channelSectionSubmenuCreate: Selector for the channel section submenu create button.
+ *
+ * channelSectionMenuCreateChannel: Selector for the channel section menu create channel button.
+ *
+ * skModalContent: Selector for the modal content.
+ *
+ * infiniteSpinner: Selector for the infinite spinner.
+ *
+ * channelNameOptionsList: Selector for the channel name options list.
+ *
+ * channelNameInput: Selector for the channel name input.
+ *
+ * createChannelNextButton: Selector for the create channel next button.
+ *
+ * inviteToWorkspaceSkipButton: Selector for the invite to workspace skip button.
+ *
+ * menuItems: Selector for the menu items.
+ *
+ * channelDetailsModal: Selector for the channel details modal.
+ *
+ * channelDetailsSettingsTab: Selector for the channel details settings tab.
+ *
+*/
 declare const SLACK_DATA_QA_SELECTORS: {
   sectionHeadingButton: string;
   channelSectionSubmenuCreate: string;
@@ -1747,6 +3405,25 @@ declare const SLACK_DATA_QA_SELECTORS: {
   channelDetailsModal: string;
   channelDetailsSettingsTab: string;
 };
+/**
+ *
+ * Selectors for integration components.
+ *
+ * @example 
+ *
+ * import { INTEGRATION_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * integrationCard(integration: string): Method that generates a selector for the integration card based on the integration name. Accepts a string parameter representing the integration name.
+ *
+ * connectButton: Selector for the connect button.
+ *
+ * integrationStatusTag: Selector for the integration status tag.
+ *
+ * disconnectButton: Selector for the disconnect button.
+ *
+ * manageButton: Selector for the manage button.
+ *
+*/
 declare const INTEGRATION_SELECTORS: {
   integrationCard: (integration: string) => string;
   connectButton: string;
@@ -1754,6 +3431,47 @@ declare const INTEGRATION_SELECTORS: {
   disconnectButton: string;
   manageButton: string;
 };
+/**
+ *
+ * Selectors for Zapier components.
+ *
+ * @example 
+ *
+ * import { ZAPIER_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * zapTriggerStep(zapId: string): Method that generates a selector for the Zap trigger step based on the Zap ID. Accepts a string parameter representing the Zap ID.
+ *
+ * zapAccountSubstep: Selector for the Zap account substep.
+ *
+ * zapOpenSubstepContainer: Selector for the container to open substeps.
+ *
+ * modal: Selector for modals.
+ *
+ * fmPrettytext: Selector for pretty text.
+ *
+ * spinner: Selector for spinners.
+ *
+ * skeletonBlock: Selector for skeleton blocks.
+ *
+ * accountsLoader: Selector for accounts loader.
+ *
+ * floatingBox: Selector for floating boxes.
+ *
+ * connection: Selector for connections.
+ *
+ * deleteConnectionModal: Selector for the delete connection modal.
+ *
+ * deleteConnectionDropdownButton: Selector for the dropdown button to delete a connection.
+ *
+ * usageAmounts: Selector for usage amounts.
+ *
+ * universalSidebar: Selector for the universal sidebar.
+ *
+ * sidebarFooter: Selector for the sidebar footer.
+ *
+ * contextualSideBar: Selector for the contextual sidebar.
+ *
+*/
 declare const ZAPIER_SELECTORS: {
   zapTriggerStep: (zapId: string) => string;
   zapAccountSubstep: string;
@@ -1772,6 +3490,55 @@ declare const ZAPIER_SELECTORS: {
   sidebarFooter: string;
   contextualSideBar: string;
 };
+/**
+ *
+ * Selectors for embed components.
+ *
+ * @example 
+ *
+ * import { EMBED_SELECTORS } from "@bigbinary/neeto-playwright-commons";
+ * @endexample
+ * iframe(appName: string): Method that generates a selector for the iframe based on the app name.
+ *
+ * modal(appName: string): Method that generates a selector for the modal based on the app name.
+ *
+ * close(appName: string): Method that generates a selector for the close button based on the app name.
+ *
+ * loader(appName: string): Method that generates a selector for the loader based on the app name.
+ *
+ * inlineHeightInput: Selector for the inline height input field.
+ *
+ * inlineWidthInput: Selector for the inline width input field.
+ *
+ * inlineElementIdInput: Selector for the inline element ID input field.
+ *
+ * codeBlock: Selector for the code block.
+ *
+ * previewTab: Selector for the preview tab.
+ *
+ * htmlTab: Selector for the HTML tab.
+ *
+ * buttonTextInput: Selector for the button text input field.
+ *
+ * buttonPositionSelectContainer: Selector for the button position select container.
+ *
+ * buttonPositionSelectMenu: Selector for the button position select menu.
+ *
+ * buttonColorLabel: Selector for the button color label.
+ *
+ * buttonTextColorLabel: Selector for the button text color label.
+ *
+ * colorPickerTarget: Selector for the color picker target.
+ *
+ * colorpickerEditableInput: Selector for the color picker editable input.
+ *
+ * showIconCheckbox: Selector for the show icon checkbox.
+ *
+ * elementIdInput: Selector for the element ID input field.
+ *
+ * previewElementPopupButton: Selector for the preview element popup button.
+ *
+*/
 declare const EMBED_SELECTORS: {
   iframe: (appName: string) => string;
   modal: (appName: string) => string;
@@ -1821,10 +3588,22 @@ declare const NEETO_IMAGE_UPLOADER_SELECTORS: {
   widthInputField: string;
   heightInputField: string;
 };
+/**
+ *
+ * newConversation: Text for initiating a new conversation.
+ *
+ * welcomeChatBubble: Text for the welcome message displayed in the chat bubble.
+ *
+*/
 declare const CHAT_WIDGET_TEXTS: {
   newConversation: string;
   welcomeChatBubble: string;
 };
+/**
+ *
+ * agent: Text representing an agent.
+ *
+*/
 declare const MEMBER_TEXTS: {
   agent: string;
   admin: string;
@@ -1832,10 +3611,34 @@ declare const MEMBER_TEXTS: {
   hide: string;
   show: string;
 };
+/**
+ *
+ * connectHeader(integration): Method to generate text for connecting an integration account.
+ *
+ * connectedHeader(integration): Method to generate text indicating a successful connection to an integration.
+ *
+*/
 declare const INTEGRATIONS_TEXTS: {
   connectHeader: (integration: string) => string;
   connectedHeader: (integration: string) => string;
 };
+/**
+ *
+ * signOut: Text for signing out.
+ *
+ * allow: Text for allowing.
+ *
+ * loadingThread: Text indicating thread loading.
+ *
+ * name: Text for name.
+ *
+ * deleteThisChannel: Text for deleting a channel.
+ *
+ * permanentlyDeleteTheChannel: Text for confirming permanent deletion of a channel.
+ *
+ * deleteChannel: Text for deleting a channel.
+ *
+*/
 declare const SLACK_WEB_TEXTS: {
   signOut: string;
   allow: string;
@@ -1845,6 +3648,51 @@ declare const SLACK_WEB_TEXTS: {
   permanentlyDeleteTheChannel: string;
   deleteChannel: string;
 };
+/**
+ *
+ * account: Text for account.
+ *
+ * email: Text for email.
+ *
+ * continue: Text for continue.
+ *
+ * statusLabel: Text for status label.
+ *
+ * editExistingDraft: Text for editing an existing draft.
+ *
+ * signInTo: Text for signing into Zapier.
+ *
+ * yesContinueTo: Text for confirming continuation to a specific destination.
+ *
+ * testTrigger: Text for testing a trigger.
+ *
+ * editStep: Text for editing a step.
+ *
+ * continueWithSelectedRecord: Text for continuing with a selected record.
+ *
+ * publish: Text for publishing.
+ *
+ * delete: Text for deleting.
+ *
+ * loading: Text indicating loading.
+ *
+ * subdomain: Text for subdomain.
+ *
+ * apiKey: Text for API key.
+ *
+ * publishingZapHeading: Text heading for preparing Zap to go live.
+ *
+ * connectionListMenu: Text for connection list item menu.
+ *
+ * usageRegExp: Text for usage reset information.
+ *
+ * trialEndsRegExp: Text for trial end date.
+ *
+ * testCurrentlyInQueue: Text indicating test currently in queue.
+ *
+ * welcomeText(zapierLoginEmail): Method to generate welcome text for Zapier login.
+ *
+*/
 declare const ZAPIER_WEB_TEXTS: {
   account: string;
   email: string;
@@ -1869,9 +3717,19 @@ declare const ZAPIER_WEB_TEXTS: {
   testCurrentlyInQueue: string;
   welcomeText: (zapierLoginEmail: string) => string;
 };
+/**
+ *
+ * zapierApiKeyGenerated: Message indicating successful generation of Zapier API key.
+ *
+*/
 declare const TOASTR_MESSAGES: {
   zapierApiKeyGenerated: string;
 };
+/**
+ *
+ * Text indicating that Zapier's free task limit is exhausted and the test will be aborted.
+ *
+*/
 declare const ZAPIER_LIMIT_EXHAUSTED_MESSAGE = "Zapier free task limit is exhausted. Test will be aborted";
 declare const EMOJI_PICKER_LABEL = "Smileys & People";
 declare const ATTACHMENT_DELETION_TOASTR_MESSAGE = "Attachment has been successfully deleted.";
@@ -1916,7 +3774,7 @@ declare const LIST_MODIFIER_TAGS: {
  *
  * @example 
  *
- * initializeCredentials("invoice");
+ *   initializeCredentials("invoice");
  * @endexample
 */
 declare const initializeCredentials: (product: string) => void;
@@ -1938,43 +3796,152 @@ type UpdateCredentials = ({
 type ClearCredentials = () => void;
 type Hyphenize = (input: number | string) => string;
 type JoinHyphenCase = (args: string) => string;
+/**
+ *
+ * Joins multiple strings with an optional separator. It takes the following parameters:
+ *
+ * string1: The first string to join.
+ *
+ * string2: The second string to join.
+ *
+ * string3 (optional): The third string to join.
+ *
+ * separator (optional): The separator to use between strings. Default is an empty string.
+ *
+ * @example 
+ *
+ *   const result = joinString("Open", "AI", "is", "-");
+ *   console.log(result); // Output: Open-AI-is
+ * @endexample
+*/
 declare const joinString: JoinString;
+/**
+ *
+ * Reads the contents of a JSON file synchronously if it exists, otherwise returns an empty object. It takes the following parameters:
+ *
+ * path (optional): The path of the file to read. Default is STORAGE_STATE.
+ *
+ * @example 
+ *
+ *   readFileSyncIfExists()
+ * @endexample
+*/
 declare const readFileSyncIfExists: ReadFileSyncIfExists;
+/**
+ *
+ * Returns the current logged in user info.
+ *
+ * @example 
+ *
+ *   const user = getGlobalUserState()
+ * @endexample
+*/
 declare const getGlobalUserState: () => Record<string, string>;
+/**
+ *
+ * Writes data to STORAGE_STATE file.  It takes the following parameters:
+ *
+ * data: The data to write to the file.
+ *
+ * @example 
+ *
+ *   writeDataToFile("neeto")
+ * @endexample
+*/
 declare const writeDataToFile: WriteDataToFile;
 /**
  *
- * This function modifies a specified key's value in the user related data stored
- *
- * in the storageState.
+ * Updates credentials with a new key-value pair in the STORAGE_STATE json file. It takes the following parameters:
+ *
+ * key: The key of the credential to update.
+ *
+ * value: The new value to assign to the credential.
+ *
+ * @example 
+ *
+ *   updateCredentials({
+ *     key:"name",
+ *     value:'oliver'
+ *   })
+ * @endexample
+*/
+declare const updateCredentials: UpdateCredentials;
+/**
+ *
+ * Used to remove or delete all the credentials
  *
  * @example 
  *
- * // update the user
- * updateCredentials({
- *   key: "subdomainName",
- *   value: newOrganizationName,
- * });
+ *   removeCredentialFile()
  * @endexample
 */
-declare const updateCredentials: UpdateCredentials;
 declare const removeCredentialFile: ClearCredentials;
 declare const clearCredentials: ClearCredentials;
+/**
+ *
+ * Used to hyphenize the strings. It takes the following parameters:
+ *
+ * input: The string that need to hyphenized.
+ *
+ * @example 
+ *
+ *   import {hyphenize} from  "@bigbinary/neeto-playwright-commons"
+ *   const name = hyphenize("hello world")
+ *   console.log(name) // hello-world
+ * @endexample
+*/
 declare const hyphenize: Hyphenize;
+/**
+ *
+ * Joins multiple strings into a hyphen-separated lowercase string. It takes the following parameters:
+ *
+ * ...args (string[]): The strings to join.
+ *
+ * @example 
+ *
+ *   const result1 = joinHyphenCase("Hello", "World");
+ *   console.log(result1); // Output: hello-world
+ * @endexample
+*/
 declare const joinHyphenCase: JoinHyphenCase;
 /**
  *
- * This are methods which can be used to skip tests based on the current test
+ * Provides functions to skip tests based on the environment.
+ *
+ * forDevelopmentEnv: Skips the test if the environment is development.
+ *
+ * forReviewEnv: Skips the test if the environment is review.
+ *
+ * forAllExceptStagingEnv: Skips the test if the environment is not staging.
+ *
+ * forNonNightlyRun: Skips the test if it's not a nightly run in the staging environment.
  *
- * environment
+ * ifNotWithinAllowedNightlyHours: Skips the test if it's not within the allowed nightly run hours.
+ *
+ * reason: The reason for skipping the test.
+ *
+ * allowedNightlyRunHours (optional): An array of numbers representing the allowed hours for nightly runs. Default is [0, 6, 12, 18].
  *
  * @example 
  *
- * import { skipTest } from "@bigbinary/neeto-playwright-commons";
+ *   // Example usage forDevelopmentEnv:
+ *   skipTest.forDevelopmentEnv();
+ * 
+ *   // Example usage forReviewEnv:
+ *   skipTest.forReviewEnv();
+ * 
+ *   // Example usage forAllExceptStagingEnv:
+ *   skipTest.forAllExceptStagingEnv();
  * 
- * skipTest.forDevelopmentEnv(); // Skip a test if TEST_ENV is "development"
- * skipTest.forReviewEnv(); // Skip a test if TEST_ENV is "review"
- * skipTest.forAllExceptStagingEnv(); // Skip a test if TEST_ENV is NOT "staging"
+ *   // Example usage forNonNightlyRun:
+ *   skipTest.forNonNightlyRun();
+ * 
+ * 
+ *   // Example usage ifNotWithinAllowedNightlyHours:
+ *   skipTest.ifNotWithinAllowedNightlyHours({
+ *     reason: "outside allowed nightly run hours",
+ *     allowedNightlyRunHours: [0, 6, 12, 18]
+ *   })
  * @endexample
 */
 declare const skipTest: {
@@ -1990,20 +3957,119 @@ declare const skipTest: {
     allowedNightlyRunHours?: number[] | undefined;
   }) => void;
 };
+/**
+ *
+ * Checks whether setup and teardown should be skipped.
+ *
+ * @example 
+ *
+ *   const shouldSkip = shouldSkipSetupAndTeardown()
+ * @endexample
+*/
 declare const shouldSkipSetupAndTeardown: () => boolean | "";
+/**
+ *
+ * Trims and replaces multiple whitespace characters in a string with a single space. It takes the following parameters:
+ *
+ * text: The text that need to be squished.
+ *
+ * @example 
+ *
+ *   const textWithExtraSpaces = "   Hello    world   ";
+ *   const squishedText = squish(textWithExtraSpaces);
+ * 
+ *   console.log(squishedText); // Output will be "Hello world"
+ * @endexample
+*/
 declare const squish: (text: string) => string;
+/**
+ *
+ * Converts a string to camel case. It takes the following parameters:
+ *
+ * text: The text that need to be converted to camel case.
+ *
+ * @example 
+ *
+ *   const inputString = "hello_world";
+ *   const camelCaseString = toCamelCase(inputString);
+ * 
+ *   console.log(camelCaseString); // Output will be "helloWorld"
+ * @endexample
+*/
 declare const toCamelCase: (string: string) => string;
+/**
+ *
+ * Creates a function to locate elements by the data-qa attribute on a page.
+ *
+ * @example 
+ *
+ *   // Using getByDataQA to find an element with a single data-qa attribute
+ *   getByDataQA(page, 'some_data_qa_value');
+ * 
+ * 
+ *   // Using getByDataQA to find a nested element with two data-qa attributes
+ *   const findElementByNestedDataQA = getByDataQA(page, ['parent_data_qa_value', 'child_data_qa_value']);
+ * 
+ *   // Now you can use the located elements as needed
+ *   await findElementBySingleDataQA.click();
+ *   await findElementByNestedDataQA.hover();
+ * @endexample
+*/
 declare const getByDataQA: ts_toolbelt_out_Function_Curry.Curry<(page: Page, dataQa: string | [string, string]) => playwright_core.Locator>;
 interface LoginProps {
   page: Page;
   neetoPlaywrightUtilities: CustomCommands;
   loginPath?: string;
 }
+/**
+ *
+ * Used to login by using email and password. It takes the following parameters:
+ *
+ * loginPath (optional): The path to which the user should be redirected for login.
+ *
+ * page: A page object
+ *
+ * neetoPlaywrightUtilities: An object of type NeetoPlaywrightUtilities
+ *
+ * @example 
+ *
+ *   import { loginWithoutSSO } from "@bigbinary/neeto-playwright-commons"
+ * 
+ *   await loginWithoutSSO({
+ *     page,
+ *     neetoPlaywrightUtilities,
+ *     loginPath:"/home"
+ *   })
+ * @endexample
+*/
 declare const loginWithoutSSO: ({
   page,
   neetoPlaywrightUtilities,
   loginPath
 }: LoginProps) => Promise<void>;
+/**
+ *
+ * Used to Login to App
+ *
+ * Only works in staging environment. It takes the following parameters:
+ *
+ * loginPath (optional): The path to which the user should be redirected for login. Default is /
+ *
+ * page: A page object
+ *
+ * neetoPlaywrightUtilities: An object of type NeetoPlaywrightUtilities
+ *
+ * @example 
+ *
+ *   import { login } from "@bigbinary/neeto-playwright-commons"
+ * 
+ *   login({
+ *     page,
+ *     neetoPlaywrightUtilities,
+ *     loginPath:"/home"
+ *   })
+ * @endexample
+*/
 declare const login: ({
   page,
   neetoPlaywrightUtilities,
@@ -2015,16 +4081,23 @@ declare const login: ({
  *
  * neeto products.
  *
- * Usage
- *
  * @example 
  *
- * import { generateRandomBypassEmail } from "@bigbinary/neeto-playwright-commons";
+ *   import { generateRandomBypassEmail } from "@bigbinary/neeto-playwright-commons";
  * 
- * const bypassEmail = generateRandomBypassEmail();
+ *   const bypassEmail = generateRandomBypassEmail();
  * @endexample
 */
 declare const generateRandomBypassEmail: () => string;
+/**
+ *
+ * Used to extract subdomain from the error message.
+ *
+ * @example 
+ *
+ *  extractSubdomainFromError("https://wwww.bb.neetoChat.com") // bb
+ * @endexample
+*/
 declare const extractSubdomainFromError: (errorString: string) => string;
 interface AddMemberProps {
   email: string;
@@ -2047,12 +4120,84 @@ interface DeactiveMemberProps {
   requestCount?: number;
 }
 declare const memberUtils: {
+  /**
+   *
+   * Adds a member to the team via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be added.
+   *
+   * role: Role of the member (default: "Agent").
+   *
+   * appName: Name of the application.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.addMemberViaRequest({
+   *       email: "example@example.com",
+   *       appName: "MyApp",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   // OR
+   * 
+   *   await memberUtils.addMemberViaRequest({
+   *       email: "example@example.com",
+   *       appName: "MyApp",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:10
+   *   });
+   * @endexample
+  */
   addMemberViaRequest: ({
     email,
     role,
     appName,
     neetoPlaywrightUtilities
   }: AddMemberProps) => Promise<playwright_core.APIResponse | undefined>;
+  /**
+   *
+   * Edits a member's details via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be edited.
+   *
+   * firstName (optional): New first name of the member.
+   *
+   * lastName (optional): New last name of the member.
+   *
+   * newRole (optional): New role of the member.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.editMemberViaRequest({
+   *       email: "example@example.com",
+   *       firstName: "John",
+   *       lastName: "Doe",
+   *       newRole: "Admin",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   await memberUtils.editMemberViaRequest({
+   *       email: "example@example.com",
+   *       firstName: "John",
+   *       lastName: "Doe",
+   *       newRole: "Admin",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:10
+   *   })
+   * @endexample
+  */
   editMemberViaRequest: ({
     email,
     firstName,
@@ -2060,6 +4205,34 @@ declare const memberUtils: {
     newRole,
     neetoPlaywrightUtilities
   }: EditMemberProps) => Promise<void>;
+  /**
+   *
+   * Deactivates a member via API request. It takes the following parameters:
+   *
+   * email: Email of the member to be deactivated.
+   *
+   * neetoPlaywrightUtilities: Custom utility functions for API requests.
+   *
+   * requestCount (optional): Specify the number of requests.
+   *
+   * @example 
+   *
+   *   import { memberUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await memberUtils.deactivateMemberViaRequest({
+   *       email: "example@example.com",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *   });
+   * 
+   *   // OR
+   * 
+   *   await memberUtils.deactivateMemberViaRequest({
+   *       email: "example@example.com",
+   *       neetoPlaywrightUtilities: myCustomPlaywrightUtilities,
+   *       requestCount:2
+   *   });
+   * @endexample
+  */
   deactivateMemberViaRequest: ({
     email,
     neetoPlaywrightUtilities
@@ -2088,6 +4261,24 @@ interface ToggleColumnCheckboxAndVerifyVisibilityProps {
   shouldBeChecked: boolean;
 }
 declare const tableUtils: {
+  /**
+   *
+   * Used to check if columns exist in table or not. It takes the following parameters:
+   *
+   * page: A page object.
+   *
+   * columnNames: Array of column names to be checked.
+   *
+   * @example 
+   *
+   *  import { tableUtils } from  "@bigbinary/neeto-playwright-commons"
+   * 
+   *  await tableUtils.verifyTableColumnsExistence({
+   *   page,
+   *   columnNames,
+   *  });
+   * @endexample
+  */
   verifyTableColumnsExistence: ({
     page,
     columnNames
@@ -2095,11 +4286,53 @@ declare const tableUtils: {
     page: Page;
     columnNames: string[];
   }) => Promise<void>;
+  /**
+   *
+   * Used to check if the provided column matches the given visibility option. It takes the following parameters:
+   *
+   * page:  A page object.
+   *
+   * columnName: Name of the column.
+   *
+   * shouldBeVisible: Status of the column checkbox.
+   *
+   * @example 
+   *
+   *  import { tableUtils } from "@bigbinary/neeto-playwright-commons"
+   * 
+   *  await tableUtils.assertColumnHeaderVisibility({
+   *       page,
+   *       columnName,
+   *       shouldBeVisible :true,
+   *   });
+   * @endexample
+  */
   assertColumnHeaderVisibility: ({
     page,
     columnName,
     shouldBeVisible
   }: AssertColumnHeaderVisibilityProps) => Promise<void>;
+  /**
+   *
+   * Used to toggle columns from the subheader's show/hide columns button. The columns are then verified in the table. It takes the following parameters:
+   *
+   * page: A page object.
+   *
+   * tableColumns: Array of column names to be toggled.
+   *
+   * shouldBeChecked : Status of the column checkbox.
+   *
+   * @example 
+   *
+   *   import { tableUtils } from "@bigbinary/neeto-playwright-commons"
+   * 
+   *   await tableUtils.toggleColumnCheckboxAndVerifyVisibility({
+   *     page,
+   *     tableColumns,
+   *     shouldBeChecked: false,
+   *   });
+   * @endexample
+  */
   toggleColumnCheckboxAndVerifyVisibility: ({
     page,
     tableColumns,
@@ -2115,12 +4348,78 @@ interface VerifyBreadcrumbProps {
   titlesAndRoutes: BreadcrumbTitleAndRoute[];
 }
 declare const headerUtils: {
+  /**
+   *
+   * Verifies the breadcrumbs in the header of a web page. It takes the following parameters:
+   *
+   * page: An instance of the Playwright Page class representing the web page where the breadcrumbs are located.
+   *
+   * titlesAndRoutes: An array of objects containing the titles and routes of the breadcrumbs to verify.
+   *
+   * @example 
+   *
+   *   import { Page } from "@playwright/test";
+   *   import { headerUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   const breadcrumbs = [
+   *     { title: "Home", route: "/" },
+   *     { title: "Category", route: "/category" },
+   *     { title: "Subcategory", route: "/category/subcategory" }
+   *   ];
+   * 
+   *   await headerUtils.verifyBreadcrumbs({
+   *    page,
+   *    titlesAndRoutes: breadcrumbs
+   *   });
+   * @endexample
+  */
   verifyBreadcrumbs: ({
     page,
     titlesAndRoutes
   }: VerifyBreadcrumbProps) => Promise<void>;
 };
+/**
+ *
+ * Decodes a QR code from an image file and returns the decoded string.
+ *
+ * filePath: A string representing the path to the image file containing the QR code.
+ *
+ * Returns: A string representing the decoded content of the QR code, or undefined if decoding fails.
+ *
+ * @example 
+ *
+ *   import { decodeQRCodeFromFile } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *   const filePath = "path/to/qrCodeImage.png";
+ * 
+ *   const decodedString = await decodeQRCodeFromFile(filePath);
+ * @endexample
+*/
 declare const decodeQRCodeFromFile: (filePath: string) => Promise<string | undefined>;
+/**
+ *
+ * Initializes TOTP authentication by creating a TOTP instance with the specified issuer and secret. It takes the following parameters:
+ *
+ * issuer: A string representing the issuer name for TOTP authentication.
+ *
+ * secret: A string or a Secret object representing the secret key for TOTP generation.
+ *
+ * Returns: A TOTP object initialized with the provided issuer, algorithm, digits, period, and secret.
+ *
+ * @example 
+ *
+ *   import { initializeTotp } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *   // Initialize TOTP with issuer and secret
+ *   const issuer = "MyApp";
+ *   const secret = "my_secret_key";
+ *   const totp = initializeTotp({ issuer, secret });
+ * 
+ *   // Generate TOTP token
+ *   const token = totp.generate();
+ *   console.log("TOTP Token:", token);
+ * @endexample
+*/
 declare const initializeTotp: ({
   issuer,
   secret
@@ -2133,6 +4432,59 @@ type NetworkThrottlingUsingCdpParams = {
   cdpSession: CDPSession;
   emulateNetworkConditionsParameters?: EmulateNetworkConditionsParameters;
 };
+/**
+ *
+ * Throttles network conditions using CDP. It takes the following parameters:
+ *
+ * cdpSession: A CDPSession instance for sending CDP commands.
+ *
+ * emulateNetworkConditionsParameters (optional): An object representing the network conditions to emulate. Default is "Fast 3G" conditions.
+ *
+ * Throttles CPU usage using CDP. It takes the following parameters:
+ *
+ * cdpSession: A CDPSession instance for sending CDP commands.
+ *
+ * rate (optional): A number representing the throttling rate as a slowdown factor. Default is 1.25.
+ *
+ * @example 
+ *
+ *   import { cpuThrottlingUsingCDP } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *   cpuThrottlingUsingCDP({
+ *     cdpSession
+ *   })
+ * @endexample
+ * Executes code with throttled network and/or CPU resources. It takes the following parameters:
+ *
+ * code: A function representing the code to execute.
+ *
+ * kind (optional): A string specifying the type of throttling to apply. Can be "both" (default), "network", or "cpu".
+ *
+ * networkCondition (optional): An object representing the network conditions to emulate.
+ *
+ * cpuThrottlingRate (optional): A number representing the CPU throttling rate as a slowdown factor.
+ *
+ * cdpSession: A CDPSession instance for sending CDP commands.
+ *
+ * @example 
+ *
+ *   import { networkConditions } from "@constants/networkConditions";
+ *   import { executeWithThrottledResources } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *   const emulateNetworkConditionsParameters = networkConditions["Fast 3G"];
+ *   const cpuThrottlingRate = 2;
+ * 
+ *   await executeWithThrottledResources({
+ *     code: async () => {
+ *       // Your code to emulate network and CPU throttling
+ *     },
+ *     kind: "both",
+ *     networkCondition: emulateNetworkConditionsParameters,
+ *     cpuThrottlingRate,
+ *     cdpSession, // Provide the CDPSession instance
+ *   });
+ * @endexample
+*/
 declare const networkThrottlingUsingCDP: ({
   cdpSession,
   emulateNetworkConditionsParameters
@@ -2163,10 +4515,52 @@ declare const executeWithThrottledResources: ({
  *
  * Function to generate a basic HTML content with the given body.
  *
+ * @example 
+ *
+ *    basicHTMLContent(`
+ *        <h1>Hello world</h1>
+ *    `)
+ * 
+ * @endexample
 */
 declare const basicHTMLContent: (content: string) => string;
+/**
+ *
+ * This function converts a hexadecimal color code to its RGB equivalent.
+ *
+ * hex: A string representing the hexadecimal color code to be converted to RGB.
+ *
+ * @example 
+ *
+ *    import { hexToRGB } from "@bigbinary/neeto-playwright-commons";
+ * 
+ *    // Convert hexadecimal color code to RGB
+ *    const rgbColor = hexToRGB("#ff0000");
+ * 
+ *    console.log(rgbColor); // Output: 'rgb(255, 0, 0)'
+ * 
+ *    // Convert another hexadecimal color code to RGB
+ *    const anotherRGBColor = hexToRGB("#00ff00");
+ * 
+ *    console.log(anotherRGBColor); // Output: 'rgb(0, 255, 0)'
+ * @endexample
+*/
 declare const hexToRGB: (hex: string) => string;
 declare const filterUtils: {
+  /**
+   *
+   * Opens the filter pane on page.
+   *
+   * page: An instance of the Playwright Page class representing the web page where the filter pane should be opened.
+   *
+   * @example 
+   *
+   *   import { Page } from "@playwright/test";
+   *   import { filterUtils } from "@bigbinary/neeto-playwright-commons";
+   * 
+   *   await filterUtils.openFilterPane(page);
+   * @endexample
+  */
   openFilterPane: (page: Page) => Promise<void>;
   clearFiltersFromActionBlock: (page: Page) => Promise<void>;
 };
@@ -2176,9 +4570,9 @@ declare const filterUtils: {
  *
  * @example 
  *
- * import { getImagePathAndName } from "@bigbinary/neeto-playwright-commons";
+ *   import { getImagePathAndName } from "@bigbinary/neeto-playwright-commons";
  * 
- * const { imagePath, imageName } = getImagePathAndName("../assets/images/image.png");
+ *   const { imagePath, imageName } = getImagePathAndName("../assets/images/image.png");
  * @endexample
 */
 declare const getImagePathAndName: (localImagePath: string) => {
@@ -2201,15 +4595,13 @@ interface Overrides {
  *
  * used to extend the default playwright configuration object in the host project.
  *
- * Usage:
- *
  * @example 
  *
- * import { definePlaywrightConfig } from "@bigbinary/neeto-playwright-commons";
+ *   import { definePlaywrightConfig } from "@bigbinary/neeto-playwright-commons";
  * 
- * export default definePlaywrightConfig({
- *   currentsOverrides: { projectId: "******" },
- * });
+ *   export default definePlaywrightConfig({
+ *     currentsOverrides: { projectId: "******" },
+ *   });
  * @endexample
 */
 declare const definePlaywrightConfig: (overrides: Overrides) => _playwright_test.PlaywrightTestConfig<{}, {}>;