ProcessApi.cs

/*
 * Regula Document Reader Web API
 *
 * Documents recognition as easy as reading two bytes.   # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core 
 *
 * The version of the OpenAPI document: 8.1.0
 * Generated by: https://github.com/openapitools/openapi-generator.git
 */


using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Net.Mime;
using Regula.DocumentReader.WebClient.Client;
using Regula.DocumentReader.WebClient.Model;

namespace Regula.DocumentReader.WebClient.Api
{

    /// <summary>
    /// Represents a collection of functions to interact with the API endpoints
    /// </summary>
    public interface IProcessApiSync : IApiAccessor
    {
        #region Synchronous Operations
        /// <summary>
        /// Process list of documents images and return extracted data
        /// </summary>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <returns>ProcessResponse</returns>
        ProcessResponse ApiProcess(ProcessRequest processRequest, string? xRequestID = default);

        /// <summary>
        /// Process list of documents images and return extracted data
        /// </summary>
        /// <remarks>
        /// 
        /// </remarks>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <returns>ApiResponse of ProcessResponse</returns>
        ApiResponse<ProcessResponse> ApiProcessWithHttpInfo(ProcessRequest processRequest, string? xRequestID = default);
        #endregion Synchronous Operations
    }

    /// <summary>
    /// Represents a collection of functions to interact with the API endpoints
    /// </summary>
    public interface IProcessApiAsync : IApiAccessor
    {
        #region Asynchronous Operations
        /// <summary>
        /// Process list of documents images and return extracted data
        /// </summary>
        /// <remarks>
        /// 
        /// </remarks>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
        /// <returns>Task of ProcessResponse</returns>
        System.Threading.Tasks.Task<ProcessResponse> ApiProcessAsync(ProcessRequest processRequest, string? xRequestID = default, System.Threading.CancellationToken cancellationToken = default);

        /// <summary>
        /// Process list of documents images and return extracted data
        /// </summary>
        /// <remarks>
        /// 
        /// </remarks>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
        /// <returns>Task of ApiResponse (ProcessResponse)</returns>
        System.Threading.Tasks.Task<ApiResponse<ProcessResponse>> ApiProcessWithHttpInfoAsync(ProcessRequest processRequest, string? xRequestID = default, System.Threading.CancellationToken cancellationToken = default);
        #endregion Asynchronous Operations
    }

    /// <summary>
    /// Represents a collection of functions to interact with the API endpoints
    /// </summary>
    public interface IProcessApi : IProcessApiSync, IProcessApiAsync
    {

    }

    /// <summary>
    /// Represents a collection of functions to interact with the API endpoints
    /// </summary>
    public partial class ProcessApi : IDisposable, IProcessApi
    {
        private Regula.DocumentReader.WebClient.Client.ExceptionFactory _exceptionFactory = (name, response) => null;

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class.
        /// **IMPORTANT** This will also create an instance of HttpClient, which is less than ideal.
        /// It's better to reuse the <see href="https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#issues-with-the-original-httpclient-class-available-in-net">HttpClient and HttpClientHandler</see>.
        /// </summary>
        /// <returns></returns>
        public ProcessApi() : this((string)null)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class.
        /// **IMPORTANT** This will also create an instance of HttpClient, which is less than ideal.
        /// It's better to reuse the <see href="https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#issues-with-the-original-httpclient-class-available-in-net">HttpClient and HttpClientHandler</see>.
        /// </summary>
        /// <param name="basePath">The target service's base path in URL format.</param>
        /// <exception cref="ArgumentException"></exception>
        /// <returns></returns>
        public ProcessApi(string basePath)
        {
            this.Configuration = Regula.DocumentReader.WebClient.Client.Configuration.MergeConfigurations(
                Regula.DocumentReader.WebClient.Client.GlobalConfiguration.Instance,
                new Regula.DocumentReader.WebClient.Client.Configuration { BasePath = basePath }
            );
            this.ApiClient = new Regula.DocumentReader.WebClient.Client.ApiClient(this.Configuration.BasePath);
            this.Client =  this.ApiClient;
            this.AsynchronousClient = this.ApiClient;
            this.ExceptionFactory = Regula.DocumentReader.WebClient.Client.Configuration.DefaultExceptionFactory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class using Configuration object.
        /// **IMPORTANT** This will also create an instance of HttpClient, which is less than ideal.
        /// It's better to reuse the <see href="https://docs.microsoft.com/en-us/dotnet/architecture/microservices/implement-resilient-applications/use-httpclientfactory-to-implement-resilient-http-requests#issues-with-the-original-httpclient-class-available-in-net">HttpClient and HttpClientHandler</see>.
        /// </summary>
        /// <param name="configuration">An instance of Configuration.</param>
        /// <exception cref="ArgumentNullException"></exception>
        /// <returns></returns>
        public ProcessApi(Regula.DocumentReader.WebClient.Client.Configuration configuration)
        {
            if (configuration == null) throw new ArgumentNullException("configuration");

            this.Configuration = Regula.DocumentReader.WebClient.Client.Configuration.MergeConfigurations(
                Regula.DocumentReader.WebClient.Client.GlobalConfiguration.Instance,
                configuration
            );
            this.ApiClient = new Regula.DocumentReader.WebClient.Client.ApiClient(this.Configuration.BasePath);
            this.Client = this.ApiClient;
            this.AsynchronousClient = this.ApiClient;
            ExceptionFactory = Regula.DocumentReader.WebClient.Client.Configuration.DefaultExceptionFactory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class.
        /// </summary>
        /// <param name="client">An instance of HttpClient.</param>
        /// <param name="handler">An optional instance of HttpClientHandler that is used by HttpClient.</param>
        /// <exception cref="ArgumentNullException"></exception>
        /// <returns></returns>
        /// <remarks>
        /// Some configuration settings will not be applied without passing an HttpClientHandler.
        /// The features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings.
        /// </remarks>
        public ProcessApi(HttpClient client, HttpClientHandler handler = null) : this(client, (string)null, handler)
        {
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class.
        /// </summary>
        /// <param name="client">An instance of HttpClient.</param>
        /// <param name="basePath">The target service's base path in URL format.</param>
        /// <param name="handler">An optional instance of HttpClientHandler that is used by HttpClient.</param>
        /// <exception cref="ArgumentNullException"></exception>
        /// <exception cref="ArgumentException"></exception>
        /// <returns></returns>
        /// <remarks>
        /// Some configuration settings will not be applied without passing an HttpClientHandler.
        /// The features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings.
        /// </remarks>
        public ProcessApi(HttpClient client, string basePath, HttpClientHandler handler = null)
        {
            if (client == null) throw new ArgumentNullException("client");

            this.Configuration = Regula.DocumentReader.WebClient.Client.Configuration.MergeConfigurations(
                Regula.DocumentReader.WebClient.Client.GlobalConfiguration.Instance,
                new Regula.DocumentReader.WebClient.Client.Configuration { BasePath = basePath }
            );
            this.ApiClient = new Regula.DocumentReader.WebClient.Client.ApiClient(client, this.Configuration.BasePath, handler);
            this.Client =  this.ApiClient;
            this.AsynchronousClient = this.ApiClient;
            this.ExceptionFactory = Regula.DocumentReader.WebClient.Client.Configuration.DefaultExceptionFactory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class using Configuration object.
        /// </summary>
        /// <param name="client">An instance of HttpClient.</param>
        /// <param name="configuration">An instance of Configuration.</param>
        /// <param name="handler">An optional instance of HttpClientHandler that is used by HttpClient.</param>
        /// <exception cref="ArgumentNullException"></exception>
        /// <returns></returns>
        /// <remarks>
        /// Some configuration settings will not be applied without passing an HttpClientHandler.
        /// The features affected are: Setting and Retrieving Cookies, Client Certificates, Proxy settings.
        /// </remarks>
        public ProcessApi(HttpClient client, Regula.DocumentReader.WebClient.Client.Configuration configuration, HttpClientHandler handler = null)
        {
            if (configuration == null) throw new ArgumentNullException("configuration");
            if (client == null) throw new ArgumentNullException("client");

            this.Configuration = Regula.DocumentReader.WebClient.Client.Configuration.MergeConfigurations(
                Regula.DocumentReader.WebClient.Client.GlobalConfiguration.Instance,
                configuration
            );
            this.ApiClient = new Regula.DocumentReader.WebClient.Client.ApiClient(client, this.Configuration.BasePath, handler);
            this.Client = this.ApiClient;
            this.AsynchronousClient = this.ApiClient;
            ExceptionFactory = Regula.DocumentReader.WebClient.Client.Configuration.DefaultExceptionFactory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="ProcessApi"/> class
        /// using a Configuration object and client instance.
        /// </summary>
        /// <param name="client">The client interface for synchronous API access.</param>
        /// <param name="asyncClient">The client interface for asynchronous API access.</param>
        /// <param name="configuration">The configuration object.</param>
        /// <exception cref="ArgumentNullException"></exception>
        public ProcessApi(Regula.DocumentReader.WebClient.Client.ISynchronousClient client, Regula.DocumentReader.WebClient.Client.IAsynchronousClient asyncClient, Regula.DocumentReader.WebClient.Client.IReadableConfiguration configuration)
        {
            if (client == null) throw new ArgumentNullException("client");
            if (asyncClient == null) throw new ArgumentNullException("asyncClient");
            if (configuration == null) throw new ArgumentNullException("configuration");

            this.Client = client;
            this.AsynchronousClient = asyncClient;
            this.Configuration = configuration;
            this.ExceptionFactory = Regula.DocumentReader.WebClient.Client.Configuration.DefaultExceptionFactory;
        }

        /// <summary>
        /// Disposes resources if they were created by us
        /// </summary>
        public void Dispose()
        {
            this.ApiClient?.Dispose();
        }

        /// <summary>
        /// Holds the ApiClient if created
        /// </summary>
        public Regula.DocumentReader.WebClient.Client.ApiClient ApiClient { get; set; } = null;

        /// <summary>
        /// The client for accessing this underlying API asynchronously.
        /// </summary>
        public Regula.DocumentReader.WebClient.Client.IAsynchronousClient AsynchronousClient { get; set; }

        /// <summary>
        /// The client for accessing this underlying API synchronously.
        /// </summary>
        public Regula.DocumentReader.WebClient.Client.ISynchronousClient Client { get; set; }

        /// <summary>
        /// Gets the base path of the API client.
        /// </summary>
        /// <value>The base path</value>
        public string GetBasePath()
        {
            return this.Configuration.BasePath;
        }

        /// <summary>
        /// Gets or sets the configuration object
        /// </summary>
        /// <value>An instance of the Configuration</value>
        public Regula.DocumentReader.WebClient.Client.IReadableConfiguration Configuration { get; set; }

        /// <summary>
        /// Provides a factory method hook for the creation of exceptions.
        /// </summary>
        public Regula.DocumentReader.WebClient.Client.ExceptionFactory ExceptionFactory
        {
            get
            {
                if (_exceptionFactory != null && _exceptionFactory.GetInvocationList().Length > 1)
                {
                    throw new InvalidOperationException("Multicast delegate for ExceptionFactory is unsupported.");
                }
                return _exceptionFactory;
            }
            set { _exceptionFactory = value; }
        }

        /// <summary>
        /// Process list of documents images and return extracted data 
        /// </summary>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <returns>ProcessResponse</returns>
        public ProcessResponse ApiProcess(ProcessRequest processRequest, string? xRequestID = default)
        {
            Regula.DocumentReader.WebClient.Client.ApiResponse<ProcessResponse> localVarResponse = ApiProcessWithHttpInfo(processRequest, xRequestID);
            return localVarResponse.Data;
        }

        /// <summary>
        /// Process list of documents images and return extracted data 
        /// </summary>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <returns>ApiResponse of ProcessResponse</returns>
        public Regula.DocumentReader.WebClient.Client.ApiResponse<ProcessResponse> ApiProcessWithHttpInfo(ProcessRequest processRequest, string? xRequestID = default)
        {
            // verify the required parameter 'processRequest' is set
            if (processRequest == null)
                throw new Regula.DocumentReader.WebClient.Client.ApiException(400, "Missing required parameter 'processRequest' when calling ProcessApi->ApiProcess");

            Regula.DocumentReader.WebClient.Client.RequestOptions localVarRequestOptions = new Regula.DocumentReader.WebClient.Client.RequestOptions();

            string[] _contentTypes = new string[] {
                "application/json"
            };

            // to determine the Accept header
            string[] _accepts = new string[] {
                "application/json"
            };

            var localVarContentType = Regula.DocumentReader.WebClient.Client.ClientUtils.SelectHeaderContentType(_contentTypes);
            if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType);

            var localVarAccept = Regula.DocumentReader.WebClient.Client.ClientUtils.SelectHeaderAccept(_accepts);
            if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);

            if (xRequestID != null)
            {
                localVarRequestOptions.HeaderParameters.Add("X-RequestID", Regula.DocumentReader.WebClient.Client.ClientUtils.ParameterToString(xRequestID)); // header parameter
            }
            localVarRequestOptions.Data = processRequest;


            // make the HTTP request
            var localVarResponse = this.Client.Post<ProcessResponse>("/api/process", localVarRequestOptions, this.Configuration);

            if (this.ExceptionFactory != null)
            {
                Exception _exception = this.ExceptionFactory("ApiProcess", localVarResponse);
                if (_exception != null) throw _exception;
            }

            return localVarResponse;
        }

        /// <summary>
        /// Process list of documents images and return extracted data 
        /// </summary>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
        /// <returns>Task of ProcessResponse</returns>
        public async System.Threading.Tasks.Task<ProcessResponse> ApiProcessAsync(ProcessRequest processRequest, string? xRequestID = default, System.Threading.CancellationToken cancellationToken = default)
        {
            Regula.DocumentReader.WebClient.Client.ApiResponse<ProcessResponse> localVarResponse = await ApiProcessWithHttpInfoAsync(processRequest, xRequestID, cancellationToken).ConfigureAwait(false);
            return localVarResponse.Data;
        }

        /// <summary>
        /// Process list of documents images and return extracted data 
        /// </summary>
        /// <exception cref="Regula.DocumentReader.WebClient.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="processRequest"></param>
        /// <param name="xRequestID"> (optional)</param>
        /// <param name="cancellationToken">Cancellation Token to cancel the request.</param>
        /// <returns>Task of ApiResponse (ProcessResponse)</returns>
        public async System.Threading.Tasks.Task<Regula.DocumentReader.WebClient.Client.ApiResponse<ProcessResponse>> ApiProcessWithHttpInfoAsync(ProcessRequest processRequest, string? xRequestID = default, System.Threading.CancellationToken cancellationToken = default)
        {
            // verify the required parameter 'processRequest' is set
            if (processRequest == null)
                throw new Regula.DocumentReader.WebClient.Client.ApiException(400, "Missing required parameter 'processRequest' when calling ProcessApi->ApiProcess");


            Regula.DocumentReader.WebClient.Client.RequestOptions localVarRequestOptions = new Regula.DocumentReader.WebClient.Client.RequestOptions();

            string[] _contentTypes = new string[] {
                "application/json"
            };

            // to determine the Accept header
            string[] _accepts = new string[] {
                "application/json"
            };


            var localVarContentType = Regula.DocumentReader.WebClient.Client.ClientUtils.SelectHeaderContentType(_contentTypes);
            if (localVarContentType != null) localVarRequestOptions.HeaderParameters.Add("Content-Type", localVarContentType);

            var localVarAccept = Regula.DocumentReader.WebClient.Client.ClientUtils.SelectHeaderAccept(_accepts);
            if (localVarAccept != null) localVarRequestOptions.HeaderParameters.Add("Accept", localVarAccept);

            if (xRequestID != null)
            {
                localVarRequestOptions.HeaderParameters.Add("X-RequestID", Regula.DocumentReader.WebClient.Client.ClientUtils.ParameterToString(xRequestID)); // header parameter
            }
            localVarRequestOptions.Data = processRequest;


            // make the HTTP request

            var localVarResponse = await this.AsynchronousClient.PostAsync<ProcessResponse>("/api/process", localVarRequestOptions, this.Configuration, cancellationToken).ConfigureAwait(false);

            if (this.ExceptionFactory != null)
            {
                Exception _exception = this.ExceptionFactory("ApiProcess", localVarResponse);
                if (_exception != null) throw _exception;
            }

            return localVarResponse;
        }

    }
}