feat: adds button class and associated classes

Author: Evan Greer

src/embedded/classes/IterableEmbeddedMessageElementsButton.ts

@@ -0,0 +1,61 @@
+import { IterableEmbeddedMessageElementsButtonAction } from './IterableEmbeddedMessageElementsButtonAction';
+
+/**
+ * IterableEmbeddedMessageElementsButton represents a button in an embedded message.
+ */
+export class IterableEmbeddedMessageElementsButton {
+  /** The ID for the embedded message button */
+  readonly id: string;
+  /** The title for the embedded message button */
+  readonly title?: string;
+  /** The action for the embedded message button */
+  readonly action?: IterableEmbeddedMessageElementsButtonAction;
+
+  /**
+   * Creates an instance of IterableEmbeddedMessageButton.
+   *
+   * @param id - The ID for the embedded message button.
+   * @param title - The title for the embedded message button.
+   * @param action - The action for the embedded message button.
+   */
+  constructor(
+    id: string,
+    title?: string,
+    action?: IterableEmbeddedMessageElementsButtonAction
+  ) {
+    this.id = id;
+    this.title = title;
+    this.action = action;
+  }
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageButton` from a dictionary object.
+   *
+   * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageButton` instance.
+   * @returns A new instance of `IterableEmbeddedMessageButton` initialized with the provided dictionary properties.
+   */
+  static fromDict(
+    dict: Partial<EmbeddedMessageElementsButtonDict>
+  ): IterableEmbeddedMessageElementsButton {
+    if (!dict.id) {
+      throw new Error('id is required');
+    }
+    const action = dict.action
+      ? IterableEmbeddedMessageElementsButtonAction.fromDict(dict.action)
+      : undefined;
+    return new IterableEmbeddedMessageElementsButton(
+      dict.id,
+      dict.title,
+      action
+    );
+  }
+}
+
+/**
+ * An interface defining the dictionary object containing the properties for the embedded message button.
+ */
+export interface EmbeddedMessageElementsButtonDict {
+  id: string;
+  title?: string;
+  action?: IterableEmbeddedMessageElementsButtonAction;
+}

src/embedded/classes/IterableEmbeddedMessageElementsButtonAction.ts

@@ -0,0 +1,54 @@
+/**
+ * IterableEmbeddedMessageElementsButtonAction represents an action defined as a response to user events
+ * for an embedded message button.
+ */
+export class IterableEmbeddedMessageElementsButtonAction {
+  /**
+   * 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 IterableEmbeddedMessageElementsButtonAction.
+   *
+   * @param type - The type of the action.
+   * @param data - Optional data associated with the action.
+   */
+  constructor(type: string, data?: string) {
+    this.type = type;
+    this.data = data;
+  }
+
+  /**
+   * Creates an instance of `IterableEmbeddedMessageElementsButtonAction` from a dictionary object.
+   *
+   * @param dict - The dictionary object containing the properties to initialize the `IterableEmbeddedMessageElementsButtonAction` instance.
+   * @returns A new instance of `IterableEmbeddedMessageElementsButtonAction` initialized with the provided dictionary properties.
+   */
+  static fromDict(
+    dict: Partial<EmbeddedMessageButtonActionDict>
+  ): IterableEmbeddedMessageElementsButtonAction {
+    if (!dict.type) {
+      throw new Error('type is required');
+    }
+    return new IterableEmbeddedMessageElementsButtonAction(
+      dict.type,
+      dict.data
+    );
+  }
+}
+
+/**
+ * An interface defining the dictionary object containing the properties for the embedded message button action.
+ */
+export interface EmbeddedMessageButtonActionDict {
+  type: string;
+  data?: string;
+}