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;
017
018/**
019 * Indicates that a class used for request is to be serialised as binary data (e.g. for uploads).
020 *
021 * @since 7.10.0
022 */
023public interface BinaryRequest {
024
025        /**
026         * Serialises this request to a byte array.
027         *
028         * @return The binary data for this request.
029         */
030        byte[] toByteArray();
031
032        /**
033         * The MIME type header for this request to use as the {@code Content-Type}.
034         *
035         * @return The request MIME type as a string.
036         */
037        default String getContentType() {
038                return "multipart/form-data";
039        }
040}