feat: adds IterableEmbeddedMessageElements and associated classes

Author: Evan Greer

src/embedded/classes/IterableEmbeddedMessageDefaultAction.ts

@@ -0,0 +1,47 @@
+export class IterableEmbeddedMessageDefaultAction {
+  /**
+   * The type of iterable action
+   * For custom actions, the type is `action://` prefix followed by a custom action name
+   */
+  readonly type: string;
+
+  /**
+   * The url for the action when the type is `openUrl`
+   * For custom actions, data is empty
+   */
+  readonly data?: string;
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageDefaultAction`.
+   *
+   * @param type - The type of iterable action
+   * @param data - The url for the action when the type is `openUrl`
+   */
+  constructor(type: string, data?: string) {
+    this.type = type;
+    this.data = data;
+  }
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageDefaultAction` from a dictionary object.
+   *
+   * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageDefaultAction` instance.
+   * @returns A new instance of `IterableEmbeddedMessageDefaultAction` initialized with the provided dictionary properties.
+   */
+  static fromDict(
+    dict: Partial<EmbeddedMessageDefaultActionDict>
+  ): IterableEmbeddedMessageDefaultAction {
+    if (!dict.type) {
+      throw new Error('type is required');
+    }
+    return new IterableEmbeddedMessageDefaultAction(dict.type, dict.data);
+  }
+}
+
+/**
+ * An interface defining the dictionary object containing the properties for the embedded message default action.
+ */
+export interface EmbeddedMessageDefaultActionDict {
+  type: string;
+  data?: string;
+}

src/embedded/classes/IterableEmbeddedMessageElements.ts

@@ -0,0 +1,71 @@
+import { IterableEmbeddedMessageDefaultAction } from './IterableEmbeddedMessageDefaultAction';
+import { IterableEmbeddedMessageElementsButton } from './IterableEmbeddedMessageElementsButton';
+import { IterableEmbeddedMessageText } from './IterableEmbeddedMessageText';
+
+export class IterableEmbeddedMessageElements {
+  readonly title?: string;
+  readonly body?: string;
+  readonly mediaUrl?: string;
+  readonly mediaUrlCaption?: string;
+  readonly defaultAction?: IterableEmbeddedMessageDefaultAction;
+  readonly buttons?: IterableEmbeddedMessageElementsButton[];
+  readonly text?: IterableEmbeddedMessageText[];
+
+  constructor(
+    title?: string,
+    body?: string,
+    mediaUrl?: string,
+    mediaUrlCaption?: string,
+    defaultAction?: IterableEmbeddedMessageDefaultAction,
+    buttons?: IterableEmbeddedMessageElementsButton[],
+    text?: IterableEmbeddedMessageText[]
+  ) {
+    this.title = title;
+    this.body = body;
+    this.mediaUrl = mediaUrl;
+    this.mediaUrlCaption = mediaUrlCaption;
+    this.defaultAction = defaultAction;
+    this.buttons = buttons;
+    this.text = text;
+  }
+
+  static fromDict(
+    dict: Partial<EmbeddedMessageElementsDict>
+  ): IterableEmbeddedMessageElements {
+    const title = dict.title;
+    const body = dict.body;
+    const mediaUrl = dict.mediaUrl;
+    const mediaUrlCaption = dict.mediaUrlCaption;
+    const defaultAction = dict.defaultAction
+      ? IterableEmbeddedMessageDefaultAction.fromDict(dict.defaultAction)
+      : undefined;
+
+    const buttons = dict.buttons?.map((button) =>
+      IterableEmbeddedMessageElementsButton.fromDict(button)
+    );
+
+    const text = dict.text?.map((text) =>
+      IterableEmbeddedMessageText.fromDict(text)
+    );
+
+    return new IterableEmbeddedMessageElements(
+      title,
+      body,
+      mediaUrl,
+      mediaUrlCaption,
+      defaultAction,
+      buttons,
+      text
+    );
+  }
+}
+
+export interface EmbeddedMessageElementsDict {
+  title?: string;
+  body?: string;
+  mediaUrl?: string;
+  mediaUrlCaption?: string;
+  defaultAction?: IterableEmbeddedMessageDefaultAction;
+  buttons?: IterableEmbeddedMessageElementsButton[];
+  text?: IterableEmbeddedMessageText[];
+}

src/embedded/classes/IterableEmbeddedMessageText.ts

@@ -0,0 +1,45 @@
+export class IterableEmbeddedMessageText {
+  /** The id of the text element */
+  readonly id: string;
+  /** The text of the text element */
+  readonly text?: string;
+  /** The type of the text element */
+  readonly type?: string;
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageText`.
+   *
+   * @param id - The id of the text element
+   * @param text - The text of the text element
+   * @param type - The type of the text element
+   */
+  constructor(id: string, text?: string, type?: string) {
+    this.id = id;
+    this.text = text;
+    this.type = type;
+  }
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageText` from a dictionary object.
+   *
+   * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageText` instance.
+   * @returns A new instance of `IterableEmbeddedMessageText` initialized with the provided dictionary properties.
+   */
+  static fromDict(
+    dict: Partial<EmbeddedMessageTextDict>
+  ): IterableEmbeddedMessageText {
+    if (!dict.id) {
+      throw new Error('id is required');
+    }
+    return new IterableEmbeddedMessageText(dict.id, dict.text, dict.type);
+  }
+}
+
+/**
+ * An interface defining the dictionary object containing the properties for an embedded message text.
+ */
+export interface EmbeddedMessageTextDict {
+  id: string;
+  text?: string;
+  type?: string;
+}

src/embedded/classes/index.ts

@@ -1,2 +1,5 @@
 export * from './IterableEmbeddedManager';
 export * from './IterableEmbeddedPlacement';
+export * from './IterableEmbeddedMessageElementsButton';
+export * from './IterableEmbeddedMessageElementsButtonAction';
+export * from './IterableEmbeddedMessageMetadata';