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.rcs;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.messages.MediaMessageRequest;
020import com.vonage.client.messages.MessageType;
021import com.vonage.client.messages.internal.MessagePayload;
022
023/**
024 * {@link com.vonage.client.messages.Channel#RCS}, {@link MessageType#FILE} request.
025 *
026 * @since 8.11.0
027 */
028public final class RcsFileRequest extends RcsRequest implements MediaMessageRequest {
029
030        RcsFileRequest(Builder builder) {
031                super(builder, MessageType.FILE);
032                media.validateUrlExtension("pdf");
033        }
034
035        @JsonProperty("file")
036        public MessagePayload getFile() {
037                return media;
038        }
039
040        public static Builder builder() {
041                return new Builder();
042        }
043
044        public static final class Builder extends RcsRequest.Builder<RcsFileRequest, Builder> implements MediaMessageRequest.Builder<Builder> {
045                Builder() {}
046
047                /**
048                 * (REQUIRED)
049                 * The publicly accessible URL of the file attachment. Currently only supports {@code .pdf} files.
050                 *
051                 * @param url The URL as a string.
052                 * @return This builder.
053                 */
054                @Override
055                public Builder url(String url) {
056                        return super.url(url);
057                }
058
059                @Override
060                public RcsFileRequest build() {
061                        return new RcsFileRequest(this);
062                }
063        }
064}