chore: adds comments to props

Author: Evan Greer

src/embedded/classes/IterableEmbeddedMessageDefaultAction.ts

@@ -46,6 +46,8 @@ export class IterableEmbeddedMessageDefaultAction {
  * An interface defining the dictionary object containing the properties for the embedded message default action.
  */
 export interface EmbeddedMessageDefaultActionDict {
+  /** The type of the action */
   type: string;
+  /** The url for the action when the type is `openUrl` */
   data?: string;
 }

src/embedded/classes/IterableEmbeddedMessageElements.ts

@@ -91,11 +91,18 @@ export class IterableEmbeddedMessageElements {
  * An interface defining the dictionary object containing the properties for the embedded message elements.
  */
 export interface EmbeddedMessageElementsDict {
+  /** The title of the embedded message */
   title?: string;
+  /** The body of the embedded message */
   body?: string;
+  /** The url of the embedded message image */
   mediaUrl?: string;
+  /** The caption of the embedded message image */
   mediaUrlCaption?: string;
+  /** The default action of the embedded message */
   defaultAction?: IterableEmbeddedMessageDefaultAction;
+  /** The buttons of the embedded message */
   buttons?: IterableEmbeddedMessageElementsButton[];
+  /** The text elements of the embedded message */
   text?: IterableEmbeddedMessageText[];
 }

src/embedded/classes/IterableEmbeddedMessageText.ts

@@ -42,7 +42,10 @@ export class IterableEmbeddedMessageText {
  * An interface defining the dictionary object containing the properties for an embedded message text.
  */
 export interface EmbeddedMessageTextDict {
+  /** The id of the text element */
   id: string;
+  /** The text of the text element */
   text?: string;
+  /** The type of the text element */
   type?: string;
 }