WireMock.Net/src/WireMock.Net.Shared/ResponseBuilders/IBodyResponseBuilder.cs

// Copyright © WireMock.Net

using System.Text;
using JsonConverter.Abstractions;
using WireMock.Models;

namespace WireMock.ResponseBuilders;

/// <summary>
/// The BodyResponseBuilder interface.
/// </summary>
public interface IBodyResponseBuilder : IFaultResponseBuilder
{
    /// <summary>
    /// WithBody : Create a ... response based on a string.
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
    /// <param name="encoding">The body encoding.</param>
    /// <param name="jsonConverter">The JSON converter.</param>
    /// <param name="options">The JSON converter options.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(string body, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null, IJsonConverter? jsonConverter = null, JsonConverterOptions? options = null);

    /// <summary>
    /// WithBody : Create a ... response based on a callback function.
    /// </summary>
    /// <param name="bodyFactory">The delegate to build the body.</param>
    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
    /// <param name="encoding">The body encoding.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(Func<IRequestMessage, string> bodyFactory, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);

    /// <summary>
    /// WithBody : Create a ... response based on an async callback function.
    /// </summary>
    /// <param name="bodyFactory">The async delegate to build the body.</param>
    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
    /// <param name="encoding">The body encoding.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(Func<IRequestMessage, Task<string>> bodyFactory, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);

    /// <summary>
    /// WithBody : Create a ... response based on an async callback function.
    /// </summary>
    /// <param name="bodyFactory">The async delegate to build the body.</param>
    /// <param name="timeout">The timeout to wait on new items in the queue. Default value is <c>1</c> hour.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithSseBody(Func<IRequestMessage, IBlockingQueue<string?>, Task> bodyFactory, TimeSpan? timeout = null);

    /// <summary>
    /// WithBody : Create a ... response based on a bytearray.
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="destination">The Body Destination format (SameAsSource, String or Bytes).</param>
    /// <param name="encoding">The body encoding.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(byte[] body, string? destination = BodyDestinationFormat.SameAsSource, Encoding? encoding = null);

    /// <summary>
    /// WithBody : Create a string response based on a object (which will be converted to a JSON string).
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="encoding">The body encoding.</param>
    /// <param name="indented">Define whether child objects to be indented according to the Newtonsoft.Json.JsonTextWriter.Indentation and Newtonsoft.Json.JsonTextWriter.IndentChar settings.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBodyAsJson(object body, Encoding? encoding = null, bool? indented = null);

    /// <summary>
    /// WithBody : Create a string response based on a object (which will be converted to a JSON string).
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="indented">Define whether child objects to be indented according to the Newtonsoft.Json.JsonTextWriter.Indentation and Newtonsoft.Json.JsonTextWriter.IndentChar settings.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBodyAsJson(object body, bool indented);

    /// <summary>
    /// WithBodyAsJson : Create a ... response based on a callback function.
    /// </summary>
    /// <param name="bodyFactory">The delegate to build the body.</param>
    /// <param name="encoding">The body encoding.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBodyAsJson(Func<IRequestMessage, object> bodyFactory, Encoding? encoding = null);

    /// <summary>
    /// WithBodyAsJson : Create a ... response based on an async callback function.
    /// </summary>
    /// <param name="bodyFactory">The async delegate to build the body.</param>
    /// <param name="encoding">The body encoding.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBodyAsJson(Func<IRequestMessage, Task<object>> bodyFactory, Encoding? encoding = null);

    /// <summary>
    /// WithBodyFromFile : Create a ... response based on a File.
    /// </summary>
    /// <param name="filename">The filename.</param>
    /// <param name="cache">Defines if this file is cached in memory or retrieved from disk every time the response is created.</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBodyFromFile(string filename, bool cache = true);

    /// <summary>
    /// WithBody : Create a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="jsonConverter">The <see cref="IJsonConverter"/>.</param>
    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(object body, IJsonConverter jsonConverter, JsonConverterOptions? options = null);

    /// <summary>
    /// WithBody : Create a string response based on a object (which will be converted to a JSON string using the <see cref="IJsonConverter"/>).
    /// </summary>
    /// <param name="body">The body.</param>
    /// <param name="encoding">The body encoding, can be <c>null</c>.</param>
    /// <param name="jsonConverter">The <see cref="IJsonConverter"/>.</param>
    /// <param name="options">The <see cref="JsonConverterOptions"/> [optional].</param>
    /// <returns>A <see cref="IResponseBuilder"/>.</returns>
    IResponseBuilder WithBody(object body, Encoding? encoding, IJsonConverter jsonConverter, JsonConverterOptions? options = null);
}