001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.messages.whatsapp;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.messages.CaptionMediaMessageRequest;
020import com.vonage.client.messages.internal.MessagePayload;
021import com.vonage.client.messages.MessageType;
022
023public final class WhatsappImageRequest extends WhatsappRequest implements CaptionMediaMessageRequest {
024
025        WhatsappImageRequest(Builder builder) {
026                super(builder, MessageType.IMAGE);
027                media.validateUrlExtension("jpg", "jpeg", "png");
028                media.validateCaptionLength(3000);
029        }
030
031        @JsonProperty("image")
032        public MessagePayload getImage() {
033                return media;
034        }
035
036        public static Builder builder() {
037                return new Builder();
038        }
039
040        public static final class Builder extends WhatsappRequest.Builder<WhatsappImageRequest, Builder> implements CaptionMediaMessageRequest.Builder<Builder> {
041
042                Builder() {}
043
044                /**
045                 * (REQUIRED)
046                 * Sets the URL of the image attachment. Supports only {@code .jpg},
047                 * {@code .jpeg} and {@code .png} file extensions.
048                 *
049                 * @param url The URL as a string.
050                 * @return This builder.
051                 */
052                @Override
053                public Builder url(String url) {
054                        return super.url(url);
055                }
056
057                /**
058                 * (OPTIONAL)
059                 * Additional text to accompany the image. Must be between 1 and 3000 characters.
060                 *
061                 * @param caption The caption string.
062                 * @return This builder.
063                 */
064                @Override
065                public Builder caption(String caption) {
066                        return super.caption(caption);
067                }
068
069                @Override
070                public WhatsappImageRequest build() {
071                        return new WhatsappImageRequest(this);
072                }
073        }
074
075}