Merge pull request #247 from Secreto31126/limited-time-offer

Added Limited-Time Offer component

Author: Secreto31126

EXAMPLES/README.md

@@ -43,4 +43,5 @@ the most basic methods or features.
     -   [Complex template with reply buttons](template.md#complex-template-with-reply-buttons)
     -   [Complex template with call to action url](template.md#complex-template-with-call-to-action-url)
     -   [Complex template with Carousel](template.md#complex-template-with-carousel)
+    -   [Complex template with Limited-Time Offer](template.md#complex-template-with-limited-time-offer)
     -   [OTP prefab template](template.md#otp-prefab-template)

EXAMPLES/template.md

@@ -169,7 +169,7 @@ import {
     URLComponent
 } from "whatsapp-api-js/messages";
 
-const template_multi_product_message = new Template(
+const template_carousel_message = new Template(
     "template_name",
     "en",
     new BodyComponent(new BodyParameter("PROMO10")),
@@ -186,6 +186,25 @@ const template_multi_product_message = new Template(
 );
 ```
 
+## Complex template with Limited-Time Offer
+
+```ts
+import {
+    Template,
+    LTOComponent,
+    URLComponent,
+    CopyComponent
+} from "whatsapp-api-js/messages";
+
+const template_limited_time_offer_message = new Template(
+    "template_name",
+    "en",
+    new LTOComponent(1696622508595),
+    new CopyComponent("PROMO10"),
+    new URLComponent("?code=PROMO10&product=1")
+);
+```
+
 ## OTP prefab template
 
 ```ts
@@ -205,3 +224,4 @@ https://whatsappapijs.web.app/classes/messages.CopyComponent.html
 https://whatsappapijs.web.app/classes/messages.CatalogComponent.html
 https://whatsappapijs.web.app/classes/messages.MPMComponent.html
 https://whatsappapijs.web.app/classes/messages.CarouselComponent.html
+https://whatsappapijs.web.app/classes/messages.LTOComponent.html

src/messages/template.ts

@@ -849,3 +849,57 @@ export class CarouselCard implements ClientBuildableMessageComponent {
         return this;
     }
 }
+
+/**
+ * Components API object
+ *
+ * @group Template
+ */
+export class LTOComponent implements ClientBuildableMessageComponent {
+    /**
+     * The type of the component
+     */
+    readonly type = "limited_time_offer";
+    /**
+     * The parameters of the component
+     */
+    readonly parameters: [
+        {
+            type: "limited_time_offer";
+            limited_time_offer: {
+                expiration_time_ms: number;
+            };
+        }
+    ];
+
+    /**
+     * Builds a limited-time offer component for a Template message
+     *
+     * @param expiration - Offer code expiration time as a UNIX timestamp in milliseconds
+     * @throws If expiration is negative
+     */
+    constructor(expiration: number) {
+        if (expiration < 0) {
+            throw new Error(
+                "Expiration time must be a positive Unix timestamp"
+            );
+        }
+
+        this.parameters = [
+            {
+                type: "limited_time_offer",
+                limited_time_offer: {
+                    expiration_time_ms: expiration
+                }
+            }
+        ];
+    }
+
+    /**
+     * @override
+     * @internal
+     */
+    _build() {
+        return this;
+    }
+}