csharp-functions.ISynchronousClient.mustache Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openapi-generator Show documentation
There is a newer version: 7.9.0
{{>partial_header}}

using System;
using System.IO;

namespace {{packageName}}.Client
{
    /// 
    /// Contract for Synchronous RESTful API interactions.
    ///
    /// This interface allows consumers to provide a custom API accessor client.
    /// 
    public interface ISynchronousClient
    {
        /// 
        /// Executes a blocking call to some  using the GET http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Get(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the POST http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Post(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the PUT http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Put(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the DELETE http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Delete(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the HEAD http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Head(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the OPTIONS http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Options(string path, RequestOptions options, IReadableConfiguration configuration = null);

        /// 
        /// Executes a blocking call to some  using the PATCH http verb.
        /// 
        /// The relative path to invoke.
        /// The request parameters to pass along to the client.
        /// Per-request configurable settings.
        /// The return type.
        /// The response data, decorated with 
        ApiResponse Patch(string path, RequestOptions options, IReadableConfiguration configuration = null);
    }
}