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.messenger;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.messages.MediaMessageRequest;
020import com.vonage.client.messages.internal.MessagePayload;
021import com.vonage.client.messages.MessageType;
022
023public final class MessengerFileRequest extends MessengerRequest implements MediaMessageRequest {
024
025        MessengerFileRequest(Builder builder) {
026                super(builder, MessageType.FILE);
027        }
028
029        @JsonProperty("file")
030        public MessagePayload getFile() {
031                return media;
032        }
033
034        public static Builder builder() {
035                return new Builder();
036        }
037
038        public static final class Builder extends MessengerRequest.Builder<MessengerFileRequest, Builder> implements MediaMessageRequest.Builder<Builder> {
039
040                Builder() {}
041
042                /**
043                 * (REQUIRED)
044                 * Sets the URL of the file attachment. Supports a wide range of attachments including
045                 * {@code .zip}, {@code .csv} and {@code .pdf.}.
046                 *
047                 * @param url The URL as a string.
048                 * @return This builder.
049                 */
050                @Override
051                public Builder url(String url) {
052                        return super.url(url);
053                }
054
055                @Override
056                public MessengerFileRequest build() {
057                        return new MessengerFileRequest(this);
058                }
059        }
060
061}