feat: adds documentation

Author: Evan Greer

src/embedded/classes/IterableEmbeddedMessageDefaultAction.ts

@@ -1,3 +1,7 @@
+/**
+ * IterableEmbeddedMessageDefaultAction represents the default action defined as
+ * a response to user events for an embedded message
+ */
 export class IterableEmbeddedMessageDefaultAction {
   /**
    * The type of iterable action

src/embedded/classes/IterableEmbeddedMessageElements.ts

@@ -2,15 +2,36 @@ import { IterableEmbeddedMessageDefaultAction } from './IterableEmbeddedMessageD
 import { IterableEmbeddedMessageElementsButton } from './IterableEmbeddedMessageElementsButton';
 import { IterableEmbeddedMessageText } from './IterableEmbeddedMessageText';
 
+/**
+ * IterableEmbeddedMessageElements represents the elements of an embedded message.
+ */
 export class IterableEmbeddedMessageElements {
+  /** The title of the embedded message */
   readonly title?: string;
+  /** The body of the embedded message */
   readonly body?: string;
+  /** The url of the embedded message image */
   readonly mediaUrl?: string;
+  /** The caption of the embedded message image */
   readonly mediaUrlCaption?: string;
+  /** The default action of the embedded message */
   readonly defaultAction?: IterableEmbeddedMessageDefaultAction;
+  /** The buttons of the embedded message */
   readonly buttons?: IterableEmbeddedMessageElementsButton[];
+  /** The text elements of the embedded message */
   readonly text?: IterableEmbeddedMessageText[];
 
+  /**
+   * Creates an instance of `IterableEmbeddedMessageElements`.
+   *
+   * @param title - The title of the embedded message.
+   * @param body - The body of the embedded message.
+   * @param mediaUrl - The url of the embedded message image.
+   * @param mediaUrlCaption - The caption of the embedded message image.
+   * @param defaultAction - The default action of the embedded message.
+   * @param buttons - The buttons of the embedded message.
+   * @param text - The text elements of the embedded message.
+   */
   constructor(
     title?: string,
     body?: string,
@@ -29,6 +50,12 @@ export class IterableEmbeddedMessageElements {
     this.text = text;
   }
 
+  /**
+   * Creates an instance of `IterableEmbeddedMessageElements` from a dictionary object.
+   *
+   * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageElements` instance.
+   * @returns A new instance of `IterableEmbeddedMessageElements` initialized with the provided dictionary properties.
+   */
   static fromDict(
     dict: Partial<EmbeddedMessageElementsDict>
   ): IterableEmbeddedMessageElements {
@@ -60,6 +87,9 @@ export class IterableEmbeddedMessageElements {
   }
 }
 
+/**
+ * An interface defining the dictionary object containing the properties for the embedded message elements.
+ */
 export interface EmbeddedMessageElementsDict {
   title?: string;
   body?: string;

src/embedded/classes/IterableEmbeddedMessageElementsButtonAction.ts

@@ -1,6 +1,6 @@
 /**
- * IterableEmbeddedMessageElementsButtonAction represents an action defined as a response to user events
- * for an embedded message button.
+ * IterableEmbeddedMessageElementsButtonAction represents an action defined as
+ * a response to user events for an embedded message button
  */
 export class IterableEmbeddedMessageElementsButtonAction {
   /**

src/embedded/classes/IterableEmbeddedMessageText.ts

@@ -1,3 +1,6 @@
+/**
+ * IterableEmbeddedMessageText represents a text element in an embedded message.
+ */
 export class IterableEmbeddedMessageText {
   /** The id of the text element */
   readonly id: string;