net.optionfactory.whatsapp.dto.webhook.Referral Maven / Gradle / Ivy

Go to download
package net.optionfactory.whatsapp.dto.webhook;

import com.fasterxml.jackson.annotation.JsonProperty;

/**
 * The type Referral.
 *
 * @param videoUrl     Added if media_type is “video”. Contains a URL to the video.
 * @param mediaType    Media present in the ad or post the user clicked. Supported values are "image" or "video".
 * @param imageUrl     Added if media_type is “image”. Contains a URL to the raw image.
 * @param sourceType   Specifies the type of the ad's source. Supported values are "ad" or "post".
 * @param sourceId     Specifies the Meta ID for an ad or post.
 * @param body         The description, or body, from the ad or post that generated the message.
 * @param thumbnailUrl Added if media_type is “video”. Contains a URL to the thumbnail image of the clicked video.
 * @param headline     Specifies the headline used in the ad or post that generated the message.
 * @param sourceUrl    Specifies the URL that leads to the ad or post clicked by the user. Opening this URL takes you to the ad viewed by your user.
 */
public record Referral(

        @JsonProperty("video_url") String videoUrl,

        @JsonProperty("media_type") String mediaType,

        @JsonProperty("image_url") String imageUrl,

        @JsonProperty("source_type") String sourceType,

        @JsonProperty("source_id") String sourceId,

        @JsonProperty("body") String body,

        @JsonProperty("thumbnail_url") String thumbnailUrl,

        @JsonProperty("headline") String headline,

        @JsonProperty("source_url") String sourceUrl

) {
}