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.mms;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.messages.CaptionMediaMessageRequest;
020import com.vonage.client.messages.MessageType;
021import com.vonage.client.messages.internal.MessagePayload;
022
023public final class MmsAudioRequest extends MmsRequest implements CaptionMediaMessageRequest {
024
025        MmsAudioRequest(Builder builder) {
026                super(builder, MessageType.AUDIO);
027        }
028
029        @JsonProperty("audio")
030        public MessagePayload getAudio() {
031                return media;
032        }
033
034        public static Builder builder() {
035                return new Builder();
036        }
037
038        public static final class Builder extends MmsRequest.Builder<MmsAudioRequest, Builder> implements CaptionMediaMessageRequest.Builder<Builder> {
039                Builder() {}
040
041                /**
042                 * (REQUIRED)
043                 * Sets the URL of the audio attachment.
044                 *
045                 * @param url The URL as a string.
046                 * @return This builder.
047                 */
048                @Override
049                public Builder url(String url) {
050                        return super.url(url);
051                }
052
053                /**
054                 * (OPTIONAL)
055                 * Additional text to accompany the audio. Must be between 1 and 2000 characters.
056                 *
057                 * @param caption The caption string.
058                 * @return This builder.
059                 */
060                @Override
061                public Builder caption(String caption) {
062                        return super.caption(caption);
063                }
064
065                @Override
066                public MmsAudioRequest build() {
067                        return new MmsAudioRequest(this);
068                }
069        }
070}